Updated on 2022-02-22 GMT+08:00

Querying All EVS Replication Pairs (Deprecated)

Function

This API is used to query all EVS replication pairs of the current tenant.

This API has been deprecated. For details about how to use this function, see the Storage Disaster Recovery Service API Reference.

Constraints

None

URI

  • URI format

    GET /v2/{project_id}/os-vendor-replications

  • 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 EVS replication pair on the previous page, and the next EVS replication pair 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 EVS replication pairs 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 EVS replication pairs are sorted by descending order.

    offset

    No

    integer

    Specifies the offset.

    changes-since

    No

    String

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

    name

    No

    String

    Specifies the name of the EVS replication pair.

    status

    No

    String

    Specifies the status of the EVS replication pair.

    replication_consistency_group_id

    No

    String

    Specifies the ID of the replication consistency group where the EVS replication pair belongs.

    volume_ids

    No

    String

    Specifies the IDs of the EVS disks used to create the EVS replication pair.

    volume_id

    No

    String

    Specifies the ID of an EVS disk.

    priority_station

    No

    String

    Specifies the primary site of the EVS replication pair.

  • Example request

    None

Response

  • Parameter description

    Parameter

    Type

    Description

    replications

    List<replication>

    Specifies the EVS replication pairs.

    id

    String

    Specifies the ID of the EVS replication pair.

    name

    String

    Specifies the name of the EVS replication pair.

    description

    String

    Specifies the description of the EVS replication pair.

    status

    String

    Specifies the status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated).

    replication_consistency_group_id

    String

    Specifies the ID of the replication consistency group where the EVS replication pair belongs.

    volume_ids

    String

    Specifies the IDs of the EVS disks used to create the EVS replication pair.

    priority_station

    String

    Specifies the primary site of the EVS replication pair.

    created_at

    datetime

    Specifies the creation time.

    updated_at

    datetime

    Specifies the update time.

    replication_model

    String

    Specifies the replication type of the EVS replication pair.

    replication_status

    String

    Specifies the replication status of the EVS replication pair. For details, see EVS Replication Pair Status (Deprecated).

    progress

    String

    Specifies the synchronization progress of the EVS replication pair.

    Unit: %

    failure_detail

    String

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

    record_metadata

    Object

    Specifies the billing record of the replication pair. For details, see Parameters in the record_metadata field.

    fault_level

    String

    Specifies the fault level of the EVS replication pair. The value can be as follows:
    • 0: indicates that no fault occurs.
    • 2: indicates that the production disk 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.
  • Parameters in the record_metadata field

    Parameter

    Type

    Description

    volume_type

    String

    Specifies the type of the EVS disks in the EVS replication pair.

    multiattach

    Boolean

    Specifies whether the EVS disks in the EVS replication pair are shared EVS disks.

    volume_size

    integer

    Specifies the size of each EVS disk in the EVS replication pair. The unit is GB.

  • Example response
    {
        "replications": [
            {
                "status": "available", 
                "replication_model": "hypermetro", 
                "description": "replication", 
                "record_metadata": "{ \"volume_size\": 5, \"volume_type\": \"ssd\", \"multiattach\": false}", 
                "updated_at": "2017-11-27T12:08:01.463824", 
                "replication_status": "inactive", 
                "fault_level": "0", 
                "id": "190081db-9023-431d-a51a-197faf3762b5", 
                "replication_consistency_group_id": null, 
                "priority_station": "az2.dc2", 
                "volume_ids": "288a6cac-1352-460f-9b93-bfd41979f805,905d5dee-2ce4-406b-bb8a-314b3e92643e", 
                "name": "replication", 
                "created_at": "2017-11-27T12:07:59.993903", 
                "progress": null
            }, 
            {
                "status": "available", 
                "replication_model": "hypermetro", 
                "description": "replication", 
                "record_metadata": "{ \"volume_size\": 10, \"volume_type\": \"ssd\", \"multiattach\": false}", 
                "updated_at": "2017-11-28T06:16:30.725816", 
                "replication_status": "active", 
                "fault_level": "0", 
                "id": "6690b30a-b40c-4a50-bd4a-7e5c1e28b821", 
                "replication_consistency_group_id": "13b582e6-092e-4f7a-9260-8eb7a4ad860e", 
                "priority_station": "az3.dc3", 
                "volume_ids": "f3bd8265-130a-4917-815b-a074ddb06850,32eb83a2-dd2f-480d-a49e-7af6edf3c7c7", 
                "name": "replication", 
                "created_at": "2017-11-27T11:37:24.459062", 
                "progress": "100"
            }
        ]
    }

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.