全部产品
Search
文档中心

云服务器 ECS:CreateSecurityGroup

更新时间:Sep 12, 2023

调用CreateSecurityGroup新建一个安全组。新建的安全组,默认只允许安全组内的实例互相访问,安全组外的一切通信请求会被拒绝。若您想允许其他安全组实例的通信请求,或者来自互联网的访问请求,需要授权安全组权限(AuthorizeSecurityGroup)。

接口说明

调用该接口时,您需要注意:

  • 在一个阿里云地域下,您最多可以创建100个安全组。
  • 创建专有网络VPC类型的安全组时,您必须指定参数VpcId。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateSecurityGroup

系统规定参数。取值:CreateSecurityGroup

RegionId String cn-hangzhou

安全组所属地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Description String testDescription

安全组描述信息。长度为2~256个英文或中文字符,不能以http://https://开头。

默认值:空。

ClientToken String 123e4567-e89b-12d3-a456-426655440000

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多详情,请参见如何保证幂等性

SecurityGroupName String testSecurityGroupName

安全组名称。

长度为2~128个英文或中文字符。必须以大小写字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。默认值:空。

VpcId String vpc-bp1opxu1zkhn00gzv****

安全组所属VPC ID。

说明 若指定的地域支持经典网络,则允许不指定VpcId,来创建经典网络的安全组;若指定的地域不支持经典网络,则必须指定VpcId,创建专有网络的安全组。
SecurityGroupType String enterprise

安全组类型,分为普通安全组与企业安全组。取值范围:

  • normal:普通安全组。
  • enterprise:企业安全组。更多详情,请参见企业安全组概述
ServiceManaged Boolean false

该参数暂未开放使用。

ResourceGroupId String rg-bp67acfmxazb4p****

安全组所在的企业资源组ID。

Tag.N.key String null

安全组的标签键。

说明 为提高兼容性,建议您尽量使用Tag.N.Key参数。
Tag.N.Key String TestKey

安全组的标签键。

N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyunacs:开头,不能包含http://或者https://

Tag.N.Value String TestValue

安全组的标签值。

N的取值范围:1~20。一旦传入该值,允许为空字符串。最多支持128个字符,不能以acs:开头,不能包含http://或者https://

Tag.N.value String null

安全组的标签值。

说明 为提高兼容性,建议您尽量使用Tag.N.Value参数。

返回数据

名称

类型

示例值

描述

SecurityGroupId String sg-bp1fg655nh68xyz9****

安全组ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=CreateSecurityGroup
&RegionId=cn-hangzhou
&Description=testDescription
&VpcId=vpc-bp1opxu1zkhn00gzv****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSecurityGroupResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <SecurityGroupId>sg-bp1fg655nh68xyz9****</SecurityGroupId>
</CreateSecurityGroupResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "SecurityGroupId" : "sg-bp1fg655nh68xyz9****"
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidDescription.Malformed The specified parameter "Description" is not valid. 指定的资源描述格式不合法。长度为2-256个字符,不能以http://和https://开头。
400 InvalidSecurityGroupName.Malformed Specified security group name is not valid. 指定的安全组名称格式不合法。请您按照规则进行配置:默认值为空,长度为 2-128 个英文或中文字符,必须以大小字母或中文开头,可包含数字,英文句号(.),下划线(_)或连字符(-),安全组名称会展示在控制台。不能以 http:// 和 https:// 开头。
400 InvalidSecurityGroupDiscription.Malformed Specified security group description is not valid. 指定的安全组描述不合法。
400 IncorrectVpcStatus Current VPC status does not support this operation. 当前专有网络 VPC 的状态无法支持这个操作。
400 InvalidTagKey.Malformed Specified tag key is not valid. 指定的标签的键格式错误。
400 InvalidTagValue.Malformed Specified tag value is not valid. 指定的标签的值格式错误。
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. 标签中存在重复的键,请保持键的唯一性。
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 指定的标签键参数有误。
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 指定的标签值参数有误。
400 InvalidParams.GroupType The specified security group type is not valid. 指定的安全组类型无效。请检查 SecurityGroupType 参数值是否正确。
400 InvalidParams.VpcIdGroupType Only VPC instance supports enterprise level security group. 仅 VPC 网络类型的 ECS 实例支持企业级安全组。
403 QuotaExceed.SecurityGroup The maximum number of security groups is reached. 安全组数量超过额度限制。
403 InvalidVpcId.NotFound The VpcId must not empty when only support vpc vm. 指定的 VPC ID 不能为空。
403 IdempotentProcessing The previous idempotent request(s) is still processing. 先前的幂等请求仍在处理中,请稍后重试。
403 QuotaExceed.Tags %s 标签数超过可以配置的最大数量。%s为变量,将根据调用API的实际情况动态返回错误信息。
403 InvalidOperation.ResourceManagedByCloudProduct %s 云产品托管的安全组不支持修改操作。
404 InvalidRegionId.NotFound The specified region does not exist. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。
404 InvalidVpcId.NotFound Specified VPC does not exist. 指定的专有网络 VPC ID 不存在。
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records. 资源组并不在记录中。
404 InvalidRegionId.NotFound The specified parameter RegionId is not valid. 指定的RegionId不存在,请您检查此产品在该地域是否可用。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误,请重试。

访问错误中心查看更多错误码。