查询WAF独享引擎状态列表 - ListInstanceStatus
功能介绍
查询WAF独享引擎状态列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/premium-waf/instance/status
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围: 默认取值: 0 |
|
page |
否 |
Integer |
参数解释: 分页查询时,返回第几页数据 约束限制: 不涉及 取值范围: page参数的实际有效范围取决于总数据量和pagesize的取值,不能大于总页数 默认取值: 1 |
|
pagesize |
否 |
Integer |
参数解释: 分页查询时,每页包含的结果条数 约束限制: 不涉及 取值范围: [0, 总数据量] 默认取值: 10 |
|
instance_ids |
否 |
Array of strings |
参数解释: 模糊查询,独享引擎名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
run_status |
否 |
Integer |
参数解释: 实例运行状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
Content-Type |
否 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
purchased |
Boolean |
是否已购买独享引擎 |
|
total |
Integer |
总数 |
|
items |
Array of PremiumWafInstanceStatusResponse objects |
引擎实例状态信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
实例id |
|
instance_name |
String |
实例名称 |
|
status |
Integer |
参数解释: 实例计费状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
run_status |
Integer |
参数解释: 实例运行状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
|
access_status |
Integer |
参数解释: 实例接入状态 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
状态码: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的WAF独享引擎状态列表
GET https://{endpoint}/v1/{project_id}/premium-waf/instance/status
响应示例
状态码:200
独享引擎状态信息列表
{
"purchased" : true,
"total" : 1,
"items" : [ {
"id" : "id_a5e73ee6dd7a",
"instance_name" : "instance_name_f436e2bbd146",
"status" : 0,
"run_status" : 0,
"access_status" : 0
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
独享引擎状态信息列表 |
|
400 |
请求失败 |
|
401 |
token权限不足 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。