Add member accounts to Cloud Firewall with the AddInstanceMembers API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Adds member accounts to Cloud Firewall.

Operation description

This operation is used to add member accounts to Cloud Firewall.

QPS limit

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you take note of the limit when you call this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:AddInstanceMembers

create

*InstanceMember

acs:yundun-cloudfirewall::{#accountId}:instancemember/*

None

Request parameters

Parameter	Type	Required	Description	Example
Members	array<object>	Yes	The members that you want to add to Cloud Firewall.
	object	No	The list of the members that you want to add.
MemberDesc	string	No	The remarks of the member. The remarks must be 1 to 256 characters in length. You can add up to 20 members at a time.	renewal
MemberUid	integer	Yes	The UID of the member. You can add up to 20 members at a time.	258039427902****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	B40A54DF-C142-44F7-8441-B31C1EADB36E

Examples

Success response

JSON format

{
  "RequestId": "B40A54DF-C142-44F7-8441-B31C1EADB36E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParamsNotEnough	Parameters are insufficient.	Parameters are insufficient.
400	ErrorParamsInvalid	Invalid Params	The parameter is invalid.
400	ErrotMaxInstanceMemberNumExceed	The maximum number of firewall instance members is exceeded.	The maximum number of firewall instance members is exceeded.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
400	ErrorInstanceTooManyMembersOnce	too many members once.	The number of members to be added or deleted at a time exceeds the limit.
400	ErrorDbFailed	Query db failed.	DB access error.
400	ErrorInstanceMemberAlreadyExist	instance member is already exist.	The member is already added to Cloud Firewall.
400	ErrorInstanceMemberIsMaster	instance member is master account.	A firewall is enabled for an asset of the member.
400	ErrorInstanceAliuidNotDaMa	instance aliuid not DA or MA.	The Alibaba Cloud account to which Cloud Firewall belongs is not specified as a delegated administrator account or management account.
400	ErrorDBInsert	internal error: sql insert.	Request error, database insert failed
400	ErrorInstanceMemberNotBelongRd	instance member not belong rd.	The member to be added does not belong to the resource directory.
400	ErrorInstanceMemberNotStsGrant	instance member is not sts grant.	The member of the Cloud Firewall instance to be added is not authorized.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.