当您在DataWorks数据开发页面创建的文件提交成功后,文件将进入发布检查状态,DataWorks会将文件发布检查事件返回给您,您需要根据事件内容判断该文件是否可以继续进行发布校验。此时,可以通过调用CheckFileDeployment接口,将待发布文件的检查结果返回至DataWorks。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CheckFileDeployment |
要执行的操作。 |
CheckerInstanceId | String | 是 | 66_123455623_2 |
文件检查器所属的实例ID。您可以从文件发布检查事件中的CheckerInstanceId获取。 |
RegionId | String | 是 | cn-hangzhou |
服务所属的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。 |
Status | String | 是 | OK |
待发布文件的检查状态,取值如下:
|
CheckDetailUrl | String | 否 | https://result.aliyun.com/?checkerInstanceId= |
已废弃。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 86d5a5ac-0cc0-4c5f-a374-a15713b252ab |
请求ID,用于后续问题排查。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CheckFileDeployment
&CheckerInstanceId=66_123455623_2
&RegionId=cn-hangzhou
&Status=OK
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>86d5a5ac-0cc0-4c5f-a374-a15713b252ab</RequestId>
JSON
格式
{
"RequestId": "86d5a5ac-0cc0-4c5f-a374-a15713b252ab"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
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. | 您的请求过于频繁,请尝试放缓请求速度。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。