SetServerReserved

Last updated: 2021-06-23 17:07:03

1. API Description

Domain name for API request: gse.tencentcloudapi.com.

This API (SetServerReserved) is used to mark the exceptional instances as retained for troubleshooting.

ReserveValue: specifies whether to retain the instance. Valid values: 0 (do not retain), 1 (retain). Default value: 0.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: SetServerReserved.
Version Yes String Common parameter. The value used for this API: 2019-11-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
FleetId Yes String ID of the fleet to be bound with the policy
InstanceId Yes String Instance ID
ReserveValue No Integer Whether the instance is retained. Valid values: 1 (retained), 0 (not retained). Default value: 0.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Marking an instance as a reserved instance for troubleshooting

Input Example

POST / HTTP/1.1
Host: gse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetServerReserved
<Common request parameters>

{
    "FleetId": "fleet-qp3g3caa-mg4w88ho",
    "InstanceId": "ins-3g57621x",
    "ReserveValue": 1
}

Output Example

{
  "Response": {
    "RequestId": "s1611068228708726332"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation The resource is unauthorized.
InternalError An internal error occurred.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.ServiceNotOpened The service is not activated.
UnknownParameter Unknown parameter error