# 查询自定义作业详情 - ShowDocument
#### 功能介绍
查询用户自定义作业详情。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ShowDocument)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                      | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | coc:document:getDocument | Read | document \* | -   | -  | -      |
     
#### URI
GET /v1/documents/{document_id}
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                             |
|:---|:---|:---|:---|
| document_id | 是    | String | **参数解释：** 作业uuid。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
表2Query参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                    |
|:---|:---|:---|:---|
| version       | 否    | String | **参数解释：** 作业版本号，示例值v1、v2，不传默认查询最新版本。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。     |
| document_type | 否    | String | **参数解释：** 执行的作业类型。 **约束限制：** 不涉及。 **取值范围：** - PRIVATE：私有。 - PUBLIC：公共。 **默认取值：** 不涉及。 |
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                                     | 描述                                                                                           |
|:---|:---|:---|
| error_code | String                                                                   | **参数解释：** 错误码。 **取值范围：** 参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。  |
| error_msg  | String                                                                   | **参数解释：** 错误信息。 **取值范围：** 参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 |
| data       | [data] object | 返回数据。                                                                                        |
   
 表4data 
| 参数                    | 参数类型                                                                                                         | 描述                                   |
|:---|:---|:---|
| id                    | String                                                                                                       | **参数解释：** 作业id。 **取值范围：** 不涉及。       |
| document_id           | String                                                                                                       | **参数解释：** 作业uuid。 **取值范围：** 不涉及。     |
| name                  | String                                                                                                       | **参数解释：** 作业名称。 **取值范围：** 不涉及。       |
| content               | String                                                                                                       | **参数解释：** 作业内容，DSL语句。 **取值范围：** 不涉及。 |
| create_time           | Long                                                                                                         | **参数解释：** 创建时间。 **取值范围：** 不涉及。       |
| update_time           | Long                                                                                                         | **参数解释：** 更新时间。 **取值范围：** 不涉及。       |
| version               | String                                                                                                       | **参数解释：** 作业版本，如v1。 **取值范围：** 不涉及。   |
| creator               | String                                                                                                       | **参数解释：** 创建人。 **取值范围：** 不涉及。        |
| modifier              | String                                                                                                       | **参数解释：** 修改人。 **取值范围：** 不涉及。        |
| enterprise_project_id | String                                                                                                       | **参数解释：** 企业项目id。 **取值范围：** 不涉及。     |
| versions              | Array of [DocumentVersionVo] objects | **参数解释：** 版本集合。 **取值范围：** 不涉及。       |
   
 表5DocumentVersionVo 
| 参数           | 参数类型   | 描述                                |
|:---|:---|:---|
| version      | String | **参数解释：** 版本号，如v1。 **取值范围：** 不涉及。 |
| version_uuid | String | **参数解释：** 版本id。 **取值范围：** 不涉及。    |
| create_time  | String | **参数解释：** 版本创建时间。 **取值范围：** 不涉及。  |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。  |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)章节。 |
   
#### 请求示例
查询指定自定义作业详情。
```
GET https://{Endpoint}/v1/documents/{document_id}
```
#### 响应示例
**状态码：200**
请求成功。
```
{
  "data" : {
    "id" : 123,
    "document_id" : "DM2025070118023xxxxxxxxxx",
    "name" : "test_document",
    "content" : "meta:\n  name: test_document\n  schemaVersion: 3\n  description: \"\"\ninputs: {}\nsteps:\n  - name: pause\n    description: pause\n    task: hwc:runbook:suspend@1.0.0\n    inputs: {}\n    outputs: []",
    "create_time" : 1751364159273,
    "update_time" : 1751374833988,
    "version" : "v2",
    "creator" : "COC-xxxxx",
    "modifier" : "COC-xxxx",
    "enterprise_project_id" : "0",
    "versions" : [ {
      "version_uuid" : "573634e7-5e69-4b4b-b4a1-b74xxxx",
      "create_time" : 1751374833988,
      "version" : "v2"
    }, {
      "version_uuid" : "4530982f-f60b-479e-8145-b6d3xxxx",
      "create_time" : 1751364159273,
      "version" : "v1"
    } ]
  }
}
```
#### 状态码
| 状态码 | 描述                                                                                 |
|:---|:---|
| 200 | 请求成功。                                                                              |
| 400 | 包含错误信息。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。
