产品概述
使用限制
Domain name for API request: tiw.intl.tencentcloudapi.com.
This API is used to query the information about a whiteboard snapshot task.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeSnapshotTask. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore. |
| TaskID | Yes | String | ID of the query task. |
| SdkAppId | Yes | Integer | SdkAppId of the task. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskID | String | Task ID. Note: This parameter may return null, indicating that no valid values can be obtained. |
| Status | String | Task status. Running: The task is running. Finished: The task is finished. Note: This parameter may return null, indicating that no valid values can be obtained. |
| CreateTime | Integer | Creation time of the task. Unit: seconds. Note: This parameter may return null, indicating that no valid values can be obtained. |
| FinishTime | Integer | Completion time of the task. Unit: seconds. Note: This parameter may return null, indicating that no valid values can be obtained. |
| Result | SnapshotResult | Task result information. Note: This parameter may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tiw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSnapshotTask
<Common request parameters>
{
"SdkAppId": 1400127230,
"TaskID": "f2e1728c-6e87-4481-abe1-cde8542a5a10"
}{
"Response": {
"CreateTime": 1626249427,
"FinishTime": 1626250455,
"RequestId": "38d75752-85e0-4931-9837-d41be5409a0a",
"Result": {
"ErrorCode": "OK",
"ErrorMessage": "",
"Snapshots": [
"http://tiw-snapshot-1259648581.cos.ap-guangzhou.myqcloud.com/880520/f2e1728c-6e87-4481-abe1-cde8542a5a10/53255368873480.png",
"http://tiw-snapshot-1259648581.cos.ap-guangzhou.myqcloud.com/880520/f2e1728c-6e87-4481-abe1-cde8542a5a10/53255373174978.png",
"http://tiw-snapshot-1259648581.cos.ap-guangzhou.myqcloud.com/880520/f2e1728c-6e87-4481-abe1-cde8542a5a10/53255375472670.png"
],
"Total": 3
},
"Status": "Finished",
"TaskID": "f2e1728c-6e87-4481-abe1-cde8542a5a10"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| InternalError | Internal error. |
| InvalidParameter | A parameter error occurred. |
| RequestLimitExceeded | Too many requests. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceUnavailable.NotRegistered | TIW is not enabled. |
| ResourceUnavailable.ServiceExpired | The account is in arrears or the TIW service has expired. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.SdkAppId | The SdkAppId does not exist or does not match the current Tencent Cloud account. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
文档反馈