AddIpamMembers

Updated at:

Adds members to be managed by the IPAM trusted service.

Operation description

  • Multi-account management in IPAM can only be performed by the IPAM delegated administrator of a resource directory.

  • The IPAM delegated administrator can select an IPAM instance in only one region for multi-account management. The total number of managed member accounts cannot exceed 1,000.
    Important When the managed member is of the Folder type, the number of managed member accounts is calculated based on the number of resource directory member accounts contained in the folder.
  • The types of managed members include Folder and Account:
    • Folder: The IPAM delegated administrator can view the IP address usage of all resource directory member accounts under the folder in the region where IPAM takes effect.

    • Account: The IPAM delegated administrator can view the IP address usage of a specified resource directory account in the region where IPAM takes effect.

  • Managed members are not allowed to share resource discovery with the IPAM delegated administrator. The IPAM delegated administrator is also not allowed to manage members that have already shared their resource discovery with the administrator.

  • After the IPAM delegated administrator adds a managed member for the first time, the IPAM trusted service for the resource directory is enabled.

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

vpc:AddIpamMembers

create

*All Resource

*

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The ID of the region where IPAM is hosted.

You can call the DescribeRegions operation to query region IDs.

cn-hangzhou

DryRun

boolean

No

Specifies whether to only precheck the request. Valid values:

  • true: sends a check request. Members are not added to be managed by the IPAM trusted service. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the request fails the check, an error is returned. If the request passes the check, the DryRunOperation error code is returned.

  • false (default): sends a regular request. If the request passes the check, an HTTP 2xx status code is returned and members are added to be managed by the IPAM trusted service.

false

ClientToken

string

No

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

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

Note

If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.

123e4567-e89b-12d3-a456-426655440000

Members

array<object>

Yes

The members to be managed by the IPAM trusted service.

object

No

MemberId

string

No

The ID of the member.

  • Folder ID: the ID of the folder.

  • Account UID: the UID of the member accounts in the resource directory.

fd-ccccncASqa

MemberType

string

No

The type of the member. Valid values:

  • Folder: folder.

  • Account: member accounts in the resource directory.

Valid values:

  • Account :

    Member accounts in the resource folder.

  • Folder :

    Folder.

Folder

Response elements

Element

Type

Description

Example

object

BaseResult

RequestId

string

The ID of the request.

BB2C39DE-CEB8-595A-981A-F2EFCBE7324E

Examples

Success response

JSON format

{
  "RequestId": "BB2C39DE-CEB8-595A-981A-F2EFCBE7324E"
}

Error codes

HTTP status code

Error code

Error message

Description

400 OperationDenied.MemberIdNotMatchMemberType The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match. The Member Id and Member Type of [%s] in the input Members do not match.
400 OperationDenied.MemberExistInIpamRDService The operation is not allowed because %s is under the management of the IPAM. The input parameter %s has already been managed by IPAM trusted service. The same member cannot be managed repeatedly.
400 QuotaExceeded.MemberAccount The operation is not allowed because the number of % managed by IPAM has exceeded the limit, %s/%s. The member account managed by IPAM trusted service exceeds the quota limit.
400 OperationDenied.IpamResourceDiscoveryAlreadySharedWithAdmin The operation is not allowed because the resource discovery has been shared with the IPAM delegated administrator by %s. The IPAM Trusted Service does not allow the management of accounts that have already shared their resource discovery with the delegated administrator.
400 OperationDenied.IpamRDServiceAlreadyEnabledInOtherRegion The operation is not allowed because the IPAM Resource Directory service is already enabled in another region. Only one IPAM instance can be selected to manage resource directory members.
400 OperationDenied.AccountNotRDEntity The operation is not allowed because the caller does not belong to the resource directory. The caller does not belong to any resource directory and is not allowed to manage IPAM trusted service members.
400 OperationDenied.NotDelegatedAdminAccount The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory. The caller is not the delegated administrator of the IPAM trusted service in the resource directory. IPAM trusted service members are not allowed to be managed.
400 OperationDenied.IpamNotExist The operation is not allowed because the IPAM does not exist. IPAM does not exist in the current region. IPAM trusted service members cannot be managed.
400 OperationDenied.DelegateAdminAsMember The operation is not allowed because the IPAM delegate administrator cannot be a member. IPAM delegated administrators cannot add themselves as members of the IPAM trusted service.
400 OperationDenied.NoServicePrincipalAdminPrivileges The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory. The caller is not the delegated administrator of the IPAM trusted service in the resource directory. IPAM trusted service members are not allowed to be managed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.