RemoveIpamMembers

Updated at:

Removes members from the IPAM trusted service.

Operation description

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

Try it now

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

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 the IPAM is hosted. To get the region ID, call the DescribeRegions operation.

cn-hangzhou

DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: Performs a dry run. The system checks the required parameters, the request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. The members are not removed.

  • false (default): Sends a request. If the request passes the check, a 2xx HTTP status code is returned, and the members are removed.

false

ClientToken

string

No

A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among different requests. The ClientToken parameter can contain only ASCII characters. Note: If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.

123e4567-e89b-12d3-a456-426655440000

Members

array<object>

Yes

The members managed by the IPAM trusted service.

object

No

MemberId

string

No

The member ID.

  • Folder ID: The ID of the folder.

  • Account UID: The UID of the member account in the resource directory.

Folder

MemberType

string

No

The type of the member. Valid values:

  • Folder: The member is a folder.

  • Account: The member is a member account in the resource directory.

Valid values:

  • Account :

    Member account in a resource directory

  • Folder :

    Folder

fd-ccccncASqa

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 for a complete list.

Release notes

See 变更详情 for a complete list.