Renew a Subscription Lindorm Instance via API - Lindorm - Alibaba Cloud - Lindorm

Operation description

Renews a subscription instance. The renewal period can be measured in months or years. The renewal duration ranges from 1 to 9 months or 1 to 3 years. Before you call this operation, make sure that you fully understand the billing methods and pricing of Lindorm.

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

lindorm:RenewLindormInstance

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
InstanceId	string	Yes	The ID of the instance. You can call the GetLindormInstanceList operation to query the instance ID. The instance must be in the ACTIVATION (Running) state to be renewed. Instances in other states, such as CREATING (Creating), cannot be renewed.	ld-bp1z3506imz2f****
PricingCycle	string	Yes	The billing cycle of the instance. Valid values: Month: months Year: years Valid values: Month : Month. Year : Year.	Month
Duration	integer	Yes	The subscription duration of the instance. Valid values: If PricingCycle is set to Month, the instance is billed by month. Valid values: 1 to 9. If PricingCycle is set to Year, the instance is billed by year. Valid values: 1 to 3.	1

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	1556DCB0-043A-4444-8BD9-CF4A68E7EE64
InstanceId	string	The instance ID. This field may not be returned in a partially successful response.	ld-bp1z3506imz2f****
OrderId	integer	The ID of the order. You can obtain the order ID in the Orders section of the Expenses and Costs console.	213465921640411
AccessDeniedDetail	string	The details of the access denial.	{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  "InstanceId": "ld-bp1z3506imz2f****",
  "OrderId": 213465921640411,
  "AccessDeniedDetail": "{\"AuthAction\":\"xxx\",\"AuthPrincipalDisplayName\":\"222\",\"AuthPrincipalOwnerId\":\"111\",\"AuthPrincipalType\":\"SubUser\",,\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"EncodedDiagnosticMessage\":\"xxxxxx\"}"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.
400	Lindorm.Errorcode.Order.CreateFailed	Create order failed.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.
403	API.Forbidden	The API operation is forbidden in this environment.	This operation is not supported in the current environment.
403	Lindorm.Errorcode.ServiceLinkedRoleNoPermission	No permission to create service linked role.	You are not authorized to create the service-linked role.
404	Lindorm.Errorcode.PayType.IsNotValid	Pay type is not valid.
404	Lindorm.Errorcode.Commodity.NotFound	Commodity is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.