1. API Description
Domain name for API request: cwp.intl.tencentcloudapi.com.
This API is used to query snapshots created by the host.
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.
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 Params. The value used for this API: DescribeMachineSnapshot. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-02-28. |
| Region |
No |
String |
Common Params. This parameter is not required. |
| Quuids.N |
Yes |
Array of String |
CVM ID collection |
| Type |
Yes |
Integer |
Inquiry snapshot type: 0 - latest one; 1 - all |
| Limit |
Yes |
Integer |
Number of Pagination |
| Offset |
Yes |
Integer |
Pagination step size |
3. Output Parameters
| Parameter Name |
Type |
Description |
| List |
Array of MachineSnapshotInfo |
List of host snapshot |
| TotalCount |
Integer |
Total number |
| SnapshotCheck |
Boolean |
Whether snapshots created in the last 24 hours exist |
| 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. |
4. Example
Example1 Fixing Vulnerability - Querying Snapshots Created by a Host
https:
&Limit=10
&Offset=0
&Quuids.0=djskldjksld
&Type=0
&<Common request parameters>
Output Example
{
"Response": {
"List": [
{
"CreateTime": "2021-04-06 17:25:57",
"DiskId": "disk-fc19gd5w",
"HostIp": "10.104.9.143",
"HostName": "win_poc testing (129.204.117.208)",
"InstanceId": "ins-lamp8810",
"Quuid": "b9b4f569-22fc-4a90-8d7f-c9e45349cd5b",
"RegionId": 1,
"SnapshotId": "snap-fav9fuhd",
"SnapshotName": "Fixing vulnerability - OpenSSL DoS vulnerability"
}
],
"RequestId": "67060fe1-d34e-468f-8f22-d00105304496",
"TotalCount": 1,
"SnapshotCheck": true
}
}
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 |
| InternalError |
Internal error |
| InternalError.MainDBFail |
Failed to manipulate the data. |
| InvalidParameter |
Incorrect parameter. |
| InvalidParameter.InvalidFormat |
Incorrect parameter format. |
| InvalidParameter.MissingParameter |
Missing parameter. |
| InvalidParameterValue |
Invalid parameter value. |
| MissingParameter |
Missing parameter error. |
| UnauthorizedOperation |
Unauthorized operation. |