- Product Introduction
- Purchase Guide
- Server APIs
- History
- Introduction
- API Category
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs
- Other APIs
- ApplyTiwTrial
- CreateApplication
- DescribeAPIService
- DescribeApplicationInfos
- DescribeApplicationUsage
- DescribeBoardSDKLog
- DescribeIMApplications
- DescribePostpaidUsage
- DescribeRoomList
- DescribeUsageSummary
- DescribeUserList
- DescribeUserResources
- DescribeUserStatus
- DescribeWhiteboardApplicationConfig
- DescribeWhiteboardBucketConfig
- ModifyApplication
- ModifyAutoRenewFlag
- ModifyWhiteboardApplicationConfig
- ModifyWhiteboardBucketConfig
- Data Types
- Error Codes
- Contact Us
- Service Agreement
- TIW Policy
- Product Introduction
- Purchase Guide
- Server APIs
- History
- Introduction
- API Category
- Making API Requests
- Whiteboard Snapshot APIs
- Whiteboard Push APIs
- Document Transcoding APIs
- Real-Time Recording APIs
- Statistics Query APIs
- Recording Video Generation APIs
- Other APIs
- ApplyTiwTrial
- CreateApplication
- DescribeAPIService
- DescribeApplicationInfos
- DescribeApplicationUsage
- DescribeBoardSDKLog
- DescribeIMApplications
- DescribePostpaidUsage
- DescribeRoomList
- DescribeUsageSummary
- DescribeUserList
- DescribeUserResources
- DescribeUserStatus
- DescribeWhiteboardApplicationConfig
- DescribeWhiteboardBucketConfig
- ModifyApplication
- ModifyAutoRenewFlag
- ModifyWhiteboardApplicationConfig
- ModifyWhiteboardBucketConfig
- Data Types
- Error Codes
- Contact Us
- Service Agreement
- TIW Policy
1. API Description
Domain name for API request: tiw.intl.tencentcloudapi.com.
This API is used to modify the bucket configurations for document transcoding and real-time recording.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: ModifyWhiteboardBucketConfig. |
| 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. |
| SdkAppId | Yes | Integer | SdkAppId of the whiteboard application. |
| TaskType | Yes | String | Task type to be queried. recording: Real-time recording. transcode: Document transcoding. |
| BucketName | Yes | String | Name of the COS bucket. |
| BucketLocation | Yes | String | Region of the COS bucket. |
| BucketPrefix | Yes | String | Resource prefix of the bucket. |
| ResultDomain | Yes | String | Domain name of the URL of the bucket. |
3. Output Parameters
| 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. |
4. Example
Example1 Modifying the bucket configurations of a whiteboard application
Input Example
https://tiw.intl.tencentcloudapi.com/?Action=ModifyWhiteboardBucketConfig
&SdkAppId=1400000001
&TaskType=recording
&BucketLocation=ap-guangzhou
&BucketName=test-120000001
&BucketPrefix=doc
&ResultDomain=https://bucket.com
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
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 | |
| 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.CdnDomainNotFound | CDN domain name not found. |
| InvalidParameter.InvalidTaskType | Unsupported configuration task type. |
| InvalidParameter.SdkAppIdNotFound | The SdkAppId does not exist or is invalid. |
| 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. |
Yes
No
Was this page helpful?