This API is used to create a screenshot template.
POST /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Note:
- Authorization: Auth String (for more information, see Request Signature).
- When this feature is used by a sub-account, relevant permissions must be granted as instructed in Authorization Granularity Details.
This API only uses common request headers. For more information, see Common Request Headers.
This request requires the following request body:
<Request>
<Tag>Snapshot</Tag>
<Name>TemplateName</Name>
<Snapshot>
<Mode>Interval</Mode>
<Width>1280</Width>
<Height>960</Height>
<Start>0</Start>
<TimeInterval>0.5</TimeInterval>
<Count>10</Count>
<SnapshotOutMode>OnlySprite</SnapshotOutMode>
<SpriteSnapshotConfig>
<Color>Aquamarine</Color>
<Columns>3</Columns>
<Lines>3</Lines>
</SpriteSnapshotConfig>
</Snapshot>
</Request>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Request | None | Request container | Container | Yes |
Request
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Tag | Request | Template tag: Snapshot | String | Yes |
Name | Request | Template name, which can contain letters, digits, underscores (_), hyphens (-), and asterisks (*). | String | Yes |
Snapshot | Request | Screenshot | Container | Yes |
Snapshot
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required | Default Value | Constraints |
---|---|---|---|---|---|---|
Mode | Request.Snapshot | Screenshot mode | String | No | Interval |
|
Start | Request.Snapshot | Start time | String | No | 0 |
|
TimeInterval | Request.Snapshot | Screenshot time interval | String | No | None |
|
Count | Request.Snapshot | Number of screenshots | String | Yes | None | (0, 10000] |
Width | Request.Snapshot | Width | String | No | Original video width |
|
Height | Request.Snapshot | Height | String | No | Original video height |
|
CIParam | Request.Snapshot | Screenshot processing parameter | String | No | None |
|
IsCheckCount | Request.Snapshot | Whether to force check the number of screenshots | String | No | false |
|
IsCheckBlack | Request.Snapshot | Whether to enable black screen check | String | No | false | true/false |
BlackLevel | Request.Snapshot | Screenshot black screen check parameter | String | No | None |
|
PixelBlackThreshold | Request.Snapshot | Screenshot black screen check parameter | String | No | None |
|
SnapshotOutMode | Request.Snapshot | Screenshot output mode parameter | String | No | OnlySnapshot |
|
SpriteSnapshotConfig | Request.Snapshot | Image sprite output configuration | Container | No | None | None |
Snapshot.SpriteSnapshotConfig
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required | Default Value | Constraints |
---|---|---|---|---|---|---|
CellWidth | Request.Snapshot.SpriteSnapshotConfig | Subimage width | String | No | Screenshot width |
|
CellHeight | Request.Snapshot.SpriteSnapshotConfig | Subimage height | String | No | Screenshot height |
|
Padding | Request.Snapshot.SpriteSnapshotConfig | Image sprite padding size | String | No | 0 |
|
Margin | Request.Snapshot.SpriteSnapshotConfig | Image sprite margin size | String | No | 0 |
|
Color | Request.Snapshot.SpriteSnapshotConfig | Background color | String | Yes | None | For supported colors, see 2.7 Color. |
Columns | Request.Snapshot.SpriteSnapshotConfig | Number of columns in the image sprite | String | Yes | 0 | Value range: [1, 10000] |
Lines | Request.Snapshot.SpriteSnapshotConfig | Number of rows in the image sprite | String | Yes | 0 | Value range: [1, 10000] |
This API only returns common response headers. For more information, see Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<Template>
<Tag>Snapshot</Tag>
<Name>TemplateName</Name>
<TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<Snapshot>
<Mode>Interval</Mode>
<Width>1280</Width>
<Height>960</Height>
<Start>0</Start>
<TimeInterval>0.5</TimeInterval>
<Count>10</Count>
<SnapshotOutMode>OnlySprite</SnapshotOutMode>
<SpriteSnapshotConfig>
<Color>Aquamarine</Color>
<Columns>3</Columns>
<Lines>3</Lines>
</SpriteSnapshotConfig>
</Snapshot>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</Template>
</Response>
The nodes are as described below:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Response container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Tag | Response | Template tag: Snapshot | String |
Name | Response | Template name | String |
TemplateId | Response | Template ID | String |
UpdateTime | Response | Update time | String |
CreateTime | Response | Creation time | String |
Snapshot | Response | Template parameter, which is the same as the Snapshot in the request body. |
Container |
There are no special error messages for this request. For common error messages, see Error Codes.
POST /template HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml
<Request>
<Tag>Snapshot</Tag>
<Name>TemplateName</Name>
<Snapshot>
<Mode>Interval</Mode>
<Width>1280</Width>
<Height>960</Height>
<Start>0</Start>
<TimeInterval>0.5</TimeInterval>
<Count>10</Count>
<SnapshotOutMode>OnlySprite</SnapshotOutMode>
<SpriteSnapshotConfig>
<Color>Aquamarine</Color>
<Columns>3</Columns>
<Lines>3</Lines>
</SpriteSnapshotConfig>
</Snapshot>
</Request>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
<Response>
<Template>
<Tag>Snapshot</Tag>
<Name>TemplateName</Name>
<TemplateId>t1f16e1dfbdc994105b31292d45710642a</TemplateId>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<Snapshot>
<Mode>Interval</Mode>
<Width>1280</Width>
<Height>960</Height>
<Start>0</Start>
<TimeInterval>0.5</TimeInterval>
<Count>10</Count>
<SnapshotOutMode>OnlySprite</SnapshotOutMode>
<SpriteSnapshotConfig>
<Color>Aquamarine</Color>
<Columns>3</Columns>
<Lines>3</Lines>
</SpriteSnapshotConfig>
</Snapshot>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</Template>
</Response>
Apakah halaman ini membantu?