AuthorizeSecurityGroupRules

AuthorizeSecurityGroupRules

1. 接口描述

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

注意事项

  • 安全组状态需是Available

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

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

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

  • 关于规则的设定,请注意以下内容:

    • direction字段支持输入ingress或egress。表示规则入方向或出方向。

    • policy字段非必填,默认accept。表示规则访问权限。

    • ipProtocol字段支持输入tcp、udp、icmp、all。表示传输协议。

    • portRange字段支持输入1-65535范围。使用斜线(/)隔开起始端口和终止端口。正确示范:1/200。仅当ipProtocol是tcp、udp协议才允许。

    • 若是icmp或all协议,portRange字段值只允许-1/-1。

    • cidrIp字段支持输入IPv4或CIDR格式的IP地址范围。

2. 请求参数

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

参数名称必选类型描述

securityGroupId

String

安全组ID。

ruleInfos

Array of RuleInfo

安全组规则。

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: AuthorizeSecurityGroupRules
<Common Request Params>

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

Response:
{
  "requestId": "T193B3359-B718-4BA4-A633-5865A2C63ABA",
  "response": {
    "requestId": "T193B3359-B718-4BA4-A633-5865A2C63ABA"
  }
}

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

默认安全组不支持。

最后更新于