DescribePortRangeLists - 查询端口列表 - 云服务器 ECS

查询端口列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecs:DescribePortRangeLists

list

*PortRangeList

acs:ecs:{#regionId}:{#accountId}:portrangelist/*

PortRangeList

acs:ecs:{#regionId}:{#accountId}:portrangelist/{#portRangeListId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
NextToken	string	否	查询凭证（Token）。取值为上一次调用该接口返回的 NextToken 参数值，初次调用接口时无需设置该参数。	727d41872117f2816343eeb432fbc5bfd21dc824589d2a4be0b5e8707e68181f
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
PortRangeListName	string	否	端口列表的名称。长度为 2~128 个字符，必须以大小字母或中文开头，不能以 http://、https://、com.aliyun 和 com.alibabacloud 开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。	PortRangeListNameSample
PortRangeListId	array	否	端口列表 ID。N 的取值范围：0~100。
	string	否	端口列表 ID。	prl-2ze9743****
ResourceGroupId	string	否	资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。您可以调用 ListResourceGroups 查询资源组列表。说明不支持默认资源组过滤。	rg-bp67acfmxazb4p****
Tag	array<object>	否	端口列表绑定的标签数组。
	object	否	端口列表绑定的标签键值对信息。
Key	string	否	实例的标签键。N 的取值范围为 1~20。使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。	key for PortRangeList
Value	string	否	标签值。	value for PortRangeList

返回参数

名称	类型	描述	示例值
	object	返回参数信息集合。
NextToken	string	本次调用返回的查询凭证（Token）。当该返回值为空时，表示无更多返回的数据信息。	AAAAAdDWBF2
RequestId	string	请求 ID。	6040AD98-11C3-5F78-9346-FCA8E9D8960F
PortRangeLists	array<object>	端口列表信息组成的数组。
	array<object>	端口列表信息集合。
PortRangeListId	string	端口列表 ID。	prl-2ze9743****
PortRangeListName	string	端口列表的名称。	PortRangeListNameSample
MaxEntries	integer	端口列表支持的最大条目容量。	20
AssociationCount	integer	关联资源的数量。	1
Description	string	端口列表的描述信息。	This is description.
CreationTime	string	端口列表的创建时间。	2024-12-04T07:11Z
ResourceGroupId	string	端口列表所在的企业资源组 ID。	rg-2zeg82g****
Tags	array<object>	端口列表的标签组成的数组。
	object	端口列表的标签集合。
TagKey	string	端口列表的标签键。	TestKey
TagValue	string	端口列表的标签值。	TestValue

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAdDWBF2",
  "RequestId": "6040AD98-11C3-5F78-9346-FCA8E9D8960F",
  "PortRangeLists": [
    {
      "PortRangeListId": "prl-2ze9743****",
      "PortRangeListName": "PortRangeListNameSample",
      "MaxEntries": 20,
      "AssociationCount": 1,
      "Description": "This is description.",
      "CreationTime": "2024-12-04T07:11Z",
      "ResourceGroupId": "rg-2zeg82g****",
      "Tags": [
        {
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	LimitExceed.PortRangeListId	The specified number of PortRangeListId exceeds the limit.	指定的端口列表ID数量超出了数量限制。
400	InvalidParameter	The specified parameter is not valid.	无效的参数，请检查该参数是否正确。
404	InvalidRegionId.NotFound	The specified parameter RegionId is not valid.	指定的RegionId不存在，请您检查此产品在该地域是否可用。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。