Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Modifying the Backup Configuration of a Workspace Access Address

Updated on 2026-02-10 GMT+08:00

View PDF

Modifying the Backup Configuration of a Workspace Access Address

Function

Modifies the backup configuration of a Workspace access address.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:tenants:updateAccessAddressBackupConfig	Write	-	-	-	-

URI

POST /v2/{project_id}/access-config/address-backup

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
access_config	No	Array of AccessConfigInfo objects	Access configuration list.

**Table 3** AccessConfigInfo
Parameter	Mandatory	Type	Description
site_id	Yes	String	Site ID.
backup_mode	Yes	String	Whether backup is enabled. ON: enabled OFF: disabled
backup_info	No	Array of BackupInfo objects	Backup information.

**Table 4** BackupInfo
Parameter	Mandatory	Type	Description
priority	Yes	Integer	Priority. A smaller value indicates a higher priority. The value ranges from 1 to 255.
address	Yes	String	Backup access address.
address_custom	No	String	Tenant-defined backup access address.

Response Parameters

Status code: 204

Normal, no response body.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

{
  "access_config" : [ {
    "site_id" : "string",
    "backup_mode" : "string",
    "backup_info" : [ {
      "priority" : 255,
      "address" : "string",
      "address_custom" : "string"
    } ]
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
204	Normal, no response body.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
500	An internal service error occurred. For details about the error code, see the error code description.