Updated on 2024-05-11 GMT+08:00

Batch Modifying Vaults

Function

This API is used to batch modify all vaults in a project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v3/{project_id}/vaults/batch-update

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

vault

Yes

VaultBatchUpdate object

Parameters for modifying a vault.

Table 4 VaultBatchUpdate

Parameter

Mandatory

Type

Description

smn_notify

No

Boolean

Exception notification function

Default: true

threshold

No

Integer

Vault capacity threshold

Minimum: 1

Maximum: 100

Default: 80

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

updated_vaults_id

Array of strings

IDs of vaults that have been modified in batches

Minimum: 0

Example Requests

Batch modifying capacities of vaults to 60 GB

PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/batch-update

{
  "vault" : {
    "smn_notify" : true,
    "threshold" : 60
  }
}

Example Responses

Status code: 200

OK

{
  "updated_vaults_id" : [ "79bd9daa-884f-4f84-b8fe-235d58cd927d" ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.