1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
Used to proactively return the CDH.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-10-28 03:50:02.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: TerminateHosts |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| HostIds | Yes | No | Array of String | One or more CDH instance IDs to be operated. Example: ["host-ey16rkyg\r\n"] |
| DryRun | No | No | Bool | Whether to skip the actual execution logic. Example: DesAction |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TaskId | String | Task ID Example: 543225 |
| flowId | Int64 | Task Flow ID Example: 2 |
| FlowId | Int64 | Task Flow ID Example: 2 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidHostId.NotFound | The specified HostId does not exist, or does not belong to the requesting account. |
| InvalidHostId.Malformed | Invalid CDH ID. The format of the specified CDH ID is incorrect, for example, an ID length error host-1122. |
| MissingParameter | Parameters are missing. The request did not include mandatory parameters. |
| InvalidHost.NotSupported | The specified operation is not supported by this host instance. |