History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
变量名 | 变量说明 | 是否包含子变量 | 是否必选 |
bucket | 对象上传的目标存储桶。 | 否 | 否 |
object | 对象上传到存储桶内，使用的对象名称。 | 否 | 否 |
size | 对象大小，单位为 Byte。 | 否 | 否 |
region | 对象上传的存储桶所在地域。 | 否 | 否 |
mimeType | 对象元数据 Content-Type。 | 否 | 否 |
exif | 如果上传的对象为图片类型，支持查看图片的 exif 信息，变量填写格式为 ${exif.子变量}。注意： 为了避免 ReturnBody 携带的内容太多，影响接口性能，不建议直接填写 ${exif}，建议写明具体的子变量。 | 是 | 否 |
videoInfo | 如果上传的对象为音视频类型，支持查看音视频资源的元信息。变量填写格式为 ${videoInfo.子变量}。注意： 为了避免 ReturnBody 携带的内容太多，影响接口性能，不建议直接填写 ${videoInfo}，建议写明具体的子信息项。 | 是 | 否 |
imageInfo | 如果上传的对象为图片类型，支持查看图片的基本信息，变量填写格式为 ${imageInfo.子变量}。注意： 为了避免 ReturnBody 携带的内容太多，影响接口性能，不建议直接填写 ${imageInfo}，建议写明具体的子变量。 | 是 | 否 |
${变量名.子变量}、${变量名.二级子变量}。并且，为了避免 ReturnBody 携带的内容太多，影响接口性能，不建议直接填写${imageInfo}，建议写明具体的子变量。${}包裹，变量名对应的值是需要获取的回调信息。ReturnBody 支持的变量名，请参见上方的 系统变量。示例如下：# 图片信息获取示例{"bucket": "${bucket}","key": "${object}","myfilesize": "${size}","height": "${imageInfo.height}"}{"bucket":"${bucket}","key":"${object}","myfilesize":"${size}","video_duration":"${videoInfo.format.duration}","video_bitrate":"${videoInfo.format.bit_rate}"}
# 图片信息获取示例eyJidWNrZXQiOiAiJHtidWNrZXR9IiwgImtleSI6ICIke29iamVjdH0iLCAibXlmaWxlc2l6ZSI6ICIke3NpemV9IiwgImhlaWdodCI6ICIke2ltYWdlSW5mby5oZWlnaHR9In0=# 视频信息获取示例ewogICAgImJ1Y2tldCI6ICIke2J1Y2tldH0iLAogICAgImtleSI6ICIke29iamVjdH0iLAogICAgIm15ZmlsZXNpemUiOiAiJHtzaXplfSIsCiAgICAidmlkZW9fZHVyYXRpb24iOiAiJHt2aWRlb0luZm8uZm9ybWF0LmR1cmF0aW9ufSIsCiAgICAidmlkZW9fYml0cmF0ZSI6ICIke3ZpZGVvSW5mby5mb3JtYXQuYml0X3JhdGV9Igp9
x-cos-return-body 传入 Base64 编码的结果。请求示例如下：PUT /<ObjectKey> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateContent-Type: Content TypeContent-Length: Content LengthContent-MD5: MD5x-cos-return-body: eyJidWNrZXQiOiAiJHtidWNrZXR9IiwgImtleSI6ICIke29iamVjdH0iLCAibXlmaWxlc2l6ZSI6ICIke3NpemV9IiwgImhlaWdodCI6ICIke2ltYWdlSW5mby5oZWlnaHR9In0=Authorization: Auth String[Object Content]
x-cos-return-body 传入 Base64 编码的结果。POST / HTTP/1.1Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.comDate: Thu, 29 Aug 2019 07:39:34 GMTContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Length: 1119Connection: close------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="q-sign-algorithm"sha1------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="q-ak"AKIDLdDGwRp0KIuI9sZDeJG3xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="q-key-time"1759216346;1759217246------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="q-signature"71f6d4a559axxxxxxxxxxxxxxxxxxxxxxxxx------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="policy"eyJleHBpcmF0aW9uIjoiMjAyNS0wOS0zMFQwNzoyNzoyNi4wMDBaIiwiY29uZGl0aW9ucyI6W3sicS1zaWduLWFsZ29yaXRobSI6InNoYTEifSx7InEtYWsiOiJBS0lETGRER3dScDBLSXVJOXNaRGVKRzN4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHgifSx7InEtc2lnbi10aW1lIjoiMTc1OTIxNjM0NjsxNzU5MjE3MjQ2In0seyJidWNrZXQiOiJleGFtcGxlYnVja2V0LTEyNTAwMDAwMDAifSx7ImtleSI6ImV4YW1wbGVvYmplY3QifV19------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="x-cos-security-token"ZflOqzkNb2266djz4xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="key"exampleobject------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="x-cos-return-body"ewogICAgImJ1Y2tldCI6ICIke2J1Y2tldH0iLAogICAgImtleSI6ICIke29iamVjdH0iLAogICAgIm15ZmlsZXNpemUiOiAiJHtzaXplfSIsCiAgICAidmlkZW9fZHVyYXRpb24iOiAiJHt2aWRlb0luZm8uZm9ybWF0LmR1cmF0aW9ufSIsCiAgICAidmlkZW9fYml0cmF0ZSI6ICIke3ZpZGVvSW5mby5mb3JtYXQuYml0X3JhdGV9Igp9------WebKitFormBoundaryZBPbaoYE2gqeB21NContent-Disposition: form-data; name="file"; filename="example.mp4"Content-Type: video/mp4[Object Content]------WebKitFormBoundaryZBPbaoYE2gqeB21N--
POST /exampleobject?uploadId=UploadId HTTP/1.1Host: exmaplebucket-1250000000.cos.region.myqcloud.comx-cos-return-body: ewogICAgImJ1Y2tldCI6ICIke2J1Y2tldH0iLAogICAgImtleSI6ICIke29iamVjdH0iLAogICAgIm15ZmlsZXNpemUiOiAiJHtzaXplfSIsCiAgICAidmlkZW9fZHVyYXRpb24iOiAiJHt2aWRlb0luZm8uZm9ybWF0LmR1cmF0aW9ufSIsCiAgICAidmlkZW9fYml0cmF0ZSI6ICIke3ZpZGVvSW5mby5mb3JtYXQuYml0X3JhdGV9Igp9Date: GMT DateContent-Type: application/xmlContent-Length: Content LengthContent-MD5: MD5Authorization: Auth String[Request Body]
HTTP/1.1 200 OKx-cos-request-id: NWU5MDNkZjVfYzVjNzJhMDlfMjVhNzNfMWMy****{"bucket": "examplebucket-1250000000000","height": "887","key": "test.jpeg","myfilesize": "214513"}
HTTP/1.1 201 OKx-cos-request-id: NWU5MDNkZjVfYzVjNzJhMDlfMjVhNzNfMWMy****{"bucket": "examplebucket-1250000000000","key": "test.mp4","myfilesize": "214513","video_duration": 1000,"video_bitrate": 1000}
节点名称（关键字） | 父节点 | 描述 | 类型 |
ReturnBodyResult | CompleteMultipartUploadResult | ReturnBody 的结果信息。 | Container |
Status | CompleteMultipartUploadResult.ReturnBodyResult | ReturnBody 获取是否成功。枚举值支持 200、203。 200表示上传成功、获取 ReturnBody 成功； 203表示上传成功，获取 ReturnBody 失败。 | Integer |
Error | CompleteMultipartUploadResult.ReturnBodyResult | Status 为203时，说明获取 ReturnBody 失败。返回 Error，说明回调失败信息。 | Container |
Code | CompleteMultipartUploadResult.ReturnBodyResult | 回调失败信息的错误码，例如 GetReturnBodyFailed。 | String |
Message | CompleteMultipartUploadResult.ReturnBodyResult | ReturnBody 获取失败的错误信息。 | String |
ReturnBody | CompleteMultipartUploadResult.ReturnBodyResult | Status 为200时，说明上传成功、回调成功，返回 ReturnBody。内容为 ReturnBody 的 json 字符串 Base64 编码后的字符串。 | String |
HTTP/1.1 200 OKContent-Type: application/xml<CompleteMultipartUploadResult><Location>http://examplebucket-1250000000.cos.ap-beijing.myqcloud.com/exampleobject</Location><Bucket>examplebucket-1250000000</Bucket><Key>exampleobject</Key><ETag>"aa259a62513358f69e98e******"</ETag><ReturnBodyResult><Status>200|203</Status><!--Status为203时，说明ReturnBody失败，返回 Error--><Error><Code>GetReturnBodyFailed</Code><Message>Invalid return body params.</Message></Error><!--Status为200时，说明上传成功、ReturnBody计算成功，返回 json 字符串 base64 编码后的结果。--><ReturnBody>eyJhIjogImIifQ==</ReturnBody></ReturnBodyResult></CompleteMultipartUploadResult>
失败原因 | 返回码 | ErrorCode | Message |
ReturnBody 参数不合法。 | 203 | GetReturnBodyFailed | Invalid return body params. |
调用数据万象服务，由于访问无权限、未开通服务等原因导致参数获取失败。 | 203 | GetReturnBodyFailed | Error status from ci: ${code}, should return 200 OK. 其中， ${code}为数据服务返回的错误码，例如 400、403等。 |
文档反馈