- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
执行自定义作业
功能介绍
执行自定义作业。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/documents/{document_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
document_id |
是 |
String |
参数解释: 作业id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
version |
否 |
String |
参数解释: 作业版本号,若不传则默认为最新版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
parameters |
否 |
Array of parameters objects |
参数解释: 全局参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sys_tags |
否 |
Array of sys_tags objects |
参数解释: 系统标签列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
target_parameter_name |
否 |
String |
参数解释: 速率控制模式下,批量执行对象的参数名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
targets |
否 |
Array of targets objects |
参数解释: 与target_parameter_name搭配使用。选择实例化target_parameter_name参数的方式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
document_type |
否 |
String |
参数解释: 执行的作业类型。
约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 执行描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
参数解释: 参数的key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
value |
否 |
String |
参数解释: 参数的value。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
String |
参数解释: 执行作业,系统返回的作业工单id。 取值范围: 不涉及。 |
状态码:400
请求示例
执行自定义作业。
POST https://{Endpoint}/v1/documents/{document_id}
{
"version" : "v2",
"parameters" : [ {
"key" : "domain_id",
"value" : "dc2d76541f754d68xxxxxxxxx"
}, {
"key" : "project_id",
"value" : "e451729b938f491xxxxxxxxxxxxx"
}, {
"key" : "agency_urn",
"value" : "iam::dc2d76541f754d68a4c8d150xxxxxx:agency:ServiceAgencyForCOC"
} ]
}
响应示例
状态码:200
请求成功。
{
"data" : "EX20250701210145012xxxxxx"
}
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
包含错误信息。 更多状态码请参考状态码。 |
错误码
请参见错误码。