调用DescribeOfficeSites查询工作区的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeOfficeSites

系统规定参数。取值:DescribeOfficeSites。

RegionId String cn-hangzhou

地域ID。

OfficeSiteType String SIMPLE

工作区的账号系统类型。取值范围:

  • SIMPLE:便捷账号。
  • AD_CONNECTOR:企业AD账号。
OfficeSiteId.N RepeatList cn-hangzhou+dir-363353****

工作区ID。可设置一个或者多个。

MaxResults Integer 10

分页查询时每页行数。

最大值:100。

默认值:10。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

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

OfficeSites Array of OfficeSite

工作区信息集合。

ADConnectors Array of ADConnector

AD Connector的信息集合。

ADConnectorAddress String 172.24.*.*

AD Connector的连接地址。

ConnectorStatus String RUNNING

AD Connector的状态。可能值:

  • CREATING:创建中。
  • CONNECTING:连接中。需要用户在自有AD上配置域信任。
  • RUNNING:运行中。
  • EXPIRED:欠费过期。
  • CONNECT_ERROR:连接错误。
NetworkInterfaceId String eni-bp1i4wx78lgosrj6****

AD Connector挂载的网卡ID。

VSwitchId String vsw-bp19ocz3erfx15uon****

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

Bandwidth Integer 10

公网带宽峰值。可能值:0~200。

如果为0,则表示没有开通互联网访问。

CenId String cen-3gwy16dojz1m65****

云企业网实例ID。

CidrBlock String 172.16.0.0/16

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

CreationTime String 2021-05-06T05:58Z

工作区创建时间。

CustomSecurityGroupId String sg-bp1ce64o4g9mdf5u****

安全组ID。

DesktopAccessType String INTERNET

连接云桌面时允许使用的接入方式。可能值:

  • INTERNET:只允许客户端通过公网连接云桌面。
  • VPC:只允许处于VPC网络内的客户端连接云桌面。
  • ANY:不限制方式。使用客户端连接云桌面时可以自行选择连接方式。
DesktopVpcEndpoint String http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com

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

DnsAddress List ["172.24.*.*"]

企业AD对应的DNS地址。

DnsUserName String testDnsUserName

DNS用户名。

DomainName String example.com

企业AD的域名称。

DomainPassword String testPassword

域管理员的用户密码。

DomainUserName String Administrator

域管理员的用户名。

EnableAdminAccess Boolean true

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

EnableInternetAccess Boolean false

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

FileSystemIds List ["05b534****"]

NAS文件系统ID。

Logs Array of Log

注册日志信息。

Level String INFO

日志级别。可能值:

  • INFO:信息
  • ERROR:错误
  • WARN:警告
Message String code:success | message:Create Connector complete

日志详细信息。

Step String CREATE_CONNECTOR

日志信息对应的步骤。

TimeStamp String 2021-05-12T09:42Z

日志打印时间。

MfaEnabled Boolean false

是否开启多因素认证MFA。

Name String test

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

NetworkPackageId String np-amtp8e8q1o9e4****

互联网访问包ID。

OfficeSiteId String cn-hangzhou+dir-363353****

工作区ID。

OfficeSiteType String AD_CONNECTOR

工作区账号系统类型。可能值:

  • SIMPLE:便捷账号。
  • AD_CONNECTOR:企业AD账号。
SsoEnabled Boolean false

是否开启单点登录SSO。

Status String REGISTERED

工作区状态。可能值:

  • REGISTERING:注册中
  • REGISTERED:已注册
SubDnsAddress List ["172.24.*.*"]

AD子域的DNS地址。

SubDomainName String testSubDnsUserName

AD子域DNS的用户名。

TrustPassword String 82Tg****

AD信任密码。

VSwitchIds List vsw-bp19ocz3erfx15uon****

交换机ID。

VpcId String vpc-uf6tz5k67puge5jn8****

安全办公网络VPC ID。

RequestId String F369A091-002F-49C8-AD55-02A776297C7B

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeOfficeSites
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeOfficeSites>
      <RequestId>F369A091-002F-49C8-AD55-02A776297C7B</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <OfficeSites>
            <Status>REGISTERED</Status>
            <DomainName>example.com	</DomainName>
            <NetworkPackageId>np-amtp8e8q1o9e4****</NetworkPackageId>
            <EnableAdminAccess>true</EnableAdminAccess>
            <OfficeSiteType>AD_CONNECTOR</OfficeSiteType>
            <CidrBlock>172.16.0.0/16</CidrBlock>
            <SsoEnabled>false</SsoEnabled>
            <CustomSecurityGroupId>sg-bp1ce64o4g9mdf5u****</CustomSecurityGroupId>
            <MfaEnabled>false</MfaEnabled>
            <SubDomainName>testSubDnsUserName</SubDomainName>
            <Name>test</Name>
            <DomainPassword>testPassword</DomainPassword>
            <TrustPassword>82Tg****</TrustPassword>
            <OfficeSiteId>cn-hangzhou+os-c5cy7q578s8jc****</OfficeSiteId>
            <DesktopVpcEndpoint>http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com</DesktopVpcEndpoint>
            <VpcId>vpc-uf6tz5k67puge5jn8****</VpcId>
            <Bandwidth>10</Bandwidth>
            <CenId>cen-3gwy16dojz1m65****</CenId>
            <CreationTime>2021-05-06T05:58Z</CreationTime>
            <DesktopAccessType>INTERNET</DesktopAccessType>
            <DomainUserName>Administrator</DomainUserName>
            <EnableInternetAccess>false</EnableInternetAccess>
            <DnsUserName>testDnsUserName	</DnsUserName>
            <ADConnectors>
                  <ConnectorStatus>RUNNING</ConnectorStatus>
                  <VSwitchId>vsw-bp19ocz3erfx15uon****</VSwitchId>
                  <ADConnectorAddress>172.24.*.*</ADConnectorAddress>
                  <NetworkInterfaceId>eni-bp1i4wx78lgosrj6****</NetworkInterfaceId>
            </ADConnectors>
            <Logs>
                  <Message>code:success | message:Create Connector complete</Message>
                  <Level>INFO</Level>
                  <Step>CREATE_CONNECTOR</Step>
                  <TimeStamp>2021-05-12T09:42Z</TimeStamp>
            </Logs>
            <DnsAddress> ["172.24.*.*"]</DnsAddress>
            <SubDnsAddress> ["172.24.*.*"]</SubDnsAddress>
            <VSwitchIds>vsw-bp19ocz3erfx15uon****</VSwitchIds>
            <FileSystemIds>["05b534****"]</FileSystemIds>
      </OfficeSites>
</DescribeOfficeSites>

JSON格式

{
	"RequestId": "F369A091-002F-49C8-AD55-02A776297C7B",
	"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
	"OfficeSites": [{
		"Status": "REGISTERED",
		"DomainName": "example.com\t",
		"NetworkPackageId": "np-amtp8e8q1o9e4****",
		"EnableAdminAccess": "true",
		"OfficeSiteType": "AD_CONNECTOR",
		"CidrBlock": "172.16.0.0/16",
		"SsoEnabled": "false",
		"CustomSecurityGroupId": "sg-bp1ce64o4g9mdf5u****",
		"MfaEnabled": "false",
		"SubDomainName": "testSubDnsUserName",
		"Name": "test",
		"DomainPassword": "testPassword",
		"TrustPassword": "82Tg****",
		"OfficeSiteId": "cn-hangzhou+os-c5cy7q578s8jc****",
		"DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
		"VpcId": "vpc-uf6tz5k67puge5jn8****",
		"Bandwidth": "10",
		"CenId": "cen-3gwy16dojz1m65****",
		"CreationTime": "2021-05-06T05:58Z",
		"DesktopAccessType": "INTERNET",
		"DomainUserName": "Administrator",
		"EnableInternetAccess": "false",
		"DnsUserName": "testDnsUserName\t",
		"ADConnectors": [{
			"ConnectorStatus": "RUNNING",
			"VSwitchId": "vsw-bp19ocz3erfx15uon****",
			"ADConnectorAddress": "172.24.*.*",
			"NetworkInterfaceId": "eni-bp1i4wx78lgosrj6****"
		}],
		"Logs": [{
			"Message": "code:success | message:Create Connector complete",
			"Level": "INFO",
			"Step": "CREATE_CONNECTOR",
			"TimeStamp": "2021-05-12T09:42Z"
		}],
		"DnsAddress": " [\"172.24.*.*\"]",
		"SubDnsAddress": " [\"172.24.*.*\"]",
		"VSwitchIds": "vsw-bp19ocz3erfx15uon****",
		"FileSystemIds": "[\"05b534****\"]"
	}]
}