tencent cloud

Feedback

CloseWan

Last updated: 2023-08-23 14:22:58

1. API Description

Domain name for API request: cynosdb.tencentcloudapi.com.

This API is used to disable the public network.

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: CloseWan.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceGrpId Yes String Instance group ID

3. Output Parameters

Parameter Name Type Description
FlowId Integer Task flow ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Disabling the public network for a read-only group.

Input Example

https://cynosdb.tencentcloudapi.com/?Action=CloseWan&InstanceGrpId=cynosdbmysql-grp-o48ssqs5&<common request parameters>

Output Example

{
    "Response": {
        "FlowId": 734,
        "RequestId": "ed1bf4b2-4917-4f4f-9f7d-1562e34c9eeb"
    }
}

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
FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.GetNetServiceInfoError Failed to query the network information of the access group
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InternalError.OperateWanFail Public network operation failed.
InternalError.ServiceError Internal service error
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
InvalidParameterValue.ParamError Incorrect parameter.
UnauthorizedOperation.PermissionDenied CAM authentication failed.