登录管理相关接口
更新时间：2019-06-14
获取虚机登录事件统计结果
描述
- 指定最近时间time, 以及虚机列表，查询登录事件统计数据
请求结构
Plain Text
1POST /v{version}/hosteye/loginmanage/overview?time={time}&clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string
4
5{
6 "region" : REGION, //String，"bj"/"gz"/"sz"/hk02"
7 "vmList" : [
8 {
9 "instanceName" : NAME, // String, 实例名称
10 "instanceId" : NAMEID, //String, 实例长id
11 "instanceShortId" : SHORT_ID, //String, 实例短id
12 "internalIp" : "10.130.xx.xx" , //String, 内网ip
13 "publicIp" : "180.xx.xx.xx", //String, 外网ip
14 "agentStatus" : 0 //Int, 0代表离线，1代表在线
15 "crackCount" : 0 //Int, 暴力破解拦截次数
16 "abnormalCount" : 0 //Int, 暴力破解拦截次数
17 "operation" : 0 //Int, 0代表"重新安装", 1代表"查看详情"
18 },
19 ...
20 ]
21}请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 | |
|---|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 | |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken | |
| time | int | 否 | Query参数 | 查询的最近小时数，默认为24小时 | |
| region | region | String | 是 | RequestBody | 区域 |
| vmList | list<VmLoginSummaryModel> | 是 | RequestBody | 虚机登录事件统计数据 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| region | region | 区域 |
| vmList | list<VmLoginSummaryModel> | 虚机登录事件统计数据 |
请求示例
Plain Text
1POST /v2/hosteye/loginmanage/overview?time=24&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "region" : REGION, //String，"bj"/"gz"/"sz"/hk02"
7 "vmList" : [
8 {
9 "instanceName" : NAME, // String, 实例名称
10 "instanceId" : NAMEID, //String, 实例长id
11 "instanceShortId" : SHORT_ID, //String, 实例短id
12 "internalIp" : "10.130.xx.xx" , //String, 内网ip
13 "publicIp" : "180.xx.xx.xx", //String, 外网ip
14 "agentStatus" : 0 //Int, 0代表离线，1代表在线
15 "crackCount" : 0 //Int, 暴力破解拦截次数
16 "abnormalCount" : 0 //Int, 暴力破解拦截次数
17 "operation" : 0 //Int, 0代表"重新安装", 1代表"查看详情"
18 },
19 ...
20 ]
21}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "region" : REGION, //String，"bj"/"gz"/"sz"/hk02"
10 "vmList" : [
11 {
12 "instanceName" : NAME, // String, 实例名称
13 "instanceId" : NAMEID, //String, 实例长id
14 "instanceShortId" : SHORT_ID, //String, 实例短id
15 "internalIp" : "10.130.xx.xx" , //String, 内网ip
16 "publicIp" : "180.xx.xx.xx", //String, 外网ip
17 "agentStatus" : 0 //Int, 0代表离线，1代表在线
18 "crackCount" : 0 //Int, 暴力破解拦截次数
19 "abnormalCount" : 0 //Int, 暴力破解拦截次数
20 "operation" : 0 //Int, 0代表"重新安装", 1代表"查看详情"
21 },
22 ...
23 ]
24}获取虚机登录次数趋势
描述
- 指定虚机长id, 获取0点以来每小时统计的登录次数趋势。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/{instance_uuid}/eventCount?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| t0 | int | 昨日23:00:00至今日00:00:00间登录次数 |
| t1 | int | 今日00:00:00至今日01:00:00间登录次数 |
| .. | .. | .. |
| t24 | int | 今日23:00:00至今日24:00:00间登录次数 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/eventCount?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "t0": LOGIN_COUNT_0, //INT,昨日23:00:00至今日00:00:00间登录事件计数. key为字符串，value为int.
10 "t1": LOGIN_COUNT_1, //INT,今日00:00:00至今日01:00:00间登录事件计数
11 ...
12 "t24": LOGIN_COUNT_24, //INT,今日23:00:00至今日24:00:00间登录事件计数
13} 获取虚机登录事件列表
描述
- 指定最近时间time, 可选指定源IP或登录账号，查询登录事件列表。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/{instance_uuid}/eventList?time={time}&sourceIp={sourceIp}&loginAccount={loginAccount}&pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
| time | int | 否 | Query参数 | 查询的最近小时数，默认为24小时 |
| pageNo | int | 否 | Query | 页号，默认为1 |
| pageSize | int | 否 | Query | 页大小，默认为10 |
| sourceIp | String | 否 | Query | 来源IP |
| loginAccount | String | 否 | Query | 登录账号 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| totalCount | int | 总事件数目 |
| details | list<loginEventModel> | 登录事件列表 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/eventList?time=24&pageNo=1&pageSize=10&&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "details": [
10 {
11 "loginTime": LOGIN_TIME,
12 "eventType": EVENT_TYPE,
13 "repeatCount" : REPEAT_COUNT,
14 "targetVmid": LOGIN_TIME,
15 "sourceIp": SOURCE_IP, //String,来源IP，
16 "ipLocation": LOCATION,
17 "ipStatus" : STATUS,
18 "loginAccount": LOGIN_ACCOUNT,
19 "loginType": LOGIN_TYPE,
20 "loginResult":LOGIN_RESULT,
21 "operationStatus": CMD_STATUS,
22 },
23 ...
24 ],
25 "totalCount": 57 //Int,总数
26}来源IP一键加白
描述
- 对指定虚机长id和来源IP加白。
请求结构
Plain Text
1POST /v{version}/hosteye/loginmanage/{instance_uuid}/white/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
| ip | String | 是 | URL | 来源IP |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1POST /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS指定虚机移除白名单IP
描述
- 将指定虚机移除白名单IP。
请求结构
Plain Text
1DELETE /v{version}/hosteye/loginmanage/{instance_uuid}/white/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
| ip | String | 是 | URL | 来源IP |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1DELETE /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS获取虚机白名单IP列表
描述
- 获取虚机白名单IP列表。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/{instance_uuid}/whiteList?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| whiteList | list |
白名单ip列表 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/whiteList?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 'whiteList': [
10 "1.1.1.1",
11 "2.2.2.2"
12 ]
13}获取虚机封禁IP列表
描述
- 获取虚机封禁IP列表。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/{instance_uuid}/denyList?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| denyList | list |
封禁ip列表 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/denyList?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 'denyList': [
10 "1.224.150.34",
11 "115.230.124.21"
12 ]
13}指定虚机解封禁某IP
描述
- 对指定虚机IP进行解封禁。
请求结构
Plain Text
1PUT /v{version}/hosteye/loginmanage/{instance_uuid}/unblock/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| instance_uuid | String | 是 | URL | 虚机长id |
| ip | String | 是 | URL | 来源IP |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1PUT /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/unblock/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS获取区域白名单IP列表
描述
- 获取区域白名单IP列表。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/showWhite?ip={ip}&pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| ip | String | 否 | Query | 白名单IP |
| pageNo | int | 否 | Query | 页号，默认为1 |
| pageSize | int | 否 | Query | 页大小，默认为10 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| totalCount | int | 白名单ip总数目 |
| list | list<LoginWhiteIpModel> | 登录白名单ip列表 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/showWhite?ip=1.1.1.1&pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "list":[
10 {
11 "region":"bj",
12 "whiteIp":"1.1.1.1",
13 "ipLocation":"澳大利亚",
14 "cmdInProcess":0,
15 "applyCount":2,
16 "failedCount":0,
17 "vmList":[
18 {
19 "vmid":"409cc6fa-bcf9-45b9-8c4f-b9ada0a7c06a",
20 "whiteStatus":12,
21 "region":"bj"
22 },
23 {
24 "vmid":"81d76287-ec0c-4e2d-8ea6-198d8a5a294c",
25 "whiteStatus":12,
26 "region":"bj"
27 }
28 ]
29 }
30 ],
31 "totalCount":1
32}获取全局白名单IP列表
描述
- 获取全局白名单IP列表。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/showAllWhite?ip={ip}&pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| ip | String | 否 | Query | 白名单IP |
| pageNo | int | 否 | Query | 页号，默认为1 |
| pageSize | int | 否 | Query | 页大小，默认为10 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| totalCount | int | 白名单ip总数目 |
| list | list<LoginWhiteIpModel> | 登录白名单ip列表 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/showAllWhite?ip=1.1.1.1&pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "list":[
10 {
11 "region":"bj",
12 "whiteIp":"1.1.1.1",
13 "ipLocation":"澳大利亚",
14 "cmdInProcess":0,
15 "applyCount":2,
16 "failedCount":0,
17 "vmList":[
18 {
19 "vmid":"409cc6fa-bcf9-45b9-8c4f-b9ada0a7c06a",
20 "whiteStatus":12,
21 "region":"bj"
22 },
23 {
24 "vmid":"81d76287-ec0c-4e2d-8ea6-198d8a5a294c",
25 "whiteStatus":12,
26 "region":"bj"
27 }
28 ]
29 }
30 ],
31 "totalCount":1
32} 查看区域白名单IP配置
描述
- 查看区域白名单IP配置。
请求结构
Plain Text
1GET /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| ip | String | 是 | URL | 白名单IP |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| region | region | 区域 |
| vmList | list<VmWhiteStatusModel> | 登录白名单ip列表 |
请求示例
Plain Text
1GET /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "region":"bj",
10 "vmList":[
11 {
12 "vmid":"409cc6fa-bcf9-45b9-8c4f-b9ada0a7c06a",
13 "whiteStatus":12
14 },
15 {
16 "vmid":"81d76287-ec0c-4e2d-8ea6-198d8a5a294c",
17 "whiteStatus":12
18 }
19 ]
20}添加白名单IP配置
描述
- 添加白名单IP配置。
请求结构
Plain Text
1POST /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string
4{
5 "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
6 "vmList" : [vmid1, vmid2], //String, 如9c308f36-dfbd-445a-9443-8a805f16f8c9,
7}请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| ip | String | 是 | URL | 白名单IP |
| region | region | 是 | RequestBody | 区域 |
| vmList | list<HOSTEYE/API参考/附录1.mdString> | 是 | RequestBody | 虚机长id列表 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1POST /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
7 "vmList" : [vmid1, vmid2], //String, 如9c308f36-dfbd-445a-9443-8a805f16f8c9,
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS更新白名单IP配置
描述
- 更新白名单IP配置。
请求结构
Plain Text
1PUT /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string
4
5{
6 "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
7 "vmList" : [
8 {
9 "vmid" : VMID , //String，Instance_uuid
10 "currentStatus" : OLD_STATUS, / /int, 0 代表未勾选， 1 代表被勾选
11 "expectedStatus" : NEW_STATUS, // int, 0 代表未勾选，1代表被勾选
12 },
13 ]
14}请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| ip | String | 是 | URL | 白名单IP |
| region | region | 是 | RequestBody | 区域 |
| vmList | list<VmUpdateWhiteStatusModel> | 是 | RequestBody | 虚机长id更新状态列表 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1PUT /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6 "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
7 "vmList" : [
8 {
9 "vmid" : VMID ,
10 "currentStatus" : OLD_STATUS,
11 "expectedStatus" : NEW_STATUS,
12 },
13 ]
14}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS删除白名单IP配置
描述
- 删除白名单IP配置。
请求结构
Plain Text
1DELETE /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
2Host: bss.{region}.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值2 |
| clientToken | String | 是 | Query参数 | 幂等性Token，详见clientToken |
| ip | String | 是 | URL | 白名单IP |
| region | region | 是 | RequestBody | 区域 |
| vmList | list<VmUpdateWhiteStatusModel> | 是 | RequestBody | 虚机长id更新状态列表 |
返回状态码
成功返回200，失败返回见错误码。
返回头域
除公共头域外，无其他特殊头域。
返回参数
无特殊返回参数。
请求示例
Plain Text
1DELETE /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2HOST bss.{region}.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS