tencent cloud

Feedback

DescribeInstanceSupportFeature

Last updated: 2024-12-04 11:19:22

1. API Description

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

This API (DescribeInstanceSupportFeature) is used to query the supported features of the instance.

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: DescribeInstanceSupportFeature.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Specify the instance ID.
For example: crs-xjhsdj****. Please log in to the [Redis Console] (https://console.tencentcloud.com/redis#/) and copy the instance ID from the instance list.
Sample value: crs-asdasdas.
FeatureName Yes String Feature names.
- Read-local-node-only: Proximity access feature.- multi-account: Multiple accounts feature.

3. Output Parameters

Parameter Name Type Description
Support Boolean Whether to support.
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 Sample 1

This example shows you how to query whether proximity access is supported.

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceSupportFeature
<Common request parameters>
{
    "InstanceId": "crs-fhsw2mh4",
    "FeatureName": "read-local-node-only"
}

Output Example

{
    "Response": {
        "RequestId": "60b6c537-1021-4360-a7b9-90feaca647a1",
        "Support": true
    }
}

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
InternalError.InternalError Internal error.
InvalidParameter.ActionNotFound The corresponding API was not found.
InvalidParameter.PermissionDenied The API has no CAM permissions.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.