Updated on 2025-07-14 GMT+08:00

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.

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

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

ports

Array of NeutronPort objects

Port list.

Table 5 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 6 FixedIp

Parameter

Type

Description

subnet_id

String

Subnet ID.

ip_address

String

Port IP address.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

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 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

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 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

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 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

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, see the error code description.

Error Codes

See Error Codes.