云桌面 WORKSPACE-查询云办公服务详情:响应参数

时间:2024-09-05 16:31:34

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

唯一标识ID。

ad_domains

AdInfo object

域信息。

vpc_id

String

VPC ID。

vpc_name

String

VPC名称。

access_mode

String

接入方式。

  • INTERNET:表示互联网接入。
  • DEDICATED:表示专线接入。
  • BOTH:表示同时支持互联网接入和专线接入。

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:销户失败。
  • 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订购桌面。

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。

is_send_email

Boolean

桌面退订是否发送邮件通知。

authorized_collect_log

Boolean

是否授权收集日志。

authorized_hda_upgrade

Boolean

是否授权hda升级。

dc_vnc_ip

String

自定义的专线VNC地址

表4 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信息。

表5 TlsConfig

参数

参数类型

描述

cert_pem

String

pem内容, 有则更新,无则上传。查询不返回。

cert_start_time

String

证书生效开始时间,时间参考样例 2022-01-25T09:24:27。

cert_end_time

String

证书生效截止时间,时间参考样例 2022-01-25T09:24:27。

表6 SubnetInfo

参数

参数类型

描述

subnet_id

String

子网的网络ID。

表7 SecurityGroup

参数

参数类型

描述

id

String

安全组ID。

name

String

安全组名称。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

support.huaweicloud.com/api-workspace/ListWorkspaces.html