Updated on 2025-11-03 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. Default value: N/A

For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A

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

Whether to send SMN notifications. The default value is true.

The options are as follows:

  • true: SMN notifications will be sent.

  • false: SMN notifications will not be sent.

threshold

No

Integer

Vault capacity threshold. If the vault usage exceeds this threshold and smn_notify is true, a notification will be sent.

Range: 1 to 100. The default value is 80.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

updated_vaults_id

Array of strings

IDs of the vaults that have been modified in one batch. Range: N/A

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.