使用DescribeOfficeSites查询办公网络属性-无影云电脑企业版-阿里云-阿里云帮助中心

查询办公网络的所有属性，包括ID、名称、状态、创建时间等。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ecd:DescribeOfficeSites	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	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
SecurityProtection	string	否	办公网络安全防护配置。枚举值： SASE：SASE。 OFF：关闭。	SASE

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token。NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	查询结果总数。	20
OfficeSites	array<object>	办公网络信息集合。
OfficeSite	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：赋予本地管理员权限 [默认值]。 false：不赋予本地管理员权限。	true
EnableCrossDesktopAccess	boolean	是否开启办公网络内云电脑互通。开启后，同一个办公网络内的云电脑之间可以实现相互访问彼此的网络。	false
DesktopVpcEndpoint	string	VPC 连接云电脑时所使用的终端节点。	http://ep-bp1s2vmbj55r5rzc**.epsrv-bp1pcfhpwvlpny01**.cn-hangzhou.privatelink.aliyuncs.com
DesktopAccessType	string	连接云电脑时允许使用的接入方式。说明 VPC 连接方式依赖于阿里云私网连接 PrivateLink 服务，该服务不收取费用。该参数设置为`VPC`或者`Any`时，系统将自动为您开通私网连接服务。枚举值： INTERNET：只允许客户端通过公网连接云电脑。[默认值]。 VPC：只允许处于VPC网络内的客户端连接云电脑。。 ANY：不限制方式。使用客户端连接云电脑时可以自行选择连接方式。。	INTERNET
DomainName	string	企业 AD 的域名称。	example.com
SsoEnabled	boolean	是否开启单点登录 SSO。	false
CidrBlock	string	办公网络 VPC 所包含的 IPv4 网段。	47.100.XX.XX
Bandwidth	integer	公网带宽峰值。可能值：0~1000Mbps。如果为空或 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 的状态。	attached
MfaEnabled	boolean	是否开启多因素认证 MFA。	false
NetworkPackageId	string	互联网访问包 ID。	np-amtp8e8q1o9e4****
DnsUserName	string	DNS 用户名。	testDnsUserName
OfficeSiteType	string	办公网络账号体系类型。枚举值： SIMPLE：便捷账号。 AD_CONNECTOR：企业AD账号。	AD_CONNECTOR
ADConnectors	array<object>	AD Connector 的信息集合。
ADConnector	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	array<object>	注册日志信息。
Log	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 数组。
vSwitchId	string	交换机 ID。	vsw-bp19ocz3erfx15uon****
FileSystemIds	array	NAS 文件系统 ID 数组。
FileSystemId	string	NAS 文件系统 ID。	["05b534****"]
SubDnsAddress	array	AD 子域的 DNS 地址数组。
SubAddress	string	AD 子域的 DNS 地址。	["172.24.XX.XX"]
DnsAddress	array	AD 域对应的 DNS 地址数组。
Address	string	AD 域对应的 DNS 地址。	["172.24.XX.XX"]
CustomDnsAddress	array	自定义 DNS 地址数组。
CustomDnsAddress	string	自定义 DNS 地址。	["172.24.XX.XX"]
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 类型。枚举值： SAML：SAML。	SAML
ProtocolType	string	协议类型。枚举值： HDX：HDX协议。 ASP：阿里云自研ASP协议。	ASP
AdHostname	string	域控主机名。必须符合 Windows 主机命名规范。	beijing-ad01
RdsLicenseStatus	string	RDS 许可证的状态。	2
RdsLicenseAddress	string	RDS 许可证的 IP 地址。	47.100.XX.XX
RdsLicenseDomainName	string	RDS 许可证所在的域名称。	example.com
BackupDns	string	备用域控 DNS 地址。	172.24.XX.XX
BackupDCHostname	string	备用域控主机名。	beijing-ad02
EnableServiceRoute	boolean	是否开启云服务路由访问管控。	false
SubnetMode	string	办公网络子网模式。枚举值： 0：跟随办公网络模式。 1：半管控模式。	0
SecurityProtection	string	办公网络安全防护配置。枚举值： SASE：SASE。 OFF：关闭。	SASE
CustomAccessPoint	string	自定义接入网关地址。	gw-****.com
ResourceAmounts	array<object>	资源数量列表。
ResourceAmount	object
resourceType	string	资源类型。枚举值： desktop：云电脑。 desktopGroup：共享型云电脑。	desktop
amount	long	资源数量。	1
TotalResourceAmount	long	网卡总数。	1
NmVersion	string	网络版本。新版支持无影云应用等产品。枚举值： DEFAULT：旧版。 NM：新版。	NM
AcceleratorId	string	全球加速实例 ID。	ga-bp1astu3yrplkzoo2****

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 20,
  "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.XX.XX"
        ]
      ],
      "DnsAddress": [
        [
          "172.24.XX.XX"
        ]
      ],
      "CustomDnsAddress": [
        [
          "172.24.XX.XX"
        ]
      ],
      "NeedVerifyLoginRisk": false,
      "DesktopCount": 1,
      "TotalEdsCount": 0,
      "TotalEdsCountForGroup": 0,
      "NeedVerifyZeroDevice": true,
      "CloudBoxOfficeSite": true,
      "SsoType": "SAML",
      "ProtocolType": "ASP",
      "AdHostname": "beijing-ad01",
      "RdsLicenseStatus": 2,
      "RdsLicenseAddress": "47.100.XX.XX",
      "RdsLicenseDomainName": "example.com",
      "BackupDns": "172.24.XX.XX",
      "BackupDCHostname": "beijing-ad02",
      "EnableServiceRoute": false,
      "SubnetMode": 0,
      "SecurityProtection": "SASE",
      "CustomAccessPoint": "gw-****.com",
      "ResourceAmounts": [
        {
          "resourceType": "desktop",
          "amount": 1
        }
      ],
      "TotalResourceAmount": 1,
      "NmVersion": "NM",
      "AcceleratorId": "ga-bp1astu3yrplkzoo2****",
      "LdapUrl": "",
      "IsLdap": true,
      "AccountType": "",
      "AuthorityHost": "",
      "TenantId": "",
      "ClientId": "",
      "ClientSecret": ""
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2025-10-24	OpenAPI 返回结构发生变更	查看变更详情
2025-04-10	OpenAPI 返回结构发生变更	查看变更详情
2025-01-20	OpenAPI 返回结构发生变更	查看变更详情
2024-12-06	OpenAPI 返回结构发生变更	查看变更详情
2024-10-23	OpenAPI 返回结构发生变更	查看变更详情
2024-08-05	OpenAPI 返回结构发生变更	查看变更详情
2024-07-10	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-01	OpenAPI 返回结构发生变更	查看变更详情
2024-04-29	OpenAPI 返回结构发生变更	查看变更详情
2023-07-12	OpenAPI 返回结构发生变更	查看变更详情
2023-06-13	OpenAPI 返回结构发生变更	查看变更详情
2023-04-19	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	OpenAPI 返回结构发生变更	查看变更详情