Applying a Policy to a Vault
Function
This API is used to apply a policy to a vault.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v3/{project_id}/vaults/{vault_id}/associatepolicy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
vault_id |
Yes |
String |
Vault ID. For details about how to obtain the vault ID, see Obtaining a Vault ID. |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
destination_vault_id |
No |
String |
Target vault ID. This parameter is mandatory only when a replication policy is set. For details about how to obtain the vault ID, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region. |
policy_id |
No |
String |
Policy ID. Specify either policy_id or add_policy_ids. For details about how to obtain the backup policy ID, see Obtaining a Backup Policy ID. |
add_policy_ids |
No |
Array of strings |
List of IDs of new policies associated in the multi-policy scenario. Specify either policy_id or add_policy_ids. For details about how to obtain the backup policy ID, see Obtaining a Backup Policy ID. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
associate_policy |
VaultPolicyResp object |
Details of applying a policy to a vault |
Parameter |
Type |
Description |
---|---|---|
destination_vault_id |
String |
Vault ID of the destination region. This parameter is available only when a replication policy is configured. For details about how to obtain the vault ID, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region. |
policy_id |
String |
Configured policy ID |
vault_id |
String |
Vault ID for configuring the policy ID |
Example Requests
Applying a policy to a vault
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/associatepolicy { "policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5" }
Example Responses
Status code: 200
OK
{ "associate_policy" : { "vault_id" : "2402058d-8373-4b0a-b848-d3c0dfdc71a8", "policy_id" : "7075c397-25a0-43e2-a83a-bb16eaca3ee5" } }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot