Querying All Replication Consistency Groups (Deprecated)

Function

This API is used to query all replication consistency groups of the current tenant.

Note

This API has been deprecated. To use this function, see Storage Disaster Recovery Service API Reference.

Constraints

None

URI

  • URI format

    GET /v2/{project_id}/os-vendor-replication-consistency-groups

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    marker

    No

    String

    Specifies the ID of the last replication consistency group on the previous page. The next replication consistency group ID is returned.

    limit

    No

    integer

    Specifies the maximum number of query results that can be returned.

    The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.

    sort_key

    No

    String

    Specifies that the returned results are sorted by keyword. The default keyword is created_at, indicating that the replication consistency groups are sorted by creation time.

    sort_dir

    No

    String

    Specifies that the returned results are sorted by ascending or descending order. The default value is desc, indicating that the replication consistency groups are sorted by descending order.

    offset

    No

    integer

    Specifies the offset.

    changes-since

    No

    String

    Specifies to query all the replication consistency groups that have been updated from the specified time point to the current time.

    name

    No

    String

    Specifies the name of the replication consistency group.

    status

    No

    String

    Specifies the status of the replication consistency group.

    priority_station

    No

    String

    Specifies the primary site of the replication consistency group.

    volume_id

    No

    String

    Specifies the ID of an EVS disk.

  • Example request

    None

Response

  • Parameter description

    Parameter

    Type

    Description

    replication_consistency_groups

    List<replication_consistency_group>

    Specifies the replication consistency groups.

    id

    String

    Specifies the ID of the replication consistency group.

    name

    String

    Specifies the name of the replication consistency group.

    description

    String

    Specifies the description of the replication consistency group.

    status

    String

    Specifies the status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated).

    priority_station

    String

    Specifies the primary site.

    replication_model

    String

    Specifies the replication type of the replication consistency group.

    replication_status

    String

    Specifies the replication status of the replication consistency group. For details, see Replication Consistency Group Status (Deprecated).

    replication_ids

    list

    Specifies the IDs of all EVS replication pairs in the replication consistency group.

    created_at

    datetime

    Specifies the creation time.

    updated_at

    datetime

    Specifies the latest update time.

    failure_detail

    String

    Specifies the returned error code if the status of the replication consistency group is error. For details, see Details of EVS Replication failure_detail Values (Deprecated).

    fault_level

    String

    Specifies the fault level of the replication consistency group. The value can be as follows:

    • 0: indicates that no fault occurs.

    • 2: indicates that a production disk in the replication consistency group does not have read/write permissions. In this case, you are advised to perform a failover.

    • 5: indicates that the replication link is disconnected. In this case, a failover cannot be performed. Contact technical support engineers.

  • Example response

    {
        "replication_consistency_groups": [
       {
                "status": "available",
                "priority_station": "az3.dc3",
                "replication_ids": [
                    "86080dc0-2fcf-4b85-8102-bc123eb8dcaa",
                    "580b730e-3160-4382-8a4e-174515d1fa77"
                ],
                "name": "replication consistency group",
                "replication_model": "hypermetro",
                "fault_level": "0",
                "updated_at": "2017-11-28T07:17:21.904376",
                "created_at": "2017-11-28T03:05:10.677939",
                "replication_status": "active-stopped",
                "id": "57b84092-7a75-4e22-bc2a-fab0bec547c5",
                "description": "replication consistency group"
            },
            {
                "status": "available",
                "priority_station": "az3.dc3",
                "replication_ids": [
                    "3e9ba31c-6406-4060-870e-b7736ac76836",
                    "6690b30a-b40c-4a50-bd4a-7e5c1e28b821"
                ],
                "name": "replication consistency group",
                "replication_model": "hypermetro",
                "fault_level": "0",
                "updated_at": "2017-11-28T06:29:27.155762",
                "created_at": "2017-11-27T11:38:50.421364",
                "replication_status": "active",
                "id": "13b582e6-092e-4f7a-9260-8eb7a4ad860e",
                "description": "replication consistency group"
            }
        ]
    }
    

Status Codes

  • Normal

    Returned Value

    Description

    200

    The server has processed the request.

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The server failed to process the request.

    401 Unauthorized

    You must enter the username and password to access the requested page.

    403 Forbidden

    You are forbidden to access the requested page.

    404 Not Found

    The requested page was not found.

    405 Method Not Allowed

    You are not allowed to use the method specified in the request.

    406 Not Acceptable

    The response generated by the server cannot be accepted by the client.

    407 Proxy Authentication Required

    You must use the proxy server for authentication. Then, the request can be processed.

    408 Request Timeout

    The request timed out.

    409 Conflict

    The request cannot be processed due to a conflict.

    500 Internal Server Error

    Failed to complete the request because of an internal service error.

    501 Not Implemented

    Failed to complete the request because the server does not support the requested function.

    502 Bad Gateway

    Failed to complete the request because the server has received an invalid response.

    503 Service Unavailable

    Failed to complete the request because the service is unavailable.

    504 Gateway Timeout

    A gateway timeout error occurs.