ModifyPortRangeList

更新时间:
复制 MD 格式

Modifies the name and entries of a port list. You can call this operation to add, modify, and remove entries for a port list.

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:ModifyPortRangeList

update

*PortRangeList

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

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the port list. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

RegionId

string

Yes

The region ID of the port list. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

ClientToken

string

No

The client token that is used to ensure the idempotence of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

PortRangeListId

string

Yes

The ID of the port list.

prl-2ze9743****

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

Description

string

No

The description of the port list. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

This is description.

AddEntry

array<object>

No

The entries that you want to add or modify for the port list.

object

No

Entry N that you want to add or modify for the port list.

PortRange

string

No

The port range in entry N. Valid values of N: 0 to 200. Take note of the following limits:

  • The total number of entries in the port list cannot exceed the MaxEntries value.

  • PortRange in different entries cannot be duplicated.

  • The value of this parameter cannot be the same as the value of RemoveEntry.N.PortRange.

80/80

Description

string

No

The description of the port range in entry N. The description must be 2 to 32 characters in length and cannot start with http:// or https://. Valid values of N: 0 to 200.

This is description.

RemoveEntry

array<object>

No

The entries that you want to remove from the port list.

object

No

Entry N that you want to remove from the port list.

PortRange

string

No

The port range in entry N. Valid values of N: 0 to 200. Take note of the following limits:

  • PortRange in different entries cannot be duplicated.

  • The value of this parameter cannot be the same as the value of AddEntry.N.PortRange.

80/80

Response elements

Element

Type

Description

Example

object

The data returned.

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidOperation.Conflict The port range list has conflict task. The port list has conflicting tasks.
400 InvalidPortRangeListId.NotFound The specified port range list was not found. The specified port list was not found.
400 InvalidOperation.MaxEntriesCountExceed The specified MaxEntries exceeded the upper limit. The specified MaxEntries parameter exceeds the maximum limit.
400 InvalidOperation.EntryCountExceedMaxEntries The number of entries in the port list exceeds MaxEntries. The number of entries specified exceeds the MaxEntries value of the port list.
400 LimitExceed.MaxEntries The number of entries exceeds the MaxEntries of the specified PortRangeList. The number of entries in the port list exceeds the MaxEntries value.
400 LimitExceed.Entry The number of entries added or removed exceeds the limit. The number of entries to add or remove at a time exceeds the upper limit.
400 InvalidParameter.PortRangeDuplicated The specified PortRange is duplicated. Duplicate port range specified
400 InvalidParameter.PortRangeListName The specified parameter PortRangeListName is not valid. The specified port list name is invalid.
400 InvalidMaxEntries.LessThanCurrentEntries The specified MaxEntries is less than current entries. The maximum number of entries in the port list, which is less than the current number of entries.
400 InvalidParameter.PortRange The specified parameter PortRange is not valid. It should be two integers less than 65535 in specified format. Entries in the port list PortRange not in the required format. Two integers less than 65535 should be specified, separated by a slash.
400 MissingParameter Missing mandatory parameter. Required parameters must be specified.
400 InvalidDescription.Malformed The specifid Description is not valid. The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
403 AuthorizationLimitExceed The limit of authorization records in the security group reaches.
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.