本接口用于創建一個安全組。
接口說明
- 通過該接口創建的普通安全組組內連通策略默認是組內互通,您可以通過 ModifySecurityGroupPolicy 進行修改。
- 通過該接口創建的企業安全組組內連通策略默認是組內隔離,并且不能修改。
- 單個地域下,安全組的數量有限制,您最少可以創建 100 個安全組。詳細信息,請參見安全組使用限制。
- 創建專有網絡 VPC 類型的安全組時,您必須指定參數 VpcId。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:CreateSecurityGroup | create | *SecurityGroup acs:ecs:{#regionId}:{#accountId}:securitygroup/* *VPC acs:vpc:{#regionId}:{#accountId}:vpc/{#vpcId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 安全組所屬地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
Description | string | 否 | 安全組描述信息。長度為 2~256 個英文或中文字符,不能以 默認值:空。 | testDescription |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符,且不能超過 64 個字符。更多詳情,請參見如何保證冪等性。 | 123e4567-e89b-12d3-a456-426655440000 |
SecurityGroupName | string | 否 | 安全組名稱。長度為 2~128 個字符,必須以大小寫字母或中文開頭,不能以 | testSecurityGroupName |
VpcId | string | 否 | 安全組所屬 VPC ID。 說明
若指定的地域支持經典網絡,則允許不指定 VpcId,來創建經典網絡的安全組;若指定的地域不支持經典網絡,則必須指定 VpcId,創建專有網絡的安全組。
| vpc-bp1opxu1zkhn00gzv**** |
SecurityGroupType | string | 否 | enterprise | |
ServiceManaged | boolean | 否 | 該參數暫未開放使用。 | false |
ResourceGroupId | string | 否 | 安全組所在的企業資源組 ID。 | rg-bp67acfmxazb4p**** |
Tag | array<object> | 否 | 安全組綁定的標簽數組。數組長度:0~20。 | |
object | 否 | 安全組綁定的標簽。 | ||
key | string | 否 | 安全組的標簽鍵。 說明
為提高兼容性,建議您盡量使用 Tag.N.Key 參數。
| null |
Key | string | 否 | 安全組的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 128 個字符,不能以 | TestKey |
Value | string | 否 | 安全組的標簽值。 一旦傳入該值,允許為空字符串。最多支持 128 個字符,不能包含 | TestValue |
value | string | 否 | 安全組的標簽值。 說明
為提高兼容性,建議您盡量使用 Tag.N.Value 參數。
| null |
返回參數
示例
正常返回示例
JSON
格式
{
"SecurityGroupId": "sg-bp1fg655nh68xyz9****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidDescription.Malformed | The specified parameter "Description" is not valid. | 指定的資源描述格式不合法。長度為2-256個字符,不能以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 實例支持企業級安全組。 |
400 | InvalidSecurityGroupName.Malformed | The specified parameter SecurityGroupName is not valid. | 指定的安全組名稱格式不合法。請您按照規則進行配置:默認值為空,長度為 2-128 個英文或中文字符,必須以大小字母或中文開頭,可包含數字,英文句號(.),下劃線(_)或連字符(-),安全組名稱會展示在控制臺。不能以 http:// 和 https:// 開頭。 |
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. | 內部錯誤,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-23 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-04-07 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |