调用DescribeOfficeSites查询工作区的详细信息_无影云电脑-阿里云帮助中心

查询工作区的详细信息。

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域ID。	cn-hangzhou
OfficeSiteType	string	否	工作区的账号系统类型。枚举值： SIMPLE：便捷账号。 AD_CONNECTOR：企业AD账号。	SIMPLE
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
NextToken	string	否	下一个查询开始的Token。	caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteId	array	否	工作区ID。可设置1~100个。
	string	否	工作区ID。	cn-hangzhou+dir-363353****
Status	string	否	工作区状态。枚举值： REGISTERING：注册中。 DEREGISTERING：取消中。 REGISTERED：已注册。 NEEDCONFIGTRUST：需要配置信任关系。 CONFIGTRUSTFAILED：配置信任关系失败。 DEREGISTERED：已取消。 ERROR：配置错误。 CONFIGTRUSTING：配置信任关系中。 NEEDCONFIGUSER：需要配置用户。	REGISTERED

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的Token。NextToken为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSites	object []	工作区信息集合。
Status	string	工作区状态。枚举值： REGISTERING：注册中。 DEREGISTERING：取消中。 REGISTERED：已注册。 NEEDCONFIGTRUST：需要配置信任关系。 CONFIGTRUSTFAILED：配置信任关系失败。 DEREGISTERED：已取消。 ERROR：配置错误。 CONFIGTRUSTING：配置信任关系中。 NEEDCONFIGUSER：需要配置用户。	REGISTERED
CreationTime	string	工作区创建时间。	2021-05-06T05:58Z
VpcId	string	安全办公网络VPC ID。	vpc-uf6tz5k67puge5jn8****
VpcType	string	VPC的使用方式。枚举值： Basic：基础型。 Customized：定制型。 Standard：标准型。	Basic
EnableAdminAccess	boolean	是否为使用云桌面的用户赋予本地管理员权限。	true
EnableCrossDesktopAccess	boolean	是否开通工作区内桌面互通功能。开启工作区内桌面互通后，同一个工作区内的桌面之间可以实现相互访问彼此的网络。	false
DesktopVpcEndpoint	string	VPC连接桌面时所使用的终端节点。	http://ep-bp1s2vmbj55r5rzc**.epsrv-bp1pcfhpwvlpny01**.cn-hangzhou.privatelink.aliyuncs.com
DesktopAccessType	string	连接云桌面时允许使用的接入方式。枚举值： INTERNET：只允许客户端通过公网连接云桌面。。 VPC：只允许处于VPC网络内的客户端连接云桌面。。 ANY：不限制方式。使用客户端连接云桌面时可以自行选择连接方式。。	INTERNET
DomainName	string	企业AD的域名称。	example.com
SsoEnabled	boolean	是否开启单点登录SSO。	false
CidrBlock	string	工作区对应安全办公网络包含的IPv4网段。	47.100.XX.XX
Bandwidth	integer	公网带宽峰值。可能值：0~1000。如果为空或0，则表示没有开通互联网访问。	10
TrustPassword	string	说明该参数暂未开放使用。	To be hidden.
Name	string	工作区名称。同一地域下，该名称唯一。	test
EnableInternetAccess	boolean	是否已开通公网访问功能。	false
DomainPassword	string	域管理员的用户密码。	testPassword
CustomSecurityGroupId	string	安全组ID。	sg-bp1ce64o4g9mdf5u****
OuName	string	对接AD域中的组织单元。	example.com/Domain Controllers
DomainUserName	string	域管理员的用户名。	Administrator
SubDomainName	string	AD子域DNS的用户名。	testSubDnsUserName
OfficeSiteId	string	工作区ID。	cn-hangzhou+dir-363353****
CenId	string	云企业网实例ID。	cen-3gwy16dojz1m65****
CenAttachStatus	string	云企业网CEN的状态。
MfaEnabled	boolean	是否开启多因素认证MFA。	false
NetworkPackageId	string	互联网访问包ID。	np-amtp8e8q1o9e4****
DnsUserName	string	DNS用户名。	testDnsUserName
OfficeSiteType	string	工作区账号系统类型。枚举值： SIMPLE：便捷账号。 AD_CONNECTOR：企业AD账号。	AD_CONNECTOR
ADConnectors	object []	AD Connector的信息集合。
ConnectorStatus	string	AD Connector的状态。枚举值： CONNECT_ERROR：连接错误。 RUNNING：运行中。 CONNECTING：连接中。需要完成AD域配置。。 EXPIRED：欠费过期。 CREATING：创建中。	RUNNING
VSwitchId	string	AD Connector所在网络对应的交换机ID。	vsw-bp19ocz3erfx15uon****
ADConnectorAddress	string	AD Connector的连接地址。	172.24..
TrustKey	string	配置AD信任关系时设置的信任密码。	password123***
NetworkInterfaceId	string	AD Connector挂载的网卡ID。	eni-bp1i4wx78lgosrj6****
Specification	string	AD Connector规格。枚举值： 1：通用型。 2：高级型。	1
Logs	object []	注册日志信息。
Step	string	日志信息对应的步骤。	CREATE_CONNECTOR
Message	string	日志详细信息。	code:success \| message:Create Connector complete
TimeStamp	string	日志打印时间。	2021-05-12T09:42Z
Level	string	日志级别。枚举值： ERROR：错误。 INFO：信息。 WARN：警告。	INFO
VSwitchIds	array	交换机ID数组。
	string	交换机ID。	vsw-bp19ocz3erfx15uon****
FileSystemIds	array	NAS文件系统ID数组。
	string	NAS文件系统ID。	["05b534****"]
SubDnsAddress	array	AD子域的DNS地址数组。
	string	AD子域的DNS地址。	["172.24.."]
DnsAddress	array	AD域对应的DNS地址数组。
	string	AD域对应的DNS地址。	["172.24.."]
NeedVerifyLoginRisk	boolean	登录是否需要二次验证。仅适用于便捷工作区。如果开启了登录二次验证，则便捷用户登录客户端时，系统将检测登录账号是否有安全风险。如果有风险，系统将发送验证码到该账号关联的邮箱，便捷用户使用验证码验证通过后才能登录客户端。	false
DesktopCount	long	已创建的云桌面数量。	1
TotalEdsCount	long	云桌面数量。	0
TotalEdsCountForGroup	long	桌面组里云桌面数量。	0
NeedVerifyZeroDevice	boolean	是否开启可信设备校验。枚举值： true：开启。 false：不开启。	true
CloudBoxOfficeSite	boolean	是否为云盒工作区。枚举值： true：云盒工作区。 false：公网工作区。	true
SsoType	string	SSO类型。	To be hidden.
ProtocolType	string	工作区协议类型。枚举值： HDX：HDX协议。 ASP：阿里巴巴自研ASP协议。	ASP
AdHostname	string	域控主机名。必须符合Windows主机命名规范。	beijing-ad01
RdsLicenseStatus	string	RDS License的状态。	2
RdsLicenseAddress	string	RDS License的IP地址。	47.100.XX.XX
RdsLicenseDomainName	string	RDS License所在的域名称。	test.com

示例

正常返回示例

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": false,
      "DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
      "DesktopAccessType": "INTERNET",
      "DomainName": "example.com",
      "SsoEnabled": false,
      "CidrBlock": "47.100.XX.XX",
      "Bandwidth": 10,
      "TrustPassword": "To be hidden.",
      "Name": "test",
      "EnableInternetAccess": false,
      "DomainPassword": "testPassword",
      "CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
      "OuName": "example.com/Domain Controllers",
      "DomainUserName": "Administrator",
      "SubDomainName": "testSubDnsUserName",
      "OfficeSiteId": "cn-hangzhou+dir-363353****",
      "CenId": "cen-3gwy16dojz1m65****",
      "CenAttachStatus": "",
      "MfaEnabled": false,
      "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": false,
      "DesktopCount": 1,
      "TotalEdsCount": 0,
      "TotalEdsCountForGroup": 0,
      "NeedVerifyZeroDevice": true,
      "CloudBoxOfficeSite": true,
      "SsoType": "To be hidden.",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01",
      "RdsLicenseStatus": "2",
      "RdsLicenseAddress": "47.100.XX.XX",
      "RdsLicenseDomainName": "test.com"
    }
  ]
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-07-12

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2023-06-13

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2023-04-19

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2021-08-19

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2021-08-19

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2021-08-19

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更