CreateIpamResourceDiscovery - Virtual Private Cloud - Alibaba Cloud Documentation Center

Creates a resource discovery instance of a custom type.

Operation description

Each Alibaba Cloud account can have only one resource discovery instance in each region.
This operation creates only resource discovery instances of a custom type.

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

create

*IpamResourceDiscovery

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The request region. Note The request region is the hosted region of the resource discovery instance.	cn-hangzhou
IpamResourceDiscoveryName	string	No	The name of the resource discovery.	name
IpamResourceDiscoveryDescription	string	No	The description of the resource discovery.	description
OperatingRegionList	array	Yes	The list of regions where the resource discovery is effective.
	string	No	The region where the resource discovery is effective. Note The request region must be included.	cn-hangzhou
ResourceGroupId	string	No	The resource group ID.	rg-aek2sermdd6****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request without creating the resource discovery instance. The system checks for required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the DryRunOperation error code is returned. false (default): Sends a normal request. After the request passes the check, an HTTP 2xx status code is returned and the resource discovery instance is created.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique parameter value from your client. The client token supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.	123e4567-e89b-12d3-a456-426655440000
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length. It must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and it cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	BB2C39DE-CEB8-595A-981A-F2EFCBE7324E
IpamResourceDiscoveryId	string	The ID of the resource discovery instance.	ipam-res-disco-jt5f2af2u6nk2z321****

Examples

Success response

JSON format

{
  "RequestId": "BB2C39DE-CEB8-595A-981A-F2EFCBE7324E",
  "IpamResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.OperatingRegion	The operating region is invalid.	The operating region is invalid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	OperationDenied.OperatingRegionsNeedIncludeHomeRegion	The operating regions do not contain home region.	The operating regions do not contain home region.
400	QuotaExceeded.IpamResourceDiscoveryQuotaPerRegion	The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.	The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.