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
cos:GetObject、ci:CreateAIImageCropJob。cos:PutObject。cos:PutObject。GET /<ObjectKey>?ci-process=AIImageCrop&width=<width>&height=<height>&fixed=<fixed> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
GET /?ci-process=AIImageCrop&width=<width>&height=<height>&fixed=<fixed>&detect-url=<detect-url> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
参数 | 含义 | 类型 | 是否必选 |
ObjectKey | 对象文件名，例如：folder/document.jpg | String | 否 |
ci-process | 数据万象处理能力，智能裁剪固定为 AIImageCrop | String | 是 |
detect-url | 您可以通过填写 detect-url 处理任意公网可访问的图片链接。不填写 detect-url 时，后台会默认处理 ObjectKey ，填写了 detect-url 时，后台会处理 detect-url 链接，无需再填写 ObjectKey。 detect-url 示例： http://www.example.com/abc.jpg ，需要进行 UrlEncode，处理后为http%3A%2F%2Fwww.example.com%2Fabc.jpg | String | 否 |
width | 需要裁剪区域的宽度，与 height 共同组成所需裁剪的图片宽高比例；输入数字请大于0、小于图片宽度的像素值 | Double | 是 |
height | 需要裁剪区域的高度，与 width 共同组成所需裁剪的图片宽高比例；输入数字请大于0、小于图片高度的像素值；width : height 建议取值在[1, 2.5]之间，超过这个范围可能会影响效果 | Double | 是 |
fixed | 是否严格按照 width 和 height 的值进行输出 取值为0时，宽高比例（width : height）会简化为最简分数，即如果 width 输入10、height 输入20，会简化为1：2 取值为1时，输出图片的宽度等于 width，高度等于 height；默认值为0 | Integer | 否 |
ignore-error | 当此参数为1时，针对文件过大等导致处理失败的场景，会直接返回原图而不报错 | Integer | 否 |
HTTP/1.1 200 OKContent-Type: image/pngContent-Length: 98645Date: Tue, 23 Apr 2022 09:06:16 GMTStatus: 200 OKServer: tencent-cix-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****[pic-content]
GET /filename.jpg?ci-process=AIImageCrop&width=<width>&height=<height>&fixed=<fixed> HTTP/1.1Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comDate: Tue, 23 Apr 2022 09:06:16 GMTAuthorization: <Auth String>
HTTP/1.1 200 OKContent-Type: image/jpgContent-Length: 98645Date: Tue, 23 Apr 2022 09:06:16 GMTStatus: 200 OKServer: tencent-cix-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****[pic-content]
PUT /<ObjectKey> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth StringPic-Operations: <PicOperations>
头部名称 | 描述 | 类型 |
Pic-Operations | 对图片进行操作的参数 | String |
参数名称 | 描述 | 类型 | 是否必选 |
is_pic_info | 是否返回原图信息，0不返回原图信息，1返回原图信息，默认为0 | Int | 否 |
rules | 处理规则，一条规则对应一个处理结果（目前支持五条规则），不填则不进行图片处理 | Array | 否 |
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 存储结果的目标存储桶名称，格式为 BucketName-AppId，如果不指定的话默认保存到当前存储桶 | String | 否 |
fileid | 处理后文件的保存路径及名称。名称规则说明： 例如源文件的路径及文件名为：/p1/test1.jpg 以/开头为绝对路径，例如 fileid 值为 /p2/test2.jpg 时，表示在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件 不以/开头为相对路径，例如 fileid 值为 p2/test2.jpg 时，表示在 p1 文件夹中新建了一个 p2 文件夹，然后在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件 注意：请不要以/结尾，否则会产生空文件名 如希望修复后的图片覆盖原图，请将 fileid 字段设置为<ObjectKey> | String | 是 |
rule | 处理参数 | String | 是 |
参数名称 | 描述 | 类型 | 是否必选 |
ci-process | 数据万象处理能力，智能裁剪参数固定为 AIImageCrop | String | 是 |
width | 需要裁剪区域的宽度，与 height 共同组成所需裁剪的图片宽高比例；输入数字请大于0、小于图片宽度的像素值 | Integer | 是 |
height | 需要裁剪区域的高度，与 width 共同组成所需裁剪的图片宽高比例；输入数字请大于0、小于图片高度的像素值；width : height 建议取值在[1, 2.5]之间，超过这个范围可能会影响效果 | Integer | 是 |
fixed | 是否严格按照 width 和 height 的值进行输出 取值为0时，宽高比例（width : height）会简化为最简分数，即如果 width 输入10、height 输入20，会简化为1：2 取值为1时，输出图片的宽度等于 width，高度等于 height；默认值为0 | Integer | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 |
UploadResult | 无 | 请求结果 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
OriginalInfo | UploadResult | 原图信息 | Container |
ProcessResults | UploadResult | 请求处理结果 | Container |
节点名称 | 父节点 | 描述 | 类型 |
Key | OriginalInfo | 原图文件名 | String |
Location | OriginalInfo | 图片路径 | String |
ETag | OriginalInfo | 原图 ETag 值 | String |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Object | ProcessResults | 每个图片的处理结果 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Key | Object | 裁剪后图片文件名 | String |
Location | Object | 裁剪后的图片链接 | String |
ETag | Object | 裁剪后图片的 ETag 值 | String |
Size | Object | 裁剪后图片大小 | Int |
PUT /<ObjectKey> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth StringPic-Operations:{"is_pic_info": 1,"rules": [{"fileid": "exampleobject","rule": "ci-process=AIImageCrop&width=<width>&height=<height>&fixed=<fixed>"}]}
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 23 Apr 2022 09:06:16 GMTStatus: 200 OKServer: tencent-cix-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<UploadResult><OriginalInfo><Key>ObjectKey</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/filename.jpg</Location><ETag>"ed60e3598e6862d8c8443a06acfb2153"</ETag></OriginalInfo><ProcessResults><Object><Key>exampleobject</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location><Format/><Size>354256</Size><ETag>"521451f63c331becf533e466732c1091"</ETag></Object></ProcessResults></UploadResult>
POST /<ObjectKey>?image_process HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth StringPic-Operations: <PicOperations>
头部名称 | 描述 | 类型 |
Pic-Operations | 对图片进行操作的参数 | String |
参数名称 | 描述 | 类型 | 是否必选 |
is_pic_info | 是否返回原图信息，0不返回原图信息，1返回原图信息，默认为0 | Int | 否 |
rules | 处理规则，一条规则对应一个处理结果（目前支持五条规则），不填则不进行图片处理 | Array | 否 |
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 存储结果的目标存储桶名称，格式为 BucketName-AppId，如果不指定的话默认保存到当前存储桶 | String | 否 |
fileid | 处理后文件的保存路径及名称。名称规则说明： 例如源文件的路径及文件名为：/p1/test1.jpg 以/开头为绝对路径，例如 fileid 值为 /p2/test2.jpg 时，表示在 p2文件夹中存储了一个文件名为 test2.jpg 的文件 不以/开头为相对路径，例如 fileid 值为 p2/test2.jpg 时，表示在 p1文件夹中新建了一个 p2文件夹，然后在 p2文件夹中存储了一个文件名为 test2.jpg 的文件 注意：请不要以/结尾，否则会产生空文件名 如希望修复后的图片覆盖原图，请将 fileid 字段设置为<ObjectKey> | String | 是 |
rule | 处理参数 | String | 是 |
参数名称 | 描述 | 类型 | 是否必选 |
ci-process | 数据万象处理能力，智能裁剪参数固定为 AIImageCrop | String | 是 |
width | 需要裁剪区域的宽度，与 height 共同组成所需裁剪的图片宽高比例；输入数字请大于0、小于图片宽度的像素值 | Integer | 是 |
height | 需要裁剪区域的高度，与 width 共同组成所需裁剪的图片宽高比例；输入数字请大于0、小于图片高度的像素值；width : height 建议取值在[1, 2.5]之间，超过这个范围可能会影响效果 | Integer | 是 |
fixed | 是否严格按照 width 和 height 的值进行输出 取值为0时，宽高比例（width : height）会简化为最简分数，即如果 width 输入10、height 输入20，会简化为1：2 取值为1时，输出图片的宽度等于 width，高度等于 height；默认值为0 | Integer | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 |
UploadResult | 无 | 请求结果 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
OriginalInfo | UploadResult | 原图信息 | Container |
ProcessResults | UploadResult | 请求处理结果 | Container |
节点名称 | 父节点 | 描述 | 类型 |
Key | OriginalInfo | 原图文件名 | String |
Location | OriginalInfo | 图片路径 | String |
ETag | OriginalInfo | 原图 ETag 值 | String |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Object | ProcessResults | 每个图片的处理结果 | Container |
节点名称（关键字） | 父节点 | 描述 | 类型 |
Key | Object | 裁剪后图片文件名 | String |
Location | Object | 裁剪后的图片链接 | String |
ETag | Object | 裁剪后图片的 ETag 值 | String |
Size | Object | 裁剪后图片大小 | Int |
POST /<ObjectKey>?image_process HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateContent-length: SizeAuthorization: Auth StringPic-Operations:{"rules": [{"fileid": "exampleobject","rule": "ci-process=AIImageCrop&width=<width>&height=<height>&fixed=<fixed>"}]}
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 23 Apr 2022 09:06:16 GMTStatus: 200 OKServer: tencent-cix-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<UploadResult><OriginalInfo><Key>ObjectKey</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/filename.jpg</Location><ETag>"ed60e3598e6862d8c8443a06acfb2153"</ETag></OriginalInfo><ProcessResults><Object><Key>exampleobject</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location><Format/><Size>354256</Size><ETag>"521451f63c331becf533e466732c1091"</ETag></Object></ProcessResults></UploadResult>
文档反馈