Help Center> Document Database Service> API Reference> APIs V3.0 (Recommended)> DB Instance Management> Querying the Name of the Replica Set in the Connection Address
Updated on 2023-11-24 GMT+08:00

Querying the Name of the Replica Set in the Connection Address

API Description

This API is used to query the name of the replica set in the connection address.

Restrictions

This API applies only to replica set instances.

URI

  • URI format

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/replica-set/name

  • URI example
    https://dds.cn-north-1.myhuaweicloud.com/v3/0d248ca90800d3902f79c014f11df3b8/instances/593416e7c9da4a4c97c6ad5b086b8ddfin02/replica-set/name
    Table 1 Request parameters

    Name

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    User token obtained from IAM. For details, see Authentication.

    project_id

    Yes

    String

    Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID.

    instance_id

    Yes

    String

    Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Requests

None

Responses

  • Parameter description

    Status code: 200

    Table 2 Response body parameters

    Name

    Type

    Description

    name

    String

    Name of the replica set in the connection address.

    Status code: 406

    Table 3 Response body parameters

    Name

    Type

    Description

    ErrorResponse

    Array of Table 4 objects

    This operation is not allowed because the instance is not a replica set instance.

    Table 4 ErrorResponse

    Name

    Type

    Description

    error_code

    String

    Error code returned when a task submission exception occurs.

    error_msg

    String

    Error description returned when a task submission exception occurs.

  • Example response
    Status code: 200
    { 
        "name" : "replica" 
    }

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.