Jump to

• Request
• Response
• Examples

Add Storage

post

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/storage/add

Adds storage to the service instance.

Request

Supported Media Types

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

Path Parameters

• domainName: string
  Name of the identity domain for the Oracle Cloud Service account.
• serviceName: string
  Name of the Oracle SOA Cloud Service instance.

Body ()

The request body defines the details of the storage request. Bold indicates a required value.

Root Schema : add-storage-request

Type: object

Show Source

• components(optional): object components

{
    "type":"object",
    "properties":{
        "components":{
            "type":"object",
            "properties":{
                "WLS":{
                    "type":"object",
                    "properties":{
                        "hosts":{
                            "type":"array",
                            "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
                            "items":{
                                "type":"string",
                                "description":"A WLS host the operation add storage applies to."
                            }
                        },
                        "domain":{
                            "type":"array",
                            "description":"Domain / Middleware / Backup and the storage to add."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : components

Type: object

Show Source

• WLS(optional): object WLS

{
    "type":"object",
    "properties":{
        "WLS":{
            "type":"object",
            "properties":{
                "hosts":{
                    "type":"array",
                    "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
                    "items":{
                        "type":"string",
                        "description":"A WLS host the operation add storage applies to."
                    }
                },
                "domain":{
                    "type":"array",
                    "description":"Domain / Middleware / Backup and the storage to add."
                }
            }
        }
    }
}

Nested Schema : WLS

Type: object

Show Source

• domain(optional): array domain
  Domain / Middleware / Backup and the storage to add.
• hosts(optional): array hosts
  An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.

{
    "type":"object",
    "properties":{
        "hosts":{
            "type":"array",
            "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
            "items":{
                "type":"string",
                "description":"A WLS host the operation add storage applies to."
            }
        },
        "domain":{
            "type":"array",
            "description":"Domain / Middleware / Backup and the storage to add."
        }
    }
}

Nested Schema : domain

Type: array

Domain / Middleware / Backup and the storage to add.

Nested Schema : hosts

Type: array

An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.

Show Source

• Array of: string
  A WLS host the operation add storage applies to.

{
    "type":"array",
    "description":"An array of hosts to be controlled via the mentioned operation. The service is controlled if ALL hosts are listed, making this the same behavior as including allServiceHosts:true.",
    "items":{
        "type":"string",
        "description":"A WLS host the operation add storage applies to."
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted

Body ()

Root Schema : add-storage-response

Type: object

The response body contains information about the add storage operation.

Show Source

• details: object details
  The details of the add storage operation.

{
    "required":[
        "details"
    ],
    "description":"The response body contains information about the add storage operation.",
    "properties":{
        "details":{
            "type":"object",
            "description":"The details of the add storage operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the add storage operation."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation. For example: <code>scaleup.job.submitted</code>"
                }
            }
        }
    }
}

Nested Schema : details

Type: object

The details of the add storage operation.

Show Source

• jobId(optional): string
  Job ID for the add storage operation.
• message(optional): string
  System message that describes the operation. For example: scaleup.job.submitted

{
    "type":"object",
    "description":"The details of the add storage operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the add storage operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>scaleup.job.submitted</code>"
        }
    }
}

Back to Top

Examples

The following example shows how to add a storage to an Oracle SOA Cloud Service instance by submitting a POST request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -v -X POST -u username:Password1! -d @start.json -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" https://rest-server_url.com/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}/storage/add

Example of Request Header

The following example shows the request header.

-u '{userName}:{password}'	
Content-Type:application/vnd.com.oracle.oracloud.provisioning.Service+json
X-ID-TENANT-NAME: {domainName}
Accept: application/json

Example of Request Body

The following example shows the request in JSON format.

{
  "components": {
    "WLS": {
      "hosts": [
        "myInstance1-wls-1"],
        "domain": "4"
    }
  }
}

Example of Response Body

The following example shows the response document returned in JSON format:

{
  "details": {
    "message": "Submitted job to add storage for service [ServiceName] in domain [DomainName].",
    "jobId": "12997"
  }
}

Back to Top