tencent cloud

文档反馈

DescribeReplicationInstances

最后更新时间:2024-03-21 17:45:37

    1. API Description

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

    This API is used to query the list of replication instances.

    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: DescribeReplicationInstances.
    Version Yes String Common Params. The value used for this API: 2019-09-24.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    RegistryId Yes String Instance ID
    Offset No Integer Offset. Default value: 0
    Limit No Integer Maximum number of output entries. Default value: 20, maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of instances
    ReplicationRegistries Array of ReplicationRegistry Replication instance list
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Querying the list of replication instances

    Input Example

    https://tcr.tencentcloudapi.com/?Action=DescribeReplicationInstances
    &RegistryId=tcr-12345
    &Offset=0
    &Limit=10
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "76e69894-670f-4440-8773-075763fbdb80",
            "TotalCount": 1,
            "ReplicationRegistries": [
                {
                    "RegistryId": "tcr-06d62e1r",
                    "ReplicationRegistryId": "tcr-06d62e1r-5",
                    "ReplicationRegionId": 5,
                    "ReplicationRegionName": "ap-hongkong",
                    "Status": "Running",
                    "CreatedAt": "2020-09-28T15:34:59+08:00"
                }
            ]
        }
    }
    

    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 Internal error. Please check and try again.
    InternalError.DbError Database error. Please check and try again.
    InvalidParameter Parameter error. Please check and try again.
    MissingParameter Missing parameters. Please check and try again.
    OperationDenied Operation denied.
    ResourceInsufficient.ErrorInstanceNotRunning Exceptional instance status.
    UnauthorizedOperation The operation is unauthorized.
    UnknownParameter Unknown parameter error. Please check and try again.
    UnsupportedOperation Unsupported operation
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持