Skip to main content

ModifyBucketOfCloudStorage

Select

SaaS
Customer Managed

Modify configuration of a specific bucket of a specific cloud storage

Path Parameters
  • cloudStorageId int32 required

    Id of cloud Storage

  • bucketId int32 required

    Id of Bucket

Request Body

  • cloudType string required

    Possible values: [Alibaba Cloud Object Storage Service]

    Name of cloud vendor

  • mediaAgent object required
  • id int32
  • name string
  • serviceHost string

    Default value: oss.aliyuncs.com

    IP address or fully qualified domain name or URL for the cloud library based on cloud vendor

  • credentials object
  • id int32
  • name string
  • bucket string

    Name of bucket

  • storageClass string

    Possible values: [Bucket's default, Standard, Standard - Infrequent access, Archive, Standard/Archive (Combined Storage Tiers), Infrequent Access/Archive (Combined Storage Tiers)]

    Appropriate storage class for your account

  • proxyAddress string

    If the MediaAgent accesses the mount path using a proxy then proxy server address needs to be provided. If you want to remove proxy information, pass empty string in proxyAddress.

  • port int32

    Port for proxy configuration

  • username string

    Username for proxy configuration

  • password password

    Password for proxy configuration (Should be in Base64 format)

  • access string

    Possible values: [READ_AND_WRITE, READ]

    The access type for the access path can be either read (writing to path not allowed) or read and write (writing to path allowed).

  • enable boolean

    Enable/Disable access of bucket to a media Agent

  • configuration object
  • enable boolean

    When true, means mount path is enabled

  • disableBackupLocationForFutureBackups boolean

    When true, prevents new data writes to backup location by changing number of writers to zero

  • prepareForRetirement boolean

    When true, the deduplicated blocks in the mount path will not be referenced when there are multiple mount paths in the library.

  • storageAcceleratorCredentials object
  • id int32
  • name string
Responses

Success


Schema
  • errorMessage string
  • errorCode int32
PUT /v4/storage/cloud/:cloudstorageid/bucket/:bucketid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
cloudStorageId — path required
bucketId — path required
Body

{
"cloudType": "Alibaba Cloud Object Storage Service",
"mediaAgent": {
"id": 0,
"name": "string"
},
"serviceHost": "oss.aliyuncs.com",
"credentials": {
"id": 0,
"name": "string"
},
"bucket": "string",
"storageClass": "Bucket's default",
"proxyAddress": "string",
"port": 0,
"username": "string",
"password": "string",
"access": "READ_AND_WRITE",
"enable": true,
"configuration": {
"enable": true,
"disableBackupLocationForFutureBackups": true,
"prepareForRetirement": true,
"storageAcceleratorCredentials": {
"id": 0,
"name": "string"
}
}
}
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/Storage/Cloud/:cloudStorageId/Bucket/:bucketId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"cloudType": "Alibaba Cloud Object Storage Service",
"mediaAgent": {
"id": 0,
"name": "string"
},
"serviceHost": "oss.aliyuncs.com",
"credentials": {
"id": 0,
"name": "string"
},
"bucket": "string",
"storageClass": "Bucket'\''s default",
"proxyAddress": "string",
"port": 0,
"username": "string",
"password": "string",
"access": "READ_AND_WRITE",
"enable": true,
"configuration": {
"enable": true,
"disableBackupLocationForFutureBackups": true,
"prepareForRetirement": true,
"storageAcceleratorCredentials": {
"id": 0,
"name": "string"
}
}
}'