文档首页/ 云运维中心 COC/ API参考/ API/ 变更管理/ 下载附件 - DownloadAttachment
更新时间:2025-10-23 GMT+08:00
分享

下载附件 - DownloadAttachment

功能介绍

附件下载操作需基于已上传的附件资源。上传附件时,需调用/v1/{ticket_type}/attachments接口完成上传;成功上传后,可从接口响应中获取doc_id参数。下载附件时,凭借此doc_id再次调用/v1/{ticket_type}/attachments接口,即可获取已上传的对应附件资源,实现附件全生命周期管理。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    coc:ticket:downloadFile

    Read

    -

    -

    -

    -

URI

GET /v1/{ticket_type}/attachments/{doc_id}

表1 路径参数

参数

是否必选

参数类型

描述

ticket_type

String

参数解释:

工单类型,此处传递固定值incident。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

缺省值:incident

最小长度:1

最大长度:255

doc_id

String

参数解释:

需要下载的文件唯一ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

最小长度:1

最大长度:100

请求参数

响应参数

状态码:200

请求成功,响应头中Content-Type值为application/octet-stream,表示该接口返回的为文件流。

更多状态码请参考状态码

状态码:400

表2 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释:

服务标识。

取值范围:

不涉及

默认取值:

049

缺省值:049

最小长度:3

最大长度:100000000

error_code

String

参数解释:

请求响应代码。

取值范围:

GOM.00000000~GOM.00009999999

默认取值:

GOM.00000000

缺省值:GOM.00000000

最小长度:1

最大长度:15

error_msg

String

参数解释:

请求响应描述。

取值范围:

不涉及

最小长度:0

最大长度:100000000

请求示例

下载附件请求示例。

GET https://{Endpoint}/v1/incident/attachments/c70d6b38-3783-4d62-9c4a-c6924925e848

响应示例

状态码:400

服务器未能处理请求。

更多状态码请参考状态码

{
  "error_code" : "GOM.00007256",
  "error_msg" : "参数错误",
  "provider_code" : 4,
  "data" : null
}

状态码

状态码

描述

200

请求成功,响应头中Content-Type值为application/octet-stream,表示该接口返回的为文件流。

更多状态码请参考状态码

400

服务器未能处理请求。

更多状态码请参考状态码

错误码

请参见错误码

相关文档