防护边界实例列表
更新时间：2024-05-30
描述
查询防护边界实例的列表。
请求结构
GET /v{version}/cfw/instance?instanceType=nat HTTP/1.1
Host: cfw.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| instanceType | String | 是 | Query参数 | 实例类型，取值[ eip | nat | etGateway | peerconn | csn | ipv6Gateway ] |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | Integer | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
| status | String | 否 | Query参数 | 防护状态，取值 [ unbound | protected | unprotected ] |
| region | String | 否 | Query参数 | 地域信息，取值 [ bj | gz | su | fsh | hkg | bd | fwh | sin ] |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
| instances | List<Instance> | 防护实例列表 |
请求示例
GET /v1/cfw/instance?marker=nat-bmqiw94bc5h&instanceType=nat HTTP/1.1
Host: cfw.baidubce.com
Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/20220316T06:27:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca74ad5451d921571cb844c0a50
Date: Thu, 16 Mar 2022 06:29:48 GMT
Content Type: application/json;charset=UTF 8
Server: BWS
{
"marker": "nat-bmqiw94bc5h",
"isTruncated": false,
"maxKeys": 1000,
"instances": [
{
"instanceId": "nat-bmqiw94bc5h8",
"instanceName": "bgvhjghvnfv",
"region": "bj",
"cfwId": "cfw-sbn3tjuqhvnx",
"cfwName": "cfw_2",
"status": "protected"
}
]
}