• Storage Disaster Recovery Service

sdrs
  1. Help Center
  2. Storage Disaster Recovery Service
  3. API Reference
  4. API
  5. Protected Instance
  6. Deleting an NIC from a Protected Instance

Deleting an NIC from a Protected Instance

Function

This API is used to delete an NIC from the specified protected instance.

Constraints and Limitations

  • The status of the protection group must be available.
  • The status of the protected instance must be available.
  • 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 tenant ID.

    protected_instance_id

    Yes

    string

    Specifies the ID of a protected instance.

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    nic_id

    Yes

    string

    Specifies the port ID of the NIC.

  • Example request
    { 
         "nic_id": " f0ac4394-7e4a-4409-9701-husge283dbc3" 
       
     }

Response

  • Parameter description

    Parameter

    Type

    Description

    job_id

    string

    Specifies the job ID.

  • 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.