Skip to main content

OCI Object storage client creation​

Select

SaaS
Customer Managed

Operation to create IBM Object Storage client

Request Body
  • clientInfo object
  • clientType integer required
  • cloudClonnectorProperties object required
  • instanceType string required

    Possible values: [ORACLE_STORAGE_SERVICE]

  • instance object required
  • instance object required
  • instanceName string
  • commCellId integer
  • applicationId integer
  • cloudAppsInstance object required
  • instanceTypeDisplayName string

    Possible values: [Oracle Cloud Infrastructure]

  • instanceType string

    Possible values: [ORACLE_STORAGE_SERVICE]

  • generalCloudProperties object required
  • numberOfBackupStreams integer

    Number of backup streams for default subclient

  • memberServers object[]
  • client object
  • clientName string

    Access node name

  • _type_ integer
  • credentials object
  • credentialName string
  • objectStorageInstance object
  • isCloudEncryptionKeySet boolean
  • oraCloudInstance object required
  • endpointURL string
  • compartmentName string
  • includeSubCompartments boolean

    Flag to include all the subcompartements

  • credentialType string required
  • useResourcePoolInfo boolean
  • plan object required
  • planName string
  • entity object required
  • clientName string
Responses

OK

Schema
  • value object
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • _type_ integer
POST /client

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/webconsole/api
Security Scheme
token
Body
{

  "clientInfo": {

    "clientType": 0,

    "cloudClonnectorProperties": {

      "instanceType": "ORACLE_STORAGE_SERVICE",

      "instance": {

        "instance": {

          "instanceName": "string",

          "commCellId": 0,

          "applicationId": 0

        },

        "cloudAppsInstance": {

          "instanceTypeDisplayName": "Oracle Cloud Infrastructure",

          "instanceType": "ORACLE_STORAGE_SERVICE",

          "generalCloudProperties": {

            "numberOfBackupStreams": 0,

            "memberServers": [

              {

                "client": {

                  "clientName": "string",

                  "_type_": 0

                }

              }

            ],

            "credentials": {

              "credentialName": "string"

            }

          },

          "objectStorageInstance": {

            "isCloudEncryptionKeySet": true

          },

          "oraCloudInstance": {

            "endpointURL": "string",

            "compartmentName": "string",

            "includeSubCompartments": true

          },

          "credentialType": "string"

        },

        "useResourcePoolInfo": true

      }

    },

    "plan": {

      "planName": "string"

    }

  },

  "entity": {

    "clientName": "string"

  }

}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Client' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientInfo": {
    "clientType": 0,
    "cloudClonnectorProperties": {
      "instanceType": "ORACLE_STORAGE_SERVICE",
      "instance": {
        "instance": {
          "instanceName": "string",
          "commCellId": 0,
          "applicationId": 0
        },
        "cloudAppsInstance": {
          "instanceTypeDisplayName": "Oracle Cloud Infrastructure",
          "instanceType": "ORACLE_STORAGE_SERVICE",
          "generalCloudProperties": {
            "numberOfBackupStreams": 0,
            "memberServers": [
              {
                "client": {
                  "clientName": "string",
                  "_type_": 0
                }
              }
            ],
            "credentials": {
              "credentialName": "string"
            }
          },
          "objectStorageInstance": {
            "isCloudEncryptionKeySet": true
          },
          "oraCloudInstance": {
            "endpointURL": "string",
            "compartmentName": "string",
            "includeSubCompartments": true
          },
          "credentialType": "string"
        },
        "useResourcePoolInfo": true
      }
    },
    "plan": {
      "planName": "string"
    }
  },
  "entity": {
    "clientName": "string"
  }
}'