RenewInstance

更新时间:
复制 MD 格式

Renews an instance.

Operation description

Before you call this API, make sure that you fully understand the billing model and billable items of Serverless StarRocks.

When you call this API, note that only subscription instances can be renewed.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /webapi/order/renew_instance HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

c-b25e21e24388****

Duration

integer

Yes

The subscription duration.

1

PricingCycle

string

Yes

Duration unit:

  • Month

  • Year

Valid only when payType is PrePaid.

Year

BillingInstanceIds

string

Yes

A comma-separated list of billing instance IDs to renew. Billing instances include clusters and compute groups.

ng-dd8933281e46****

PromotionOptionNo

string

No

The coupon ID.

youhuiquan_12378dfj6

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID.

32A44F0D-BFF6-5664-999A-218BBDE74XXX

Success

boolean

Indicates whether the request succeeded.

True

ErrorCode

string

The error code.

Success

ErrMessage

string

The error message.

Invalid params: [instance not exists].

Data

object

The response data.

OrderIds

array

A list of order IDs.

string

The order ID.

24793054452****

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE74XXX",
  "Success": true,
  "ErrorCode": "Success",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Data": {
    "OrderIds": [
      "24793054452****"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.