DescribeSupportProxyVersion

Last updated: 2025-11-13 20:51:37

DescribeSupportProxyVersion

Last updated: 2025-11-13 20:51:37

1. API Description

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

This API is used to query supported database proxy versions.

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: DescribeSupportProxyVersion.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID
ProxyGroupId	No	String	Database proxy group ID

3. Output Parameters

Parameter Name	Type	Description
SupportProxyVersions	Array of String	Supported database proxy version collections.
CurrentProxyVersion	String	The current proxy version number.
SupportProxyVersionDetail	Array of ProxyVersionInfo	Specifies the proxy version details.
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 Query the Supported Database Proxy Versions

This example shows you how to query the supported database proxy versions.

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSupportProxyVersion
<Common request parameters>

{
    "ClusterId": "cynosdbmysql-dnofdr2c",
    "ProxyGroupId": "cynosdbmysql-proxy-4378e0kd"
}

Output Example

{
    "Response": {
        "SupportProxyVersions": [
            "3.1.4"
        ],
        "CurrentProxyVersion": "3.1.1",
        "SupportProxyVersionDetail": [
            {
                "ProxyVersion": "3.1.5",
                "ProxyVersionType": "BATE"
            }
        ],
        "RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43"
    }
}

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

Tencent Cloud CLI 3.0

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	Operation failed
FailedOperation.DatabaseAccessError	Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
OperationDenied.ClusterStatusDeniedError	For the cluster in this status, the operation is not allowed.
OperationDenied.InstanceStatusDeniedError	For the instance in this status, the operation is not allowed.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
ResourceNotFound.InstanceNotFoundError	The instance does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud