查询办公网络的所有属性，包括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 |
| MaxResults | integer | 否 | 分页查询时每页行数。
| 10 |
| NextToken | string | 否 | 下一个查询开始的 Token。 | caeba0bbb2be03f84eb48b699f0a4883 |
| OfficeSiteId | array | 否 | 办公网络 ID。可设置 1~100 个。 | |
| string | 否 | 办公网络 ID。 | cn-hangzhou+dir-363353**** | |
| Status | string | 否 | 办公网络状态。 枚举值：
| REGISTERED |
| SecurityProtection | string | 否 | 办公网络安全防护配置。 枚举值：
| SASE |
返回参数
示例
正常返回示例
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.*.*\"]"
],
"DnsAddress": [
" [\"172.24.*.*\"]"
],
"CustomDnsAddress": [
""
],
"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": "",
"ResourceAmounts": [
{
"resourceType": "",
"amount": 0
}
],
"TotalResourceAmount": 0,
"NmVersion": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 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 返回结构发生变更 | 查看变更详情 |