1. API Description
Domain name for API request: cdb.intl.tencentcloudapi.com.
This API (CloseWanService) is used to disable public network access for TencentDB instance, which will make public IP addresses inaccessible.
A maximum of 100 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.
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: CloseWanService. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2017-03-20. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId |
Yes |
String |
Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| AsyncRequestId |
String |
Async task request ID, which can be used to query the execution result of an async task. |
| 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 Disabling public network access for an instance
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloseWanService
<Common request parameters>
{
"InstanceId": "cdb-ezq1vzem"
}
Output Example
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestId": "841592f6-dd318344-aea19230-38912726"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 |
CAM signature/authentication error. |
| FailedOperation.StatusConflict |
Task status conflict. |
| InvalidParameter |
Parameter error. |
| InvalidParameter.InstanceNotFound |
The instance does not exist. |
| OperationDenied |
Operation denied. |
| OperationDenied.WrongStatus |
The backend task status is invalid. |