Skip to main content
API Explorer|API Explorer
Resource Center/Network Service/Network Service Operations/Security Group Operations
POSTSecurity Group OperationsSince 0.6SynchronousAuth Required

AddSecurityGroupRule

AddSecurityGroupRule

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • securityGroupUuidStringRequired

    The security group UUID.

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • rulesListRequired

      The rules in the security group.

    • remoteSecurityGroupUuidsList

      Optional. The security group that the rule takes effect.

    • priorityInteger

      Optional. The priority of security group rule.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventorySecurityGroupInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • stateStringRequired

      当前状态。

    • ipVersionIntegerRequired

      The IP version.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • attachedL3NetworkUuidsSetRequired

      No description provided.

    • rulesListRequired

      See rules.

      • uuidStringRequired

        The resource UUID.

      • securityGroupUuidStringRequired

        The security group UUID.

      • typeStringRequired

        The traffic type.

      • ipVersionIntegerRequired

        The IP version.

      • startPortIntegerRequired

        If the protocol is TCP or UDP, this parameter is the start port of the port range. If the protocol is ICMP, this parameter is the ICMP type.

      • endPortIntegerRequired

        If the protocol is TCP or UDP, this parameter is the end port of the port range. If the protocol is ICMP, this parameter is the ICMP type.

      • protocolStringRequired

        The traffic protocol type.

      • stateStringRequired

        The rule state, which is not implemented in the current version.

      • priorityIntegerRequired

        The priority of security group rule.

      • descriptionStringRequired

        The description of the security group rule.

      • srcIpRangeStringRequired

        The range of source IP.

      • dstIpRangeStringRequired

        The range of target IP.

      • srcPortRangeStringRequired

        The range of source port, which is not implemented in the current version.

      • dstPortRangeStringRequired

        The range of target port.

      • actionStringRequired

        The default action of the security group rule.

      • allowedCidrStringRequired

        The allowed CIDR, which has different meanings according to different traffic types. If the traffic type is Ingress, the allowed CIDR is a source CIDR that is allowed to access VM NICs. If the traffic type is Egress, the allowed CIDR is a destination CIDR that is allowed to leave from VM NICs.

      • remoteSecurityGroupUuidStringRequired

        远程安全组UUID。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

POST/zstack/v1/security-groups/{securityGroupUuid}/rules

/zstack/v1/security-groups/{securityGroupUuid}/rules

Operation ID

AddSecurityGroupRule

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/security-groups/{securityGroupUuid}/rules' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"rules":["<rules>"],"remoteSecurityGroupUuids":["<remoteSecurityGroupUuids>"],"priority":1},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "5949aece9cd64d5a939d6dc5e2c1f327", "name": "web", "description": "for test", "state": "Enabled", "createDate": "Sep 22, 2017 12:24:11 PM", "lastOpDate": "Sep 22, 2017 12:24:11 PM", "internalId": 0 } }

Change History

This API has no change history records yet.

View all change history