Querying the SSH Login IP Address Whitelist

Function

This API is used to query the SSH login IP address whitelist.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/setting/login-white-ip

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
white_ip	No	String	Whitelisted IP address or IP CIDR block. An IP CIDR block consists of an IP address and a mask, which are separated by a slash (/).

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number of SSH login IP address whitelists
data_list	Array of LoginWhiteIpResponseInfo objects	List of SSH login IP address whitelists

**Table 5** LoginWhiteIpResponseInfo
Parameter	Type	Description
enabled	Boolean	Whitelist status. The options are as follows: true: enabled false: disabled
white_ip	String	Whitelisted IP address or IP CIDR block. An IP CIDR block consists of an IP address and a mask, which are separated by a slash (/).
total_num	Integer	Total number of server IDs
host_id_list	Array of strings	Server ID list

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "enabled" : true,
    "white_ip" : "192.78.***.0/255.255.255.0",
    "total_num" : 1,
    "host_id_list" : [ "81***56f-6264-4d3f-9c81-be8e93****ce6" ]
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Server Installation and Configuration

Previous topic: Adding, Editing, or Deleting a Common Login Location

Next topic: Managing Login IP Addresses

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot