PrevNext
请输入关键字

Recent Pages

文档
云数据库 Redis
    文档
    Download PDF

    DescribeInstanceNodeInfo

    最后更新时间：2021-07-28 16:46:47
    下载PDF

    1. API Description

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

    This API is used to query instance node information.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DescribeInstanceNodeInfo.
    Version Yes String Common parameter. The value used for this API: 2018-04-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID
    Limit No Integer List size
    Offset No Integer The offset value

    3. Output Parameters

    Parameter Name Type Description
    ProxyCount Integer The number of proxy nodes
    Proxy Array of ProxyNodes Proxy node information
    Note: this field may return null, indicating that no valid values can be obtained.
    RedisCount Integer The number of redis nodes
    Redis Array of RedisNodes Redis node information
    Note: this field may return null, indicating that no valid values can be obtained.
    TendisCount Integer The number of tendis nodes
    Tendis Array of TendisNodes Tendis node information
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    Input Example

    https://redis.tencentcloudapi.com/?Action=DescribeInstanceNodeInfo
&InstanceId=crs-asdasdas
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6",
    "ProxyCount": 10,
    "RedisCount": 10,
    "TendisCount": 5,
    "Proxy": [
      {
        "NodeId": "6abb7c308ed3d65930599d6f3d978971864cec77"
      }
    ],
    "Redis": [
      {
        "ClusterId": 0,
        "NodeId": "0f2ce0f969c4f43bc338bc1d6f60597d654bb3e4",
        "NodeRole": "slave"
      }
    ],
    "Tendis": [
      {
        "NodeId": "54dc6b83093359783abd2f0b07da61d3",
        "NodeRole": "master"
      }
    ]
  }
}

    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.SystemError Internal system error, which is irrelevant to the business.
    InternalError.InternalError Internal error.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款