Login Management Related Interface

Last Updated：2020-10-10

Description

Specify the latest time and list of virtual machines, and query statistics of log events.

Request structure

POST /v{version}/hosteye/loginmanage/overview?time={time}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

{
    "region" : REGION, //String, "bj"/"gz"/"sz"/hk02"
    "vmList" : [
        {
           "instanceName" : NAME, 	 // String, instance name 
           "instanceId" : NAMEID, 	 // String, instance long id 
           "instanceShortId" : SHORT_ID,     //String, instance short id 
           "internalIp" : "10.130.xx.xx"  ,     //String, intranet ip 
           "publicIp" : "180.xx.xx.xx",       //String, extranet ip 
           "agentStatus" : 0 	 // Int, 0 means offline, 1 means online 
           "crackCount"  : 0 	 // Int, number of interceptions of brute force 
           "abnormalCount"  : 0 	 // Int, number of interceptions of brute force 
           "operation"  : 0 	 	 // Int, 0 means "Re-install", 1 means "View details" 
        },
        ...
	]
}

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
time	int	No	Query parameter	The most recent hours to be queried with default of 24 hours
region	region	String	Yes	RequestBody	Region
vmList	list<VmLoginSummaryModel>	Yes	RequestBody	Statistics of the login events of virtual machines

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
region	region	Region
vmList	list<VmLoginSummaryModel>	Statistics of the login events of virtual machines

Request example

POST /v2/hosteye/loginmanage/overview?time=24&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "region" : REGION, //String, "bj"/"gz"/"sz"/hk02"
    "vmList" : [
        {
           "instanceName" : NAME, 	 // String, instance name 
           "instanceId" : NAMEID, 	 // String, instance long id 
           "instanceShortId" : SHORT_ID,     //String, instance short id 
           "internalIp" : "10.130.xx.xx"  ,     //String, intranet ip 
           "publicIp" : "180.xx.xx.xx",       //String, extranet ip 
           "agentStatus" : 0 	 // Int, 0 means offline, 1 means online 
           "crackCount"  : 0 	 // Int, number of interceptions of brute force 
           "abnormalCount"  : 0 	 // Int, number of interceptions of brute force 
           "operation"  : 0 	 	 // Int, 0 means "Re-install", 1 means "View details" 
        },
        ...
	]
}

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "region" : REGION, //String, "bj"/"gz"/"sz"/hk02"
    "vmList" : [
        {
           "instanceName" : NAME, 	 // String, instance name 
           "instanceId" : NAMEID, 	 // String, instance long id 
           "instanceShortId" : SHORT_ID,     //String, instance short id 
           "internalIp" : "10.130.xx.xx"  ,     //String, intranet ip 
           "publicIp" : "180.xx.xx.xx",       //String, extranet ip 
           "agentStatus" : 0 	 // Int, 0 means offline, 1 means online 
           "crackCount"  : 0 	 // Int, number of interceptions of brute force 
           "abnormalCount"  : 0 	 // Int, number of interceptions of brute force 
           "operation"  : 0 	 	 // Int, 0 means "Re-install", 1 means "View details" 
        },
        ...
    ]
}

Description

Specify the virtual machine long id to get the trend of login times per hour since 00:00.

Request structure

GET /v{version}/hosteye/loginmanage/{instance_uuid}/eventCount?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
t0	int	Login times from 23:00:00 yesterday to 00:00:00 today
t1	int	Login times from 00:00:00 today to 01:00:00 today
..	..	..
t24	int	Login times from 23:00:00 today to 24:00:00 today

Request example

GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/eventCount?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "t0": LOGIN_COUNT_0, //INT, number of login events from 23:00:00 yesterday to 00:00:00 today. key is strings and value is int. 
    "t1": LOGIN_COUNT_1, //INT, number of login events from 00:00:00 today to 01:00:00 today 
	 ...
    "t24": LOGIN_COUNT_24, //INT, number of login events from 23:00:00 today to 24:00:00 today 
}

Description

Specify the latest time. You can select the source IP or login account to query the list of login events.

Request structure

GET /v{version}/hosteye/loginmanage/{instance_uuid}/eventList?time={time}&sourceIp={sourceIp}&loginAccount={loginAccount}&pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id
time	int	No	Query parameter	The most recent hours to be queried with default of 24 hours
pageNo	int	No	Query	Page number with default of 1
pageSize	int	No	Query	Page size with default of 10
sourceIp	String	No	Query	Source IP
loginAccount	String	No	Query	Login account

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
totalCount	int	Number of events
details	list<loginEventModel>	List of login events

Request example

GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/eventList?time=24&pageNo=1&pageSize=10&&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "details": [
        {
            "loginTime": LOGIN_TIME,
            "eventType": EVENT_TYPE, 
            "repeatCount" : REPEAT_COUNT,                                 
            "targetVmid": LOGIN_TIME,     
            "sourceIp": SOURCE_IP, //String, source IP, 
            "ipLocation": LOCATION,        
            "ipStatus" : STATUS,           
            "loginAccount": LOGIN_ACCOUNT, 
            "loginType": LOGIN_TYPE,       
            "loginResult":LOGIN_RESULT,    
            "operationStatus": CMD_STATUS, 
        },
        ...
    ],
    "totalCount": 57 // Int, total number 
}

Add the Source IP to the Whitelist

Description

Add the specified virtual machine long id and source id to the whitelist.

Request structure

POST /v{version}/hosteye/loginmanage/{instance_uuid}/white/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id
ip	String	Yes	URL	Source IP

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

There is no special return parameter.

Request example

POST /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

Remove the Specified Virtual Machine from the Whitelist IP

Description

Remove the specified virtual machine from the whitelist IP.

Request structure

DELETE /v{version}/hosteye/loginmanage/{instance_uuid}/white/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id
ip	String	Yes	URL	Source IP

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

There is no special return parameter.

Request example

DELETE /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

Get the Virtual Machine Whitelist IP List

Description

Get the virtual machine whitelist IP list.

Request structure

GET /v{version}/hosteye/loginmanage/{instance_uuid}/whiteList?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
whiteList	list	Whitelist ip list

Request example

GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/whiteList?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
	'whiteList': [
    	"1.1.1.1", 
    	"2.2.2.2"
    ]
}

Get the IP List of Virtual Machine Denied

Description

Get the IP list of virtual machine denied.

Request structure

GET /v{version}/hosteye/loginmanage/{instance_uuid}/denyList?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
denyList	list	List of denied ips

Request example

GET /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/denyList?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
 
{
	'denyList': [
    	"1.224.150.34", 
    	"115.230.124.21"
    ]
}

Unblock the Specified Virtual Machine IP

Description

Unblock the specified virtual machine IP.

Request structure

PUT /v{version}/hosteye/loginmanage/{instance_uuid}/unblock/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
instance_uuid	String	Yes	URL	Virtual machine long id
ip	String	Yes	URL	Source IP

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

There is no special return parameter.

Request example

PUT /v2/hosteye/loginmanage/ffff2065-460a-498a-8c6e-e771088a0001/unblock/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

Get the List of Whitelist IPs in the Region

Description

Get the list of whitelist IPs in the region.

Request structure

GET /v{version}/hosteye/loginmanage/showWhite?ip={ip}&pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
ip	String	No	Query	Whitelist IP
pageNo	int	No	Query	Page number with default of 1
pageSize	int	No	Query	Page size with default of 10

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
totalCount	int	Total number of whitelist IPs
list	list<LoginWhiteIpModel>	login whitelist ip list

Request example

GET /v2/hosteye/loginmanage/showWhite?ip=1.1.1.1&pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "list":[
        {
            "region":"bj",
            "whiteIp":"1.1.1.1",
            "ipLocation": "Australia", 
            "cmdInProcess":0,
            "applyCount":2,
            "failedCount":0,
            "vmList":[
                {
                    "vmid":"409cc6fa-bcf9-45b9-8c4f-b9ada0a7c06a",
                    "whiteStatus":12,
                    "region":"bj"
                },
                {
                    "vmid":"81d76287-ec0c-4e2d-8ea6-198d8a5a294c",
                    "whiteStatus":12,
                    "region":"bj"
                }
            ]
        }
    ],
    "totalCount":1
}

Get the List of Whitelist IPs in the Global

Description

Get the list of whitelist IPs in the global.

Request structure

GET /v{version}/hosteye/loginmanage/showAllWhite?ip={ip}&pageNo={pageNo}&pageSize={pageSize}&clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
ip	String	No	Query	Whitelist IP
pageNo	int	No	Query	Page number with default of 1
pageSize	int	No	Query	Page size with default of 10

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
totalCount	int	Total number of whitelist IPs
list	list<LoginWhiteIpModel>	login whitelist ip list

Request example

GET /v2/hosteye/loginmanage/showAllWhite?ip=1.1.1.1&pageNo=1&pageSize=10&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "list":[
        {
            "region":"bj",
            "whiteIp":"1.1.1.1",
            "ipLocation": "Australia", 
            "cmdInProcess":0,
            "applyCount":2,
            "failedCount":0,
            "vmList":[
                {
                    "vmid":"409cc6fa-bcf9-45b9-8c4f-b9ada0a7c06a",
                    "whiteStatus":12,
                    "region":"bj"
                },
                {
                    "vmid":"81d76287-ec0c-4e2d-8ea6-198d8a5a294c",
                    "whiteStatus":12,
                    "region":"bj"
                }
            ]
        }
    ],
    "totalCount":1
}

View the Configuration of Whitelist IPs in the Region

Description

View the configuration of whitelist IPs in the region.

Request structure

GET /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
ip	String	Yes	URL	Whitelist IP

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

Parameter name	Type	Description
region	region	Region
vmList	list<VmWhiteStatusModel>	login whitelist ip list

Request example

GET /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "region":"bj",
    "vmList":[
        {
            "vmid":"409cc6fa-bcf9-45b9-8c4f-b9ada0a7c06a",
            "whiteStatus":12
        },
        {
            "vmid":"81d76287-ec0c-4e2d-8ea6-198d8a5a294c",
            "whiteStatus":12
        }
    ]
}

Add Whitelist IP Configuration

Description

Add whitelist IP configuration.

Request structure

POST /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string
{   
    "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
    "vmList": [vmid1, vmid2], // String, such as 9c308f36-dfbd-445a-9443-8a805f16f8c9, 
}

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
ip	String	Yes	URL	Whitelist IP
region	region	Yes	RequestBody	Region
vmList	list <HOSTEYE/API reference/Appendix 1.mdString>	Yes	RequestBody	List of virtual machine long ids

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

There is no special return parameter.

Request example

POST /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
 
{   
    "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
    "vmList": [vmid1, vmid2], // String, such as 9c308f36-dfbd-445a-9443-8a805f16f8c9, 
}

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

Update Whitelist IP Configuration

Description

Update whitelist IP configuration.

Request structure

PUT /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string
 
{   
    "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
    "vmList" : [ 
        { 
            "vmid" : VMID , //String, Instance_uuid
            "currentStatus": OLD_STATUS, // int, 0 means unticked, 1 means ticked 
            "expectedStatus": NEW_STATUS, // int, 0 means unticked, 1 means ticked 
        },
    ]
}

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
ip	String	Yes	URL	Whitelist IP
region	region	Yes	RequestBody	Region
vmList	list<VmUpdateWhiteStatusModel>	Yes	RequestBody	update status list of virtual machine long id

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

There is no special return parameter.

Request example

PUT /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
 
{   
    "region": REGION, //String, "bj"/"gz"/"sz"/"hk02"/
    "vmList" : [ 
        { 
            "vmid" : VMID ,
            "currentStatus" : OLD_STATUS,
            "expectedStatus" : NEW_STATUS,
        },
    ]
}

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

Delete Whitelist IP Configuration

Description

Delete whitelist IP configuration.

Request structure

DELETE /v{version}/hosteye/loginmanage/white/{ip}?clientToken={clientToken} HTTP/1.1
Host: bss.{region}.baidubce.com
Authorization: authorization string

Request header

There are no other special headers except the public headers.

Request parameter

Parameter name	Type	Required or not	Parameter position	Description
version	String	Yes	URL parameter	API version number (the current value is 2)
clientToken	String	Yes	Query parameter	For details of idempotent Token, please see clientToken
ip	String	Yes	URL	Whitelist IP
region	region	Yes	RequestBody	Region
vmList	list<VmUpdateWhiteStatusModel>	Yes	RequestBody	update status list of virtual machine long id

Return status code

Successfully return to 200; for failure, please see Error Code.

Return header

There are no other special headers except the public headers.

Return parameter

There is no special return parameter.

Request example

DELETE /v2/hosteye/loginmanage/white/1.1.1.1?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST bss.{region}.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

Response example

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

Error Code

Website Backdoor Related Interface

百度智能云

Host Security

Login Management Related Interface

Add the Source IP to the Whitelist

Remove the Specified Virtual Machine from the Whitelist IP

Get the Virtual Machine Whitelist IP List

Get the IP List of Virtual Machine Denied

Unblock the Specified Virtual Machine IP

Get the List of Whitelist IPs in the Region

Get the List of Whitelist IPs in the Global

View the Configuration of Whitelist IPs in the Region

Add Whitelist IP Configuration

Update Whitelist IP Configuration

Delete Whitelist IP Configuration

Host Security

Login Management Related Interface

Get Statistics of the Login Events of Virtual Machines

Get Trend of the Login Times of Virtual Machines

Get List of Login Events of Virtual Machines

Add the Source IP to the Whitelist

Remove the Specified Virtual Machine from the Whitelist IP

Get the Virtual Machine Whitelist IP List

Get the IP List of Virtual Machine Denied

Unblock the Specified Virtual Machine IP

Get the List of Whitelist IPs in the Region

Get the List of Whitelist IPs in the Global

View the Configuration of Whitelist IPs in the Region

Add Whitelist IP Configuration

Update Whitelist IP Configuration

Delete Whitelist IP Configuration