OpenVpcIpamService - Virtual Private Cloud - Alibaba Cloud Documentation Center

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. This token is generated by the client and must be unique for each request. The token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the `RequestId` of the request as the `ClientToken`. The `RequestId` may be different for each request.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The ID of the managed region for IPAM.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	3F814C37-B032-5477-AF5A-2925D0593CD4
Code	string	The status code.	200
Message	string	The returned message.	successful

Examples

Success response

JSON format

{
  "RequestId": "3F814C37-B032-5477-AF5A-2925D0593CD4",
  "Code": "200",
  "Message": "successful"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.ExceedPurchaseLimit	You have reached the limit of purchase quantity.	The purchase limit is reached.
400	Forbidden.RAM	The user is not authorized to operate on the specified resource, or the API operation does not support RAM.	The user is not authorized to operate on the specified resource, or the API operation does not support RAM.
400	OperationFailed.AliGroupUserCanNotBuyInnerCommodity	IPAM has no group cloud product label, and users within the group are not allowed to purchase.	IPAM does not have a merchandise tag and cannot be purchased by an internal group user.
400	Order.NoRealNameAuthentication	Real-name verification has not been completed for the account.	You have not performed real-name authentication. Please go to the account center to complete real-name authentication.
400	OperationFailed.BasicInfoUncompleted	You have not completed your basic personal information, please complete the information and try again.	Your basic information is incomplete. Specify the information and try again.
400	OperationFailed.AccountBalanceInsufficient	The account balance of this user is insufficient to place the order.	The account balance of this user is insufficient to place the order.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.