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

Updated on 2025-07-14 GMT+08:00

View PDF

Obtaining the Backup Configuration of a Workspace Access Address

Function

Obtains 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.

URI

GET /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 header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It 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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
access_config	Array of AccessConfigInfo objects	Access configuration list.

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

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

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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

None

Example Responses

Status code: 200

Response to the request for obtaining the backup configuration of a Workspace access address.

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

Status Codes

Status Code	Description
200	Response to the request for obtaining the backup configuration of a Workspace access address.
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, see the error code description.