Jump to

• Request
• Response
• Examples

Delete an IP Reservation

delete

/paas/api/v1.1/network/{identityDomainId}/services/MySQLCS/ipreservations/{ipResName}

This endpoint is not available in accounts where regions are not supported. It is also not applicable to service instances created on Oracle Cloud Infrastructure.

Deletes an IP reservation created in MySQL Cloud Service. Only unused IP reservations can be deleted. If a delete activity is already in progress, you cannot initiate another delete request.

Request

Path Parameters

• identityDomainId: string
  Identity domain ID for the MySQL Cloud Service account.
• ipResName: string
  Name of the unused IP reservation to delete. To retrieve the name, see View All IP Reservations.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the MySQL Cloud Service account.

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.

The Location header returns a URI that can be used to view the job status, as described in View the Status of an Operation by Job Id.

Body ()

Root Schema : deleteipres-response

Type: object

Show Source

• computeSite(optional): string
  Location of the IP reservation.
• ipResName(optional): string
  Name of the unused IP reservation to be deleted.
• jobId(optional): string
  Job ID of the delete operation.

{
    "properties":{
        "computeSite":{
            "type":"string",
            "description":"Location of the IP reservation."
        },
        "ipResName":{
            "type":"string",
            "description":"Name of the unused IP reservation to be deleted."
        },
        "jobId":{
            "type":"string",
            "description":"Job ID of the delete operation."
        }
    }
}

409 Response

Conflict. Returned if the IP reservation is in use. The message displayed is: The IP Reservation [ip_reservation_name] is already in use by service [service_instance_name].

Examples

The following example shows how to delete an IP reservation from MySQL Cloud Service by submitting a DELETE request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X DELETE -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/network/ExampleIdentityDomain/services/mysqlcs/ipreservations/ipres05

Example of Response Header

The following shows an example of the response header. The Location header returns the URI that can be used to view the job status. See View the Status of an Operation by Job Id.

HTTP/1.1 202 Accepted
Date: Wed, 22 Mar 2017 23:02:17 GMT
Transfer-Encoding: chunked
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/1457148
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format:

{
    "jobId":"1457148",
    "ipResName":"ipres05",
    "computeSite":"uscom-central-1"
}