All Products
Search

This Product

    Virtual Private Cloud:AssociateNetworkAcl

    Document Center

    Virtual Private Cloud:AssociateNetworkAcl

    Last Updated:Aug 29, 2024

    Associates a network access control list (ACL) with a vSwitch.

    Operation description

    Description

    • AssociateNetworkAcl is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeNetworkAclAttributes operation to query the status of the task.

      • If the network ACL is in the BINDING state, the network ACL is being associated.
      • If the network ACL is in the BINDED state, the network ACL is associated.

    • You cannot repeatedly call the AssociateNetworkAcl operation to associate a network ACL within the specified period of time.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:AssociateNetworkAclupdate
    • NetworkAcl
      acs:vpc:{#regionId}:{#accountId}:networkacl/{#NetworkAclId}
    • VSwitch
      acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    Resourcearray<object>No

    The information about the associated resources.

    objectNo
    ResourceTypestringYes

    The type of resource with which you want to associate the network ACL. Set the value to VSwitch.

    Valid values of N: 0 to 29. You can associate a network ACL with up to 30 vSwitches.

    		VSwitch
    ResourceIdstringYes

    The ID of the associated resource.

    		vsw-bp1de348lntdw****
    NetworkAclIdstringYes

    The ID of the network ACL.

    		nacl-a2do9e413e0sp****
    RegionIdstringYes

    The region ID of the network ACL. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		123e4567-e89b-12d3-a456-426655440000
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request.

    		true

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "4CF20CC7-D1FC-425B-A15B-DF7C8E2131A7"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ParameterMissing.AliUidParameterMissing.AliUid-
    400ParameterMissing.BidParameterMissing.Bid-
    400ParameterMissing.RegionIdParameterMissing.RegionId-
    400ParameterEmpty.RegionIdParameterEmpty.RegionId-
    400ParameterMissing.NetworkAclIdParameterMissing.NetworkAclId-
    400ParameterEmpty.NetworkAclIdParameterEmpty.NetworkAclId-
    400ParameterMissing.ResourcesParameterMissing.Resources-
    400ParameterEmpty.ResourcesParameterEmpty.Resources-
    400InvalidNetworkAcl.NotFoundThe special Network Acl is not found.The network ACL is not found.
    400NetworkStatus.ModifyingThe special Network Acl is in modifying.The network ACL is being modified.
    400ResourceStatus.ErrorThe binding instance is in middle status.The status of the instance is invalid.
    400InvalidResource.NotFoundThe binding instance is not found.-
    400InvalidResource.VpcErrorThe network acl and resource not in same vpc.-
    400InvalidResource.BindingExistThe binding instance has been binded.The instance is already in the Associated state.
    400NotSupport.NetworkAclNetwork acl is not support now.-
    400ParameterIllegal.ResourceTypeThe specified resource type is illegal.-
    500InternalErrorThe request processing has failed due to some unknown error.An unknown error occurred.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-24API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details