All Products
Search

This Product

    WUYING Workspace:ListOfficeSiteOverview

    Document Center

    WUYING Workspace:ListOfficeSiteOverview

    Last Updated:Apr 03, 2024

    Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ForceRefreshbooleanNo

    Specifies whether to refresh the cache.

    		false
    MaxResultsintegerNo

    The number of entries to return on each page.

    • Valid values: 1 to 100
    • Default value: 10
    		10
    NextTokenstringNo

    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
    OfficeSiteIdarrayNo

    The office network IDs. You can specify IDs of 1 to 100 office networks.

    stringNo

    The office network ID.

    		cn-hangzhou+dir-363353****
    QueryRangeintegerNo

    The query scope. Cloud computers in a cloud computer pool are pooled cloud computers.

    Default values:

    • 1 (default): queries non-pooled cloud computers in the office network.
    • 2: queries pooled cloud computers in the office network.
    • 3: queries all cloud computers in the office network.
    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    NextTokenstring

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

    		caeba0bbb2be03f84eb48b699f0a4883
    RequestIdstring

    The ID of the request.

    		1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    OfficeSiteOverviewResultsobject []

    The office network information.

    OfficeSiteStatusstring

    The office network status.

    Default values:

    • CONFIGUSERFAILED

    • REGISTERING

    • REGISTERED

    • NEEDCONFIGTRUST

    • CONFIGUSERING

    • CONFIGTRUSTFAILED

    • ERROR

    • CONFIGTRUSTING

    • NEEDCONFIGUSER

    		REGISTERED
    TotalEdsCountinteger

    The total number of cloud computers in the office network.

    		1
    TotalEdsCountForGroupinteger

    The total number of cloud computers in the cloud computer pool.

    		1
    WillExpiredEdsCountinteger

    The number of cloud computers that are about to expire in the office network.

    		0
    WillExpiredEdsCountForGroupinteger

    The number of cloud computers that are about to expire in the cloud computer pool.

    		0
    OfficeSiteIdstring

    The office network ID.

    		cn-hangzhou+dir-363353****
    RunningEdsCountinteger

    The number of cloud computers that are running in the office network.

    		1
    RunningEdsCountForGroupinteger

    The number of running cloud computers in the cloud computer pool.

    		1
    OfficeSiteNamestring

    The office network name.

    		test
    VpcTypestring

    The office network type and its suitable VPC type.

    Valid values:

    • standard (default): standard, exclusive VPC
    • customized: custom, user VPC
    • basic: basic, shared VPC
    		standard
    HasExpiredEdsCountinteger

    The number of expired cloud computers in the office network.

    		0
    HasExpiredEdsCountForGroupinteger

    The number of expired cloud computers in the cloud computer pool.

    		0
    RegionIdstring

    The ID of the region where the office network resides.

    		cn-hangzhou

    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 timeSummary of changesOperation
    2023-04-13The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2021-12-09The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.