DescribePortRangeLists-阿里云帮助中心

Queries the port lists.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribePortRangeLists

list

*PortRangeList

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

PortRangeList

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
NextToken	string	No	The pagination token that is used in the request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	727d41872117f2816343eeb432fbc5bfd21dc824589d2a4be0b5e8707e68181f
MaxResults	integer	No	The maximum number of entries per page. Maximum value: 100 Default value: 10.	10
PortRangeListName	string	No	The name of the port list. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http://, https://, com.aliyun, or com.alibabacloud. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	PortRangeListNameSample
PortRangeListId	array	No	The ID of the port list. Valid values of N: 0 to 100.
	string	No	The ID of the port list.	prl-2ze9743****
ResourceGroupId	string	No	The ID of the resource group. If you specify this parameter to query resources, up to 1,000 resources that belong to the specified resource group can be returned in the response. You can call the ListResourceGroups operation to query the most recent resource group list. Note A default resource group is not supported.	rg-bp67acfmxazb4p****
Tag	array<object>	No	The tags that are added to the port list.
	object	No	The tag (key-value pairs) that is added to the port list.
Key	string	No	The key of tag N. Valid values: 1 to 20. If you specify a single tag to query resources, up to 1,000 resources to which the tag is added are returned. If you specify multiple tags to query resources, up to 1,000 resources to which all specified tags are added are returned. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation.	key for PortRangeList
Value	string	No	The value of tag N.	value for PortRangeList

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	A pagination token. If the return value is empty, no more data is returned.	AAAAAdDWBF2
RequestId	string	The request ID.	6040AD98-11C3-5F78-9346-FCA8E9D8960F
PortRangeLists	array<object>	Details of the port lists.
	array<object>	Details of the port list.
PortRangeListId	string	The ID of the port list.	prl-2ze9743****
PortRangeListName	string	The name of the port list.	PortRangeListNameSample
MaxEntries	integer	The maximum number of entries in the port list.	20
AssociationCount	integer	The number of associated resources.	1
Description	string	The description of the port list.	This is description.
CreationTime	string	The time when the port list was created.	2024-12-04T07:11Z
ResourceGroupId	string	The ID of the resource group to which to assign the port list.	rg-2zeg82g****
Tags	array<object>	The tags of the port list.
	object	The tag of the port list.
TagKey	string	The key of tag N.	TestKey
TagValue	string	The value of tag N.	TestValue

Examples

Success response

JSON format

{
  "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"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	LimitExceed.PortRangeListId	The specified number of PortRangeListId exceeds the limit.	The number of port list IDs specified exceeds the limit.
400	InvalidParameter	The specified parameter is not valid.	A specified parameter is invalid.
404	InvalidRegionId.NotFound	The specified parameter RegionId is not valid.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.