RenewServiceInstanceResources - Compute Nest - Alibaba Cloud Documentation Center

Renews the subscription resources for a private deployment service instance. This operation supports two renewal methods: renewing all subscription resources for a service instance or renewing only specific resources. You can use only one method per request.

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

computenest:RenewServiceInstanceResources

update

*ServiceInstance

acs:computenest:{#regionId}:{#AccountId}:serviceinstance/{#serviceInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
ServiceInstanceId	string	Yes	The service instance ID.	si-b58c874912fc4294****
PeriodUnit	string	No	The time unit of the renewal duration for all subscription resources in the service instance. This parameter specifies the unit for `Period`. Valid values: `Month` and `Year`. Default value: `Month`.	Month
ClientToken	string	No	A client token to ensure that the request is idempotent. Generate a unique value for this parameter from your client for each request. The token can contain only ASCII characters and must not exceed 64 characters in length.	123e4567-e89b-12d3-a456-426655440000
Period	integer	No	The renewal duration for all subscription resources in the service instance. The unit is specified by `PeriodUnit`.	1
ResourcePeriod	array<object>	No	The list of resource renewals.
	object	No	The resource renewal configuration.
ResourceArn	string	No	The Aliyun Resource Name (ARN) of the resource.	acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2
PeriodUnit	string	No	The time unit of the renewal duration for the resource. This parameter specifies the unit for `Period`. Valid values: `Month` and `Year`. Default value: `Month`.	Month
Period	integer	No	The renewal duration for the resource. The unit is specified by `PeriodUnit`.	1

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	13FE89A5-C036-56BF-A0FF-A31C59819FD7
RenewalResult	object	The renewal result.
TotalCount	integer	The number of resources to be renewed.	10
Succeeded	integer	The number of successfully renewed resources.	9
Failed	integer	The number of resources that failed to be renewed.	1
FailureDetails	array<object>	The details of renewal failures.
	object	The details of a renewal failure.
ResourceArn	string	The ARN of the resource.	acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2
ErrorMessage	string	The error message.	Error message
ErrorCode	string	The error code.	InvalidPeriod

Examples

Success response

JSON format

{
  "RequestId": "13FE89A5-C036-56BF-A0FF-A31C59819FD7",
  "RenewalResult": {
    "TotalCount": 10,
    "Succeeded": 9,
    "Failed": 1
  },
  "FailureDetails": [
    {
      "ResourceArn": "acs:ecs:cn-hongkong:1488317743351199:instance/i-j6c6f3lbky38o8rpeqw2",
      "ErrorMessage": "Error message",
      "ErrorCode": "InvalidPeriod"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.