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

Adds member accounts to Cloud Firewall.

Operation description

Adds member accounts to Cloud Firewall.

Before you begin

The caller's Alibaba Cloud account must be a delegated administrator (DA) or management account (MA) of a resource directory. Otherwise, the error ErrorInstanceAliuidNotDaMa (-103313) is returned. Call DescribeInstanceRdAccounts to verify the identity of the current account.
The member UID to be added must belong to the same resource directory. Otherwise, the error ErrorInstanceMemberNotBelongRd (-103308) is returned.

Rate limit

The single-user queries per second (QPS) limit for this operation is 10. If the number of calls per second exceeds the limit, throttling is triggered. Throttling may affect your business. Call this operation within the limit.

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 list of Cloud Firewall member accounts to add. Call DescribeInstanceRdAccounts to obtain the available MemberUid values. You can add up to 20 members at a time, subject to the instance member quota.	AddInstanceMembers
	object	No	The list of member accounts to add.
MemberDesc	string	No	The remarks of the Cloud Firewall member account. The value must be 1 to 256 characters in length. You can add up to 20 member accounts.	renewal
MemberUid	integer	Yes	The UID of the Cloud Firewall member account. You can add up to 20 member accounts.	258039427902****

Response elements

Element	Type	Description	Example
	object
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.	instance aliuid not DA or MA.
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.
400	-103000	The specified member UID does not belong to the current Resource Directory.	The specified member UID does not belong to the current Resource Directory.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.