DeleteIpamResourceDiscovery

Updated at:

Deletes a custom resource discovery instance.

Operation description

  • You cannot delete a resource discovery instance that is shared.

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:DeleteIpamResourceDiscovery

delete

*IpamResourceDiscovery

acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

IpamResourceDiscoveryId

string

Yes

The instance ID of the resource discovery.

ipam-res-disco-jt5f2af2u6nk2z321****

DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run without deleting the resource discovery instance. 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): performs a regular request. If the request passes the check, an HTTP 2xx status code is returned and the resource discovery instance is deleted.

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 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 is unique.

123e4567-e89b-12d3-a456-426655440000

Response elements

Element

Type

Description

Example

object

The list of returned information.

RequestId

string

The request ID.

9F8315CB-560E-5F1E-B069-6E44B440CAF8

Examples

Success response

JSON format

{
  "RequestId": "9F8315CB-560E-5F1E-B069-6E44B440CAF8"
}

Error codes

HTTP status code

Error code

Error message

Description

400 DryRunOperation Request validation has been passed with DryRun flag set. The DryRun validation passed.
400 OperationDenied.OperateShareResource The operation is not allowed because the instance is a shared resource. The operation is not allowed because the instance is a shared resource.
400 ResourceNotFound.IpamResourceDiscovery The dependent instance of IPAM resource discovery is not found. The dependent instance of IPAM resource discovery is not found.
400 OperationDenied.UnexpectedType The operation is not allowed because the input type is unexpected. The operation is not allowed because the input type is unexpected.
400 DependencyViolation.ShareResource The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed. The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.