Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Virtual Private Cloud/ API Reference/ API V3/ Security Group Rule/ Adding Rules to a Specified Security Group

Adding Rules to a Specified Security Group

Updated on 2025-01-07 GMT+08:00

Function

This API is used to add rules to a specified security group.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

POST /v3/{project_id}/vpc/security-groups/{security_group_id}/security-group-rules/batch-create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For details about how to obtain a project ID, see Obtaining a Project ID.

security_group_id

Yes

String

Security Group ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

security_group_rules

Yes

Array of BatchCreateSecurityGroupRulesOption objects

Request body for batch creating security group rules.

ignore_duplicate

No

Boolean

Specifies whether to ignore duplicate security group rules during creation.

Default: false

dry_run

No

Boolean

  • Whether to only send the check request.

  • The value can be:

    • true: A check request will be sent and no security group rule will be created. Check items include mandatory parameters, request format, and permission verification. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned.

    • false (default value): A request will be sent and a security group rule will be created.

Table 3 BatchCreateSecurityGroupRulesOption

Parameter

Mandatory

Type

Description

description

No

String

  • Provides supplementary information about the security group.

  • The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

direction

Yes

String

  • Inbound or outbound direction of a security group rule.

  • The value can be:

    • ingress: inbound direction.

    • egress: outbound direction.

ethertype

No

String

  • IP version

  • The value can be IPv4 or IPv6.

  • If you do not set this parameter, IPv4 is used by default.

protocol

No

String

  • Protocol type

  • The value can be icmp, tcp, udp, icmpv6 or an IP number (0 to 255).

  • Constraints:

    • If the parameter is left blank, all protocols are supported.

    • When the protocol is icmpv6, IP version should be IPv6.

    • When the protocol is icmp, IP version should be IPv4.

multiport

No

String

  • Port or port range

  • The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80).

  • The port is from 1 to 65535.

remote_ip_prefix

No

String

  • Remote IP address. If direction is set to egress, the parameter specifies the source IP address. If direction is set to ingress, the parameter specifies the destination IP address.

  • The value is an IP address or a CIDR block.

  • Constraints:

    • The parameter is mutually exclusive with parameters remote_group_id and remote_address_group_id.

    • If this parameter is left blank, the remote IP address is not limited, and the traffic from all remote IP addresses is allowed or rejected.

remote_group_id

No

String

  • ID of the remote security group, which allows or denies traffic to and from the security group.

  • Value range: ID of an existing security group.

  • The parameter is mutually exclusive with parameters remote_ip_prefix and remote_address_group_id.

remote_address_group_id

No

String

  • ID of the remote IP address group.

  • Value range: ID of an existing IP address group.

  • The parameter is mutually exclusive with parameters remote_ip_prefix and remote_group_id.

action

No

String

  • Action of the security group rule.

  • The value can be:

    • allow

    • deny

  • The default value is allow.

priority

No

String

  • Rule priority in a security group.

  • The value is from 1 to 100. The value 1 indicates the highest priority.

  • The default value is 1.

enabled

No

Boolean

  • Whether to enable a security group rule.

  • Value range: true or false

  • Default value: true

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

security_group_rules

Array of SecurityGroupRule objects

Response body for batch creating security group rules.

request_id

String

Request ID.

Table 5 SecurityGroupRule

Parameter

Type

Description

id

String

  • Security group rule ID, which uniquely identifies the security group rule.

  • The value is in UUID format with hyphens (-).

description

String

  • Provides supplementary information about the security group rule.

  • The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

security_group_id

String

  • ID of the security group to which the security group rule belongs.

direction

String

  • Inbound or outbound direction of a security group rule.

  • The value can be:

    • ingress: inbound direction.

    • egress: outbound direction.

protocol

String

  • Protocol type

  • The value can be icmp, tcp, udp, icmpv6, or an IP number.

  • Constraints:

    • If the parameter is left blank, all protocols are supported.

    • When the protocol is icmpv6, IP version should be IPv6.

    • When the protocol is icmp, IP version should be IPv4.

ethertype

String

  • IP version

  • The value can be IPv4 or IPv6.

  • If you do not set this parameter, IPv4 is used by default.

multiport

String

  • Port or port range

  • The value can be a single port (80), a port range (1-30), or inconsecutive ports separated by commas (22,3389,80).

action

String

  • Action of the security group rule.

  • The value can be: allow, deny.

  • The default value is deny.

priority

Integer

  • Rule priority.

  • The value is from 1 to 100. The value 1 indicates the highest priority.

remote_group_id

String

  • ID of the remote security group, which allows or denies traffic to and from the security group.

  • Value range: ID of an existing security group.

  • The parameter value is mutually exclusive with parameters remote_ip_prefix and remote_address_group_id.

remote_ip_prefix

String

  • Remote IP address.

    • If direction is set to egress, the parameter specifies the source IP address.

    • If direction is set to ingress, the parameter specifies the destination IP address.

  • The value is an IP address or a CIDR block.

  • Constraints:

    • The parameter value is mutually exclusive with parameters remote_group_id and remote_address_group_id.

remote_address_group_id

String

  • ID of the remote IP address group.

  • Value range: ID of an existing IP address group

  • The parameter value is mutually exclusive with parameters remote_ip_prefix and remote_group_id.

created_at

String

  • Time when the security group rule is created.

  • UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

updated_at

String

  • Time when the security group rule is updated.

  • UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

project_id

String

  • ID of the project to which the security group rule belongs.

enabled

Boolean

  • Whether to enable a security group rule.

  • Value range: true or false

  • Default value: true

Example Requests

Adding two inbound rules to the security group whose ID is 15457509-18f9-4387-bae6-d4ed1898b301 with duplicate rules ignored

POST https://{Endpoint}/v3/{project_id}/vpc/security-groups/15457509-18f9-4387-bae6-d4ed1898b301/security-group-rules/batch-create

{
  "ignore_duplicate" : true,
  "security_group_rules" : [ {
    "direction" : "ingress",
    "description" : "",
    "protocol" : "tcp",
    "action" : "allow",
    "priority" : 1,
    "ethertype" : "IPv4",
    "multiport" : "22",
    "remote_ip_prefix" : "117.78.12.122/32"
  }, {
    "direction" : "ingress",
    "description" : "",
    "protocol" : "tcp",
    "action" : "allow",
    "priority" : 1,
    "ethertype" : "IPv4",
    "multiport" : "22",
    "remote_ip_prefix" : "117.78.12.122/32"
  } ]
}

Example Responses

Status code: 201

Normal response to the POST operation. For more status codes, see Status Codes.

  • {
      "security_group_rules" : [ {
        "id" : "abef369b-d646-4b8a-9f44-fcd248a6c421",
        "project_id" : "5f6387106c2048b589b369d96c2f23a2",
        "security_group_id" : "15457509-18f9-4387-bae6-d4ed1898b301",
        "direction" : "ingress",
        "protocol" : "tcp",
        "description" : "",
        "created_at" : "2023-04-28T04:08:52.000+00:00",
        "updated_at" : "2023-04-28T04:08:52.000+00:00",
        "ethertype" : "IPv4",
        "remote_ip_prefix" : "117.78.12.122/32",
        "multiport" : 22,
        "action" : "allow",
        "priority" : 1,
        "remote_group_id" : null,
        "remote_address_group_id" : null,
        "enabled" : true
      } ],
      "request_id" : "f1ae2c6f9e94babf077cd3b3e1570c81"
    }

Status Codes

Status Code

Description

201

Normal response to the POST operation. For more status codes, see Status Codes.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback