文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 网络/ 查询端口列表 - ListPorts
更新时间：2025-12-29 GMT+08:00
查看PDF
分享

查询端口列表 - ListPorts

功能介绍

查询端口列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:networks:listPorts

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/ports

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

分页查询的起始资源ID。

limit

否

Integer

功能说明：每页返回的个数。取值范围：1~2000。默认值：2000。

ip_address

否

String

ip地址。

subnet_id

否

String

子网ID。

is_used

否

Boolean

是否被使用。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

ports

Array of NeutronPort objects

端口列表。
表5 NeutronPort

参数

参数类型

描述

id

String

端口唯一标识。

status

String

私有ip状态。

network_id

String

端口所属网络的ID。

device_id

String

端口所属设备的Id。

fixed_ips

Array of FixedIp objects

端口IP。
表6 FixedIp

参数

参数类型

描述

subnet_id

String

所属子网ID。

ip_address

String

端口IP地址。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

无

响应示例

状态码：200

校验结果。

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

状态码

状态码

描述

200

校验结果。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 网络