Querying IP Addresses

Function

This API is used to query IP addresses of an endpoint.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/endpoints/{endpoint_id}/ipaddresses

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
endpoint_id	Yes	String	Endpoint ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
ipaddresses	Array of IpaddressesData objects	List data structure

**Table 4** IpaddressesData
Parameter	Type	Description
status	String	Resource status
id	String	Endpoint ID, which is a UUID used to identify the endpoint
ip	String	IP address
create_time	String	The creation time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS
update_time	String	The update time. Format: yyyy-MM-dd'T'HH:mm:ss.SSS
subnet_id	String	Subnet ID
error_info	String	Error message

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Definition Error code Range N/A
message	String	Definition Error description Range N/A

Example Requests

None

Example Responses

Status code: 200

Successful request

{
  "ipaddresses" : [ {
    "status" : "ACTIVE",
    "id" : "ff80808169be2efb0169bef85d740015",
    "ip" : "192.168.0.11",
    "create_time" : "2019-03-27T19:45:41.181",
    "update_time" : "2019-03-27T19:45:42.181",
    "subnet_id" : "485620bd-482a-43e7-9718-410079f860e2",
    "error_info" : null
  }, {
    "status" : "ACTIVE",
    "id" : "ff80808169be2efb0169bef85d740014",
    "ip" : "192.168.0.10",
    "create_time" : "2019-03-27T19:45:41.181",
    "update_time" : "2019-03-27T19:45:42.181",
    "subnet_id" : "485620bd-482a-43e7-9718-410079f860e2",
    "error_info" : null
  } ]
}