Modify Instance

Select

SaaS

Modifies the properties of the object storage instance

Path Parameters

• instanceId string required

  ID of the object storage instance

application/json

Request Body

This request enables modifications to the instance name, the associated access nodes, authentication method, host url, and the assigned plan.

• instanceProperties object

  cloudAppsInstance object

  instanceType string required

  Possible values: [ALIBABA_OSS, AMAZON_S3, AZURE_BLOB, AZURE_DATA_LAKE, GOOGLE_CLOUD, IBM_COS, ORACLE_STORAGE_SERVICE]

  Type of the object storage instance.

  generalCloudProperties object required

  memberServers object[]

  List of access nodes / access node groups associated with the instance.

  client object

  clientId integer

  Access node ID

  clientName string

  Access node name

  clientGroupId integer

  Access node group's ID

  clientGroupName string

  Access node group's name

  credentials object required

  credentialId integer

  ID of the credential

  credentialName string

  Name of the credential

  cloudInstance object required

  Based on the cloud vendor and authentication type, the parameter name and it's value will vary. Please refer to the examples for more details.

  hostURL string

  URL for the instance

  useIamRole boolean

  Exclusive for S3 instances.

  adAccountName string

  Exclusive to azure instances.

  serverName string

  URL for Azure Datalake / GCP instances.

  GCPProjectId string

  Project ID for GCP instance.

  endpointURL string

  URL for OCI instances

  compartmentName string

  Exclusive to OCI instance. Name of the compartment.

  includeSubCompartments boolean

  Exclusive to OCI instance. To include subcompartments, set to True.

  credentialType string required

  Possible values: [AMAZON_S3, AMAZON_STS_IAM_ROLE, AMAZON_IAM_ROLE, AZUREACCOUNT, MICROSOFT_AZURE, MICROSOFT_AZURE_VM_ROLE, GOOGLE_CLOUD, GOOGLE_SERVICE_ACCOUNT, ALICLOUD_OSS, IBM_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE]

  Type of the credential based on cloud vendor.

  planEntity object

  planId integer

  ID of the plan associated with instance.

  planName string

  Name of the plan associated with instance.

  newName string

  Name for the object storage instance

Responses

• 200
• 409

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object[]

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  clientId integer

  _SubclType_ integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "warningCode": 0,
      "errorCode": 0,
      "warningMessage": "string",
      "entity": {
        "subclientId": 0,
        "clientId": 0,
        "_SubclType_": 0,
        "instanceName": "string",
        "instanceId": 0,
        "_type_": 0
      }
    }
  ]
}

Conflict

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

instanceId — path required

Body

• Default
• Modify name
• Modify S3 instance with STS assume role with IAM authentication
• Modify S3 instance with IAM authentication
• Modify S3 instance with Access and Secret keys authentication
• Modify Azure Blob / Azure fileshare instance with IAM AD authentication
• Modify Azure Blob / Azure fileshare instance with Access key and Account name authentication
• Modify Azure Blob / Azure fileshare instance with Managed Identity authentication
• Modify Azure Datalake instance with IAM AD authentication
• Modify Azure Datalake instance with Access key and Account name authentication
• Modify Azure Datalake instance with Managed Identity authentication
• Modify GCP instance with Access and Secret Keys authentication
• Modify GCP instance with Service account authentication
• Modify Alibaba instance
• Modify OCI instance
• Modify IBM instance

---

{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance/:instanceId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "cloudAppsInstance": {
      "instanceType": "ALIBABA_OSS",
      "generalCloudProperties": {
        "memberServers": [
          {
            "client": {
              "clientId": 0,
              "clientName": "string",
              "clientGroupId": 0,
              "clientGroupName": "string"
            }
          }
        ],
        "credentials": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "cloudInstance": {
        "hostURL": "string",
        "useIamRole": true,
        "adAccountName": "string",
        "serverName": "string",
        "GCPProjectId": "string",
        "endpointURL": "string",
        "compartmentName": "string",
        "includeSubCompartments": true
      },
      "credentialType": "AMAZON_S3"
    },
    "planEntity": {
      "planId": 0,
      "planName": "string"
    },
    "newName": "string"
  }
}'