文档

DescribeOfficeSites - 查询办公网络的详细信息

更新时间:

查询办公网络(原工作区)的所有属性,包括ID、名称、状态、创建时间等。

调试

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

授权信息

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

请求参数

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

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
OfficeSiteTypestring

办公网络的账号体系类型。

枚举值:
  • SIMPLE便捷账号
  • AD_CONNECTOR企业AD账号
SIMPLE
MaxResultsinteger

分页查询时每页行数。

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

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
OfficeSiteIdarray

办公网络 ID。可设置 1~100 个。

string

办公网络 ID。

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

办公网络状态。

枚举值:
  • REGISTERING注册中
  • DEREGISTERING取消中
  • REGISTERED已注册
  • NEEDCONFIGTRUST需要配置信任关系
  • CONFIGTRUSTFAILED配置信任关系失败
  • DEREGISTERED已取消
  • ERROR配置错误
  • CONFIGTRUSTING配置信任关系中
  • NEEDCONFIGUSER需要配置用户
REGISTERED

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSitesobject []

办公网络信息集合。

Statusstring

办公网络状态。

枚举值:
  • REGISTERING注册中
  • DEREGISTERING取消中
  • REGISTERED已注册
  • NEEDCONFIGTRUST需要配置信任关系
  • CONFIGTRUSTFAILED配置信任关系失败
  • DEREGISTERED已取消
  • ERROR配置错误
  • CONFIGTRUSTING配置信任关系中
  • NEEDCONFIGUSER需要配置用户
REGISTERED
CreationTimestring

办公网络创建时间。

2021-05-06T05:58Z
VpcIdstring

安全办公网络 VPC ID。

vpc-uf6tz5k67puge5jn8****
VpcTypestring

VPC 的使用方式。

枚举值:
  • Basic基础型
  • Customized定制型
  • Standard标准型
Basic
EnableAdminAccessboolean

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

枚举值:
  • true赋予本地管理员权限 [默认值]
  • false不赋予本地管理员权限
true
EnableCrossDesktopAccessboolean

是否开启办公网络内云电脑互通。开启后,同一个办公网络内的云电脑之间可以实现相互访问彼此的网络。

false
DesktopVpcEndpointstring

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

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

连接云电脑时允许使用的接入方式。

说明 VPC 连接方式依赖于阿里云私网连接 PrivateLink 服务,该服务不收取费用。该参数设置为VPC或者Any时,系统将自动为您开通私网连接服务。
枚举值:
  • INTERNET只允许客户端通过公网连接云电脑。[默认值]
  • VPC只允许处于VPC网络内的客户端连接云电脑。
  • ANY不限制方式。使用客户端连接云电脑时可以自行选择连接方式。
INTERNET
DomainNamestring

企业 AD 的域名称。

example.com
SsoEnabledboolean

是否开启单点登录 SSO。

false
CidrBlockstring

办公网络 VPC 所包含的 IPv4 网段。

47.100.XX.XX
Bandwidthinteger

公网带宽峰值。可能值:0~1000。
如果为空或 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****
CenAttachStatusstring

云企业网 CEN 的状态。

attached
MfaEnabledboolean

是否开启多因素认证 MFA。

false
NetworkPackageIdstring

互联网访问包 ID。

np-amtp8e8q1o9e4****
DnsUserNamestring

DNS 用户名。

testDnsUserName
OfficeSiteTypestring

办公网络账号体系类型。

枚举值:
  • SIMPLE便捷账号
  • AD_CONNECTOR企业AD账号
AD_CONNECTOR
ADConnectorsobject []

AD Connector 的信息集合。

ConnectorStatusstring

AD Connector 的状态。

枚举值:
  • CONNECT_ERROR连接错误
  • RUNNING运行中
  • CONNECTING连接中。需要完成AD域配置。
  • EXPIRED欠费过期
  • CREATING创建中
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通用型
  • 2高级型
1
Logsobject []

注册日志信息。

Stepstring

日志信息对应的步骤。

CREATE_CONNECTOR
Messagestring

日志详细信息。

code:success | message:Create Connector complete
TimeStampstring

日志打印时间。

2021-05-12T09:42Z
Levelstring

日志级别。

枚举值:
  • ERROR错误
  • INFO信息
  • WARN警告
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
TotalEdsCountlong

云电脑数量。

0
TotalEdsCountForGrouplong

云电脑池(原桌面组)里的云电脑数量。

0
NeedVerifyZeroDeviceboolean

是否开启可信设备校验。

枚举值:
  • true开启
  • false不开启
true
CloudBoxOfficeSiteboolean

是否为云盒办公网络。

枚举值:
  • true云盒办公网络
  • false公网办公网络
true
SsoTypestring

SSO 类型。

DingTalk
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
ASP
AdHostnamestring

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

beijing-ad01
RdsLicenseStatusstring

RDS 许可证的状态。

2
RdsLicenseAddressstring

RDS 许可证的 IP 地址。

47.100.XX.XX
RdsLicenseDomainNamestring

RDS 许可证所在的域名称。

example.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": "attached",
      "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": "DingTalk",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01",
      "RdsLicenseStatus": "2",
      "RdsLicenseAddress": "47.100.XX.XX",
      "RdsLicenseDomainName": "example.com"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈