Help Center/ Workspace/ API Reference/ Workspace APIs/ Huawei Cloud Workspace/ Querying Site Information
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Site Information

Function

Queries site information.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:sites:get

    Read

    -

    -

    -

    -

URI

GET /v2/{project_id}/sites

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

availability_zone_id

No

String

AZ.

site_type

No

String

Site type. The value can be CENTER or IES.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

site_infos

Array of SiteInfo objects

Site information list.

total_count

Integer

Total number of sites.
Table 4 SiteInfo

Parameter

Type

Description

site_id

String

Site ID.

site_name

String

Site name.

site_type

String

Configuration status.

  • CENTER: center initialization

  • IES: edge initialization

project_id

String

Project ID.

status

String

Site status.

create_time

String

Creation time.

network_config

NetworkConfig object

Network information.
Table 5 NetworkConfig

Parameter

Type

Description

vpc_id

String

VPC ID.

vpc_name

String

VPC name.

subnet_ids

Array of strings

Service subnet. You can specify the returned network ID to subscribe to a desktop.

management_subnet_cidr

String

The subnet segment occupied by the backend management component.

management_node_subnet_id

String

The subnet ID occupied by the managed node among the business subnets returned by subnet_ids.

vpc_config_infos

Array of VpcConfigInfo objects

VPC configuration information list.

dc_vnc_ip

String

User-defined Direct Connect VNC address.
Table 6 VpcConfigInfo

Parameter

Type

Description

used_subnet_ids

Array of strings

Information about used subnets.

vpc_id

String

VPC ID.

subnet_ids

Array of strings

Subnet IDs

default_access_vpc

Boolean

Whether the default access VPC is used.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

Queries site information.

GET /v2/fb2e5ec048384c8f9469d42db0037908/sites

Example Responses

Status code: 200

Queries site information.

{
  "site_infos" : [ {
    "site_id" : "22033f05-b7e1-44c4-a45f-630aa8acc42c",
    "site_name" : "Huawei Cloud Central Site",
    "az_code" : "cn-north-7a,cn-north-7b,cn-north-7c",
    "site_type" : "CENTER",
    "project_id" : "902b906e372241fe9b4e2e7280d64613",
    "status" : "openSuccess"
  } ]
}

Status Codes

Status Code

Description

200

Queries site information.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

500

An internal service error occurred. For details about the error code, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Huawei Cloud Workspace