接口功能介绍
该接口提供用户创建安全组入向规则功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
注意事项:
入向规则:direction参数填写”ingress“
接口约束
当前资源池下,安全组存在(即参数securityGroupID真实存在,且与regionID对应)
URI
POST /v4/ecs/vpc/create-security-group-ingress
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
securityGroupID | 是 | String | 安全组ID,您可以查看安全组概述了解安全组相关信息 获取: 查 查询用户安全组列表 创 创建安全组 |
sg-bp67axxxxzb4p | |
securityGroupRules | 是 | Array of Objects | 规则信息列表,您可以查看安全组概述了解安全组相关配置 | securityGroupRules | |
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。长度为1-64字符,要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | 123e4567-e89b-12d3-a456-426655440000 |
表 securityGroupRules
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
direction | 是 | String | 规则方向,入方向则填写ingress | ingress | |
action | 是 | String | 授权策略,取值范围:accept(允许),drop(拒绝)。 | accept | |
priority | 否 | Integer | 优先级,取值范围:[1, 100] 注:取值越小优先级越大。 |
100 | |
protocol | 是 | String | 网络协议,取值范围:ANY(任意)、TCP、UDP、ICMP(v4) | ANY | |
ethertype | 是 | String | IP类型,取值范围:IPv4、IPv6 | IPv4 | |
destCidrIp | 是 | String | 远端地址:0.0.0.0/0 | 0.0.0.0/0 | |
description | 否 | String | 安全组规则描述信息,满足以下规则: ① 长度0-128字符, ② 支持拉丁字母、中文、数字, 特殊字符 !@#¥%……&*()——-+={}《》?:“”【】、;‘',。、 不能以 http: / https: 开头 |
出方向 | |
range | 否 | String | 安全组开放的传输层协议相关的源端端口范围 | 8000-9000 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | String | statusCode为900时的错误信息,英文 | success | |
description | String | statusCode为900时的错误信息,中文 | 成功 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1:创建一个入向允许策略
在华东1一安全组上创建入向允许策略,优先级为5,网络协议为TCP协议,IP类型为IPv4,远端地址为任意地址,端口号范围为1-10000
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"securityGroupID":"sg-p2qs0qmigm",
"clientToken":"openapi-create-security-group-egress-test-01",
"securityGroupRules":[
{
"direction":"ingress",
"action":"accept",
"priority":5,
"protocol":"TCP",
"ethertype":"IPv4",
"destCidrIp":"0.0.0.0/0",
"description":"openapi-test-01",
"range":"1-10000"
}
]
}
示例2:创建一个入向拒绝策略
在华东1一安全组上创建入向拒绝策略,优先级为10,网络协议为UDP协议,IP类型为IPv6,远端地址为任意地址,端口号范围为所有端口
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"securityGroupID":"sg-p2qs0qmigm",
"clientToken":"openapi-create-security-group-egress-test-02",
"securityGroupRules":[
{
"direction":"ingress",
"action":"drop",
"priority":10,
"protocol":"UDP",
"ethertype":"IPv6",
"destCidrIp":"0.0.0.0/0",
"description":"openapi-test-02",
"range":"1-65535"
}
]
}
响应示例
{
"statusCode":800,
"description":"成功",
"errorCode":"SUCCESS",
"message":"success"
}
状态码
请参考 状态码
错误码
请参考 错误码