产品概述
使用限制
Domain name for API request: tiw.intl.tencentcloudapi.com.
This API is used to modify the task-related configurations of a whiteboard application, including the bucket and callback URL.
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: ModifyWhiteboardApplicationConfig. |
| 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. |
| SdkAppId | Yes | Integer | SdkAppId of the whiteboard application. |
| Configs.N | Yes | Array of WhiteboardApplicationConfig | Task-related configurations of the whiteboard application. |
| Parameter Name | Type | Description |
|---|---|---|
| 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: ModifyWhiteboardApplicationConfig
<Common request parameters>
{
"Configs": [
{
"AdminUserId": "abcde",
"BucketPrefix": "doc",
"ResultDomain": "xxx",
"AdminUserSig": "abcde",
"Callback": "http://www.example.com/callback",
"BucketName": "test-120000001",
"SdkAppId": 1400000001,
"TaskType": "recording",
"BucketLocation": "ap-guangzhou",
"CallbackKey": "abcde"
}
],
"SdkAppId": 1400000001
}{
"Response": {
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
}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. |
| FailedOperation | Operation failed. |
| FailedOperation.CosBucketInvalid | Invalid COS bucket. The bucket does not exist or is not authorized. |
| FailedOperation.GetCredentialFail | Failed to obtain a temporary key. |
| InvalidParameter | A parameter error occurred. |
| InvalidParameter.BodyParameterTypeUnmatched | The parameter type does not match. |
| InvalidParameter.CallbackAddressFormatError | The callback address format is invalid. |
| InvalidParameter.CdnDomainNotFound | CDN domain name not found. |
| InvalidParameter.InvalidTaskType | Unsupported configuration task type. |
| InvalidParameter.SdkAppIdNotFound | The SdkAppId does not exist or is invalid. |
| InvalidParameter.UnmarshalJSONBodyFail | JSON parsing failed, which may be due to parameter type mismatch. |
| ResourceUnavailable.NotRegistered | TIW is not enabled. |
| ResourceUnavailable.ServiceExpired | The account is in arrears or the TIW service has expired. |
| UnauthorizedOperation.SdkAppId | The SdkAppId does not exist or does not match the current Tencent Cloud account. |
文档反馈