文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 租户配置/ 获取云办公服务接入地址备份配置
更新时间：2025-07-09 GMT+08:00
查看PDF
分享

获取云办公服务接入地址备份配置

功能介绍

该接口用于获取云办公服务接入地址备份配置。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

access_config

Array of AccessConfigInfo objects

接入配置列表信息。
表4 AccessConfigInfo

参数

参数类型

描述

site_id

String

站点Id。

backup_mode

String

备份模式是否开启。

  • ON:开启。

  • OFF:关闭。

backup_info

Array of BackupInfo objects

备份信息。
表5 BackupInfo

参数

参数类型

描述

priority

Integer

优先级，数字越小，优先级越高，取值1-255。

address

String

接入备份地址。

address_custom

String

租户自定义接入备份地址。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

无

响应示例

状态码：200

获取云办公服务接入地址备份配置息响应。

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

状态码

状态码

描述

200

获取云办公服务接入地址备份配置息响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 租户配置