AuthorizeSecurityGroupRule

AuthorizeSecurityGroupRule

1. 接口描述

本接口用于新增安全组单条规则。

注意事项

• 安全组状态需是Available。

• 默认安全组不支持修改。

• 同一规则方向，规则不能重复。

• 安全组的规则数量最多40条，入方向最多20条、出方向最多20条。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
securityGroupId	是	String	安全组ID。
direction	是	String	规则方向。 ingress: 入方向 egress：出方向
policy	否	String	设置访问权限。取值范围： accept（默认值）：接受访问。 目前只支持accept。
ipProtocol	是	String	传输层协议。取值大小写敏感。取值范围： tcp：TCP协议。 udp：UDP协议。 icmp：ICMP协议。 all：支持所有协议。
portRange	是	String	目的端安全组开放的传输层协议相关的端口范围。取值范围： TCP/UDP协议：取值范围为1~65535。使用斜线（/）隔开起始端口和终止端口。正确示范：1/200；错误示范：200/1。 ICMP协议：-1/-1。 all： -1/-1。
cidrIp	是	String	源端IP地址范围。支持CIDR格式和IPv4格式的IP地址范围。默认值：0.0.XX.XX/0。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

示例

1. 新增SecurityGroup的规则。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: AuthorizeSecurityGroupRule
<Common Request Params>

Request:
{
  "securityGroupId": "your-security-group-id",
  "direction": "egress",
  "policy": "accept",
  "ipProtocol": "tcp",
  "portRange": "22/22",
  "cidrIp": "0.0.0.0/0"
}

Response:
{
  "requestId": "T79B0A6A1-2921-4702-8F48-46C0541744FC",
  "response": {
    "requestId": "T79B0A6A1-2921-4702-8F48-46C0541744FC"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
400	INVALID_PARAMETER_SECURITY_GROUP_RULE_ID_NOT_ALLOW	安全组规则ID不允许传。
400	INVALID_PARAMETER_SECURITY_GROUP_POLICY	安全组规则Policy参数错误。
400	INVALID_PARAMETER_SECURITY_GROUP_PORT_RANGE	安全组规则PortRange参数错误。
400	INVALID_PARAMETER_SECURITY_GROUP_PRIORITY	安全组规则Priority参数错误。
400	INVALID_PARAMETER_SECURITY_GROUP_SOURCE_CIDR_IP	安全组规则SourceCidrIp参数错误。
403	OPERATION_DENIED_SECURITY_GROUP_EXIST_REPEAT_RULE	安全组规则存在重复。
404	INVALID_SECURITY_GROUP_NOT_FOUND	指定的安全组不存在。
403	OPERATION_DENIED_SECURITY_GROUP_STATUS_NOT_AVAILABLE	安全组状态不是Available。
403	OPERATION_DENIED_SECURITY_GROUP_RULE_EXCEED_LIMIT	安全组规则超过限制。
403	OPERATION_DENIED_DEFAULT_SECURITY_GROUP_NOT_SUPPORT	默认安全组不支持。