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
水印类型 | 特性 | 适用场景 |
半盲水印（type1） | 抗攻击性强，但提取水印需原图 | 小图（640px x 640px以下）使用 |
全盲水印（type2） | 提取方便，提取水印仅需水印图，无需对比原图 | 批量添加，批量校验 |
文字盲水印（type3） | 可直接将文字信息添加至图片中 | 终端信息添加 |
PUT /<ObjectKey> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth StringPic-Operations: <PicOperations>[Object Content]
参数名称 | 描述 | 类型 | 是否必选 |
is_pic_info | 是否返回原图信息。0表示不返回原图信息，1表示返回原图信息，默认为0 | Int | 否 |
rules | 处理规则，一条规则对应一个处理结果（目前最多支持五条规则），不填则不进行图片处理 | Array | 否 |
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 存储结果的目标存储桶名称，格式为：BucketName-APPID，如果不指定的话默认保存到当前存储桶 | String | 否 |
fileid | 处理后文件的保存路径及名称。名称规则说明： 例如源文件的路径及文件名为：/p1/test1.jpg 1. 以/开头为绝对路径，例如 fileid 值为 /p2/test2.jpg 时，表示在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件。 2. 不以 / 开头为相对路径，例如 fileid 值为 p2/test2.jpg 时，表示在 p1 文件夹中新建了一个 p2 文件夹，然后在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件。 3. 注意：请不要以 / 结尾，否则会产生空文件名。 | String | 是 |
rule | 处理参数，可参见图片处理 API。 若按指定样式处理，则以 style/ 开头，后加样式名，如样式名为“test”，则 rule 字段为 style/test | String | 是 |
watermark/3/type/<type>/image/<imageUrl>/text/<text>/level/<level>
参数名称 | 描述 | 类型 | 是否必选 |
type | 盲水印类型，有效值：1为半盲水印；2为全盲水印；3为文字盲水印 | Int | 是 |
image | 盲水印图片地址，需要经过 URL 安全的 Base64 编码。 当 type 为1或2时必填，type 为3时无效。 指定的水印图片必须同时满足如下条件： 1. 盲水印图片与原图片必须位于同一个存储桶下； 2. URL 必须以 http:// 开始，不能省略 http 头，也不能填 https 头，例如以下地址为非法水印地址： examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png https://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png | String | 否 |
text | 盲水印文字，需要经过 URL 安全的 Base64 编码。当 type 为3时必填，type 为1或2时无效。 | String | 否 |
level | 只对全盲水印（type=2）有效。level 的取值范围为{1,2,3}，默认值为1，level 值越大则图片受影响程度越大、盲水印效果越好。 | Int | 否 |
参数名称 | 描述 | 类型 |
UploadResult | 原图信息 | Container |
参数名称 | 描述 | 类型 |
OriginalInfo | 原图信息 | Container |
ProcessResults | 图片处理结果 | Container |
节点名称 | 描述 | 类型 |
Key | 原图文件名 | String |
Location | 图片路径 | String |
ImageInfo | 原图图片信息 | Container |
节点名称 | 描述 | 类型 |
Format | 格式 | String |
Width | 图片宽度 | Int |
Height | 图片高度 | Int |
Quality | 图片质量 | Int |
Ave | 图片主色调 | String |
Orientation | 图片旋转角度 | Int |
节点名称 | 描述 | 类型 |
Object | 每一个图片处理结果 | Container |
节点名称 | 描述 | 类型 |
Key | 文件名 | String |
Location | 图片路径 | String |
Format | 图片格式 | String |
Width | 图片宽度 | Int |
Height | 图片高度 | Int |
Size | 图片大小 | Int |
Quality | 图片质量 | Int |
PUT /exampleobject HTTP/1.1Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comDate: Tue, 03 Apr 2018 09:06:15 GMTAuthorization:XXXXXXXXXXXXPic-Operations:{"is_pic_info": 1,"rules": [{"fileid": "exampleobject","rule": "watermark/3/type/1/image/aHR0cDovL2V4YW1wbGVzLTEyNTEwMDAwMDQucGljc2gubXlxY2xvdWQuY29tL3NodWl5aW4uanBn"}]}Content-Length: 64[Object Content]
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTStatus: 200 OKx-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<UploadResult><OriginalInfo><Key>exampleobject</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location><ImageInfo><Format>JPEG</Format><Width>640</Width><Height>427</Height><Quality>100</Quality><Ave>0xa18454</Ave><Orientation>1</Orientation></ImageInfo></OriginalInfo><ProcessResults><Object><Key>exampleobject</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location><Format>png</Format><Width>640</Width><Height>427</Height><Size>463092</Size><Quality>100</Quality></Object></ProcessResults></UploadResult>
GET /<ObjectKey>?watermark/3/type/<type>/image/<imageUrl>/text/<text> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
参数 | 描述 | 类型 | 是否必选 |
ObjectKey | 对象文件名，例如 folder/sample.jpg。 | String | 是 |
type | 盲水印类型，有效值：1为半盲水印；2为全盲水印；3为文字盲水印 | Int | 是 |
image | 盲水印图片地址，需要经过 URL 安全的 Base64 编码。 当 type 为1或2时必填，type 为3时无效。 指定的水印图片必须同时满足如下条件： 1. 盲水印图片与原图片必须位于同一个存储桶下； 2. URL 必须以 http:// 开始，不能省略 http 头，也不能填 https 头，例如以下地址为非法水印地址： examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png https://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png | String | 否 |
text | 盲水印文字，需要经过 URL 安全的 Base64 编码。 当 type 为3时必填，type 为1或2时无效。 | String | 否 |
level | 只对全盲水印（type=2）有效。level 的取值范围为{1,2,3}，默认值为1，level 值越大则图片受影响程度越大、盲水印效果越好。 | Int | 否 |
https://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/sample.jpeg?watermark/3/type/3/text/dGVuY2VudCBjbG91ZA==
POST /<ObjectKey>?image_process HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization: Auth StringPic-Operations: <PicOperations>
参数名称 | 描述 | 类型 | 是否必选 |
is_pic_info | 是否返回原图信息。0表示不返回原图信息，1表示返回原图信息，默认为0 | Int | 否 |
rules | 处理规则，一条规则对应一个处理结果（目前最多支持五条规则），不填则不进行图片处理 | Array | 否 |
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 存储结果的目标存储桶名称，格式为：BucketName-APPID，如果不指定的话默认保存到当前存储桶 | String | 否 |
fileid | 处理后文件的保存路径及名称。名称规则说明： 例如源文件的路径及文件名为：/p1/test1.jpg 1. 以/开头为绝对路径，例如 fileid 值为 /p2/test2.jpg 时，表示在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件。 2. 不以 / 开头为相对路径，例如 fileid 值为 p2/test2.jpg 时，表示在 p1 文件夹中新建了一个 p2 文件夹，然后在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件。 3. 注意：请不要以 / 结尾，否则会产生空文件名。 | String | 是 |
rule | 处理参数，可参见图片处理 API。 若按指定样式处理，则以 style/ 开头，后加样式名，如样式名为“test”，则 rule 字段为 style/test | String | 是 |
watermark/3/type/<type>/image/<imageUrl>/text/<text>/level/<level>
参数 | 描述 | 类型 | 是否必选 |
type | 盲水印类型，有效值：1为半盲水印；2为全盲水印；3为文字盲水印 | Int | 是 |
image | 盲水印图片地址，需要经过 URL 安全的 Base64 编码。 当 type 为1或2时必填，type 为3时无效。 指定的水印图片必须同时满足如下条件： 1. 盲水印图片与原图片必须位于同一个存储桶下； 2. URL 必须以 http:// 开始，不能省略 http 头，也不能填 https 头，例如以下地址为非法水印地址： examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png https://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png | String | 否 |
text | 盲水印文字，需要经过 URL 安全的 Base64 编码。当 type 为3时必填，type 为1或2时无效。 | String | 否 |
level | 只对全盲水印（type=2）有效。level 的取值范围为{1,2,3}，默认值为1，level 值越大则图片受影响程度越大、盲水印效果越好。 | Int | 否 |
参数名称 | 描述 | 类型 |
UploadResult | 原图信息 | Container |
参数名称 | 描述 | 类型 |
OriginalInfo | 原图信息 | Container |
ProcessResults | 图片处理结果 | Container |
节点名称 | 描述 | 类型 |
Key | 原图文件名 | String |
Location | 图片路径 | String |
ImageInfo | 原图图片信息 | Container |
节点名称 | 描述 | 类型 |
Format | 格式 | String |
Width | 图片宽度 | Int |
Height | 图片高度 | Int |
Quality | 图片质量 | Int |
Ave | 图片主色调 | String |
Orientation | 图片旋转角度 | Int |
节点名称 | 描述 | 类型 |
Object | 每一个图片处理结果 | Container |
节点名称 | 描述 | 类型 |
Key | 文件名 | String |
Location | 图片路径 | String |
Format | 图片格式 | String |
Width | 图片宽度 | Int |
Height | 图片高度 | Int |
Size | 图片大小 | Int |
Quality | 图片质量 | Int |
POST /exampleobject?image_process HTTP/1.1Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comDate: Tue, 03 Apr 2018 09:06:15 GMTAuthorization:XXXXXXXXXXXXPic-Operations:{"is_pic_info": 1,"rules": [{"fileid": "exampleobject","rule": "watermark/3/type/1/image/aHR0cDovL2V4YW1wbGVzLTEyNTEwMDAwMDQucGljc2gubXlxY2xvdWQuY29tL3NodWl5aW4uanBn"}]}Content-Length: 64
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTStatus: 200 OKx-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<UploadResult><OriginalInfo><Key>exampleobject</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location><ImageInfo><Format>JPEG</Format><Width>640</Width><Height>427</Height><Quality>100</Quality><Ave>0xa18454</Ave><Orientation>1</Orientation></ImageInfo></OriginalInfo><ProcessResults><Object><Key>exampleobject</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location><Format>png</Format><Width>640</Width><Height>427</Height><Size>463092</Size><Quality>100</Quality></Object></ProcessResults></UploadResult>
PUT /<ObjectKey> HTTP/1.1Host: <BucketName-APPID>.cos.<Region>.myqcloud.comDate: GMT DateAuthorization:XXXXXXXXXXXXPic-Operations: <PicOperations>[Object Content]
参数名称 | 描述 | 类型 | 是否必选 |
is_pic_info | 是否返回原图信息。0表示不返回原图信息，1表示返回原图信息，默认为0 | Int | 否 |
rules | 处理规则，一条规则对应一个处理结果（目前最多支持五条规则），不填则不进行图片处理 | Array | 否 |
参数名称 | 描述 | 类型 | 是否必选 |
bucket | 存储结果的目标存储桶名称，格式为：BucketName-APPID，如果不指定的话默认保存到当前存储桶 | String | 否 |
fileid | 处理后文件的保存路径及名称。名称规则说明： 例如源文件的路径及文件名为：/p1/test1.jpg 1. 以/开头为绝对路径，例如 fileid 值为 /p2/test2.jpg 时，表示在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件。 2. 不以 / 开头为相对路径，例如 fileid 值为 p2/test2.jpg 时，表示在 p1 文件夹中新建了一个 p2 文件夹，然后在 p2 文件夹中存储了一个文件名为 test2.jpg 的文件。 3. 注意：请不要以 / 结尾，否则会产生空文件名。 | String | 是 |
rule | 处理参数，请参见图片处理 API。 若按指定样式处理，则以 style/ 开头，后加样式名，如样式名为“test”，则 rule 字段为 style/test | String | 是 |
watermark/4/type/<type>/image/<imageUrl>
参数 | 描述 | 类型 | 是否必选 |
type | 盲水印类型，有效值：1为半盲水印；2为全盲水印；3为文字盲水印，必须跟添加盲水印时的 type 类型一致。 | Int | 是 |
image | 图片地址，根据 type 值填写： 当 type 为1，则 image 必填，且为原图图片地址。 当 type 为2，则 image 必填，且为水印图地址。 当 type 为3，则 image 无需填写（无效）。 image 需要经过 URL 安全的 Base64 编码，指定的图片必须同时满足如下条件： 1. 图片与存在水印的图片必须位于同一个对象存储桶下。 2. URL 必须以 http:// 开始，不能省略 http 头，也不能填 https 头，例如以下地址为非法水印地址： examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png https://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/watermark.png | String | 否 |
参数 | 父节点 | 描述 | 类型 |
WatermarkStatus | Object | 当 type 为2时返回该字段，表示提取到全盲水印的可信度。具体为0-100的数字，75分以上表示确定有盲水印，60-75表示疑似有盲水印，60以下可认为未提取到盲水印 | Int |
PUT /exampleobject1 HTTP/1.1Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comDate: Tue, 03 Apr 2018 09:06:15 GMTAuthorization:XXXXXXXXXXXXPic-Operations:{"is_pic_info": 1,"rules": [{"fileid": "exampleobject2","rule": "watermark/4/type/2/image/aHR0cDovL2V4YW1wbGVzLTEyNTEwMDAwMDQucGljc2gubXlxY2xvdWQuY29tL2ZpbGVuYW1lLmpwZWc="}]}Content-Length: 64[Object Content]
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTStatus: 200 OKx-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<UploadResult><OriginalInfo><Key>exampleobject1</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject1</Location><ImageInfo><Format>JPEG</Format><Width>640</Width><Height>427</Height><Quality>100</Quality><Ave>0xa18454</Ave><Orientation>1</Orientation><FrameCount>1</FrameCount></ImageInfo></OriginalInfo><ProcessResults><Object><Key>exampleobject2</Key><Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject2</Location><Format>png</Format><Width>640</Width><Height>427</Height><Size>463092</Size><Quality>100</Quality><FrameCount>1</FrameCount><WatermarkStatus>86</WatermarkStatus></Object></ProcessResults></UploadResult>
文档反馈