首页 无影云桌面 API参考(云桌面管控) API目录 工作区 DescribeOfficeSites - 查询工作区的详细信息

DescribeOfficeSites - 查询工作区的详细信息

查询工作区的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
OfficeSiteTypestring

工作区的账号系统类型。

SIMPLE
MaxResultsinteger

分页查询时每页行数。

  • 最大值:100。
  • 默认值:10。
10
NextTokenstring

下一个查询开始的Token。

caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteIdarray

工作区ID。可设置1~100个。

string

工作区ID。

cn-hangzhou+dir-363353****
Statusstring

工作区状态。

REGISTERED

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的Token。NextToken为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSitesarray

工作区信息集合。

object

工作区对象。

Statusstring

工作区状态。

REGISTERED
CreationTimestring

工作区创建时间。

2021-05-06T05:58Z
VpcIdstring

安全办公网络VPC ID。

vpc-uf6tz5k67puge5jn8****
VpcTypestring

VPC的使用方式。

Basic
EnableAdminAccessboolean

是否为使用云桌面的用户赋予本地管理员权限。

true
EnableCrossDesktopAccessboolean

是否开通工作区内桌面互通功能。开启工作区内桌面互通后,同一个工作区内的桌面之间可以实现相互访问彼此的网络。

false
DesktopVpcEndpointstring

VPC连接桌面时所使用的终端节点。

http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com
DesktopAccessTypestring

连接云桌面时允许使用的接入方式。

INTERNET
DomainNamestring

企业AD的域名称。

example.com
SsoEnabledboolean

是否开启单点登录SSO。

false
CidrBlockstring

工作区对应安全办公网络包含的IPv4网段。

172.16.0.0/16
Bandwidthinteger

公网带宽峰值。可能值:0~200。
如果为0,则表示没有开通互联网访问。

10
TrustPasswordstring
说明该参数暂未开放使用。
To be hidden.
Namestring

工作区名称。同一地域下,该名称唯一。

test
EnableInternetAccessboolean

是否已开通公网访问功能。

false
DomainPasswordstring

域管理员的用户密码。

testPassword
CustomSecurityGroupIdstring

安全组ID。

sg-bp1ce64o4g9mdf5u****
OuNamestring

对接AD域中的组织单元。

example.com/Domain Controllers
DomainUserNamestring

域管理员的用户名。

Administrator
SubDomainNamestring

AD子域DNS的用户名。

testSubDnsUserName
OfficeSiteIdstring

工作区ID。

cn-hangzhou+dir-363353****
CenIdstring

云企业网实例ID。

cen-3gwy16dojz1m65****
MfaEnabledboolean

是否开启多因素认证MFA。

false
NetworkPackageIdstring

互联网访问包ID。

np-amtp8e8q1o9e4****
DnsUserNamestring

DNS用户名。

testDnsUserName
OfficeSiteTypestring

工作区账号系统类型。

AD_CONNECTOR
ADConnectorsarray

AD Connector的信息集合。

object

AD Connector对象。

ConnectorStatusstring

AD Connector的状态。

RUNNING
VSwitchIdstring

AD Connector所在网络对应的交换机ID。

vsw-bp19ocz3erfx15uon****
ADConnectorAddressstring

AD Connector的连接地址。

172.24.*.*
TrustKeystring

配置AD信任关系时设置的信任密码。

password123***
NetworkInterfaceIdstring

AD Connector挂载的网卡ID。

eni-bp1i4wx78lgosrj6****
Specificationstring

AD Connector规格。

1
Logsarray

注册日志信息。

object

注册日志对象。

Stepstring

日志信息对应的步骤。

CREATE_CONNECTOR
Messagestring

日志详细信息。

code:success | message:Create Connector complete
TimeStampstring

日志打印时间。

2021-05-12T09:42Z
Levelstring

日志级别。

INFO
VSwitchIdsarray

交换机ID数组。

string

交换机ID。

vsw-bp19ocz3erfx15uon****
FileSystemIdsarray

NAS文件系统ID数组。

string

NAS文件系统ID。

["05b534****"]
SubDnsAddressarray

AD子域的DNS地址数组。

string

AD子域的DNS地址。

["172.24.*.*"]
DnsAddressarray

AD域对应的DNS地址数组。

string

AD域对应的DNS地址。

["172.24.*.*"]
NeedVerifyLoginRiskboolean

登录是否需要二次验证。仅适用于便捷工作区。
如果开启了登录二次验证,则便捷用户登录客户端时,系统将检测登录账号是否有安全风险。如果有风险,系统将发送验证码到该账号关联的邮箱,便捷用户使用验证码验证通过后才能登录客户端。

false
DesktopCountlong

已创建的云桌面数量。

1
NeedVerifyZeroDeviceboolean

是否开启可信设备校验。

true
CloudBoxOfficeSiteboolean

是否为云盒工作区。

true
SsoTypestring

SSO类型。

To be hidden.
ProtocolTypestring

工作区协议类型。

ASP
AdHostnamestring

域控主机名。 必须符合Windows主机命名规范。

beijing-ad01

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "OfficeSites": [
    {
      "Status": "REGISTERED",
      "CreationTime": "2021-05-06T05:58Z",
      "VpcId": "vpc-uf6tz5k67puge5jn8****",
      "VpcType": "Basic",
      "EnableAdminAccess": true,
      "EnableCrossDesktopAccess": true,
      "DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
      "DesktopAccessType": "INTERNET",
      "DomainName": "example.com\t",
      "SsoEnabled": true,
      "CidrBlock": "172.16.0.0/16",
      "Bandwidth": 10,
      "TrustPassword": "To be hidden.",
      "Name": "test",
      "EnableInternetAccess": true,
      "DomainPassword": "testPassword",
      "CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
      "OuName": "example.com/Domain Controllers",
      "DomainUserName": "Administrator",
      "SubDomainName": "testSubDnsUserName",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "CenId": "cen-3gwy16dojz1m65****",
      "MfaEnabled": true,
      "NetworkPackageId": "np-amtp8e8q1o9e4****",
      "DnsUserName": "testDnsUserName\t",
      "OfficeSiteType": "AD_CONNECTOR",
      "ADConnectors": [
        {
          "ConnectorStatus": "RUNNING",
          "VSwitchId": "vsw-bp19ocz3erfx15uon****",
          "ADConnectorAddress": "172.24.*.*",
          "TrustKey": "password123***",
          "NetworkInterfaceId": "eni-bp1i4wx78lgosrj6****",
          "Specification": "1"
        }
      ],
      "Logs": [
        {
          "Step": "CREATE_CONNECTOR",
          "Message": "code:success | message:Create Connector complete",
          "TimeStamp": "2021-05-12T09:42Z",
          "Level": "INFO"
        }
      ],
      "VSwitchIds": [
        "vsw-bp19ocz3erfx15uon****"
      ],
      "FileSystemIds": [
        "[\"05b534****\"]"
      ],
      "SubDnsAddress": [
        " [\"172.24.*.*\"]"
      ],
      "DnsAddress": [
        " [\"172.24.*.*\"]"
      ],
      "NeedVerifyLoginRisk": true,
      "DesktopCount": 1,
      "NeedVerifyZeroDevice": true,
      "CloudBoxOfficeSite": true,
      "SsoType": "To be hidden.",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈