更新时间:2025-07-09 GMT+08:00

查询站点信息

功能介绍

用于查询站点信息的接口。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/sites

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

availability_zone_id

String

可用区。

site_type

String

站点类型,支持CENTER、IES。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

site_infos

Array of SiteInfo objects

站点信息列表。

total_count

Integer

站点总数。

表5 SiteInfo

参数

参数类型

描述

site_id

String

站点id。

site_name

String

站点名字。

site_type

String

配置状态。

  • CENTER: 中心初始化

  • IES: 边缘初始化

project_id

String

项目ID。

status

String

站点状态。

create_time

String

创建时间。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码:503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/fb2e5ec048384c8f9469d22db0037908/sites

响应示例

状态码:200

查询站点信息的接口。

{
  "site_infos" : [ {
    "site_id" : "22033f05-b7e1-44c4-a45f-630aa8acc42c",
    "site_name" : "华为云中心站",
    "az_code" : "cn-north-7a,cn-north-7b,cn-north-7c",
    "site_type" : "CENTER",
    "project_id" : "902b906e372241fe9b4e2e7280d64613",
    "status" : "openSuccess"
  } ]
}

状态码

状态码

描述

200

查询站点信息的接口。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码