Queries the overview information of workspaces.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListOfficeSiteOverview

The operation that you want to perform. Set the value to ListOfficeSiteOverview.

RegionId String Yes cn-hangzhou

The ID of the region.

ForceRefresh Boolean No false

Specifies whether to refresh the cache. Valid values:

  • true: skips the cache to obtain the latest data.
  • false: obtains data in the cache, which improves the performance of calling the ListOfficeSiteOverview operation.
OfficeSiteId.N RepeatList No cn-hangzhou+dir-363353****

The ID of workspace N. You can specify up to 100 workspace IDs.

MaxResults Integer No 10

The maximum number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query.

Response parameters

Parameter Type Example Description
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If this parameter is empty, all results are returned.

OfficeSiteOverviewResults Array of OfficeSiteOverviewResult

Details about the workspaces.

HasExpiredEdsCount Integer 0

The number of expired cloud desktops within the workspace.

OfficeSiteId String cn-hangzhou+dir-363353****

The ID of the workspace.

OfficeSiteName String test

The name of the workspace.

OfficeSiteStatus String REGISTERED

The status of the workspace. Valid values:

  • REGISTERING
  • REGISTERED
RegionId String cn-hangzhou

The region ID of the workspace.

RunningEdsCount Integer 1

The number of cloud desktop running within the workspace.

TotalEdsCount Integer 1

The total number of cloud desktops within the workspace.

WillExpiredEdsCount Integer 0

The number of cloud desktops that are about to expire within the workspace.

RequestId String EC330A26-1940-4A26-A4C8-E99AE907E25B

The ID of the request.

Samples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=ListOfficeSiteOverview
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success response

XML format

<ListOfficeSiteOverviewResponse>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <RequestId>EC330A26-1940-4A26-A4C8-E99AE907E25B</RequestId>
      <OfficeSiteOverviewResults>
            <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>
            <HasExpiredEdsCount>0</HasExpiredEdsCount>
            <TotalEdsCount>1</TotalEdsCount>
            <WillExpiredEdsCount>0</WillExpiredEdsCount>
            <RunningEdsCount>1</RunningEdsCount>
            <OfficeSiteName>test</OfficeSiteName>
            <RegionId>cn-hangzhou</RegionId>
            <OfficeSiteStatus>REGISTERED</OfficeSiteStatus>
      </OfficeSiteOverviewResults>
</ListOfficeSiteOverviewResponse>

JSON format

{
    "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
    "RequestId": "EC330A26-1940-4A26-A4C8-E99AE907E25B",
    "OfficeSiteOverviewResults": [{
        "OfficeSiteId": "cn-hangzhou+dir-363353****",
        "HasExpiredEdsCount": "0",
        "TotalEdsCount": "1",
        "WillExpiredEdsCount": "0",
        "RunningEdsCount": "1",
        "OfficeSiteName": "test",
        "RegionId": "cn-hangzhou",
        "OfficeSiteStatus": "REGISTERED"
    }]
}