All Products
Search
Document Center

BSS OpenAPI:ReleaseInstance

Last Updated:Mar 01, 2024

Releases instances by Virtual Network Operators (VNOs).

Operation description

This operation is provided for only VNOs to release instances. If a non-specific VNO calls this operation, the request is blocked.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringYes

The code of the service.

ecs
SubscriptionTypestringYes

The billing method. Valid values:

Subscription: the subscription billing method.

PayAsYouGo: the pay-as-you-go billing method.

PayAsYouGo
InstanceIdsstringYes

The ID of the instance. Separate multiple IDs with commas (,). A maximum of 100 IDs can be specified.

rm-xxxxxxxxxxxx
RenewStatusstringNo

The method that is used to renew the instance. Valid values:

AutoRenewal: automatically renews the instance.

ManualRenewal: manually renews the instance.

NotRenewal: does not renew the instance.

AutoRenewal
RegionstringNo

The region in which the instance resides.

cn-hangzhou
ProductTypestringNo

The type of the service.

ecs

Response parameters

ParameterTypeDescriptionExample
object

The return result.

Messagestring

The description of the execution result.

successful
RequestIdstring

The ID of the request, which can be used for troubleshooting.

UUID
Dataobject

data

ReleaseResultboolean

Indicates whether the instance is released.

true
HostIdstring

The site of the execution host.

cn
Codestring

The HTTP status code.

Invalid_Product_Code
Successboolean

A value of true indicates that the execution is complete.

A value of false indicates that an error occurs during the execution.

true

Examples

Sample success responses

JSONformat

{
  "Message": "successful",
  "RequestId": "UUID",
  "Data": {
    "ReleaseResult": true,
    "HostId": "cn"
  },
  "Code": "Invalid_Product_Code",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

For a list of error codes, visit the Service error codes.