Skip to main content

Modify Alibaba object storage instance​

Select

SaaS
Customer Managed

Alibaba object storage instance modify operation

Path Parameters
  • instanceId string required

    id of the instance which needs to be modified

Request Body
  • instanceProperties object
  • instance object required
  • applicationId integer
  • clientId integer
  • instanceId integer
  • cloudAppsInstance object required
  • instanceTypeDisplayName string required

    Possible values: [Alibaba Cloud OSS]

    instanceTypeDisplayName

  • instanceType string required

    Possible values: [ALIBABA_OSS]

  • generalCloudProperties object
  • numberOfBackupStreams integer required

    Number of backup streams for default subclient

  • memberServers object[] required
  • client object
  • clientName string

    Access node name

  • _type_ integer
  • credentials object required
  • credentialName string
  • objectStorageInstance object
  • isCloudEncryptionKeySet boolean
  • alibabaInstance object required
  • hostURL string
  • credentialType string
  • planEntity object required
  • planName string
  • association object required
  • entity object[]
  • clientName string
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object[]
  • warningCode integer
  • errorCode integer
  • warningMessage string
  • entity object
  • subclientId integer
  • clientId integer
  • instanceName string
  • instanceId integer
  • _type_ integer
POST /instance/:instanceid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "instanceProperties": {

    "instance": {

      "applicationId": 0,

      "clientId": 0,

      "instanceId": 0

    },

    "cloudAppsInstance": {

      "instanceTypeDisplayName": "Alibaba Cloud OSS",

      "instanceType": "ALIBABA_OSS",

      "generalCloudProperties": {

        "numberOfBackupStreams": 0,

        "memberServers": [

          {

            "client": {

              "clientName": "string",

              "_type_": 0

            }

          }

        ],

        "credentials": {

          "credentialName": "string"

        }

      },

      "objectStorageInstance": {

        "isCloudEncryptionKeySet": true

      },

      "alibabaInstance": {

        "hostURL": "string"

      },

      "credentialType": "string"

    },

    "planEntity": {

      "planName": "string"

    }

  },

  "association": {

    "entity": [

      {

        "clientName": "string"

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/webconsole/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "applicationId": 0,
      "clientId": 0,
      "instanceId": 0
    },
    "cloudAppsInstance": {
      "instanceTypeDisplayName": "Alibaba Cloud OSS",
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "numberOfBackupStreams": 0,
        "memberServers": [
          {
            "client": {
              "clientName": "string",
              "_type_": 0
            }
          }
        ],
        "credentials": {
          "credentialName": "string"
        }
      },
      "objectStorageInstance": {
        "isCloudEncryptionKeySet": true
      },
      "alibabaInstance": {
        "hostURL": "string"
      },
      "credentialType": "string"
    },
    "planEntity": {
      "planName": "string"
    }
  },
  "association": {
    "entity": [
      {
        "clientName": "string"
      }
    ]
  }
}'