用于在数据开发过程中触发扩展点时,通过将扩展程序对扩展点事件的检查结果返回给数据开发系统。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MessageId | string | 否 | DataWorks 开放消息的消息 ID。当触发扩展点事件后,您可以从接收到的事件消息中获取消息 ID。 消息格式,可参考消息格式。 | 8abcb91f-d266-4073-b907-2ed670378ed1 |
ExtensionCode | string | 否 | 扩展程序的唯一标识。您可以登录 DataWorks 控制台,进入开放平台的 Extensions 页签查看标识。 | 8abcb91f-d266-4073-b907-2ed670378ed1 |
CheckResult | string | 否 | 扩展程序对本次扩展点事件的检查状态。取值如下:
| OK |
CheckResultTip | string | 否 | 扩展程序对本次扩展点事件进行检查的摘要信息。该信息会显示在您当前的开发页面上,当本次检查存在警告或者检查不通过时,您可以通过该摘要信息快速定位原因。 | Succeeded |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 没有权限,请授权 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史