Querying Ports

Function

Queries ports.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:networks:listPorts	List	-	-	-	-

URI

GET /v2/{project_id}/ports

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Resource ID at the beginning for pagination query.
limit	No	Integer	Specifies the number of records displayed on each page. The value ranges from 1 to 2,000. Default value: 2,000.
ip_address	No	String	IP address.
subnet_id	No	String	Subnet ID.
is_used	No	Boolean	Whether to use or not.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
ports	Array of NeutronPort objects	Port list.

**Table 4** NeutronPort
Parameter	Type	Description
id	String	Port ID that uniquely identifies the port.
status	String	Private IP address status.
network_id	String	ID of the network where the port is.
device_id	String	ID of the device to which the port belongs.
fixed_ips	Array of FixedIp objects	Port IP address.

**Table 5** FixedIp
Parameter	Type	Description
subnet_id	String	Subnet ID.
ip_address	String	Port IP address.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

None

Example Responses

Status code: 200

Verification result.

{
  "ports" : [ {
    "id" : "string",
    "status" : "string",
    "network_id" : "string",
    "fixed_ips" : [ {
      "subnet_id" : "string",
      "ip_address" : "string"
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Verification result.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.