REST API for MySQL Cloud Service

Add Storage to a Service instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/storage/add

Add storage to a MySQL Cloud Service instance. MySQL Cloud Service supports adding storage to dataStorage, backupStorage, or MySQLLogStorage.

Request

Supported Media Types

application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

identityDomainId: string

Name of the identity domain for the MySQL Cloud Service account.
serviceId: string

The user-defined name of the Oracle MySQL Cloud Service instance.

Header Parameters

X-ID-TENANT-NAME: string

Name of the identity domain for the MySQL Cloud Service account.

The request body defines details for the add storage operation.

Root Schema : Add Storage Request Body

Type: object

Title: Add Storage Request Body

Defines component parameters for the add storage operation. See the nested 'components' schema for details.

Show Source

components(optional): object Add Storage Component Details

Title: Add Storage Component Details

Details for the 'components' schema in the add storage operation.

{
    "title":"Add Storage Request Body",
    "description":"Defines component parameters for the add storage operation. See the nested 'components' schema for details.",
    "type":"object",
    "properties":{
        "components":{
            "$ref":"#/definitions/service-add-storage-components-post-request"
        }
    }
}

Nested Schema : Add Storage Component Details

Type: object

Title: Add Storage Component Details

Details for the 'components' schema in the add storage operation.

Show Source

backupStorage(optional): integer

Amount of backup storage (GB), from 50 to 2000. This becomes the new backupStorage value. The current value can be increased, but not decreased.
dataStorage(optional): integer

Amount of data storage (GB), from 10 to 2000. This becomes the new dataStorage value. The current value can be increased, but not decreased.
hosts: array Hosts with Added Storage

Title: Hosts with Added Storage

A list of hosts to control by this add storage operation. For example, a common host name format is instancename-mysql-1 where instancename is the name of the particular MySQL Cloud Service instance.
MySQLLogStorage(optional): integer

Amount of redolog storage storage (GB), from 60 to 2000. This becomes the new MySQLLogStorage value. The current value can be increased, but not decreased.

{
    "title":"Add Storage Component Details",
    "description":"Details for the 'components' schema in the add storage operation.",
    "properties":{
        "dataStorage":{
            "type":"integer",
            "description":"Amount of data storage (GB), from 10 to 2000. This becomes the new dataStorage value. The current value can be increased, but not decreased."
        },
        "backupStorage":{
            "type":"integer",
            "description":"Amount of backup storage (GB), from 50 to 2000. This becomes the new backupStorage value. The current value can be increased, but not decreased."
        },
        "MySQLLogStorage":{
            "type":"integer",
            "description":"Amount of redolog storage storage (GB), from 60 to 2000. This becomes the new MySQLLogStorage value. The current value can be increased, but not decreased."
        },
        "hosts":{
            "title":"Hosts with Added Storage",
            "description":"A list of hosts to control by this add storage operation. For example, a common host name format is instancename-mysql-1 where instancename is the name of the particular MySQL Cloud Service instance.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "hosts"
    ]
}

Nested Schema : Hosts with Added Storage

Type: array

Title: Hosts with Added Storage

A list of hosts to control by this add storage operation. For example, a common host name format is instancename-mysql-1 where instancename is the name of the particular MySQL Cloud Service instance.

Show Source

[0]: string

{
    "title":"Hosts with Added Storage",
    "description":"A list of hosts to control by this add storage operation. For example, a common host name format is instancename-mysql-1 where instancename is the name of the particular MySQL Cloud Service instance.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

202 Response

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

Root Schema : Response Body

Type: object

Title: Response Body

The response body contains information about the operation.

Show Source

jobId(optional): string

Job ID for the operation.
message(optional): string

System message that describes the operation. For example: Snapshot a service [{serviceId}] is submitted as an asynchronous job.

{
    "title":"Response Body",
    "description":"The response body contains information about the operation.",
    "properties":{
        "message":{
            "description":"System message that describes the operation. For example: <code>Snapshot a service [{serviceId}] is submitted as an asynchronous job.</code>",
            "type":"string"
        },
        "jobId":{
            "description":"Job ID for the operation.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to start an add storage operation by submitting a POST request on the REST endpoint using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.

cURL Command

curl -i -X POST \
  -u "username:password" \
  -H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
  -H "Accept: application/json" \
  -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" \
  -d '{"components":{"mysql":{ "dataStorage":"120", "backupStorage":"120", "MySQLLogStorage":"120", "hosts":"[mytestinstance-mysql-1]" }}}' \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/storage/add

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Server: Oracle-Application-Server-11g
Strict-Transport-Security: max-age=31536000;includeSubDomains
Location: https://rest_server_url/paas/api/v1.1/activitylog/TestCorp/job/12815164
Content-Language: en
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 005MWfNdQ2o6uHFpR0H7id0003mK0001DG
X-ORACLE-DMS-ECID: 005MWfNdQ2o6uHFpR0H7id0003mK0001DG
Service-URI: https://rest_server_url/paas/api/v1.1/instancemgmt/TestCorp/services/MySQLCS/MyTestInstance
X-Frame-Options: DENY
Content-Type: application/json
Vary: user-agent
Date: Mon, 25 Sep 2017 22:11:43 GMT
Connection: close

Example of Response Body

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

{
	"details": {
		"message": "Submitted job to add storage for service [MyTestInstance] in domain [ExampleIdentityDomain].",
		"jobId": "12815164"
	}
}