查询云办公服务详情 - ListWorkspaces

功能介绍

该接口用于查询云办公服务详情。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/workspaces

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
id	String	唯一标识ID。
is_global	Boolean	开通服务是否是全局服务。
ad_domains	AdInfo object	域信息。
vpc_id	String	VPC ID。
vpc_name	String	VPC名称。
access_mode	String	接入方式。 INTERNET：表示互联网接入。 DEDICATED：表示专线接入。 BOTH：表示同时支持互联网接入和专线接入。
adn_conflict_network	String	ADN上网冲突网段列表，多个网段信息用分号隔开，列表长度不超过50。
dedicated_subnets	String	专线接入网段，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。
dedicated_access_address	String	专线接入地址，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。
internet_access_address	String	互联网接入地址，只有access_mode为“INTERNET”或“BOTH”时才会返回该参数。
internet_access_port	String	互联网接入端口。
status	String	云办公服务的状态。 PREPARING：准备开通。 SUBSCRIBING：开通中。 SUBSCRIBED：已开通。 SUBSCRIPTION_FAILED：开通失败。 DEREGISTERING：销户中。 DEREGISTRATION_FAILED：销户失败。 RECYCLING：清理资源中。 RECYCLED：清理资源成功。 RECYCLE_FAILED：清理资源失败。 CLOSED：已销户未开通。
access_status	String	互联网和专线切换任务的状态。 init：初始化 - 开通服务后的初始状态。 available：可用 - 执行过任务且成功后恢复的正常状态。 internetOpening：开启中 - 开通互联网接入开启中。 dedicatedOpening：开启中 - 开通专线接入开启中。 internetOpenFailed：开启失败 - 开通互联网接入开启失败。 dedicatedOpenFailed：开启失败 - 开通专线接入开启失败。 openSuccess：开启成功 - 开通接入方式成功。 internetClosing：关闭中 - 关闭互联网接入关闭中。 dedicatedClosing：关闭中 - 关闭专线接入关闭中。 internetCloseFailed：关闭失败 - 关闭互联网接入方式失败。 dedicatedCloseFailed：关闭失败 - 关闭专线接入方式失败。 closeSuccess：关闭成功 - 关闭接入方式成功。 internetAccessPortModifying：互联网接入端口修改中。 internetAccessPortModifyFailed：端口修改失败。
subnet_ids	Array of SubnetInfo objects	业务子网，可以指定返回的网络ID订购桌面。
vpc_config_infos	Array of VpcConfigInfo objects	VPC配置信息列表。
management_subnet_cidr	String	管理组件的子网网段。
infrastructure_security_group	SecurityGroup object	开通服务会在指定的VPC下创建管理组件的安全组。
desktop_security_group	SecurityGroup object	开通服务会在指定的VPC下创建桌面的安全组。
closable	Boolean	是否可以取消服务。
config_status	String	配置状态。 "0"：开通服务成功，且对接AD成功。 "1"：开通服务成功，但AD配置失败。 "2"：开通服务成功，但AD配置失败后存在其他错误。 "3"：开通服务成功，AD未开启对接。
progress	String	开通服务或注销服务的进度，格式为百分比，如：100%。
job_id	String	开通服务或取消服务的任务ID。
fail_code	Integer	失败错误码。
fail_reason	String	失败原因。
enterprise_id	String	企业ID。
enterprise_project_id	String	企业项目ID。
is_send_email	Boolean	桌面退订是否发送邮件通知。
authorized_collect_log	Boolean	是否授权收集日志。
authorized_hda_upgrade	Boolean	是否授权hda升级。
site_configs	Array of SiteConfigsResponse objects	站点配置。
dc_vnc_ip	String	自定义的专线VNC地址。
is_authorized_install_agent	Boolean	是否授权桌面自动安装agent插件。
is_support_ipv6	Boolean	是否支持ipv6。
enable_user_create_snapshot	Boolean	是否授权最终租户创建快照。

表3 AdInfo
参数	参数类型	描述
domain_type	String	域类型。 LITE_AS：本地认证。 LOCAL_AD：本地AD。
domain_name	String	域名，域类型为LOCAL_AD时有值。
domain_admin_account	String	域管理员账号，域类型为LOCAL_AD时有值。
active_domain_name	String	主域控制器名称，域类型为LOCAL_AD时有值。
active_domain_ip	String	主域控制器IP地址，域类型为LOCAL_AD时有值。
standby_domain_name	String	备域控制器名称，域类型为LOCAL_AD时有值。
standby_domain_ip	String	备域控制器IP地址，域类型为LOCAL_AD时有值。
active_dns_ip	String	主DNS IP地址，域类型为LOCAL_AD时有值。
standby_dns_ip	String	备DNS IP地址，域类型为LOCAL_AD时有值。
delete_computer_object	String	是否在删除桌面的同时删除AD上对应的计算机对象，'0'代表不删除，'1'代表删除。
use_ldaps	Boolean	是否开启LDAPS。
tls_config	TlsConfig object	TLS信息。
cba_enabled	Boolean	是否开启智能卡认证。
certificate_id	String	智能卡证书id。
domain_controllers	Array of DomainController objects	域控制器信息列表。

表4 TlsConfig
参数	参数类型	描述
cert_pem	String	pem内容, 有则更新，无则上传。查询不返回。
cert_start_time	String	证书生效开始时间，时间参考样例 2022-01-25T09:24:27。
cert_end_time	String	证书生效截止时间，时间参考样例 2022-01-25T09:24:27。

表5 DomainController
参数	参数类型	描述
dc_ip	String	域控制器IP地址。
dc_name	String	域控制器名称。

表6 SubnetInfo
参数	参数类型	描述
subnet_id	String	子网的网络ID。

表7 SiteConfigsResponse
参数	参数类型	描述
site_id	String	站点id。
site_type	String	配置状态。 CENTER：中心初始化 IES：边缘初始化
site_name	String	站点名称。
status	String	云办公服务的状态。 PREPARING：准备初始化服务 SUBSCRIBING：初始化服务中 SUBSCRIBED：已初始化服务 SUBSCRIPTION_FAILED：初始化服务失败 DEREGISTERING：清理资源中 DEREGISTRATION_FAILED：清理资源失败 RECYCLING：清理资源中。 RECYCLED：清理资源成功。 RECYCLE_FAILED：清理资源失败。 CLOSED：已销户未初始化服务
access_status	String	互联网和专线切换任务的状态。 init：初始化 - 开通服务后的初始状态 available：可用 - 执行过任务且成功后恢复的正常状态 internetOpening：开启中 - 开通互联网接入开启中 dedicatedOpening：开启中 - 开通专线接入开启中 internetOpenFailed：开启失败 - 开通互联网接入开启失败 dedicatedOpenFailed：开启失败 - 开通专线接入开启失败 openSuccess：开启成功 - 开通互联网接入成功 internetClosing：关闭中 - 关闭互联网接入关闭中 dedicatedClosing：关闭中 - 关闭专线接入关闭中 internetCloseFailed：关闭失败 - 关闭互联网接入方式失败 dedicatedCloseFailed：关闭失败 - 关闭专线接入方式失败 closeSuccess：关闭成功 - 关闭接入方式成功 internetAccessPortModifying：互联网接入端口修改中 internetAccessPortModifyFailed: 端口修改失败
config_status	String	配置状态。 "0"：开通服务成功，且对接AD成功 "1"：开通服务成功，但AD配置失败 "2"：开通服务成功，但AD配置失败后存在其他错误 "3"：开通服务成功，AD未开启对接
infrastructure_security_group	SecurityGroup object	开通服务会在指定的VPC下创建管理组件的安全组。
desktop_security_group	SecurityGroup object	开通服务会在指定的VPC下创建桌面的安全组。
availability_zones	Array of strings	开通服务资源使用的可用分区。
job_id	String	开通服务或取消服务的任务ID。
progress	String	初始化服务或清理资源的进度，格式为100%。
fail_code	Integer	失败错误码。
fail_reason	String	失败原因。
network_config	NetworkConfig object	网络信息。
access_config	AccessConfig object	接入信息。
closable	Boolean	是否可以取消服务。

表8 SecurityGroup
参数	参数类型	描述
id	String	安全组ID。
name	String	安全组名称。

表9 NetworkConfig
参数	参数类型	描述
vpc_id	String	VPC ID。
vpc_name	String	VPC名称。
subnet_ids	Array of strings	业务子网，可以指定返回的网络ID订购桌面。
management_subnet_cidr	String	后端管理组件占用的子网网段。
management_node_subnet_id	String	subnet_ids所返回的业务子网中,被管理节点所占用的子网id。
vpc_config_infos	Array of VpcConfigInfo objects	VPC配置信息列表。

**表10** VpcConfigInfo
参数	参数类型	描述
used_subnet_ids	Array of strings	已使用的子网信息。
vpc_id	String	VPC ID。
subnet_ids	Array of strings	子网ID列表。
default_access_vpc	Boolean	是否为默认接入VPC。

**表11** AccessConfig
参数	参数类型	描述
access_mode	String	接入方式。 INTERNET：表示互联网接入 DEDICATED：表示专线接入 BOTH：表示同时支持互联网接入和专线接入
internet_access_address	String	互联网接入地址，只有access_mode为“INTERNET”或“BOTH”时才会返回该参数。
internet_access_port	String	互联网接入端口。
dedicated_access_address	String	专线接入地址，只有access_mode为“DEDICATED”或“BOTH”时才会返回该参数。
dedicated_access_standby_address	Array of strings	专线接入备用地址，只有当开启专线备用线路时才会返回该参数。
standby_address_result_code	String	专线备用线路失败错误码。
dedicated_cidrs	String	专线接入网段。接入模式包含专线方式时选填，多个网段信息用分号隔开，列表长度不超过5。

状态码：400

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/workspaces

响应示例

状态码：200

查询云办公服务详情响应。

{
  "id" : "8aa1908f74824d8701748bf039600065",
  "status" : "SUBSCRIBED",
  "config_status" : "0",
  "closable" : false,
  "ad_domains" : {
    "domain_type" : "LOCAL_AD",
    "domain_admin_account" : "vdsadmin",
    "active_domain_name" : "ecs-ad.vdesktop.com",
    "active_domain_ip" : "192.168.0.131",
    "standby_domain_name" : "",
    "standby_domain_ip" : "",
    "active_dns_ip" : "192.168.0.131",
    "standby_dns_ip" : "",
    "domain_name" : "vdesktop.com",
    "cba_enabled" : true,
    "certificate_id" : "xxxxxxxxxxx"
  },
  "vpc_id" : "fd3b4069-ac1e-45d2-ba27-4c18cd692d26",
  "vpc_name" : "vpc-be75",
  "dedicated_access_address" : "https://192.168.0.53",
  "dedicated_subnets" : "192.168.0.0/24;10.0.0.0/16",
  "internet_access_address" : "https://172.16.25.134",
  "internet_access_port" : "443",
  "access_mode" : "BOTH",
  "subnet_ids" : [ {
    "subnet_id" : "5dee0216-2260-47c2-9368-98a27d910e55"
  } ],
  "management_subnet_cidr" : "192.168.0.0/24",
  "infrastructure_security_group" : {
    "id" : "ffba6eda-5170-4343-b8a3-c306e0f21c88",
    "name" : "WorkspaceManagerSecurityGroup"
  },
  "desktop_security_group" : {
    "id" : "04abbdf6-e848-4c90-bdb1-6de856fa8a34",
    "name" : "WorkspaceUserSecurityGroup"
  },
  "progress" : "100%",
  "access_status" : "openSuccess",
  "is_send_email" : true,
  "authorized_collect_log" : false,
  "authorized_hda_upgrade" : false,
  "vpc_config_infos" : [ {
    "vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc1",
    "subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet1" ],
    "default_access_vpc" : true
  }, {
    "vpc_id" : "04abbdf6-e848-4c90-bdb1-6de856favpc2",
    "subnet_ids" : [ "04abbdf6-e848-4c90-bdb1-6de85subnet3" ]
  } ]
}

状态码

状态码	描述
200	查询云办公服务详情响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
500	服务内部错误，具体返回错误码请参见错误码说明。