cvm — Cloud Virtual Machine
cvm · 2017-03-12
ModifyInstancesRenewFlag
POST
Modify the renewal flag of monthly subscription instances.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /cvm/ModifyInstancesRenewFlag path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://cvm.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/cvm/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: cvm.api3.convergecloud.com' \
-H 'X-TC-Action: ModifyInstancesRenewFlag' \
-H 'X-TC-Version: 2017-03-12' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"InstanceIds":["<InstanceId>"],"RenewFlag":"<RenewFlag>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| InstanceIds | string[] | Yes | For one or more instance IDs to be operated. You can obtain the instance ID through the `instanceid` in the returned value from the API DescribeInstances. The maximum number of instances that can be operated for each request is 100. |
| RenewFlag | string | Yes | Auto-renewal flag. Valid values: NOTIFY_AND_AUTO_RENEW: Notifies of expiration and performs auto-renewal. NOTIFY_AND_MANUAL_RENEW: Notifies of expiration but does not perform auto-renewal. DISABLE_NOTIFY_AND_MANUAL_RENEW: Not notifies of expiration nor perform auto-renewal. If this parameter is specified to NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis aft… |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
// action-specific fields,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/cvm.
Request bodyvalid JSONPOST cvm.api3.convergecloud.com · ModifyInstancesRenewFlag