API Usage Guidelines
+Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+SDRS APIs
+-
+
- Job
+
+ - API Version
+
+ - Active-Active Domain
+
+ - Protection Group
+
+ - Protected Instance
+
+ - Replication Pair
+
+ - DR Drill
+
+ - Tag Management
+
+ - Task Center
+
+ - Tenant Quota Management
+
+
Job
+Querying the Job Status
+Function
This API is used to query the execution status of a job.
+
After a job, such as creating or deleting a protection group, creating or deleting a protected instance, and creating or deleting a replication pair, is issued, job_id is returned, based on which you can query the execution status of the job.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+job_id
+Yes
+String
+Specifies the job ID.
+Specifies the returned parameter when the asynchronous API command is issued. For details, see the description in Function.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+status
+String
+Specifies the job status.
+- SUCCESS: The job was successfully executed.
- RUNNING: The job is in progress.
- FAIL: The job failed.
- INIT: The job is being initialized.
entities
+Object
+Specifies the job object.
+The value of this parameter varies depending on the job type. If the job is a protection group-related operation, the value will be server_group_id. If a subjob is available, details about the subjob are displayed.
+For details, see Table 1.
+job_id
+String
+Specifies the job ID.
+For details, see the description in Function.
+job_type
+String
+Specifies the job type.
+- createProtectionGroupNoCG: Creates a protection group.
- deleteProtectionGroupNoCG: Deletes a protection group.
- startProtectionGroupNoCG: Enables protection for a protection group.
- reprotectProtectionGroupNoCG: Enables protection again for a protection group.
- stopProtectionGroupNoCG: Disables protection for a protection group.
- failoverProtectionGroupNoCG: Performs a failover for a protection group.
- reverseProtectionGroupNoCG: Performs a planned failover for a protection group.
- createProtectedInstanceNoCG: Creates a protected instance.
- deleteProtectedInstanceNoCG: Deletes a protected instance.
- attachReplicationPairNew: Attaches a replication pair to a protected instance.
- detachReplicationPairNew: Detaches a replication pair from a protected instance.
- addNicNew: Adds a NIC to a protected instance.
- deleteNicNew: Deletes a NIC from a protected instance.
- resizeProtectedInstanceNew: Modifies the specifications of a protected instance.
- createReplicationPairNoCG: Creates a replication pair.
- deleteReplicationPairNoCG: Deletes a replication pair.
- expandReplicationPairNew: Expands the capacity of a replication pair.
- createDisasterRecoveryDrill: Creates a DR drill.
- deleteDisasterRecoveryDrill: Deletes a DR drill.
begin_time
+String
+Specifies the start time.
+The default format is as follows: "yyyy-MM-dd 'T' HH:mm:ss.SSSZ", for example, 2019-04-01T12:00:00.000Z.
+end_time
+String
+Specifies the end time.
+The default format is as follows: "yyyy-MM-dd 'T' HH:mm:ss.SSSZ", for example, 2019-04-01T12:00:00.000Z.
+error_code
+String
+Specifies the error code returned upon a job execution failure.
+For details, see Error Codes.
+fail_reason
+String
+Specifies the cause of a job execution failure.
+For details, see Error Codes.
+message
+String
+Specifies the error message returned when an error occurs.
+For details, see the abnormal returned values in Returned Values.
+code
+String
+Specifies the error code returned when an error occurs.
+For details, see the abnormal returned values in Returned Values.
++
+Table 1 entities field description Parameter
+Type
+Description
+server_group_id
+String
+Specifies the ID of the protection group being queried.
+sub_jobs
+Array of objects
+Specifies the execution information of a subjob. When no subjob exists, the value of this parameter is left empty. The structure of each subjob is similar to that of the parent job.
+
- Example response
{ + "status": "SUCCESS", + "entities": { + "server_group_id": "a59d008e-4bad-4bf3-9b17-6cc25e7da483" + }, + "job_id": "0000000062db92d70162db9d200f000a", + "job_type": "createProtectionGroupNoCG", + "begin_time": "2018-04-19T01:55:30.443Z", + "end_time": "2018-04-19T01:55:45.493Z", + "error_code": null, + "fail_reason": null + }+Or
+{ + "job_id": "ff8080826b45d4a5016b5036242c0025", + "job_type": "stopProtectionGroupNoCG", + "begin_time": "2019-06-13T09:40:53.930Z", + "end_time": "2019-06-13T09:41:01.946Z", + "status": "SUCCESS", + "error_code": null, + "fail_reason": null, + "entities": { + "sub_jobs": [ + { + "job_id": "ff8080826b45d4a5016b50362868002a", + "job_type": "stopProtectionGroupRepNoCG", + "begin_time": "2019-06-13T09:40:55.015Z", + "end_time": "2019-06-13T09:40:58.951Z", + "status": "SUCCESS", + "error_code": null, + "fail_reason": null, + "entities": { + "server_group_id": "1fd6903c-48f9-4772-8974-112dfbd74427" + } + }, + { + "job_id": "ff8080826b45d4a5016b50362870002b", + "job_type": "stopProtectionGroupRepNoCG", + "begin_time": "2019-06-13T09:40:55.022Z", + "end_time": "2019-06-13T09:40:58.952Z", + "status": "SUCCESS", + "error_code": null, + "fail_reason": null, + "entities": { + "server_group_id": "1fd6903c-48f9-4772-8974-112dfbd74427" + } + } + ] + } +} +{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
API Version
+Querying API Versions
+Function
This API is used to query all available API versions of SDRS.
+Constraints
None
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+versions
+Array of objects
+Specifies the API version list.
+For details, see Table 1.
++ + +
+Table 1 versions field description Parameter
+Type
+Description
+id
+String
+Specifies the version ID, for example, v1.
+links
+Array of objects
+Specifies the API URL.
+For details, see Table 2.
+version
+String
+Specifies the version. If the APIs of this version support microversions, the system returns the supported maximum microversion. If the microversion is not supported, the system returns an empty value.
+status
+String
+Specifies the version status. Values are as follows:
+CURRENT: widely used version
+SUPPORT: earlier version which is still supported
+DEPRECATED: deprecated version which may be deleted later
+updated
+String
+Specifies the version release time in UTC format. For example, the release time of v1 is 2018-05-30T15:00:00Z.
+min_version
+String
+Specifies the microversion. If APIs of a version support microversions, the system returns the supported minimum microversion. If microversions are not supported, the system returns an empty value.
+
- Example response
{ + "versions": [ + { + "id": "v1", + "links": [ + { + "href": "https://sdrs.localdomain.com/v1", + "rel": "self" + } + ], + "status": "CURRENT", + "updated": "2018-05-30T15:00:00Z", + "version": "", + "min_version": "" + } + ] +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying a Specified API Version
+Function
This API is used to query a specified API version.
+Constraints and Limitations
None
+URI
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+version
+Object
+Specifies the version of an API.
+For details, see Table 1.
++ + +
+Table 1 version field description Parameter
+Type
+Description
+id
+String
+Specifies the version ID, for example, v1.
+links
+Array of objects
+Specifies the API URL.
+For details, see Table 2.
+version
+String
+Specifies the version. If the APIs of this version support microversions, the system returns the supported maximum microversion. If the microversion is not supported, the system returns an empty value.
+status
+String
+Specifies the version status. Values are as follows:
+CURRENT: widely used version
+SUPPORT: earlier version which is still supported
+DEPRECATED: deprecated version which may be deleted later
+updated
+String
+Specifies the version release time, which must be the UTC time. For example, the release time of v1 is 2018-05-30T15:00:00Z.
+min_version
+String
+Specifies the microversion. If APIs of a version support microversions, the system returns the supported minimum microversion. If microversions are not supported, the system returns an empty value.
+
- Example response
{ + "version": { + "id": "v1", + "links": [ + { + "href": "https://sdrs.localdomain.com/v1", + "rel": "self" + } + ], + "status": "CURRENT", + "updated": "2018-05-30T00:00:00Z", + "version": "", + "min_version": "" + } +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+
- Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Active-Active Domain
+Querying an Active-Active Domain
+Function
This API is used to query an active-active domain.
+An active-active domain consists of the local storage device and remote storage device. Application servers can access data across data centers using an active-active domain.
+Constraints and Limitations
None
+URI
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+domains
+Array of objects
+Specifies the information about an active-active domain.
+For details, see Table 1.
++ + + + +
+Table 1 domains field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of an active-active domain.
+name
+String
+Specifies the name of an active-active domain.
+description
+String
+Specifies the description of an active-active domain.
+sold_out
+Boolean
+Specifies whether resources of an active-active domain are sold out.
+local_replication_cluster
+Object
+Specifies the parameters related to the replication cluster in one AZ (either the production site AZ or DR site AZ) of the active-active domain.
+For details, see Table 2.
+remote_replication_cluster
+Object
+Specifies the parameters related to replication cluster in the other AZ (either the production site AZ or DR site AZ) of the active-active domain.
+For details, see Table 3.
+ - Example response
{ + "domains": [ + { + "id": "fb4bb8e3-a574-4437-a156-78c916aeea4d", + "name": "ActiveactiveDomain", + "description": "my domain", + "sold_out": false, + "local_replication_cluster": { + "availability_zone": "eu-de-01" + }, + "remote_replication_cluster": { + "availability_zone": "eu-de-02" + } + } + ] +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Protection Group
+ +-
+
- Creating a Protection Group
+
+ - Querying Protection Groups
+
+ - Querying the Details of a Protection Group
+
+ - Deleting a Protection Group
+
+ - Changing the Name of a Protection Group
+
+ - Enabling Protection or Enabling Protection Again for a Protection Group
+
+ - Disabling Protection for a Protection Group
+
+ - Performing a Failover for a Protection Group
+
+ - Performing a Planned Failover for a Protection Group
+
+
Creating a Protection Group
+Function
This API is used to create a protection group.
+ This API is an asynchronous interface. If this API is invoked successfully, the request is issued. To query the creation result, invoke the API described in Querying the Job Status.
+Constraints and Limitations
None
+URI
+Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+server_group
+Yes
+Object
+Specifies the information about a protection group.
+For details, see Table 1.
++
+Table 1 server_group field description Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the name of a protection group. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+description
+No
+String
+Specifies the description of a protection group. The description can contain a maximum of 64 bytes. The value cannot contain the left angle bracket (<) or right angle bracket (>).
+source_availability_zone
+Yes
+String
+Specifies the production site AZ of a protection group.
+You can obtain this value by calling the API described in Active-Active Domain.
+target_availability_zone
+Yes
+String
+Specifies the DR site AZ of a protection group.
+You can obtain this value by calling the API described in Active-Active Domain.
+domain_id
+Yes
+String
+Specifies the ID of an active-active domain.
+You can obtain this value by calling the API described in Active-Active Domain.
+source_vpc_id
+Yes
+String
+Specifies the ID of the VPC for the production site.
+dr_type
+No
+String
+Specifies the deployment model. The default value is migration, indicating migration within a VPC.
+
- Example requestPOST https://{endpoint}/v1/{project_id}/server-groups+
{ + "server_group": + { + "name":"testname", + "description":"description", + "source_availability_zone":"eu-de-01", + "target_availability_zone":"eu-de-02", + "domain_id":"fb4bb8e3-a574-4437-a156-78c916aeea4d", + "source_vpc_id":"046852ef-c49d-409b-8389-546aaaa5701f", + "dr_type":"migration", + + } +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db9d200f000a" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Protection Groups
+Function
This API is used to query all protection groups of the current tenant.
+Constraints and Limitations
None
+URI
+- Request filter field description
++
+Parameter
+Mandatory
+Type
+Description
+limit
+No
+Integer
+Specifies the maximum number of results returned each time. The value is a positive integer from 0 to 1000. The default value is 1000.
+offset
+No
+Integer
+Specifies the offset of each request. The default value is 0. The value must be a number and cannot be negative.
+status
+No
+String
+Specifies the protection group status.
+For details, see Protection Group Status.
+name
+No
+String
+Specifies the name of a protection group.
+Fuzzy search is supported.
+query_type
+No
+String
+Specifies the query type.
+- status_abnormal: indicates to query protection groups in the abnormal status.
- stop_protected: indicates to query protection groups for which the protection is disabled.
- period_no_dr_drill: indicates to query the protection groups for which the no DR drills have been performed in a specified duration. The default duration is 3 months.
- This parameter is invalid when the value is set to general or left empty.
availability_zone
+No
+String
+Specifies the current production site AZ of a protection group.
+You can obtain this value by calling the API described in Querying an Active-Active Domain.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+server_groups
+Array of objects
+Specifies the information about protection groups.
+For details, see Table 1.
+count
+Integer
+Specifies the number of protection groups that meet the filtering criteria.
++
+Table 1 server_groups field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protection group.
+name
+String
+Specifies the name of a protection group.
+description
+String
+Specifies the description of a protection group.
+status
+String
+Specifies the status of a protection group. For details, see Protection Group Status.
+progress
+Integer
+Specifies the synchronization progress of a protection group.
+Unit: %
+source_availability_zone
+String
+Specifies the production site AZ configured when a protection group is created.
+The value does not change after a planned failover or failover.
+target_availability_zone
+String
+Specifies the DR site AZ configured when a protection group is created.
+The value does not change after a planned failover or failover.
+domain_id
+String
+Specifies the ID of an active-active domain.
+domain_name
+String
+Specifies the name of an active-active domain.
+priority_station
+String
+Specifies the current production site of a protection group.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
protected_instance_num
+Integer
+Specifies the number of protected instances in a protection group.
+replication_num
+Integer
+Specifies the number of replication pairs in a protection group.
+disaster_recovery_drill_num
+Integer
+Specifies the number of DR drills in a protection group.
+protected_status
+String
+Specifies whether protection is enabled or not.
+- started: Protection is enabled.
- stopped: Protection is disabled.
NOTE:+The system has been upgraded. For newly protection groups, the value of this parameter is null.
+replication_status
+String
+Specifies the data synchronization status.
+- active: Data has been synchronized.
- inactive: Data is not synchronized.
- copying: Data is being synchronized.
- active-stopped: Data synchronization is stopped.
NOTE:+The system has been upgraded. For newly protection groups, the value of this parameter is null.
+health_status
+String
+Specifies the health status of a protection group.
+- normal: The protection group is normal.
- abnormal: The protection group is abnormal.
NOTE:+The system is upgraded recently. For protection groups created after the upgrade, the value of this parameter is null.
+source_vpc_id
+String
+Specifies the ID of the VPC for the production site.
+target_vpc_id
+String
+Specifies the ID of the VPC for the DR site.
+test_vpc_id
+String
+Specifies the ID of the VPC used for a DR drill. This parameter is not used in the current version.
+dr_type
+String
+Specifies the deployment model. The default value is migration, indicating migration within a VPC.
+created_at
+String
+Specifies the time when a protection group was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a protection group was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+protection_type
+String
+Specifies the protection mode.
+- replication-pair: indicates that data synchronization is performed at the replication pair level.
- null: indicates that data synchronization is performed at the replication consistency group level.
NOTE:+The system has been upgraded. Data synchronization is performed at the replication pair level for all resources, and the returned value is replication-pair.
+replication_model
+String
+Specifies the protection mode.
+NOTE:+This parameter is reserved.
+server_type
+String
+Specifies the type of managed servers.
+- ECS: indicates that ECSs are managed.
- Example response
{ + "count": 2, + "server_groups": [ + { + "id": "40df180b-9fe2-471a-8c64-1b758dc84189", + "name": "testname", + "description": "description", + "source_availability_zone": "eu-de-01", + "target_availability_zone": "eu-de-02", + "domain_id": "fb4bb8e3-a574-4437-a156-78c916aeea4d", + "domain_name": "ActiveactiveDomain", + "status": "available", + "protected_status": null, + "replication_status": null, + "health_status": null, + "progress": 0, + "priority_station": "source", + "protected_instance_num": 0, + "replication_num": 0, + "disaster_recovery_drill_num": 0, + "source_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f", + "target_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f", + "test_vpc_id": null, + "dr_type": "migration", + "server_type":"ECS" + "created_at": "2019-05-23 03:51:58.256", + "updated_at": "2019-05-23 07:48:12.484", + "protection_type": "replication-pair", + "replication_model": null + }, + { + "id": "decf224d-87fe-403a-8721-037a1a45c287", + "name": "Protection-Group-lwx", + "description": null, + "source_availability_zone": "eu-de-01", + "target_availability_zone": "eu-de-02", + "domain_id": "fb4bb8e3-a574-4437-a156-78c916aeea4d", + "domain_name": "ActiveactiveDomain", + "status": "available", + "protected_status": null, + "replication_status": null, + "health_status": null, + "progress": 0, + "priority_station": "source", + "protected_instance_num": 0, + "replication_num": 0, + "disaster_recovery_drill_num": 0, + "source_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f", + "target_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f", + "test_vpc_id": null, + "dr_type": "migration", + "server_type":ECS, + "created_at": "2019-05-22 08:16:54.413", + "updated_at": "2019-05-23 07:48:12.493", + "protection_type": "replication-pair", + "replication_model": null + } + ] + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying the Details of a Protection Group
+Function
This API is used to query the details about a protection group, such as the protection group ID and name.
+Constraints and Limitations
None
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+server_group
+Object
+Specifies the details of a protection group.
+For details, see Table 1.
++
+Table 1 server_group field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protection group.
+name
+String
+Specifies the name of a protection group.
+description
+String
+Specifies the description of a protection group.
+status
+String
+Specifies the status of a protection group.
+For details, see Protection Group Status.
+progress
+Integer
+Specifies the synchronization progress of a protection group.
+Unit: %
+source_availability_zone
+String
+Specifies the production site AZ configured when a protection group is created.
+The value does not change after a planned failover or failover.
+target_availability_zone
+String
+Specifies the DR site AZ configured when a protection group is created.
+The value does not change after a planned failover or failover.
+domain_id
+String
+Specifies the ID of an active-active domain.
+domain_name
+String
+Specifies the name of an active-active domain.
+priority_station
+String
+Specifies the current production site of a protection group.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
protected_instance_num
+Integer
+Specifies the number of protected instances in a protection group.
+replication_num
+Integer
+Specifies the number of replication pairs in a protection group.
+disaster_recovery_drill_num
+Integer
+Specifies the number of DR drills in a protection group.
+protected_status
+String
+Specifies whether protection is enabled or not.
+- started: Protection is enabled.
- stopped: Protection is disabled.
NOTE:+The system is upgraded recently. For protection groups created after the upgrade, the value of this parameter is null.
+replication_status
+String
+Specifies the data synchronization status.
+- active: Data has been synchronized.
- inactive: Data is not synchronized.
- copying: Data is being synchronized.
- active-stopped: Data synchronization is stopped.
NOTE:+The system is upgraded recently. For protection groups created after the upgrade, the value of this parameter is null.
+health_status
+String
+Specifies the health status of a protection group.
+- normal: The protection group is normal.
- abnormal: The protection group is abnormal.
NOTE:+The system is upgraded recently. For protection groups created after the upgrade, the value of this parameter is null.
+source_vpc_id
+String
+Specifies the ID of the VPC for the production site.
+target_vpc_id
+String
+Specifies the ID of the VPC for the DR site.
+test_vpc_id
+String
+Specifies the ID of the VPC used for a DR drill.
+NOTE:+This parameter is reserved.
+dr_type
+String
+Specifies the deployment model. The default value is migration, indicating migration within a VPC.
+created_at
+String
+Specifies the time when a protection group was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a protection group was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+protection_type
+String
+Specifies the protection mode.
+- null: indicates that data synchronization is performed at the replication consistency group level. No partial synchronization failure will occur.
- replication-pair: indicates that data synchronization is performed at the replication pair level.
replication_model
+String
+Specifies the protection mode.
+NOTE:+This parameter is reserved.
+server_type
+String
+Specifies the type of managed servers.
+- ECS: indicates that ECSs are managed.
- Example response
{ + "server_group": { + "id": "decf224d-87fe-403a-8721-037a1a45c287", + "name": "Protection-Group-lwx", + "description": null, + "source_availability_zone": "eu-de-01", + "target_availability_zone": "eu-de-02", + "domain_id": "fb4bb8e3-a574-4437-a156-78c916aeea4d", + "domain_name": "ActiveactiveDomain", + "status": "available", + "protected_status": null, + "replication_status": null, + "health_status": null, + "progress": 0, + "priority_station": "source", + "protected_instance_num": 0, + "replication_num": 0, + "disaster_recovery_drill_num": 0, + "source_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f", + "target_vpc_id": "046852ef-c49d-409b-8389-546aaaa5701f", + "test_vpc_id": null, + "dr_type": "migration", + "server_type": "ECS", + "created_at": "2019-05-22 08:16:54.413", + "updated_at": "2019-05-23 09:11:10.856", + "protection_type": "replication-pair", + "replication_model": null + } +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In the preceding example, error indicates a general error, for example, badrequest or itemNotFound. An example is provided as follows:
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting a Protection Group
+Function
This API is used to delete the specified protection group.
+Constraints and Limitations
The protection group does not have protected instances, replication pairs, or DR drills.
+ A protection group cannot be deleted if it has protected instances, replication pairs, or DR drills. To delete a protected instance, a replication pair, or a DR drill, see Deleting a Protected Instance, Deleting a Replication Pair, and Deleting a DR Drill.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
+Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ +"job_id": "0000000062db92d70162db9d200f0011" +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Changing the Name of a Protection Group
+Function
This API is used to change the name of a protection group.
+Constraints and Limitations
None
+URI
+- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+server_group
+Yes
+Object
+Specifies the information about a protection group.
+For details, see Table 1.
++
+Table 1 server_group field description Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the name of a protection group.
+- The name can contain a maximum of 64 bytes.
- The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
- Example request +
Response
- Parameter description
++ +
+Table 2 Parameter description Parameter
+Type
+Description
+server_group
+Object
+Specifies the details of a protection group.
+For details, see Table 3.
++
+Table 3 server_group field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protection group.
+name
+String
+Specifies the name of a protection group. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+description
+String
+Specifies the description of a protection group.
+status
+String
+Specifies the status of a protection group.
+For details, see Protection Group Status.
+progress
+Integer
+Specifies the synchronization progress of a protection group.
+Unit: %
+source_availability_zone
+String
+Specifies the production site AZ configured when a protection group is created.
+The value does not change after a planned failover or failover.
+target_availability_zone
+String
+Specifies the DR site AZ configured when a protection group is created.
+The value does not change after a planned failover or failover.
+domain_id
+String
+Specifies the ID of an active-active domain.
+domain_name
+String
+Specifies the name of an active-active domain.
+protected_status
+String
+Specifies whether protection is enabled or not.
+- started: Protection is enabled.
- stopped: Protection is disabled.
replication_status
+String
+Specifies the data synchronization status.
+- active: Data has been synchronized.
- inactive: Data is not synchronized.
- copying: Data is being synchronized.
- active-stopped: Data synchronization is stopped.
health_status
+String
+Specifies the health status of a protection group.
+- normal: The protection group is normal.
- abnormal: The protection group is abnormal.
priority_station
+String
+Specifies the current production site of a protection group.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
protected_instance_num
+Integer
+Specifies the number of protected instances in a protection group.
+replication_num
+Integer
+Specifies the number of replication pairs in a protection group.
+disaster_recovery_drill_num
+Integer
+Specifies the number of DR drills in a protection group.
+source_vpc_id
+String
+Specifies the ID of the VPC for the production site.
+target_vpc_id
+String
+Specifies the ID of the VPC for the DR site.
+test_vpc_id
+String
+Specifies the ID of the VPC used for a DR drill.
+dr_type
+String
+Specifies the deployment model. The default value is migration, indicating migration within a VPC.
+server_type
+String
+Specifies the type of managed servers.
+- ECS: indicates that ECSs are managed.
created_at
+String
+Specifies the time when a protection group was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, 2019-04-01 12:00:00.0.
+updated_at
+String
+Specifies the time when a protection group was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, 2019-04-01 12:00:00.0.
+protection_type
+String
+Specifies the protection mode.
+- null: indicates that data synchronization is performed at the replication consistency group level. No partial synchronization failure will occur.
- replication-pair: indicates that data synchronization is performed at the replication pair level.
replication_model
+String
+Specifies the protection mode.
+NOTE:+This parameter is reserved.
+
- Example response
{ + "server_group": { + "id": "e98cefcd-2398-4a4d-8c52-c79f00e21484", + "name": "my_test_server_group", + "description": "test_server_group_sdrs", + "status": "available", + "progress": 0, + "source_availability_zone": "eu-de-01", + "target_availability_zone": "eu-de-02", + "domain_id": "523ab8ad-3759-4933-9436-4cf4ebb20867", + "domain_name": "my domain", + "protected_status": "stopped", + "replication_status": "active-stopped", + "health_status": "normal", + "priority_station": "source", + "protected_instance_num": 0, + "replication_num": 0, + "disaster_recovery_drill_num": 0, + "source_vpc_id": "ac784bd6-a79c-4def-9ff8-dc87940d5335", + "target_vpc_id": "ac784bd6-a79c-4def-9ff8-dc87940d5335", + "test_vpc_id": null, + "dr_type": "migration", + "server_type":"ECS", + "created_at": "2018-05-09 22:11:45.0", + "updated_at": "2018-05-09 22:11:54.0", + "protection_type": "replication-pair", + "replication_model": null + } +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Enabling Protection or Enabling Protection Again for a Protection Group
+Function
This API is used to enable protection or enable protection again for a protection group.
+Constraints and Limitations (Enabling Protection)
- The protection group must have replication pairs.
- status of the protection group must be available or error-starting.
- After you create a protected instance and enable protection on servers at the production site, modifications to the Hostname, Name, Security Group, Agency, ECS Group, Tags, and Auto Recovery configurations of servers on the production site will not synchronize to the servers at the DR site. You can manually add the configuration items to the servers at the DR site on the management console.
Constraints and Limitations (Enabling Protection Again)
- status of the protection group must be failed-over or error-reprotecting.
- Before you enable the protection again, ensure that the servers at the DR site are stopped.
URI
- URI format
POST /v1/{project_id}/server-groups/{server_group_id}/action
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+start-server-group
+Yes
+Object
+Enables protection for a protection group.
+This parameter is left empty.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "ff8080826adfae02016ae2d123fc05ed" +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Disabling Protection for a Protection Group
+Function
This API is used to disable protection for a protection group.
+Constraints and Limitations
- status of the protection group must be protected or error-stopping.
URI
- URI format
POST /v1/{project_id}/server-groups/{server_group_id}/action
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+stop-server-group
+Yes
+Object
+Disables protection for a protection group.
+This parameter is left empty by default.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "ff8080826adfae02016ae2d123fc05ed" +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Performing a Failover for a Protection Group
+Function
When the production site of a protection group becomes faulty, services of the protection group are switched over to the DR site, and servers and disks at the DR site start. After a failover is performed, the current production site of the protection group will become the DR site before the failover. Data synchronization between the production and DR sites will stop. To resume the data synchronization, you need to perform steps provided in Enabling Protection or Enabling Protection Again for a Protection Group to enable protection.
+Constraints and Limitations
- The protection group must have replication pairs.
- status of the protection group must be protected, error-failing-over, or error-reversing.
- If the server at the production site or DR site in a protected instance is deleted using the native interface, no operations can be performed on the protected instance or the protection group of the protected instance.
Constraints on Logging In to the Server After a Planned Failover, Failover, or Disaster Recovery Drill Is Executed First Time Ever
After you have performed a planned failover, failover, or DR drill for the first time:
+- If your servers are installed with Cloud-Init/Cloudbase-Init, Cloud-Init/Cloudbase-Init will start along with the server's first startup to inject the initial data. In this case, the password or key pair used to log in to the production site server, disaster recovery site server, or drill server will change.
- If your servers are not installed with Cloud-Init/Cloudbase-Init, the password or key pair used to log in to the production site server, disaster recovery site server, or drill server will not change.
The following uses a planned failover or failover as the example operation. For the login constraints on drill servers, see those for disaster recovery site servers.
+In the following example, Server A and server B are deployed. Table 1 shows the servers before and after the operation.
+ +- + |
+Production Site Server + |
+Disaster Recovery Site Server + |
+
|---|---|---|
Before + |
+Server A + |
+Server B + |
+
After + |
+Server B + |
+Server A + |
+
Detailed login constraints are described as follows:
+- If your servers use password for login, you can use the password of Server A to log in to the production site server (Server B) or disaster recovery site server (Server A).
- If your servers use key pair for login, you can use the obtained password of Server A to log in to the production site server (Server B) or disaster recovery site server (Server A).
After the first time planned failover or failover, the password or key pair remains the same for the subsequent planned failovers or failovers. In this example:
+You can use the password of Server A to log in to the production site server or disaster recovery site server.
+- When your servers use password for login,
If Cloudbase-Init is not started (normally within 3 to 5 minutes after the production site server starts), you can use the password of Server B for login.
+After Cloudbase-Init is started, the login password of Server B becomes invalid. Reset the password and use the new password for login.
+ - When your servers use key pair for login,
If Cloudbase-Init is not started (normally within 3 to 5 minutes after the production site server starts), you can use the obtained login password of Server B for login.
+After Cloudbase-Init is started, the obtained login password of Server B becomes invalid. Obtain the password again.
+
After the first time planned failover or failover, the password or key pair remains the same for the subsequent planned failovers or failovers. In this example:
+- Login using a password: Reset the password of Server B and use the new password for login.
- Login using a key pair: Obtain the password of Server B again and use the obtained password to log in to Server B.
- If your servers use password for login, you can use the password of Server A to log in to the production site server (Server B) or disaster recovery site server (Server A). Specifically:
If the login password of Server A is not changed before the operation, use this password for login.
+If the login password of server A has been changed before the operation, use the new password for login.++ For ECS OSs other than CoreOS, the login password does not change after the first time planned failover or failover.
+For ECSs running CoreOS, the login password of Server A will restore to the initial one after the first time planned failover or failover. In this case, use the login password configured when Server A is created to log in to production site Server A or disaster recovery site Server B.
+ - If your server uses key pair for login, use the SSH key pair of Server A to log in to production site Server B or disaster recovery site Server A.
URI
- URI format
POST /v1/{project_id}/server-groups/{server_group_id}/action
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+failover-server-group
+Yes
+Object
+Performs a failover for a protection group.
+This parameter is left empty by default.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "ff8080826adfae02016ae2d123fc05ed" +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Performing a Planned Failover for a Protection Group
+Function
When you perform a planned failover for a protection group, the current production site of the protection group is switched to the DR site specified when the protection group is created, or reverse. After the planned failover is performed, data synchronization between the production site and DR site continues, but the direction is reverse.
+Constraints and Limitations
- The protection group must have replication pairs.
- status of the protection group must be protected or error-reversing.
- All servers at the current production site of the protection group are stopped. During a planned failover, do not start servers at the production site and DR site. Otherwise, the planned failover may fail.
- If the production site server or DR site server of a protected instance is deleted using the native interface, the planned failover or planned failback will fail, and the protected instance as well as the protection group will become unavailable.
Restrictions on Logging In to a Server After You Perform a Planned Failover for the First Time
- If the production site server (when the protected instance is created) runs Windows and has Cloudbase-Init installed, pay attention to the following restrictions after you perform a planned failover for the first time:
- If you choose to use a password for the server login, you can use the password of the production site server 3 to 5 minutes after the DR site server starts and before Cloudbase-Init starts. It takes 1 to 2 minutes for the server to display the login UI.
After Cloudbase-Init starts, manually reset the password on the DR site server.
+After you perform a planned failback, use the configured password to log in to the production site server.
+ - If you choose to use a key for the server login, you can use the password obtained from the production site server 3 to 5 minutes after the DR site server starts and before Cloudbase-Init starts. It takes 1 to 2 minutes for the server to display the login UI.
After Cloudbase-Init starts, use the password obtained from the DR site server for the login.
+After you perform a planned failback, use the obtained password to log in to the production site server.
+
+ If you change the login password of the DR site server after you perform a planned failover for the first time, log in to the DR site server using the new password. After you perform a planned failback again, use the new password to log in to the production site server.
+ - If you choose to use a password for the server login, you can use the password of the production site server 3 to 5 minutes after the DR site server starts and before Cloudbase-Init starts. It takes 1 to 2 minutes for the server to display the login UI.
- If the production site server (when the protected instance is created) runs Windows and has no Cloudbase-Init installed, pay attention to the following restrictions after you perform a planned failover or failover for the first time:
- If you choose to use a password for the server login, use the password of the production site server to log in to the production site or DR site server.
- If you choose to use a key for the server login, use the password obtained from the production site server to log in to the production site or DR site server.
- If the production site server (when the protected instance is created) runs Linux, pay attention to the following restrictions after you perform a planned failover or failover for the first time:
- If you choose to use a password for the server login, use the password of the production site server to log in to the production site or DR site server.+
For servers running CoreOS, if you change the login password of the production site server after you perform a planned failover for the first time, log in to the DR site server using the new password. After you perform a planned failback again, use the initial password to log in to the production site server.
+ - If you choose to use a key for the server login, use the password obtained from the production site server to log in to the production site or DR site server.
- If you choose to use a password for the server login, use the password of the production site server to log in to the production site or DR site server.
URI
- URI format
POST /v1/{project_id}/server-groups/{server_group_id}/action
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+reverse-server-group
+Yes
+Object
+Performs a planned failover for a protection group.
+For details, see Table 1.
++
+Table 1 reverse-server-group field description Parameter
+Mandatory
+Type
+Description
+priority_station
+Yes
+String
+Specifies the direction of the planned failover.
+- target: indicates to fail services from the production site specified when the protection group is created to the DR site specified when a protection group is created.
- source: indicates to fail services from the DR site specified when the protection group is created to the production site specified when a protection group is created.
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db9d200f002d" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Protected Instance
+ +-
+
- Creating a Protected Instance
+
+ - Deleting a Protected Instance
+
+ - Querying Protected Instances
+
+ - Querying Details About a Protected Instance
+
+ - Changing the Name of a Protected Instance
+
+ - Attaching a Replication Pair to a Protected Instance
+
+ - Detaching a Replication Pair from a Protected Instance
+
+ - Adding an NIC to a Protected Instance
+
+ - Deleting an NIC from a Protected Instance
+
+ - Modifying the Specifications of a Protected Instance
+
+
Creating a Protected Instance
+Function
This API is used to create a protected instance. When a protected instance is created, the default name of the server at the DR site is the same as that of the server at the production site, but their IDs are different. To modify a server name, click the server name on the protected instance details page to switch to the server details page and modify the server name. Alternatively, you can call the API in Changing the Name of a Protected Instance to modify the name.
+Constraints and Limitations
- status of the protection group must be available or protected.
- No shared disk has been attached to the server.
- No protected instance has been created using the server.
- The server must be in the same VPC as the protection group.
- The physical host housing the production site server cannot be a DeH.
- If protection is enabled for servers created during capacity expansion of an Auto Scaling (AS) group, these servers cannot be deleted when the capacity of the AS group is reduced.
- If the server at the production site runs Windows and you choose the key login mode, ensure that the key pair of the server exists when you create a protected instance. Otherwise, the server at the DR site may fail to create, causing the protected instance creation failure.+
If the key pair of the production site server has been deleted, create a key pair with the same name.
+ - After you create a protected instance and enable protection on servers at the production site, modifications to the Hostname, Name, Security Group, Agency, ECS Group, Tags, and Auto Recovery configurations of servers on the production site will not synchronize to the servers at the DR site. You can manually add the configuration items to the servers at the DR site on the management console.
URI
+Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+protected_instance
+Yes
+Object
+Specifies the information about a protected instance.
+For details, see Table 1.
++ + +
+Table 1 protected_instance field description Parameter
+Mandatory
+Type
+Description
+server_group_id
+Yes
+String
+Specifies the ID of the protection group where a protected instance is added.
+For details, see Querying Protection Groups.
+server_id
+Yes
+String
+Specifies the ID of the production site server.
+NOTE:+When the API is successfully invoked, the DR site server will be automatically created.
+name
+Yes
+String
+Specifies the name of a protected instance. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+description
+No
+String
+Specifies the description of a protected instance. The description can contain a maximum of 64 bytes. The value cannot contain the left angle bracket (<) or right angle bracket (>).
+primary_subnet_id
+No
+String
+Specifies the network ID of the subnet for the primary NIC on the DR site server. The value is the same as that of neutron_network_id obtained using the VPC API.
+For details about how to query the subnets, see Querying Subnets.
+primary_ip_address
+No
+String
+Specifies the IP address of the primary NIC on the DR site server.
+This parameter is valid only when primary_subnet_id is specified.
+If this parameter is not specified when primary_subnet_id is specified, the system automatically assigns an IP address to the primary NIC on the DR site server
+flavorRef
+No
+String
+Specifies the flavor ID of the DR site server
+NOTE:+- If this parameter is not specified, the flavor ID of the DR site server is the same as that of the production site server by default.
- Servers of different specifications have different performance, which may affect applications running on the servers. To ensure the server performance after a planned failover or failover, you are recommended to use servers of specifications (CPU and memory) same or higher than the specifications of the production site servers at the DR site.
tags
+No
+Array of objects
+Specifies the tag list.
+For details, see Table 2.
+NOTE:+You can add up to 10 tags for each protected instance.
+
- Example requestPOST https://{Endpoint}/v1/{project_id}/protected-instances+
{ + "protected_instance":{ + "server_group_id": "523ab8ad-3759-4933-9436-4cf4ebb20867", + "server_id": "403b603d-1d91-42cc-a357-81f3c2daf43f", + "name": "test_protected_instance_name", + "description": "my description", + "primary_subnet_id": "a32217fh-3413-c313-6342-3124d3491502", + "primary_ip_address": "192.168.0.5", + "flavorRef": "s3.large.2", + "tags": [ + { + "key": "key1", + "value":"value1" + }, + { + "key": "key", + "value": "value3" + } + ] + } + }+
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db9d200f00bb" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting a Protected Instance
+Function
This API is used to delete a specified protected instance.
+Constraints and Limitations
status of the protected instance must be available, protected, failed-over, error, error-starting, error-stopping, error-reversing, error-failing-over, error-deleting, error-reprotecting, error-resizing, invalid, or fault.
+URI
- URI format
DELETE /v1/{project_id}/protected-instances/{protected_instance_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+For details, see Querying Protected Instances.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+delete_target_server
+No
+Boolean
+Specifies whether to delete the DR site server. The default value is false.
+delete_target_eip
+No
+Boolean
+Specifies whether to delete the EIP of the DR site server. The default value is false.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db3ab00f00df" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Protected Instances
+Function
This API is used to query all protected instances of the current tenant.
+Constraints and Limitations
None
+URI
+- Request filter field description
++
+Parameter
+Mandatory
+Type
+Description
+server_group_id
+No
+String
+Specifies the ID of the protection group, in which all protected instances are queried.
+For details, see the parameter description in Querying Protection Groups.
+server_group_ids
+No
+Array of strings
+Specifies the protection group ID list. The value is in the following format: server_group_ids=['server_group_id1','server_group_id2',...,'server_group_idx']. Convert it using URL encoding.
+- All the protected instances with valid server_group_id in server_group_ids are returned.
- The protected instances of a maximum of 30 server_group_id values can be queried.
- If parameters server_group_id and server_group_ids are both specified in the request, server_group_id will be ignored.
protected_instance_ids
+No
+Array of strings
+Specifies the protected instance ID list. The value is in the following format: protected_instance_ids=['protected_instance_id1','protected_instance_id2',...,'protected_instance_idx']. Convert it using URL encoding.
+- All the protected instances with valid protected_instance_id in protected_instance_ids are returned.
- The protected instances of a maximum of 30 protected_instance_id values can be queried.
- If parameter server_group_id or server_group_ids is specified in the request, protected_instance_ids will be ignored.
limit
+No
+Integer
+Specifies the maximum number of results returned each time. The value is a positive integer from 0 to 1000. The default value is 1000.
+offset
+No
+Integer
+Specifies the offset of each request. The default value is 0. The value must be a number and cannot be negative.
+status
+No
+String
+Specifies the status of a protected instance.
+For details, see Protected Instance Status.
+name
+No
+String
+Specifies the name of a protected instance. Fuzzy search is supported.
+query_type
+No
+String
+Specifies the query type.
+- status_abnormal: indicates to query protected instances in the abnormal status.
- This parameter is invalid when the value is set to general or left empty.
availability_zone
+No
+String
+Specifies the current production site AZ of the protection group containing the protected instance.
+You can obtain this value by calling the API described in Querying an Active-Active Domain.
+
Request
- Request parameter description +
- Example request
GET https://{Endpoint}/v1/{project_id}/protected-instances?server_group_ids=%5b%2221d65fa4-430e-4761-b9ad-4e27364f874c%22%2c%22943c7d15-0371-4b89-b1a6-db1ef35c9263%22%5d&status=available++ Use URL encoding for server_group_ids or protected_instance_ids.
+
Response
- Parameter description
++ +
+Parameter
+Type
+Description
+protected_instances
+Array of objects
+Specifies the information about protected instances.
+For details, see Table 1.
+count
+Integer
+Specifies the number of protected instances.
++ +
+Table 1 protected_instances field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protected instance.
+name
+String
+Specifies the name of a protected instance.
+description
+String
+Specifies the description of a protected instance.
+server_group_id
+String
+Specifies the ID of a protection group.
+status
+String
+Specifies the status of a protected instance.
+For details, see Protected Instance Status.
+progress
+Integer
+Specifies the synchronization progress of a protected instance.
+Unit: %
+source_server
+String
+Specifies the production site server ID.
+target_server
+String
+Specifies the DR site server ID.
+created_at
+String
+Specifies the time when a protected instance was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a protected instance was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the protected instance.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
attachment
+Array of objects
+Specifies the attached replication pairs.
+For details, see Table 2.
+tags
+Array of objects
+Specifies the tag list.
+For details, see Table 3.
+metadata
+Object
+Specifies the metadata of a protected instance.
+For details, see Table 4.
++ + + + +
+Table 2 attachment field description Parameter
+Type
+Description
+replication
+String
+Specifies the ID of a replication pair.
+device
+String
+Specifies the device name.
+
- Example response
{ + "protected_instances": [ + { + "id": "67a2cc7e-fb87-41a8-ba28-9c032abcaee1", + "name": "protected_instance_xff", + "description": "protected_instance_xff", + "server_group_id": "21d65fa4-430e-4761-b9ad-4e27364f874c", + "status": "available", + "progress": 0, + "source_server": "d1e8e8a7-ae6f-4f40-bead-20093976961e", + "target_server": "9bad52b9-ca5a-4274-ba9e-3c8ca9843fa1", + "created_at": "2018-11-06 11:09:25.861", + "updated_at": "2018-11-06 11:12:11.716", + "priority_station": "source", + "attachment": [ + { + "replication": "08d6b5a0-9a12-4263-a468-30d71d10498c", + "device": "/dev/vdb" + }, + { + "replication": "4c332757-dc77-458d-9883-03d701cde2f2", + "device": "/dev/vda" + } + ], + "tags": [ + { + "key": "aaaaaaa", + "value": "01234567889" + }, + { + "key": "ffffff", + "value": "dddd" + } + ], + "metadata": {} + }, + { + "id": "50f5091e-9e9e-473c-a932-2a2cbcbeb1ff", + "name": "ecs_sdrs_test", + "description": "1111", + "server_group_id": "943c7d15-0371-4b89-b1a6-db1ef35c9263", + "status": "protected", + "progress": 100, + "source_server": "5fb92d6c-b0cb-46c9-824b-b90ec5500ae6", + "target_server": "c6c0ff54-fa1f-43ef-9ccc-1774e40c8745", + "created_at": "2018-11-06 09:27:52.258", + "updated_at": "2018-11-06 09:44:59.853", + "priority_station": "target", + "attachment": [ + { + "replication": "6568f7c4-0510-4f39-929d-8ffccbd4fd47", + "device": "/dev/vda" + } + ], + "tags": [ + { + "key": "aaaaaaa", + "value": "01234567889" + }, + { + "key": "ffffff", + "value": "dddd" } + ], + "metadata": {} + } + ], + "count": 2 +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Details About a Protected Instance
+Function
This API is used to query the details about a protected instance, such as the protected instance ID and name.
+Constraints and Limitations
None
+URI
- URI format
GET /v1/{project_id}/protected-instances/{protected_instance_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+protected_instance
+Object
+Specifies the details about a protected instance.
+For details, see Table 1.
++ +
+Table 1 protected_instances field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protected instance.
+name
+String
+Specifies the name of a protected instance.
+description
+String
+Specifies the description of a protected instance.
+server_group_id
+String
+Specifies the ID of a protection group.
+status
+String
+Specifies the status of a protected instance.
+For details, see Protected Instance Status.
+progress
+Integer
+Specifies the synchronization progress of a protected instance.
+Unit: %
+source_server
+String
+Specifies the production site server ID.
+target_server
+String
+Specifies the DR site server ID.
+created_at
+String
+Specifies the time when a protected instance was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a protected instance was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the protected instance.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
attachment
+Array of objects
+Specifies the attached replication pairs.
+For details, see Table 2.
+tags
+Array of objects
+Specifies the tag list.
+For details, see Table 3.
+metadata
+Object
+Specifies the metadata of a protected instance.
+For details, see Table 4.
++ +
+Table 2 attachment field description Parameter
+Type
+Description
+replication
+String
+Specifies the ID of a replication pair.
+device
+String
+Specifies the device name.
++ +
+Table 3 tags field description Parameter
+Type
+Description
+key
+String
+Specifies the tag key.
+value
+String
+Specifies the tag value.
++
+Table 4 Field metadata description Parameter
+Type
+Description
+__system__frozen
+String
+Specifies whether the resource is frozen.
+- true: indicates that the resource is frozen.
- Empty: indicates that the resource is not frozen.
- Example response
{ + "protected_instance": { + "id": "50f5091e-9e9e-473c-a932-2a2cbcbeb1ff", + "name": "ecs_sdrs_test", + "description": "1111", + "server_group_id": "943c7d15-0371-4b89-b1a6-db1ef35c9263", + "status": "available", + "progress": 0, + "source_server": "5fb92d6c-b0cb-46c9-824b-b90ec5500ae6", + "target_server": "c6c0ff54-fa1f-43ef-9ccc-1774e40c8745", + "created_at": "2018-11-06 09:27:52.258", + "updated_at": "2018-11-06 09:44:59.853", + "priority_station": "target", + "attachment": [ + { + "replication": "6568f7c4-0510-4f39-929d-8ffccbd4fd47", + "device": "/dev/vda" + } + ], + "tags": [ + { + "key": "aaaaaaa", + "value": "01234567889" + }, + { + "key": "ffffff", + "value": "dddd" + } + ], + "metadata": {} + } +} ++Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Changing the Name of a Protected Instance
+Function
This API is used to change the name of a protected instance.
+Constraints and Limitations
None
+URI
- URI format
PUT /v1/{project_id}/protected-instances/{protected_instance_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+protected_instance
+Yes
+Object
+Specifies the information about a protected instance.
+For details, see Table 1.
++
+Table 1 protected_instance field description Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the name of a protected instance. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+
- Example request +
Response
- Parameter description
++ +
+Parameter
+Type
+Description
+protected_instance
+Object
+Specifies the details about a protected instance.
+For details, see Table 2.
++ +
+Table 2 protected_instance field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protected instance.
+name
+String
+Specifies the name of a protected instance. The name can contain a maximum of 64 bytes consisting of only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+description
+String
+Specifies the description of a protected instance.
+server_group_id
+String
+Specifies the ID of a protection group.
+status
+String
+Specifies the status of a protected instance. For details, see Protected Instance Status.
+progress
+Integer
+Specifies the synchronization progress of a protected instance.
+Unit: %
+source_server
+String
+Specifies the production site server ID.
+target_server
+String
+Specifies the DR site server ID.
+created_at
+String
+Specifies the time when a protected instance was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, 2019-04-01 12:00:00.0.
+updated_at
+String
+Specifies the time when a protected instance was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.S", for example, 2019-04-01 12:00:00.0.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the protected instance.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
attachment
+Array of objects
+Specifies the attached replication pairs.
+For details, see Table 3.
+tags
+Array of objects
+Specifies the tag list.
+For details, see Table 4.
+metadata
+Object
+Specifies the metadata of a protected instance.
+For details, see Table 5.
++ + + + +
+Table 3 attachment field description Parameter
+Type
+Description
+replication
+String
+Specifies the ID of a replication pair.
+device
+String
+Specifies the device name.
+
- Example response
{ + "protected_instance": { + "id": "00000000632302f501632305f63c000e", + "name": "test_protected_instance_name", + "description": "_sdrs_protected_instance", + "server_group_id": "00000000632302f501632305ac75000a", + "status": "available", + "progress": 0, + "source_server": "5597a320-7a36-4462-9f85-a0d01edfb416", + "target_server": "e37ed7de-bd76-4189-8445-be747205322d", + "created_at": "2018-05-02 22:43:03.0", + "updated_at": "2018-05-02 22:47:27.0", + "priority_station": "target", + "attachment": [ + { + "replication": "6568f7c4-0510-4f39-929d-8ffccbd4fd47", + "device": "/dev/vda" + } + ], + "tags": [ + { + "key": "aaaaaaa", + "value": "01234567889" + }, + { + "key": "ffffff", + "value": "dddd" + } + ], + "metadata": {} + } + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Attaching a Replication Pair to a Protected Instance
+Function
This API is used to attach the specified replication pair to the specified protected instance.
+Constraints and Limitations
- status of the protection group must be available or protected.
- status of the protected instance must be available or protected.
- status of the replication pair must be available or protected.
- The non-shared replication pair has not been attached to any protected instance.
URI
- URI format
POST /v1/{project_id}/protected-instances/{protected_instance_id}/attachreplication
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+replicationAttachment
+Yes
+Object
+Attaches a replication pair to a protected instance.
+For details, see Table 1.
++
+Table 1 replicationAttachment field description Parameter
+Mandatory
+Type
+Description
+replication_id
+Yes
+String
+Specifies the ID of a replication pair.
+You can obtain this value by calling the API described in Querying Replication Pairs.
+device
+Yes
+String
+Specifies the disk device name of a replication pair.
+NOTE:+- The new disk device name cannot be the same as an existing one.
- Set the parameter value to /dev/sda for the system disks of protected instances created using Xen servers and to /dev/sdx for data disks, where x is a letter in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to /dev/sdb and /dev/sdc, respectively. If you set a device name starting with /dev/vd, the system uses /dev/sd by default.
- Set the parameter value to /dev/vda for the system disks of protected instances created using KVM servers and to /dev/vdx for data disks, where x is a letter in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to /dev/vdb and /dev/vdc, respectively. If you set a device name starting with /dev/sd, the system uses /dev/vd by default.
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db9d200f00bb" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Detaching a Replication Pair from a Protected Instance
+Function
This API is used to detach a specified replication pair from a specified protected instance.
+Constraints and Limitations
- status of the protection group must be available, protected, failed-over, error-starting, error-stopping, error-reversing, or error-failing-over.
- status of the protected instance must be available, protected, failed-over, error-starting, error-stopping, error-reversing, error-failing-over, error-deleting, error-reprotecting, error-resizing, invalid, or fault.
- status of the replication pair must be available, protected, failed-over, error-attaching, error-detaching, error-starting, error-stopping, error-reversing, error-failing-over, error-deleting, error-reprotecting, error-extending, invalid, or fault.
- The replication pair has been attached to a protected instance.
- A system disk (attached to /dev/sda or /dev/vda) can be detached only when the server is in the Stopped state. Therefore, stop the server before detaching the system disk.
- Data disks can be detached online or offline, which means that the server containing the disks can either be in the Running or Stopped state.
For details about how to detach a disk online, see in the Elastic Cloud Server User Guide.
+
URI
- URI format
DELETE /v1/{project_id}/protected-instances/{protected_instance_id}/detachreplication/{replication_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+replication_id
+Yes
+String
+Specifies the ID of a replication pair.
+You can query replication pairs attached to the protected instance by calling the API described in Querying Replication Pairs.
+
Request
+Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db921dgf00bb" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Adding an NIC to a Protected Instance
+Function
This API is used to add an NIC to the specified protected instance.
+Constraints and Limitations
- status of the protection group must be available or protected.
- status of the protected instance must be available or protected.
- The subnet of the NIC to be added must belong to the same VPC of the protected group and protected instance.
URI
- URI format
POST /v1/{project_id}/protected-instances/{protected_instance_id}/nic
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+
Request
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+subnet_id
+Yes
+String
+Specifies the subnet ID of the NIC to be added. It is network_id of the subnet, which is the same as the neutron_network_id value.
+security_groups
+No
+Array of objects
+Specifies the security group of the NIC to be added. Specifies the security group of the NIC.
+For details, see Table 1.
+ip_address
+No
+String
+Specifies an IP address. If this parameter is not included, an IP address is automatically assigned.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000062db92d70162db9d200f32dh" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting an NIC from a Protected Instance
+Function
This API is used to delete an NIC from the specified protected instance.
+Constraints and Limitations
- status of the protection group must be available or protected.
- status of the protected instance must be available or protected.
- The primary NIC cannot be deleted.
URI
- URI format
POST /v1/{project_id}/protected-instances/{protected_instance_id}/nic/delete
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+nic_id
+Yes
+String
+Specifies the port ID of the NIC.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000011db92d70162db9d20df32ch" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Modifying the Specifications of a Protected Instance
+Function
This API is used to modify the specifications of a server in a protected instance, including:
+- Modify the specifications of both the production and DR site servers.
- Modify the specifications of only the production site server.
- Modify the specifications of only the DR site server.
You can perform this operation only when the servers of which the specifications to be modified are stopped.
+ Servers of different specifications have different performance, which may affect applications running on the servers. To ensure the server performance after a planned failover or failover, you are recommended to use servers of specifications (CPU and memory) same or higher than the specifications of the production site servers at the DR site.
+Constraints and Limitations
- status of the protection group must be available or protected.
- status of the protected instance must be available, protected, or error-resizing.
- Servers of which the specifications to be modified are stopped.
URI
- URI format
POST /v1/{project_id}/protected-instances/{protected_instance_id}/resize
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+resize
+Yes
+Object
+Modifies the specifications of a protected instance.
+The target server flavors to which a flavor can be changed are the same as those for ECS. You can use the ECS API to query these flavors. For details, see section "Querying the Target ECS Flavors to Which a Flavor Can Be Changed" in Elastic Cloud Server API Reference.
+For details, see Table 1.
++
+Table 1 resize field description Parameter
+Mandatory
+Type
+Description
+flavorRef
+No
+String
+Specifies the flavor ID of the production and DR site servers after the modification.
+NOTE:+If you specify this parameter, the system modifies the specifications of both the production and DR site servers. After the modification, the production site server and DR site server use the same specifications.
+production_flavorRef
+No
+String
+Specifies the flavor ID of the production site server after the modification.
+NOTE:+- If you specify this parameter, the system modifies the specifications of only the production site server.
- If flavorRef is specified, production_flavorRef does not take effect.
dr_flavorRef
+No
+String
+Specifies the flavor ID of the DR site server after the modification.
+NOTE:+- If you specify this parameter, the system modifies the specifications of only the DR site server.
- If flavorRef is specified, dr_flavorRef does not take effect.
- Example request
POST https://{Endpoint}/v1/{project_id}/protected-instances/00000000632302f501632305f63c000e/resize
+Example 1: Modify the specifications of the production and DR site servers to e2.small. Example request:+ +{ + "resize": { + "flavorRef": "e2.small" + } + }+Example 2: Modify the specifications of the production and DR site serves to s3.small.1 and s3.large.2 respectively. Example request:
+{ + "resize": { + "production_flavorRef": "s3.small.1", + "dr_flavorRef": "s3.large.2" + } + }+ +Example 3: Modify the specifications of the production site server to e2.small, and retain the DR site server specifications. Example request:+ +{ + "resize": { + "production_flavorRef": "e2.small" + } + }+Example 4: Modify the specifications of the DR site server to e2.small, and retain the production site server specifications. Example request:
+{ + "resize": { + "dr_flavorRef": "e2.small" + } + }+ + +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000011db92d70162db9d20df32ch" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Replication Pair
+-
+
- Creating a Replication Pair
+
+ - Deleting a Replication Pair
+
+ - Querying Replication Pairs
+
+ - Querying Details About a Replication Pair
+
+ - Expanding the Capacity of a Replication Pair
+
+ - Changing the Name of a Replication Pair
+
+
Creating a Replication Pair
+Function
This API is used to create a replication pair and add it to the specified protection group.
+Constraints and Limitations
- status of the protection group must be available or protected.
- If server_type of the protection group is set to ECS, the disk status is Available.
URI
+Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+replication
+Yes
+Object
+Specifies the information about a replication pair.
+For details, see Table 1.
++
+Table 1 replication field description Parameter
+Mandatory
+Type
+Description
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+You can obtain this value by calling the API described in Querying Protection Groups.
+volume_id
+Yes
+String
+Specifies the ID of the production site disk.
+NOTE:+When the API is successfully invoked, the DR site disk will be automatically created.
+name
+Yes
+String
+Specifies the name of a replication pair. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+description
+No
+String
+Specifies the description of a replication pair. The value can contain a maximum of 64 bytes and cannot contain the left angle bracket (<) or right angle bracket (>).
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000011db92d36662db9d20df32ch" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting a Replication Pair
+Function
This API is used to delete a specified replication pair.
+Constraints and Limitations
- status of the protection group must be available, protected, failed-over, error-starting, error-stopping, error-reversing, or error-failing-over, error-deleting, or error-reprotecting.
- status of the replication pair must be available, protected, failed-over, error, error-starting, error-stopping, error-reversing, error-failing-over, error-deleting, error-reprotecting, error-attaching, error-extending, invalid, or fault.
- The replication pair has not been attached to a protected instance.
URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+replication_id
+Yes
+String
+Specifies the ID of a replication pair.
+You can obtain this value by calling the API described in Querying Replication Pairs.
+
Request
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+replication
+Yes
+Object
+Specifies the information about a replication pair.
+For details, see Table 1.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000011db92d34587db9d20df32ch" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Replication Pairs
+Function
This API is used to query all replication pairs in a specified protection group. If you do not specify the protection group, the system lists all the replication pairs of the tenant.
+Constraints and Limitations
None
+URI
+- Request filter field description
++
+Parameter
+Mandatory
+Type
+Description
+server_group_id
+No
+String
+Specifies the ID of a protection group.
+You can obtain this value by calling the API described in Querying Protection Groups.
+server_group_ids
+No
+Array of strings
+Specifies the protection group ID list. The value is in the following format: server_group_ids=['server_group_id1','server_group_id2',...,'server_group_idx']. Convert it using URL encoding.
+- All the replication pairs with valid server_group_id in server_group_ids are returned.
- The replication pairs of a maximum of 30 server_group_id values can be queried.
- If parameters server_group_id and server_group_ids are both specified in the request, server_group_id will be ignored.
protected_instance_id
+No
+String
+Specifies the ID of a protected instance.
+You can obtain this value by calling the API described in Querying Protected Instances.
+protected_instance_ids
+No
+Array of strings
+Specifies the protected instance ID list. The value is in the following format: protected_instance_ids=['protected_instance_id1','protected_instance_id2',...,'protected_instance_idx']. Convert it using URL encoding.
+- All the replication pairs with valid protected_instance_id in protected_instance_ids are returned.
- The replication pairs of a maximum of 30 protected_instance_id values can be queried.
- If parameters protected_instance_id and protected_instance_ids are both specified in the request, protected_instance_id will be ignored.
name
+No
+String
+Specifies the name of a replication pair. Fuzzy search is supported.
+status
+No
+String
+Specifies the status of a replication pair.
+For details, see Replication Pair Status.
+limit
+No
+Integer
+Specifies the maximum number of results returned each time. The value is a positive integer from 0 to 1000. The default value is 1000.
+offset
+No
+Integer
+Specifies the offset of each request. The default value is 0. The value must be a number and cannot be negative.
+query_type
+No
+String
+Specifies the query type.
+- To query replication pairs in the abnormal status, set query_type to status_abnormal.
- Otherwise, set query_type to general or leave it empty.
availability_zone
+No
+String
+Specifies the current production site AZ of the protection group containing the replication pair.
+You can obtain this value by calling the API described in Querying an Active-Active Domain.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+replications
+Array of objects
+Specifies the information about replication pairs.
+For details, see Table 1.
+count
+Integer
+Specifies the number of replication pairs.
++ +
+Table 1 replications field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a replication pair.
+name
+String
+Specifies the name of a replication pair.
+description
+String
+Specifies the description of a replication pair.
+replication_model
+String
+Specifies the replication mode of a replication pair. The default value is hypermetro, indicating synchronous replication.
+status
+String
+Specifies the status of a replication pair.
+For details, see Replication Pair Status.
+progress
+Integer
+Specifies the synchronization progress of a replication pair.
+Unit: %
+replication_status
+String
+Specifies the data synchronization status.
+- active: Data has been synchronized.
- inactive: Data is not synchronized.
- copying: Data is being synchronized.
- active-stopped: Data synchronization is stopped.
attachment
+Array of objects
+Specifies the device name.
+For details, see Table 2.
+server_group_id
+String
+Specifies the ID of a protection group.
+volume_ids
+String
+Specifies the ID of the disk used to create a replication pair.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the replication pair.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
fault_level
+String
+Specifies the fault level of a replication pair.
+- 0: No fault occurs.
- 2: The disk of the current production site does not have read/write permissions. In this case, you are advised to perform a failover.
- 5: The replication link is disconnected. In this case, a failover is not allowed. Contact customer service.
created_at
+String
+Specifies the time when a replication pair was created.
+The default format is as follows: ""yyyy-MM-ddTHH:mm:ss.SSSSSS", for example, 2019-04-01T12:00:00.000000.
+updated_at
+String
+Specifies the time when a replication pair was updated.
+The default format is as follows: ""yyyy-MM-ddTHH:mm:ss.SSSSSS", for example, 2019-04-01T12:00:00.000000.
+record_metadata
+Object
+Specifies the SDR data of a replication pair.
+For details, see Table 3.
+failure_detail
+String
+Specifies the error code returned only when status of a replication pair is error.
+For details, see the returned value in Error Codes.
++ +
+Table 2 attachment field description Parameter
+Type
+Description
+device
+String
+Specifies the device name.
+protected_instance
+String
+Specifies the ID of the protected instance to which the replication pair is attached.
++
+Table 3 record_metadata field description Parameter
+Type
+Description
+multiattach
+Boolean
+Specifies whether the disk in a replication pair is a shared disk.
+bootable
+Boolean
+Specifies whether the disk in a replication pair is a system disk.
+volume_size
+Integer
+Specifies the size of the disk in a replication pair. Unit: GB
+volume_type
+String
+Specifies the type of the disk in a replication pair.
+Currently, the value can be SSD, SAS, SATA, co-p1, uh-l1, GPSSD, or ESSD.+- SSD: specifies the ultra-high I/O disk type.
- SAS: specifies the high I/O disk type.
- SATA: specifies the common I/O disk type.
- co-p1: specifies the high I/O (performance-optimized I) disk type.
- uh-l1: specifies the ultra-high I/O (latency-optimized) disk type.
- GPSSD: specifies the general purpose SSD disk type.
- ESSD: specifies the extreme SSD disk type.
Disks of the co-p1 and uh-l1 types are used exclusively for HPC ECSs and SAP HANA ECSs.
+
- Example response
{ + "count": 1, + "replications": [ + { + "id": "b93bc1c4-67ee-45a1-bc8a-d022fdd28811", + "name": "test_replication_name", + "description": "description_test", + "replication_model": "hypermetro", + "status": "available", + "progress": 0, + "replication_status": "active", + "attachment": [ + { + "device": "/dev/vda", + "protected_instance": "8a7a6339-679b-452b-948c-144e0ef85d9e" + } + ], + "server_group_id": "c2aee29a-2959-4d01-9755-01cc76a4d17d", + "volume_ids": "48dda0c0-c800-46f2-9728-a519ff783d35,388b324a-a9d1-44a4-a00d-42085f22a9bc", + "priority_station": "source", + "fault_level": "0", + "created_at": "2018-05-04T03:43:24.108526", + "updated_at": "2018-05-04T03:44:28.322873", + "record_metadata": { + "multiattach": false, + "bootable": false, + "volume_size": 10, + "volume_type": "SATA" + } + } + ] +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Details About a Replication Pair
+Function
This API is used to query the details about a replication pair.
+Constraints and Limitations
None
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+replication_id
+Yes
+Specifies the ID of a replication pair.
+You can obtain this value by calling the API described in Querying Replication Pairs.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+replication
+Object
+Specifies the information about a replication pair.
+For details, see Table 1.
++ +
+Table 1 replication field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a replication pair.
+name
+String
+Specifies the name of a replication pair.
+description
+String
+Specifies the description of a replication pair.
+replication_model
+String
+Specifies the replication mode of a replication pair. The default value is hypermetro, indicating synchronous replication.
+status
+String
+Specifies the status of a replication pair. For details, see Replication Pair Status.
+progress
+Integer
+Specifies the synchronization progress of a replication pair.
+Unit: %
+replication_status
+String
+Specifies the data synchronization status.
+- active: Data has been synchronized.
- inactive: Data is not synchronized.
- copying: Data is being synchronized.
- active-stopped: Data synchronization is stopped.
attachment
+Array of objects
+Specifies the device name.
+For details, see Table 2.
+server_group_id
+String
+Specifies the ID of a protection group.
+volume_ids
+String
+Specifies the ID of the disk used to create a replication pair.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the replication pair.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
fault_level
+String
+Specifies the fault level of a replication pair.
+- 0: No fault occurs.
- 2: The disk of the current production site does not have read/write permissions. In this case, you are advised to perform a failover.
- 5: The replication link is disconnected. In this case, a failover is not allowed. Contact customer service.
created_at
+String
+Specifies the time when a replication pair was created.
+The default format is as follows: ""yyyy-MM-ddTHH:mm:ss.SSSSSS", for example, 2019-04-01T12:00:00.000000.
+updated_at
+String
+Specifies the time when a replication pair was updated.
+The default format is as follows: ""yyyy-MM-ddTHH:mm:ss.SSSSSS", for example, 2019-04-01T12:00:00.000000.
+record_metadata
+Object
+Specifies the SDR data of a replication pair.
+For details, see Table 3.
+failure_detail
+String
+Specifies the error code returned only when status of a replication pair is error.
+For details, see the returned value in Error Codes.
++ +
+Table 2 attachment field description Parameter
+Type
+Description
+device
+String
+Specifies the device name.
+protected_instance
+String
+Specifies the ID of the protected instance to which the replication pair is attached.
++
+Table 3 record_metadata field description Parameter
+Type
+Description
+multiattach
+Boolean
+Specifies whether the disk in a replication pair is a shared disk.
+bootable
+Boolean
+Specifies whether the disk in a replication pair is a system disk.
+volume_size
+Integer
+Specifies the size of the disk in a replication pair. Unit: GB
+volume_type
+String
+Specifies the type of the disk in a replication pair.
+Currently, the value can be SSD, SAS, SATA, co-p1, uh-l1, GPSSD, or ESSD.+- SSD: specifies the ultra-high I/O disk type.
- SAS: specifies the high I/O disk type.
- SATA: specifies the common I/O disk type.
- co-p1: specifies the high I/O (performance-optimized I) disk type.
- uh-l1: specifies the ultra-high I/O (latency-optimized) disk type.
- GPSSD: specifies the general purpose SSD disk type.
- ESSD: specifies the extreme SSD disk type.
Disks of the co-p1 and uh-l1 types are used exclusively for HPC ECSs and SAP HANA ECSs.
+
- Example response
{ + "replication": + { + "id": "b93bc1c4-67ee-45a1-bc8a-d022fdd28811", + "name": "test_sdrs_replication", + "description": "test_description", + "replication_model": "hypermetro", + "status": "available", + "progress": 0, + "replication_status": "active", + "attachment": [ + { + "device": "/dev/vda", + "protected_instance": "8a7a6339-679b-452b-948c-144e0ef85d9c" + } + ], + "server_group_id": "c2aee29a-2959-4d01-9755-01cc76a4d17d", + "volume_ids": "48dda0c0-c800-46f2-9728-a519ff783d35,388b324a-a9d1-44a4-a00d-42085f22a9bc", + "priority_station": "source", + "fault_level": "0", + "created_at": "2018-05-04T03:43:24.108526", + "updated_at": "2018-05-04T03:44:28.322873", + "record_metadata": { + "multiattach": false, + "bootable": false, + "volume_size": 10, + "volume_type": "SATA" + } + } +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Expanding the Capacity of a Replication Pair
+Function
This API is used to expand the capacity of the two disks in a replication pair.
+Constraints and Limitations
- status of the replication pair must be available, protected, or error-extending.
- status of disks in the replication pair is available or in-use.
URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+replication_id
+Yes
+String
+Specifies the ID of a replication pair.
+You can obtain this value by calling the API described in Querying Replication Pairs.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+extend-replication
+Yes
+Object
+Expands disk capacity.
+For details, see Table 1.
++
+Table 1 extend-replication field description Parameter
+Mandatory
+Type
+Description
+new_size
+Yes
+Integer
+Specifies the disk capacity after expansion in a replication pair.
+Unit: GB
+NOTE:+If the value has a decimal point, the system takes the integer before the decimal point by default.
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000011db92d34587db9d20df32ch" + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Changing the Name of a Replication Pair
+Function
This API is used to change the name of a replication pair.
+Constraints and Limitations
None
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+replication_id
+Yes
+String
+Specifies the ID of a replication pair.
+You can obtain this value by calling the API described in Querying Replication Pairs.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+replication
+Yes
+Object
+Specifies the information about a replication pair.
+For details, see Table 1.
++
+Table 1 replication field description Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the name of a replication pair.
+- The name can contain a maximum of 64 bytes.
- The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
- Example request +
Response
- Parameter description
++ +
+Parameter
+Type
+Description
+replication
+Object
+Specifies the information about a replication pair.
+For details, see Table 2.
++ +
+Table 2 replication field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a replication pair.
+name
+String
+Specifies the name of a replication pair. The name can contain a maximum of 64 bytes consisting of only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+description
+String
+Specifies the description of a replication pair.
+replication_model
+String
+Specifies the replication mode of a replication pair. The default value is hypermetro, indicating synchronous replication.
+status
+String
+Specifies the status of a replication pair.
+For details, see Replication Pair Status.
+progress
+Integer
+Specifies the synchronization progress of a replication pair.
+Unit: %
+replication_status
+String
+Specifies the data synchronization status.
+- active: Data has been synchronized.
- inactive: Data is not synchronized.
- copying: Data is being synchronized.
- active-stopped: Data synchronization is stopped.
attachment
+Array of objects
+Specifies the device name.
+For details, see Table 3.
+volume_ids
+String
+Specifies the ID of the disk used to create a replication pair.
+server_group_id
+String
+Specifies the ID of a protection group.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the replication pair.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
fault_level
+String
+Specifies the fault level of a replication pair.
+- 0: No fault occurs.
- 2: The disk of the current production site does not have read/write permissions. In this case, you are advised to perform a failover.
- 5: The replication link is disconnected. In this case, a failover is not allowed. Contact customer service.
created_at
+String
+Specifies the time when a replication pair was created.
+The default format is as follows: ""yyyy-MM-ddTHH:mm:ss.SSSSSS", for example, 2019-04-01T12:00:00.000000.
+updated_at
+String
+Specifies the time when a replication pair was updated.
+The default format is as follows: "yyyy-MM-ddTHH:mm:ss.SSSSSS", for example, 2019-04-01T12:00:00.000000.
+record_metadata
+Object
+Specifies the SDR data of a replication pair.
+For details, see Table 4.
+failure_detail
+String
+Specifies the error code returned only when status of a replication pair is error.
+For details, see the returned value in Error Codes.
++ +
+Table 3 attachment field description Parameter
+Type
+Description
+protected_instance
+String
+Specifies the ID of the protected instance to which the replication pair is attached.
+device
+String
+Specifies the device name.
++
+Table 4 record_metadata field description Parameter
+Type
+Description
+multiattach
+Boolean
+Specifies whether the disk in a replication pair is a shared disk.
+bootable
+Boolean
+Specifies whether the disk in a replication pair is a system disk.
+volume_size
+Integer
+Specifies the size of the disk in a replication pair. Unit: GB
+volume_type
+String
+Specifies the type of the disk in a replication pair.
+Currently, the value can be SSD, SAS, SATA, co-p1, uh-l1, GPSSD, or ESSD.+- SSD: specifies the ultra-high I/O disk type.
- SAS: specifies the high I/O disk type.
- SATA: specifies the common I/O disk type.
- co-p1: specifies the high I/O (performance-optimized I) disk type.
- uh-l1: specifies the ultra-high I/O (latency-optimized) disk type.
- GPSSD: specifies the general purpose SSD disk type.
- ESSD: specifies the extreme SSD disk type.
Disks of the co-p1 and uh-l1 types are used exclusively for HPC ECSs and SAP HANA ECSs.
+
- Example response
{ + "replication": + { + "id": "b93bc1c4-67ee-45a1-bc8a-d022fdd28811", + "name": "new_name", + "description": "test_description", + "replication_model": "hypermetro", + "status": "available", + "progress": 0, + "replication_status": "active", + "attachment": [ + { + "device": "/dev/vda", + "protected_instance": "8a7a6339-679b-452b-948c-144e0ef85d9c" + } + ], + "volume_ids": "48dda0c0-c800-46f2-9728-a519ff783d35,388b324a-a9d1-44a4-a00d-42085f22a9bc", + "server_group_id": "0000000062d194520162d196f0fe0007", + "priority_station": "source", + "fault_level": "0", + "created_at": "2018-05-04T03:43:24.108526", + "updated_at": "2018-05-04T03:44:28.322873", + "record_metadata": { + "multiattach": false, + "bootable": false, + "volume_size": "10", + "volume_type": "SATA" + } + } + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
DR Drill
+ +-
+
- Creating a DR Drill
+
+ - Deleting a DR Drill
+
+ - Querying DR Drills
+
+ - Querying Details About a DR Drill
+
+ - Updating a DR Drill Name
+
+
Creating a DR Drill
+Function
This API is used to create a disaster recovery (DR) drill.
+Constraints and Limitations
- status of the protection group must be available, protected, failed-over, error-starting, error-stopping, error-reversing, error-reprotecting, or error-failing-over.
- Do not perform a DR drill before the first time data synchronization completes. Otherwise, the drill server may not start properly.
- If drill_vpc_id is specified (the system uses an existing drill VPC), the drill VPC CIDR block must be consistent with that of the VPC for the protection group. If drill_vpc_id is not specified, the system automatically creates a drill VPC.
- When you use a created drill VPC to create a drill, the subnet ACL rule of the drill VPC will be different from that of the VPC of the protection group. You need to manually set them to be the same one if needed.
- When you create a DR drill, if the VPC of the protection group has a customized routing table and subnets configured, the corresponding routing table will not be automatically created for the drill VPC. You need to manually create it if needed.
URI
+- Parameter description
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Specifies the project ID. + |
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+disaster_recovery_drill
+Yes
+Object
+Specifies the information about a DR drill.
+For details, see Table 1.
++
+Table 1 disaster_recovery_drill field description Parameter
+Mandatory
+Type
+Description
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+drill_vpc_id
+No
+String
+Specifies the drill VPC ID. If you do not specify this parameter, the system will automatically create a drill VPC.
+name
+Yes
+String
+Specifies the name of a DR drill. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+
- Example request +
Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+
- Example response
{ + "job_id": "0000000011db92d36662db9d20df32ch" + }+Or+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting a DR Drill
+Function
This API is used to delete a specified DR drill. After you delete the specified DR drill:
+- The DR drill as well as the disks and NICs attached to the DR drill will be deleted.
- The drill VPC and subnets of the drill VPC will not be deleted. You can create other servers using this VPC.
Constraints and Limitations
The status of the DR drill must be available, error, or error-deleting.
+URI
- URI format
DELETE /v1/{project_id}/disaster-recovery-drills/{disaster_recovery_drill_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+disaster_recovery_drill_id
+Yes
+String
+Specifies the DR drill ID.
+To query details, see Querying DR Drills.
+
Request
+Response
- Parameter description
++
+Parameter
+Type
+Description
+job_id
+String
+Specifies the job ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+ - Example response
{ + "job_id": "0000000011db92d34587db9d20df32ch" + }+Or+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying DR Drills
+Function
This API is used to query all DR drills in a specified protection group. If you do not specify the protection group, the system lists all the DR drills of the tenant.
+Constraints and Limitations
None
+URI
+- Request filter field description
++
+Parameter
+Mandatory
+Type
+Description
+server_group_id
+No
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+name
+No
+String
+Specifies the DR drill name. Fuzzy search is supported.
+status
+No
+String
+Specifies the DR drill status.
+For details, see DR Drill Status.
+drill_vpc_id
+No
+String
+Specifies the ID of the VPC used for a DR drill.
+limit
+No
+Integer
+Specifies the maximum number of results returned each time. The value is a positive integer from 0 to 1000. The default value is 1000.
+offset
+No
+Integer
+Specifies the offset of each request. The default value is 0. The value must be a number and cannot be negative.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+disaster_recovery_drills
+Array of objects
+Specifies the DR drills.
+For details, see Table 1.
+count
+Integer
+Specifies the number of DR drills.
++ + +
+Table 1 disaster_recovery_drills field description Parameter
+Type
+Description
+id
+String
+Specifies the DR drill ID.
+name
+String
+Specifies the DR drill name.
+status
+String
+Specifies the DR drill status. For details, see DR Drill Status.
+server_group_id
+String
+Specifies the ID of a protection group.
+drill_vpc_id
+String
+Specifies the ID of the VPC used for a DR drill.
+created_at
+String
+Specifies the time when a DR drill was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a DR drill was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+drill_servers
+Array of objects
+Specifies the drill servers.
+For details, see Table 2.
+
- Example response
{ + "count": 2, + "disaster_recovery_drills": [ + { + "id": "e472d26f-9624-42fb-8bfc-717d4714c225", + "name": "dr_drill_test", + "status": "available", + "server_group_id": "c2aee29a-2959-4d01-9755-01cc76a4d17d", + "drill_vpc_id": "7881f1d2-1f41-419c-873a-14ac620bc46e", + "created_at": "2018-07-18 06:41:58.681", + "updated_at": "2018-07-18 09:41:14.677", + "drill_servers": [ + { + "protected_instance": "d08ca8d7-a784-41ae-b32a-c592943f5dfc", + "drill_server_id": "9de0439a-4ee4-4199-919a-44afd20952dc" + }, + { + "protected_instance": "ea308e8b-043c-4fc6-a53c-856eae137b13", + "drill_server_id": "3eaa1c70-9719-4eb5-b577-cb92ddbffd03" + } + ] + }, + { + "id": "f96ac55f-35dd-4cc3-ba61-36c168900c99", + "name": "drill_test", + "status": "available", + "server_group_id": "3a60f45d-cf5b-49f1-a05e-ddee78cb6eef", + "drill_vpc_id": "ac784bd6-a79c-4def-9ff8-dc87940d5335", + "created_at": "2018-07-17 22:38:21.111", + "updated_at": "2018-07-17 22:47:54.845", + "drill_servers": [] + } + ] +}+Or+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Details About a DR Drill
+Function
This API is used to query the details about a DR drill.
+Constraints and Limitations
None
+URI
- URI format
GET /v1/{project_id}/disaster-recovery-drills/{disaster_recovery_drill_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+disaster_recovery_drill_id
+Yes
+Specifies the DR drill ID.
+To query details, see Querying DR Drills.
+
Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+disaster_recovery_drill
+Object
+Specifies the information about a DR drill.
+For details, see Table 1.
++ + +
+Table 1 disaster_recovery_drill field description Parameter
+Type
+Description
+id
+String
+Specifies the DR drill ID.
+name
+String
+Specifies the DR drill name.
+status
+String
+Specifies the DR drill status. For details, see DR Drill Status.
+drill_vpc_id
+String
+Specifies the ID of the VPC used for a DR drill.
+created_at
+String
+Specifies the time when a DR drill was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a DR drill was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+server_group_id
+String
+Specifies the ID of a protection group.
+drill_servers
+Array of objects
+Specifies the drill servers.
+For details, see Table 2.
+ - Example response
{ + "disaster_recovery_drill": + { + "id": "e472d26f-9624-42fb-8bfc-717d4714c225", + "name": "dr_drill_test", + "status": "available", + "server_group_id": "c2aee29a-2959-4d01-9755-01cc76a4d17d", + "drill_vpc_id": "7881f1d2-1f41-419c-873a-14ac620bc46e", + "created_at": "2018-07-18 06:41:58.681", + "updated_at": "2018-07-18 00:41:14.677", + "drill_servers": [ + { + "protected_instance": "d08ca8d7-a784-41ae-b32a-c592943f5dfc", + "drill_server_id": "9de0439a-4ee4-4199-919a-44afd20952dc" + }, + { + "protected_instance": "ea308e8b-043c-4fc6-a53c-856eae137b13", + "drill_server_id": "3eaa1c70-9719-4eb5-b577-cb92ddbffd03" + } + ] + } + }+Or+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Updating a DR Drill Name
+Function
This API is used to update a DR drill name.
+Constraints and Limitations
None
+URI
- URI format
PUT /v1/{project_id}/disaster-recovery-drills/{disaster_recovery_drill_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+disaster_recovery_drill_id
+Yes
+Specifies the DR drill ID.
+To query details, see Querying DR Drills.
+
Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+disaster_recovery_drill
+Yes
+Object
+Specifies the information about a DR drill.
+For details, see Table 1.
++
+Table 1 disaster_recovery_drill field description Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the DR drill name.
+- The name can contain a maximum of 64 bytes.
- The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
- Example request +
Response
- Parameter description
++ +
+Parameter
+Type
+Description
+disaster_recovery_drill
+Object
+Specifies the information about a DR drill.
+For details, see Table 2.
++ + +
+Table 2 disaster_recovery_drill field description Parameter
+Type
+Description
+id
+String
+Specifies the DR drill ID.
+name
+String
+Specifies the DR drill name. Specifies the name of a DR drill. The name can contain a maximum of 64 bytes. The value can contain only letters (a to z and A to Z), digits (0 to 9), decimal points (.), underscores (_), and hyphens (-).
+status
+String
+Specifies the DR drill status.
+For details, see DR Drill Status.
+drill_vpc_id
+String
+Specifies the ID of the VPC used for a DR drill.
+created_at
+String
+Specifies the time when a DR drill was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a DR drill was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+server_group_id
+String
+Specifies the ID of a protection group.
+drill_servers
+Array of objects
+Specifies the drill servers.
+For details, see Table 3.
+
- Example response
{ + "disaster_recovery_drill": + { + "id": "e472d26f-9624-42fb-8bfc-717d4714c225", + "name": "new_dr_drill_name", + "status": "available", + "server_group_id": "c2aee29a-2959-4d01-9755-01cc76a4d17d", + "drill_vpc_id": "7881f1d2-1f41-419c-873a-14ac620bc46e", + "created_at": "2018-07-18 06:41:58.681", + "updated_at": "2018-07-18 00:41:14.677", + "drill_servers": [ + { + "protected_instance": "d08ca8d7-a784-41ae-b32a-c592943f5dfc", + "drill_server_id": "9de0439a-4ee4-4199-919a-44afd20952dc" + }, + { + "protected_instance": "ea308e8b-043c-4fc6-a53c-856eae137b13", + "drill_server_id": "3eaa1c70-9719-4eb5-b577-cb92ddbffd03" + } + ] + } + }+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Tag Management
+-
+
- Querying Protected Instances by Tag
+
+ - Adding Protected Instance Tags in Batches
+
+ - Deleting Protected Instance Tags in Batches
+
+ - Adding a Protected Instance Tag
+
+ - Deleting a Protected Instance Tag
+
+ - Querying a Protected Instance Tag
+
+ - Querying Tags of All Protected Instances in a Specified Project
+
+
Querying Protected Instances by Tag
+Function
This API is used to query protected instances by tag.
+URI
+Request
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+offset
+No
+String
+Specifies the index position. This parameter is unavailable when action is set to count. If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, the value of offset is 0 by default, indicating that the query starts from the first piece of data. The offset value must be a number and cannot be a negative number.
+limit
+No
+String
+Specifies the number of limited queries. This parameter is unavailable when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number.
+action
+Yes
+String
+Specifies the operation to be performed. The value can be filter (filtering) or count (querying the total number).
+If action is set to filter, the query is performed based on the filter conditions. If action is set to count, only the total number of records is returned.
+matches
+No
+Array of objects
+Specifies the search field. The tag key is the field to be matched, for example, resource_name. The tag value indicates the value to be matched. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys.
+Determine whether fuzzy match is required based on the keys. For example, if key is resource_name, fuzzy search (case insensitive) is used by default. If value is an empty string, exact match is used. Currently, only resource_name for key is supported. Other key values will be available later.
+For details, see Table 2.
+not_tags
+No
+Array of objects
+The resources to be queried do not contain tags listed in not_tags. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.
+For details, see Table 1.
+tags
+No
+Array of objects
+The resources to be queried contain tags listed in tags. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.
+For details, see Table 1.
+tags_any
+No
+Array of objects
+The resources to be queried contain any tags listed in tags_any. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no tag filtering condition is specified, full data is returned.
+For details, see Table 1.
+not_tags_any
+No
+Array of objects
+The resources to be queried do not contain any tags listed in not_tags_any. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 20 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value in a tag must be unique. The response returns resources containing no tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no tag filtering condition is specified, full data is returned.
+For details, see Table 1.
++ +
+Table 1 tag field description Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the tag key. It contains a maximum of 127 Unicode characters. It cannot be left blank. key cannot be empty, an empty string, or spaces. Before using key, delete spaces of single-byte character (SBC) before and after the value.
+values
+Yes
+Array of strings
+Lists the tag values. Each value contains a maximum of 255 Unicode characters. Before using values, delete SBC spaces before and after the value.
+The asterisk (*) is reserved for the system. If the value starts with *, it indicates that fuzzy match is performed based on the value following *. The value cannot contain only asterisks (*).
+If the values are null, it indicates any_value (querying any value). The resources containing one or more values listed in values will be found and displayed.
++
+Table 2 Description of the match field Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the tag key.
+Currently, only resource_name for key is supported. Other key values will be available later.
+value
+Yes
+String
+Specifies the tag value.
+Each value can contain a maximum of 255 Unicode characters.
+
- Sample request when action is set to filterPOST https://{Endpoint}/v1/{project_id}/protected-instances/resource_instances/action+
{ + "offset": "100", + "limit": "100", + "action": "filter", + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ], + "not_tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ], + "tags_any": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + } + ], + "not_tags_any": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + } + ] +}+ - Sample request when action is set to countPOST https://{Endpoint}/v1/{project_id}/protected-instances/resource_instances/action+
{ + "action": "count", + "not_tags": [ + { + "key": "key1", + "values": [ + "value1", + "*value2" + ] + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "tags_any": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + } + ], + "not_tags_any": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ] +}+
Response
- Parameter description
++ +
+Parameter
+Mandatory
+Type
+Description
+resources
+Yes
+Array of objects
+Specifies the returned protected instances.
+For details, see Table 3.
+total_count
+Yes
+Integer
+Specifies the total number of resources.
+The value is not affected by the filtering criteria.
++ +
+Table 3 Description of field resource Parameter
+Mandatory
+Type
+Description
+resource_id
+Yes
+String
+Specifies the ID of a protected instance.
+resource_name
+Yes
+String
+Specifies the protected instance name. This parameter is left blank by default if there is no name.
+resource_detail
+Yes
+Object
+Specifies the details of a protected instance.
+For details, see Table 4.
+tags
+Yes
+Array of objects
+Specifies the tag list. If there is no tag in the list, tags is taken as an empty array.
+For details, see Table 8.
++ +
+Table 4 protected_instances field description Parameter
+Type
+Description
+id
+String
+Specifies the ID of a protected instance.
+name
+String
+Specifies the name of a protected instance.
+description
+String
+Specifies the description of a protected instance.
+server_group_id
+String
+Specifies the ID of a protection group.
+status
+String
+Specifies the status of a protected instance.
+For details, see Protected Instance Status.
+progress
+Integer
+Specifies the synchronization progress of a protected instance.
+Unit: %
+source_server
+String
+Specifies the production site server ID.
+target_server
+String
+Specifies the DR site server ID.
+created_at
+String
+Specifies the time when a protected instance was created.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+updated_at
+String
+Specifies the time when a protected instance was updated.
+The default format is as follows: "yyyy-MM-dd HH:mm:ss.SSS", for example, 2019-04-01 12:00:00.000.
+priority_station
+String
+Specifies the current production site AZ of the protection group containing the protected instance.
+- source: indicates that the current production site AZ is the source_availability_zone value.
- target: indicates that the current production site AZ is the target_availability_zone value.
attachment
+Array of objects
+Specifies the attached replication pairs.
+For details, see Table 2.
+tags
+Array of objects
+Specifies the tag list.
+For details, see Table 3.
+metadata
+Object
+Specifies the metadata of a protected instance.
+For details, see Table 4.
++ +
+Table 5 attachment field description Parameter
+Type
+Description
+replication
+String
+Specifies the ID of a replication pair.
+device
+String
+Specifies the device name.
++ +
+Table 6 tags field description Parameter
+Type
+Description
+key
+String
+Specifies the tag key.
+value
+String
+Specifies the tag value.
++ + +
+Table 7 Field metadata description Parameter
+Type
+Description
+__system__frozen
+String
+Specifies whether the resource is frozen.
+- true: indicates that the resource is frozen.
- Empty: indicates that the resource is not frozen.
- Example response
Example response when action is set to filter
+{ + "resources": [ + { + "resource_id": "d5a00c87-6b82-414a-a09e-59c37fff44d0", + "resource_name": "Protected-Instance-c801", + "resource_detail": { + "id": "d5a00c87-6b82-414a-a09e-59c37fff44d0", + "name": "Protected-Instance-c801", + "description": null, + "server_group_id": "525fbd01-d4d1-44fc-b341-6d734bcce245", + "status": "protected", + "progress": 100, + "source_server": "73aff1d7-48d2-494e-a9f1-a7d3ffad31ff", + "target_server": "0f6bc56b-a3bb-4707-a4fb-ccd4db5fac59", + "created_at": "2019-05-28 08:17:50.066", + "updated_at": "2019-05-30 01:40:00.74", + "priority_station": "source", + "attachment": [ + { + "replication": "42e2016e-b96e-4f75-aa57-1377a9cb45e4", + "device": "/dev/vda" + } + ], + "tags": [ + { + "key": "GH1111113fffffKdddddd", + "value": "aaappppppppddddddd" + } + ], + "metadata": {} + }, + "tags": [ + { + "key": "GH1111113fffffKdddddd", + "value": "aaappppppppddddddd" + } + ] + } + ], + "total_count": 1 +}+ - Example response when action is set to count
{ + "total_count": 1000 +}+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+OK
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Adding Protected Instance Tags in Batches
+Function
This API is used to add protected instance tags for a specified protected instance in batches.
+You can add a maximum of 20 tags to a protected instance.
+This API is idempotent.
+- If there are duplicate keys in the request body when you add tags, an error is reported.
- During tag creation, duplicate keys are not allowed. If a key exists in the database, its value will be overwritten.
URI
+- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+For details, see Querying Protected Instances.
+
Request
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+action
+Yes
+String
+Identifies the operation. The value can be create or delete.
+- create: indicates to create a tag.
tags
+Yes
+Array of objects
+Specifies the tag list.
+For details, see Table 1.
+
- Example request +
Returned Value
- Normal
++
+Returned Value
+Description
+204
+No Content
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Adding a Protected Instance Tag
+Function
You can add a maximum of 20 tags to a protected instance.
+This API is idempotent.
+If a to-be-created tag has the same key as an existing tag, the tag will be created and overwrite the existing one.
+URI
- URI format
POST /v1/{project_id}/protected-instances/{protected_instance_id}/tags
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+For details, see Querying Protected Instances.
+
Request
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+tag
+Yes
+Object
+Specifies the tag to be added.
+For details, see Table 1.
+
- Example request +
Returned Value
- Normal
++
+Returned Value
+Description
+204
+No Content
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Deleting a Protected Instance Tag
+Function
This API is idempotent.
+- During deletion, the tag character set is not verified. The URI must be encoded before the API is invoked. Other services need to decode the URI.+
Select a desired tool for URI encoding.
+ - The tag key cannot be left blank or be an empty string. If the key of the tag to be deleted does not exist, 404 will be returned.
URI
- URI format
DELETE /v1/{project_id}/protected-instances/{protected_instance_id}/tags/{key}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+For details, see Querying Protected Instances.
+key
+Yes
+String
+Specifies the tag key.
+
Request
+Returned Value
- Normal
++
+Returned Value
+Description
+204
+No Content
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Querying a Protected Instance Tag
+Function
This API is used to query tags of a specified protected instance.
+URI
- URI format
GET /v1/{project_id}/protected-instances/{protected_instance_id}/tags
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+For details, see Querying Protected Instances.
+
Request
+Response
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+tags
+Yes
+Array of objects
+Specifies the tag list.
+For details, see Table 1.
+
- Example response
{ + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] +}+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+OK
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Querying Tags of All Protected Instances in a Specified Project
+Function
This API is used to query all resource tags of a protected instance in a specified project.
+URI
+Request
+Response
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+tags
+Yes
+Array of objects
+Specifies the tag list.
+For details, see Table 1.
+
- Example response
{ + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ] +}+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+OK
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Deleting Protected Instance Tags in Batches
+Function
This API is used to delete protected instance tags for a specified protected instance in batches.
+You can add a maximum of 20 tags to a protected instance.
+This API is idempotent.
+- During tag deletion, if some tags do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.
URI
+- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+protected_instance_id
+Yes
+String
+Specifies the ID of a protected instance.
+For details, see Querying Protected Instances.
+
Request
- Parameter description
++ + +
+Parameter
+Mandatory
+Type
+Description
+action
+Yes
+String
+Identifies the operation. The value can be create or delete.
+- delete: indicates to delete a tag.
tags
+Yes
+Array of objects
+Specifies the tag list.
+For details, see Table 1.
+
Returned Values
- Normal
++
+Returned Value
+Description
+204
+No Content
+
- Abnormal
++
+Returned Value
+Description
+400
+Invalid parameters.
+401
+Authentication failed.
+403
+Insufficient permission.
+404
+The requested resource was not found.
+500
+Internal service error.
+
Task Center
+You can use the APIs described in this section to query failed tasks of the protection group level, and the failed tasks in a protection group.
+-
+
- Querying Failed Tasks
+
+ - Deleting a Failed Task
+
+ - Deleting All Failed Tasks of All Protection Groups
+
+ - Deleting All Failed Tasks of a Protection Group
+
+
Querying Failed Tasks
+Function
This API is used to query failed tasks of all protection groups or failed tasks in a specified protection group.
+Constraints and Limitations
None
+URI
+- Request filter field description
++
+Parameter
+Mandatory
+Type
+Description
+failure_status
+No
+String
+Query the task failure status.
+- createFail: indicates a creation failure.
- deleteFail: indicates a deletion failure.
- attachFail: indicates an attachment failure.
- detachFail: indicates a detachment failure.
- expandFail: indicates an expansion failure.
- resizeFail: indicates a specification change failure.
- startFail: indicates a protection enabling failure.
- stopFail: indicates a protection disabling failure.
- reverseFail: indicates a planned failover failure.
- failoverFail: indicates a failover failure.
- reprotectFail: indicates a re-protection enabling failure.
resource_name
+No
+String
+Specifies the resource name of a protection group.
+server_group_id
+No
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+resource_type
+No
+String
+Specifies the resource type.
+- server_groups: indicates a protection group.
- protected_instances: indicates a protected instance.
- replications: indicates a replication pair.
- disaster_recovery_drills: indicates a DR drill.
limit
+No
+Integer
+Specifies the maximum number of results returned each time.
+The value is a positive integer ranging from 0 to 1000, and is 1000 by default.
+offset
+No
+Integer
+Specifies the offset of each request. The default value is 0.
+The value must be a number and cannot be negative.
+
Request
- Request parameters +
- Example request
GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs
+GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs?server_group_id=XXXXX
++ - If you do not specify filter in the request, the system displays failed tasks of the protection group level, such as failed protection group creation or deletion tasks.
- To query failed tasks in a protection group, specify server_group_id in filter.
Response
- Parameter description
++ +
+Parameter
+Type
+Description
+failure_jobs
+list
+Specifies the list of the failed tasks.
+For details, see Table 1.
+count
+Integer
+Specifies the number of failed tasks in the list.
++
+Table 1 failure_jobs field description Parameter
+Type
+Description
+job_status
+String
+Specifies the task status.
+The value can be FAIL only in current version.
+- FAIL: The task failed.
resource_id
+String
+Specifies the resource ID.
+resource_name
+String
+Specifies the resource name.
+resource_type
+String
+Specifies the resource type.
+- server_groups: indicates a protection group.
- protected_instances: indicates a protected instance.
- replications: indicates a replication pair.
- disaster_recovery_drills: indicates a DR drill.
failure_status
+String
+Specifies the failed task status.
+- createFail: indicates a creation failure.
- deleteFail: indicates a deletion failure.
- attachFail: indicates an attachment failure.
- detachFail: indicates a detachment failure.
- expandFail: indicates an expansion failure.
- resizeFail: indicates a specification change failure.
- startFail: indicates a protection enabling failure.
- stopFail: indicates a protection disabling failure.
- reverseFail: indicates a planned failover failure.
- failoverFail: indicates a failover failure.
- reprotectFail: indicates a re-protection enabling failure.
job_id
+String
+Specifies the task ID.
+This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in Querying the Job Status.
+job_type
+String
+Specifies the task name.
+begin_time
+String
+Specifies the task operation time.
+The default format is as follows: "yyyy-MM-ddTHH:mm:ss.SSSZ", for example, 2019-04-01T12:00:00.000Z.
+error_code
+String
+Specifies the error code for a failed task.
+fail_reason
+String
+Specifies the task failure cause.
+
- Example response
{ + "count": 2, + "failure_jobs": [ + { + "job_status": "FAIL", + "resource_id": "17984002-ad8a-438b-8ba6-b850224634c5", + "resource_name": "Protected-Instance-ab14", + "resource_type": "protectedInstance", + "failure_status": "createFail", + "job_id": "ff808082686f229a0168707beaab014e", + "job_type": "createProtectedInstance", + "begin_time": "2019-01-21T12:56:35.754Z", + "error_code": "EVS.2024", + "fail_reason": "SdrsGenerateNativeServerParamsTask-fail:volume is error!" + }, + { + "job_status": "FAIL", + "resource_id": "897f57b2-6e94-4179-b414-9532726c59f2", + "resource_name": "Protected-Instance-5e2e", + "resource_type": "protectedInstance", + "failure_status": "createFail", + "job_id": "ff808082686f229a0168707b9be9013e", + "job_type": "createProtectedInstance", + "begin_time": "2019-01-21T12:56:15.591Z", + "error_code": "EVS.2024", + "fail_reason": "SdrsGenerateNativeServerParamsTask-fail:volume is error!" + } + ] +}+Or+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Value
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting a Failed Task
+Function
This API is used to delete a failed task.
+Constraints and Limitations
None
+URI
- URI format
DELETE /v1/{project_id}/task-center/failure-jobs/{failure_job_id}
+ - Parameter description
++
+Parameter
+Mandatory
+Description
+project_id
+Yes
+Specifies the project ID.
+failure_job_id
+Yes
+Specifies the ID of a failed task.
+For details, see Querying Failed Tasks.
+
Request
+Response
None
+Returned Value
- Normal
++
+Returned Value
+Description
+204
+No Content
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting All Failed Tasks of All Protection Groups
+Function
This API is used to delete all the failed tasks of the protection group level, such as failed protection group creation or deletion tasks.
+URI
+Request
+Response
None
+Returned Value
- Normal
++
+Returned Value
+Description
+204
+No Content
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting All Failed Tasks of a Protection Group
+Function
This API is used to delete failed tasks in a protection group, such as failed protected instance creation or deletion tasks, and failed replication pair creation and deletion tasks.
+Constraints and Limitations
- None
URI
- URI format
DELETE /v1/{project_id}/task-center/{server_group_id}/failure-jobs/batch
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID.
+server_group_id
+Yes
+String
+Specifies the ID of a protection group.
+For details, see Querying Protection Groups.
+
Request
+Response
None
+Returned Value
- Normal
++
+Returned Value
+Description
+204
+No Content
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Tenant Quota Management
+Querying the Tenant Quota
+Function
This API is used to query the tenant quota.
+Constraints and Limitations
None
+URI
+Request
+Response
- Parameter description
++ +
+Parameter
+Type
+Description
+quotas
+Object
+Specifies the tenant quota information.
+For details, see Table 1.
++ +
+Table 1 quotas field description Parameter
+Type
+Description
+resources
+Array of objects
+Lists the tenant's resource quota.
+For details, see Table 2.
++
+Table 2 resources field description Parameter
+Type
+Description
+type
+String
+Specifies the resource type. The value can be server_groups or replications.
+- server_groups: indicates protection groups.
- replications: indicates replication pairs.
used
+Integer
+Specifies the number of used resources.
+quota
+Integer
+Specifies the resource quota.
+If the value is –1, the resource is not limited.
+min
+Integer
+Specifies the minimally allowed resource quota.
+max
+Integer
+Specifies the maximally allowed resource quota.
+If the value is –1, the resource is not limited.
+ - Example response
{ + "quotas": { + "resources": [ + { + "type": "server_groups", + "used": 10, + "quota": 50, + "min": 0, + "max": -1 + }, + { + "type": "replications", + "used": 1, + "quota": 100, + "min": 0, + "max": -1 + } + ] + } +}+Or
+{ + "error": { + "message": "XXXX", + "code": "XXX" + } + }+In this example, error represents a general error, including badrequest (shown below) and itemNotFound.
+{ + "badrequest": { + "message": "XXXX", + "code": "XXX" + } + }+
Returned Values
- Normal
++
+Returned Value
+Description
+200
+The server has accepted the request.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+You are forbidden to access the requested page.
+404 Not Found
+The server could not find the requested page.
+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 could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication so that the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of a 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 receives an invalid response from an upstream server.
+503 Service Unavailable
+Failed to complete the request because the system is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+