Updated on 2023-11-21 GMT+08:00

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.

    For details about how to obtain the project ID, see Obtaining a 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
    PUT https://{Endpoint}/v1/{project_id}/protected-instances/00000000632302f501632305f63c000e
    {  
          "protected_instance": {  
              "name": "test_protected_instance_name"  
          }  
      }

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.

    Table 4 tags field description

    Parameter

    Type

    Description

    key

    String

    Specifies the tag key.

    value

    String

    Specifies the tag value.

    Table 5 metadata field 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": "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.