Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:ListOfficeSiteOverview | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ForceRefresh | boolean | No | Specifies whether to refresh the cache. | false |
| MaxResults | integer | No | The number of entries to return on each page.
| 10 |
| NextToken | string | No | The token that determines the start point of the next query. If this is your first query or no next query is to be sent, skip this parameter. If a next query is to be sent, set the parameter to the value of NextToken that is returned from the last call. | caeba0bbb2be03f84eb48b699f0a4883 |
| OfficeSiteId | array | No | The office network IDs. You can specify IDs of 1 to 100 office networks. | |
| string | No | The office network ID. | cn-hangzhou+dir-363353**** | |
| QueryRange | integer | No | The query scope. Cloud computers in a cloud computer pool are pooled cloud computers. Default values:
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"OfficeSiteOverviewResults": [
{
"OfficeSiteStatus": "REGISTERED",
"TotalEdsCount": 1,
"TotalEdsCountForGroup": 1,
"WillExpiredEdsCount": 0,
"WillExpiredEdsCountForGroup": 0,
"OfficeSiteId": "cn-hangzhou+dir-363353****",
"RunningEdsCount": 1,
"RunningEdsCountForGroup": 1,
"OfficeSiteName": "test",
"VpcType": "standard",
"HasExpiredEdsCount": 0,
"HasExpiredEdsCountForGroup": 0,
"RegionId": "cn-hangzhou"
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-04-13 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2021-12-09 | The response structure of the API has changed | View Change Details |