CreateIpamResourceDiscovery-Virtual Private Cloud(VPC)-阿里云帮助中心

Creates a custom resource discovery instance.

Operation description

Each Alibaba Cloud account supports only one resource discovery instance per region.
This API operation only supports creating custom resource discovery instances.

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 region ID. Note The region specified in the request 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 operating regions for the resource discovery.
	string	No	The operating region of the resource discovery. Note The list must include the region specified in the creation request.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2sermdd6****
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: sends a check request. No custom resource discovery instance is created. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the check fails, an error is returned. If the check succeeds, the DryRunOperation error code is returned. false (default): sends a regular request. If the check succeeds, an HTTP 2xx status code is returned and a custom resource discovery instance is created.	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 client token. The RequestId of each API request is different.	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 of the resource. 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, and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. 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, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The list of returned information.
RequestId	string	The ID of the request.	BB2C39DE-CEB8-595A-981A-F2EFCBE7324E
IpamResourceDiscoveryId	string	The instance ID of the resource discovery.	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.	The DryRun validation passed.
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.