文档首页/ 云运维中心 COC/ API参考/ API/ 变更管理/ 上传附件
更新时间：2025-09-04 GMT+08:00
查看PDF
分享

上传附件

功能介绍

上传附件，创建工单（事件单、变更单、问题单）的场景下，如需上传附件，需要先调用该接口将文件上传到obs。上传成功时，该接口将返回文档唯一id。支持文件类型：.jpg,.png,.docx,.txt,.pdf，且文本大小不超10M。

调试

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

URI

POST /v1/{ticket_type}/attachments

表1 路径参数

参数

是否必选

参数类型

描述

ticket_type

是

String

参数解释：

工单创建场景中，ticket_type字段需固定传入incident作为工单类型标识。值得注意的是，尽管该字段默认值指向的是事件单类型，但当创建变更单或问题单并需要上传附件时，仍统一使用此接口完成附件提交操作。

约束限制：

不涉及

取值范围：

固定值incident

默认取值：

不涉及

请求参数

表2 FormData参数

参数

是否必选

参数类型

描述

file

是

File

参数解释：

需要上传的文件，以表单的形式上传。

约束限制：

内容为二进制binary文本。支持文件类型：.jpg、.png、.docx、.txt、.pdf，且文本大小不超10M。

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

code

String

参数解释：

请求响应代码。

取值范围：

GOM.00000000~GOM.00009999999

默认取值：

GOM.00000000

provider_code

String

参数解释：

服务编码。

取值范围：

不涉及

默认取值：

049

msg

String

参数解释：

请求响应描述。

  • code为0，此值为空
  • code不为0，此值为具体的错误描述

取值范围：

不涉及

默认取值：

不涉及

data

ExternalAttachment object

参数解释：

上传成功后的附件信息。

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

附件文件名。

取值范围：

不涉及

默认取值：

不涉及

id

String

参数解释：

附件唯一id。

取值范围：

不涉及

默认取值：

不涉及
表4 ExternalAttachment

参数

参数类型

描述

doc_id

String

参数解释：

附件唯一id。

取值范围：

不涉及

默认取值：

不涉及

doc_name

String

参数解释：

附件文件名。

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表5 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

不涉及

默认取值：

049

error_code

String

参数解释：

请求响应代码。

取值范围：

GOM.00000000~GOM.00009999999

默认取值：

GOM.00000000

error_msg

String

参数解释：

请求响应描述。

取值范围：

不涉及

默认取值：

不涉及

请求示例

上传附件请求示例。

POST https://{Endpoint}/v1/incident/attachments

form-data表单：
key: file
value: binary二进制文件

响应示例

状态码：200

请求成功。

更多状态码请参考状态码。

{
  "name" : "uploadFile.doc",
  "id" : "78f86d47-55d6-4e98-ba51-b293ac95bc8a",
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : "049",
  "data" : {
    "doc_id" : "78f86d47-55d6-4e98-ba51-b293ac95bc8a",
    "doc_name" : "uploadFile.doc"
  }
}

状态码：400

服务器未能处理请求。

更多状态码请参考状态码。

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

状态码

状态码

描述

200

请求成功。

更多状态码请参考状态码。

400

服务器未能处理请求。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题： 变更管理

相关文档