查询实例组详情 - ShowPool
功能介绍
查询实例组详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
waf:pool:get
Read
-
g:EnterpriseProjectId
-
-
URI
GET /v1/{project_id}/premium-waf/pool/{pool_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| pool_id | 是 | String | 参数解释: 实例组ID(通过调用WAF的ListPools接口获取所有实例组信息查询实例组ID) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 实例组ID,用于唯一标识一个实例组。 取值范围: 不涉及 |
| name | String | 参数解释: 实例组名称。 取值范围: 不涉及 |
| region | String | 参数解释: 实例组所在的区域(Region)。 取值范围: 不涉及 |
| type | String | 参数解释: 实例组类型。 取值范围: |
| vpc_id | String | 参数解释: 实例组关联的虚拟私有云ID。 取值范围: 不涉及 |
| description | String | 参数解释: 实例组的描述信息。 取值范围: 不涉及 |
| hosts | Array of IdNameEntry objects | 参数解释: 实例组关联的防护域名列表。 取值范围: 不涉及 |
| instances | Array of IdNameEntry objects | 参数解释: 实例组关联的引擎实例列表。 取值范围: 不涉及 |
| enterprise_project_id | String | 参数解释: 实例组关联的企业项目ID。 取值范围: |
| create_time | Long | 参数解释: 实例组创建时间。Unix时间戳格式,单位为毫秒(ms)。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
| details | Array of IAM5ErrorDetails objects | 调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
查询项目id为project_id,实例组ID为pool_id的实例组详情。
GET https://{endpoint}/v1/{project_id}/premium-waf/pool/{pool_id} 响应示例
状态码:200
请求成功
{
"id" : "id_01fc8212735e",
"name" : "name_591ba3909d95",
"region" : "region_fda9ff0a2bbf",
"type" : "type_e26377ec3eef",
"vpc_id" : "vpc_id_175c24dd75fb",
"description" : "description_3d330a56018a",
"hosts" : [ {
"id" : "id_98790a4990a1",
"name" : "www.test.com"
} ],
"instances" : [ {
"id" : "id_ee72b93b0f94",
"name" : "name_78b221e9a884",
"service_ip" : "1.1.1.1"
} ],
"enterprise_project_id" : "0",
"create_time" : 1649217360674
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求失败 |
| 401 | token权限不足 |
| 500 | 服务器内部错误 |
错误码
请参见错误码。