接口功能介绍
该接口提供用户创建安全组功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
企业项目：保证资源隔离，需确保所有资源与云主机处于相同企业项目下才可进行挂载操作，如网络资源：VPC、安全组、弹性IP、子网。请确认安全组是否创建当前企业项目下。
接口约束
当前资源池下，虚拟私有云存在
URI
POST /v4/ecs/vpc/create-security-group
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 客户端存根，用于保证订单幂等性。长度为1-64字符，要求单个云平台账户内唯一，使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求。保留时间为24小时 | create-sg-test-01 | |
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| projectID | 否 | String | 企业项目ID，企业项目管理服务提供统一的云资源按企业项目管理，以及企业项目内的资源管理，成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注：默认值为"0" |
6732237e53bc4591b0e67d750030ebe3 | |
| vpcID | 是 | String | 虚拟私有云ID，您可以查看产品定义-虚拟私有云来了解虚拟私有云 获取： 查 查询VPC列表 创 创建VPC 注：在多可用区类型资源池下，vpcID通常为“vpc-”开头，非多可用区类型资源池vpcID为uuid格式 |
4797e8a1-722d-4996-9362-458001813e41 | |
| name | 是 | String | 安全组名称。长度为2-32个字符。不能以http:和https:开头。 | sg-bp67axxxxzb4p | |
| description | 否 | String | 安全组描述信息。长度为0-128个字符，支持拉丁字母、中文、数字, 特殊字符：！@#￥%……&*（） —— -+={} | 《》？：“”【】、；‘'，。、，不能以http:或者https:开头。注：默认值为空 | 《》？：“”【】、；‘'，。、，不能以http:或者https:开头。注：默认值为空 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | |
| returnObj | Object | 接口业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| securityGroupID | String | 安全组ID | sg-p2qs0qmigm |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：在指定企业项目、虚拟私有云下创建一个安全组在华东1创建一个指定企业项目和虚拟私有云的安全组
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"projectID": "6732237e53bc4591b0e67d750030ebe3"
"description": "openapi_create_sg_test",
"name":"sg-001",
"vpcID":"vpc-chz0ilszsp",
"clientToken": "create-sg-test-01"
}
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description": "成功",
"returnObj":{
"securityGroupID": "sg-p2qs0qmigm"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
