Skip to main content

Modify Instance​

Select

SaaS

Modifies the properties of the object storage instance

Path Parameters
  • instanceId string required

    ID of the object storage instance

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

OK

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
Loading...