CreateIpamScope - Virtual Private Cloud - Alibaba Cloud Documentation Center

Creates scopes for IPAM to manage private and public IP addresses.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM instance is hosted. Call the DescribeRegions operation to get the region ID.	cn-hangzhou
IpamId	string	Yes	The ID of the IPAM instance.	ipam-ccxbnsbhew0d6t****
IpamScopeName	string	No	The name of the IPAM scope. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test
IpamScopeDescription	string	No	The description of the IPAM scope. The description must be 1 to 256 characters in length and must start with a letter. It cannot start with `http://` or `https://`. The default value is an empty string.	test description
ResourceGroupId	string	No	The ID of the resource group to which the IPAM scope belongs.	rg-acfmxazb4ph6aiy****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request but does not create the IPAM scope. The request is checked for valid AccessKeys, RAM user permissions, and required parameters. If the check fails, a corresponding error is returned. If the check passes, the `DryRunOperation` error code is returned. false (default): Sends a normal request. If the request passes the check, a 2xx HTTP status code is returned and the IPAM scope is created.	false
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. Generate a unique value from your client. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each API request may be different.	123e4567-e89b-12d3-a456-426655440000
IpamScopeType	string	No	The type of the IPAM scope: private. Note Currently, you can create only private scopes.	private
Tag	array<object>	No	The tags.
	object	No	The 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 and can contain digits, periods (.), underscores (_), and hyphens (-). The tag key 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 response.
RequestId	string	The request ID.	E897D16A-50EB-543F-B002-C5A26AB818FF
IpamScopeId	string	The ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****

Examples

Success response

JSON format

{
  "RequestId": "E897D16A-50EB-543F-B002-C5A26AB818FF",
  "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	The IPAM entered does not exist.
400	UnsupportedFeature.PublicIpamScopeType	The feature of PublicIpamScopeType is not supported.	The IPAM you specified does not support the creation of public scope.
400	QuotaExceeded.IpamScopeQuotaPerIpam	The quota of ipamScopeQuotaPerIpam count is exceeded.	The maximum number allowed for the IPAM scope of action exceeds the limit.
400	DryRunOperation	Request validation has been passed with DryRun flag set.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.