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

调试

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

请求参数

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

系统规定参数。取值:DescribeOfficeSites

RegionId String cn-hangzhou

地域ID。

OfficeSiteType String SIMPLE

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

  • SIMPLE:便捷账号。
  • AD_CONNECTOR:企业AD账号。
MaxResults Integer 10

分页查询时每页行数。

最大值:100。

默认值:10。

NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token。

Status String REGISTERED

工作区状态。取值范围:

  • REGISTERING:注册中。
  • REGISTERED:已注册。
  • DEREGISTERING:取消中。
  • DEREGISTERED:已取消。
  • ERROR:配置错误。
  • NEEDCONFIGTRUST:需要配置信任关系。
  • NEEDCONFIGUSER:需要配置用户。
  • CONFIGTRUSTING:配置信任关系中。
  • CONFIGTRUSTFAILED:配置信任关系失败。
OfficeSiteId.N String cn-hangzhou+dir-363353****

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

返回数据

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

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

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

请求ID。

OfficeSites Array of OfficeSite

工作区信息集合。

Status String REGISTERED

工作区状态。可能值:

  • REGISTERING:注册中。
  • REGISTERED:已注册。
  • DEREGISTERING:取消中。
  • DEREGISTERED:已取消。
  • ERROR:配置错误。
  • NEEDCONFIGTRUST:需要配置信任关系。
  • NEEDCONFIGUSER:需要配置用户。
  • CONFIGTRUSTING:配置信任关系中。
  • CONFIGTRUSTFAILED:配置信任关系失败。
CreationTime String 2021-05-06T05:58Z

工作区创建时间。

VpcId String vpc-uf6tz5k67puge5jn8****

安全办公网络VPC ID。

EnableAdminAccess Boolean true

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

EnableCrossDesktopAccess Boolean false

是否开通工作区内桌面互通功能。

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

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

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

DesktopAccessType String INTERNET

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

  • INTERNET:只允许客户端通过公网连接云桌面。
  • VPC:只允许处于VPC网络内的客户端连接云桌面。
  • ANY:不限制方式。使用客户端连接云桌面时可以自行选择连接方式。
DomainName String example.com

企业AD的域名称。

SsoEnabled Boolean false

是否开启单点登录SSO。

CidrBlock String 172.16.0.0/16

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

Bandwidth Integer 10

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

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

TrustPassword String 82Tg****

该参数暂未开放使用。

Name String test

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

EnableInternetAccess Boolean false

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

DomainPassword String testPassword

域管理员的用户密码。

CustomSecurityGroupId String sg-bp1ce64o4g9mdf5u****

安全组ID。

OuName String example.com/Domain Controllers

对接AD域中的组织单元。

DomainUserName String Administrator

域管理员的用户名。

SubDomainName String testSubDnsUserName

AD子域DNS的用户名。

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

工作区ID。

CenId String cen-3gwy16dojz1m65****

云企业网实例ID。

MfaEnabled Boolean false

是否开启多因素认证MFA。

NetworkPackageId String np-amtp8e8q1o9e4****

互联网访问包ID。

DnsUserName String testDnsUserName

DNS用户名。

OfficeSiteType String AD_CONNECTOR

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

  • SIMPLE:便捷账号。
  • AD_CONNECTOR:企业AD账号。
ADConnectors Array of ADConnector

AD Connector的信息集合。

ConnectorStatus String RUNNING

AD Connector的状态。可能值:

  • CREATING:创建中。
  • CONNECTING:连接中。需要完成AD域配置。
  • RUNNING:运行中。
  • EXPIRED:欠费过期。
  • CONNECT_ERROR:连接错误。
VSwitchId String vsw-bp19ocz3erfx15uon****

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

ADConnectorAddress String 172.24.*.*

AD Connector的连接地址。

TrustKey String password123***

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

NetworkInterfaceId String eni-bp1i4wx78lgosrj6****

AD Connector挂载的网卡ID。

Logs Array of Log

注册日志信息。

Step String CREATE_CONNECTOR

日志信息对应的步骤。

Message String code:success | message:Create Connector complete

日志详细信息。

TimeStamp String 2021-05-12T09:42Z

日志打印时间。

Level String INFO

日志级别。可能值:

  • INFO:信息
  • ERROR:错误
  • WARN:警告
VSwitchIds Array of String vsw-bp19ocz3erfx15uon****

交换机ID。

FileSystemIds Array of String ["05b534****"]

NAS文件系统ID。

SubDnsAddress Array of String ["172.24.*.*"]

AD子域的DNS地址。

DnsAddress Array of String ["172.24.*.*"]

AD域对应的DNS地址。

NeedVerifyLoginRisk Boolean false

登录是否需要二次验证。仅适用于便捷工作区。

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

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "F369A091-002F-49C8-AD55-02A776297C7B",
  "OfficeSites" : [ {
    "Status" : "REGISTERED",
    "CreationTime" : "2021-05-06T05:58Z",
    "VpcId" : "vpc-uf6tz5k67puge5jn8****",
    "EnableAdminAccess" : true,
    "EnableCrossDesktopAccess" : false,
    "DesktopVpcEndpoint" : "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
    "DesktopAccessType" : "INTERNET",
    "DomainName" : "example.com\t",
    "SsoEnabled" : false,
    "CidrBlock" : "172.16.0.0/16",
    "Bandwidth" : 10,
    "TrustPassword" : "82Tg****",
    "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****",
    "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****"
    } ],
    "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
  } ]
}