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

查询办公网络的详细信息。

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
ClientIdstring

客户端生成的唯一 ID。

42f6645a-9c3c-4772-be2a-cc5f5732****
OfficeSiteIdarray

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

string

办公网络 ID。

cn-hangzhou+dir-363353****

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
OfficeSitesarray<object>

办公网络信息集合。

OfficeSiteobject

办公网络信息。

SsoServiceUrlstring

SSO 连接。

https://eds-cn-shanghai-67****
DesktopAccessTypestring

连接办公网络时允许使用的接入方式。

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

VPC 连接云电脑时所使用的终端节点。

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

办公网络账号系统类型。

枚举值:
  • ad_connectorAD域账号
  • simple便捷账号
SIMPLE
ProviderIdstring

用户账号 BID。

268****
OfficeSiteIdstring

办公网络 ID。

cn-hangzhou+dir-363353****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "OfficeSites": [
    {
      "SsoServiceUrl": "https://eds-cn-shanghai-67****",
      "DesktopAccessType": "VPC",
      "DesktopVpcEndpoint": "http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com",
      "OfficeSiteType": "SIMPLE",
      "ProviderId": "268****",
      "OfficeSiteId": "cn-hangzhou+dir-363353****"
    }
  ]
}

错误码

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