# 执行自定义作业 - ExecuteDocument
#### 功能介绍
执行用户自定义作业。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ExecuteDocument)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                  | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | coc:document:execute | Write | document \* | -   | -  | -      |
     
#### URI
POST /v1/documents/{document_id}
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                           |
|:---|:---|:---|:---|
| document_id | 是    | String | **参数解释：** 作业id。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
#### 请求参数
表2请求Body参数 
| 参数                    | 是否必选 | 参数类型                                                                                             | 描述                                                                                                                 |
|:---|:---|:---|:---|
| 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                                                                                           | **参数解释：** 执行的作业类型。 **约束限制：** 不涉及。 **取值范围：** - PRIVATE：私有。 - PUBLIC：公共。 **默认取值：** 不涉及。                              |
| description           | 否    | String                                                                                           | **参数解释：** 执行描述。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                       |
   
 表3parameters 
| 参数    | 是否必选 | 参数类型   | 描述                                                                    |
|:---|:---|:---|:---|
| key   | 否    | String | **参数解释：** 作业参数的key。 **约束限制：** 不涉及。 **取值范围：** 不涉及，用户定义。 **默认取值：** 不涉及。 |
| value | 否    | String | **参数解释：** 参数的value。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。      |
   
 表4sys_tags 
| 参数    | 是否必选 | 参数类型   | 描述                                                                    |
|:---|:---|:---|:---|
| key   | 否    | String | **参数解释：** 系统标签的key。 **约束限制：** 不涉及。 **取值范围：** 不涉及，用户定义。 **默认取值：** 不涉及。 |
| value | 否    | String | **参数解释：** 系统标签的value。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。    |
   
 表5targets 
| 参数     | 是否必选 | 参数类型             | 描述                                                                                                                                     |
|:---|:---|:---|:---|
| key    | 否    | String           | **参数解释：** 实例化执行目标的维度，枚举：InstanceValues，BatchValues。 **约束限制：** 不涉及。 **取值范围：** - InstanceValues：实例模式。 - BatchValues：批次模式。 **默认取值：** 不涉及。 |
| values | 否    | Array of strings | **参数解释：** 根据target_parameter_name指定全局参数指定要执行的目标实例。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                        |
   
#### 响应参数
**状态码：200**
表6响应Body参数 
| 参数   | 参数类型   | 描述                                         |
|:---|:---|:---|
| data | String | **参数解释：** 执行作业，系统返回的作业工单id。 **取值范围：** 不涉及。 |
   
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。  |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 |
   
#### 请求示例
执行自定义作业。
```
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 | 包含错误信息。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。