RemoveIpamMembers

Updated at:

Removes a member managed by the IPAM trusted service.

Operation description

  • After the IPAM delegated administrator removes the last managed member, the IPAM trusted service for the resource directory is disabled.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 perform a dry run only. Valid values:

  • true: Sends a dry run request and does not remove the member 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 dry run, an error is returned. If the request passes the dry run, the DryRunOperation error code is returned.

  • false (default): Sends a normal request. If the request passes the dry run, an HTTP 2xx status code is returned and the member managed by the IPAM trusted service is removed.

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 token, but you must make sure that the token 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 client token. The RequestId of each API request may be different.

123e4567-e89b-12d3-a456-426655440000

Members

array<object>

Yes

The members 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 request ID.

3F814C37-B032-5477-AF5A-2925D0593CD4

Examples

Success response

JSON format

{
  "RequestId": "3F814C37-B032-5477-AF5A-2925D0593CD4"
}

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.IpamRDServiceMemberNotExist The operation is not allowed because %s is not managed by the IPAM. The member %s to be removed from the input parameter is not managed by IPAM trusted service.
400 OperationDenied.IpamRDServiceNotEnableInOperationRegion The operation is not allowed because the IPAM RD service is not enabled in the current region. The IPAM instance in the operating region does not manage any resource directory members.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.