更新时间:2024-12-27 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

创建时间。

agent_info

Array of Vag objects

网关节点信息。

表6 Vag

参数

参数类型

描述

id

String

vAG信息ID。

project_id

String

项目ID。

site_id

String

站点ID。

vag_ip

String

vAG IP,与管理节点相同的IP。

private_ip

String

vAG内网IP,HDA往这个IP上报心跳。

private_ipv6

String

vAG内网IPv6。

vag_port_id

String

vAG端口ID,与管理节点相同的端口的ID。

ssh_user

String

SSH用户的名称,固定为gandalf。

ssh_pwd

String

SSH用户的密码。

vm_id

String

vAG所属ECS的ID。

name

String

vAG所属机器名。

internal_ip

String

vAG内部通信IP,最终租户VPC的子网IP。

internal_ipv6

String

vAG内部通信IPV6。

internal_port_id

String

vAG内部通信端口ID,最终租户VPC的子网中端口的ID。

external_ip

String

外部通信IP,可能独立的EIP。

external_id

String

外部通信ID,可能独立的EIP ID。

root_user

String

root用户的名称,固定为root。

root_pwd

String

root用户的密码。

status

String

vag操作状态。

availability_zone

String

可用分区。

create_time

Long

创建时间。

create_time_str

String

创建时间字符串。

state

String

vag服务状态 NOT_USE:维护,ON_USE:启用,CANCELLATION:退服。

number_of_online_user

Long

在线用户数。

running_status

String

vag运行状态。

domain_id

String

租户侧domainId。

version

String

vag当前版本号。

latest_version

String

vag最新版本号。

access_edge_version

String

wksAccessEdge版本号。

tenant_lock

Integer

项目是否被锁定 0是未锁定 1是锁定。

resource_pool_id

String

资源池id。

role

String

agent角色,如:vag,vap4down,vap4up,authConnector。

resource_pool_type

String

资源池类型,public,private。

edge_sk

String

边缘sk。

has_heartbeat

Boolean

是否有心跳。

user_count

Integer

VAG负载个数。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

状态码: 503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

encoded_authorization_message

String

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

请求示例

GET /v2/fb2e5ec048384c8f9469d22db0037908/sites

响应示例

状态码: 200

查询站点信息的接口。

{
  "site_infos" : [ {
    "site_id" : "string",
    "site_name" : "string",
    "site_type" : "string",
    "project_id" : "string",
    "status" : "string",
    "create_time" : "string",
    "agent_info" : [ {
      "id" : "string",
      "project_id" : "string",
      "site_id" : "string",
      "vag_ip" : "string",
      "private_ip" : "string",
      "private_ipv6" : "string",
      "vag_port_id" : "string",
      "ssh_user" : "gandalf",
      "ssh_pwd" : "string",
      "vm_id" : "string",
      "name" : "string",
      "internal_ip" : "string",
      "internal_ipv6" : "string",
      "internal_port_id" : "string",
      "external_ip" : "string",
      "external_id" : "string",
      "root_user" : "string",
      "root_pwd" : "string",
      "status" : "string",
      "availability_zone" : "string",
      "create_time" : 255,
      "create_time_str" : "string",
      "state" : "string",
      "number_of_online_user" : 20000,
      "running_status" : "string",
      "domain_id" : "string",
      "version" : "string",
      "latest_version" : "string",
      "access_edge_version" : "string",
      "tenant_lock" : 0,
      "resource_pool_id" : "string",
      "role" : "string",
      "resource_pool_type" : "string",
      "edge_sk" : "string",
      "has_heartbeat" : true,
      "user_count" : 0
    } ]
  } ],
  "total_count" : 200000
}

状态码

状态码

描述

200

查询站点信息的接口。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

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

503

服务不可用。

错误码

请参见错误码

相关文档