華為云計(jì)算 云知識(shí) 創(chuàng)建安全組CreateSecurityGroup
創(chuàng)建安全組CreateSecurityGroup

 

功能介紹

創(chuàng)建安全組。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

POST /v1/{project_id}/security-groups

參數(shù)說明請(qǐng)參見表1。
表1 參數(shù)說明

名稱

是否必選

說明

project_id

項(xiàng)目ID,獲取項(xiàng)目ID請(qǐng)參見獲取項(xiàng)目ID

請(qǐng)求參數(shù)

表2 請(qǐng)求參數(shù)

名稱

是否必選

參數(shù)類型

說明

security_group

security_group object

安全組對(duì)象,請(qǐng)參見表3。

表3 security_group字段說明

名稱

是否必選

參數(shù)類型

說明

name

String

  • 功能說明:安全組名稱
  • 取值范圍:1-64個(gè)字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))

vpc_id

String

安全組所在的vpc的資源標(biāo)識(shí)

說明:

該參數(shù)功能已廢棄,不建議繼續(xù)使用。

當(dāng)前該參數(shù)只作提示用,不約束安全組在此vpc下。

enterprise_project_id

String

  • 功能說明:企業(yè)項(xiàng)目ID。創(chuàng)建安全組時(shí),給安全組綁定企業(yè)項(xiàng)目ID。
  • 取值范圍:最大長度36字節(jié),帶“-”連字符的UUID格式,或者是字符串“0”?!?”表示默認(rèn)企業(yè)項(xiàng)目。
說明:

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見《企業(yè)管理用戶指南》。

請(qǐng)求示例

  • 創(chuàng)建一個(gè)安全組,命名為sg-01,所在vpc id為3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85。
    POST https://{Endpoint}/v1/{project_id}/security-groups
    
    {
        "security_group": {
            "name": "sg-01", 
            "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2"
        }
    }

響應(yīng)參數(shù)

表4 響應(yīng)參數(shù)

名稱

參數(shù)類型

說明

security_group

security_group object

安全組對(duì)象,請(qǐng)參見表5。

表5 security_group字段說明

名稱

參數(shù)類型

說明

name

String

安全組名稱

description

String

安全組描述

id

String

安全組唯一標(biāo)識(shí)

vpc_id

String

安全組所在的vpc的資源標(biāo)識(shí)

說明:

該參數(shù)功能已廢棄,不建議繼續(xù)使用。

當(dāng)前該參數(shù)只作提示用,不約束安全組在此vpc下。

security_group_rules

Array of security_group_rule objects

默認(rèn)安全組規(guī)則列表,保證安全組內(nèi)互通。

enterprise_project_id

String

  • 功能說明:企業(yè)項(xiàng)目ID。創(chuàng)建安全組時(shí),給安全組綁定企業(yè)項(xiàng)目ID。
  • 取值范圍:最大長度36字節(jié),帶“-”連字符的UUID格式,或者是字符串“0”?!?”表示默認(rèn)企業(yè)項(xiàng)目。
說明:

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見《企業(yè)管理用戶指南》。

表6 security_group_rule對(duì)象

名稱

參數(shù)類型

說明

id

String

安全組規(guī)則標(biāo)識(shí)

description

String

  • 功能說明:安全組規(guī)則描述
  • 取值范圍:0-255個(gè)字符,支持?jǐn)?shù)字、字母、中文字符

security_group_id

String

安全組標(biāo)識(shí)

direction

String

  • 功能說明:出入控制方向
  • 取值范圍:
    • egress:出方向
    • ingress:入方向

ethertype

String

  • 功能說明:IP協(xié)議類型
  • 取值范圍:IPv4,IPv6

protocol

String

  • 功能說明:協(xié)議類型
  • 取值范圍:icmp、tcp、udp、icmpv6等
  • 約束:為空表示支持所有協(xié)議

port_range_min

Integer

port_range_max

Integer

remote_ip_prefix

String

  • 功能說明:遠(yuǎn)端IP地址,當(dāng)direction是egress時(shí)為虛擬機(jī)訪問端的地址,當(dāng)direction是ingress時(shí)為訪問虛擬機(jī)的地址
  • 取值范圍:IP地址,或者cidr格式
  • 約束:和remote_group_id,remote_address_group_id互斥

remote_group_id

String

  • 功能說明:對(duì)端安全組id
  • 約束:和remote_ip_prefix,remote_address_group_id互斥

remote_address_group_id

String

  • 功能說明:遠(yuǎn)端IP地址組ID
  • 約束:和remote_ip_prefix,remote_group_id互斥

tenant_id

String

  • 功能說明:安全組規(guī)則所屬項(xiàng)目ID

響應(yīng)示例

{
    "security_group": {
        "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", 
        "name": "qq", 
        "description": "", 
        "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", 
        "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
        "security_group_rules": [
            {
                "direction": "egress", 
                "ethertype": "IPv4", 
                "id": "369e6499-b2cb-4126-972a-97e589692c62", 
                "description": "",
                "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
            }, 
            {
                "direction": "ingress", 
                "ethertype": "IPv4", 
                "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", 
                "description": "",
                "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", 
                "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
                "remote_address_group_id": null
            }
        ]
    }
}

狀態(tài)碼

請(qǐng)參見狀態(tài)碼。

錯(cuò)誤碼

請(qǐng)參考錯(cuò)誤碼