All Products
Search
Document Center

ENS:AuthorizeSecurityGroup

Last Updated:Nov 18, 2024

Creates an inbound security group rule. This operation allows or denies the inbound traffic from other devices to instances in the security group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:AuthorizeSecurityGroupupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IpProtocolstringYes

The transport layer protocol. The values of this parameter are case-sensitive. Valid values:

  • tcp
  • udp
  • icmp
  • gre
  • all: All protocols are supported.
all
PortRangestringYes

The range of destination ports that correspond to the transport layer protocol for security group rule N. Valid values:

  • When the IpProtocol parameter is set to tcp or udp, the port number range is 1 to 65535. The start port number and the end port number are separated by a forward slash (/). Correct example: 1/200. Incorrect example: 200/1.
  • When the IpProtocol parameter is set to icmp, the port number range is -1/-1, which indicates all ports.
  • When the IpProtocol parameter is set to gre, the port number range is -1/-1, which indicates all ports.
  • When the IpProtocol parameter is set to all, the port number range is -1/-1, which indicates all ports.
22/22
SecurityGroupIdstringYes

The ID of the security group.

sg-bp67acfmxazb4ph***
PolicystringNo

The action of security group rule N that determines whether to allow inbound access. Valid values:

  • accept: allows access.
  • drop: denies access and returns no responses.

Default value: accept.

accept
PriorityintegerNo

The priority of security group rule N. Valid values: 1 to 100.

Default value: 1.

1
SourceCidrIpstringYes

The source IPv4 CIDR block. CIDR blocks and IPv4 addresses are supported.

This parameter is empty by default.

10.0.XX.XX/8
SourcePortRangestringNo

The range of port numbers that correspond to the transport layer protocol for the source security group. Valid values:

  • When the IpProtocol parameter is set to tcp or udp, the port number range is 1 to 65535. The start port number and the end port number are separated by a forward slash (/). Correct example: 1/200. Incorrect example: 200/1.
  • When the IpProtocol parameter is set to icmp, the port number range is -1/-1, which indicates all ports.
  • When the IpProtocol parameter is set to gre, the port number range is -1/-1, which indicates all ports.
  • When the IpProtocol parameter is set to all, the port number range is -1/-1, which indicates all ports.
22/22

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400InvalidSecurityGroupId.NotFoundThe specified SecurityGroupId does not exist.-
400SecurityGroupRuleConflict.DuplicatedThe SecurityGroup rule already exists.-
400AuthorizationLimitExceedThe limit of authorization records in the security group reaches.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-09-05The Error code has changedView Change Details
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details