接口功能介绍
该接口提供用户修改安全组入方向规则描述的功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
当前资源池下,安全组、安全组规则存在(即参数securityGroupID、securityGroupRuleID真实存在,且与regionID对应)
URI
POST /v4/ecs/vpc/modify-security-group-ingress
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
securityGroupID | 是 | String | 安全组ID,您可以查看安全组概述了解安全组相关信息 获取: 查 查询用户安全组列表 创 创建安全组 |
sg-bp67axxxxzb4p | |
securityGroupRuleID | 是 | String | 安全组入向规则ID,获取: 查 查询用户安全组详情 创 创建安全组入向规则 注:在多可用区类型资源池下,安全组ID通常以“sg-”开头,非多可用区类型资源池安全组ID为uuid格式 |
79fa97e3-c48b-xxxxx-9f46-6a13d8163678 | |
description | 否 | String | 安全组规则描述信息,满足以下规则: ① 长度0-128字符, ② 支持拉丁字母、中文、数字, 特殊字符 !@#¥%……&*()——-+={}《》?:“”【】、;‘',。、 不能以 http: / https: 开头 |
modify_test | |
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。长度为1-64字符,要求单个云平台账户内唯一,使用同一个ClientToken值,其他请求参数相同时,则代表为同一个请求。保留时间为24小时 | 123e4567-e89b-12d3-a456-426655440000 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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一个安全组的入向规则描述
{
"securityGroupID":"sg-p2qs0qmigm",
"regionID":"bb9fdb42056f11eda1610242ac110002",
"securityGroupRuleID":"79fa97e3-c48b-xxxxx-9f46-6a13d8163678",
"description":"openapi_modify_test_02",
"clientToken": "openapi_modify_security_group_rule_description_02"
}
响应示例
{
"statusCode":800,
"description":"成功",
"errorCode":"SUCCESS",
"message":"success"
}
状态码
请参考 状态码
错误码
请参考 错误码