Domain name for API request: lighthouse.intl.tencentcloudapi.com.
This API is used to query the image information of a reset instance.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeResetInstanceBlueprints. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID |
| Offset | No | Integer | Offset. Default value: 0. For more information on Offset, please see the relevant section in Overview. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, please see the relevant section in the API Overview. |
| Filters.N | No | Array of Filter | Filter list Type: String Required: no Valid values: APP_OS: application image; PURE_OS: system image; PRIVATE: custom imageType: String Required: no Valid values: LINUX_UNIX: Linux or Unix; WINDOWS: WindowsType: String Required: no Type: String Required: no Type: String Required: no Each request can contain up to 10 Filters and 5 Filter.Values. BlueprintIds and Filters cannot be specified at the same time. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible images. |
| ResetInstanceBlueprintSet | Array of ResetInstanceBlueprint | Image reset information list |
| 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. |
POST / HTTP/1.1
Host: lighthouse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResetInstanceBlueprints
<Common Request Parameter>
{
"InstanceId": "lhins-euqk4yut"
}
{
"Response": {
"RequestId": "d085dd6e-fd50-426f-bb29-b0ed899ccdf7",
"ResetInstanceBlueprintSet": [
{
"BlueprintInfo": {
"BlueprintId": "lhbp-m1g6ap11",
"BlueprintName": "7_days_to_die_windows",
"BlueprintState": "NORMAL",
"BlueprintType": "APP_OS",
"CommunityUrl": "",
"CreatedTime": "2024-06-12T23:30:03Z",
"Description": "7 Days to Die is a survival game.",
"DisplayTitle": "7 Days to Die Windows",
"DisplayVersion": " ",
"DockerVersion": "",
"GuideUrl": "",
"ImageId": "",
"ImageUrl": "https://static.cloudcachetci.com/qcloud/ui/static/static_source_business/f1afb130-22a7-479d-a5a3-013e8f633b5a.svg",
"OsName": "Windows Server 2022 DataCenter 64bit CN",
"Platform": "WINDOWS",
"PlatformType": "WINDOWS",
"RequiredMemorySize": 2,
"RequiredSystemDiskSize": 50,
"SceneIdSet": [],
"SupportAutomationTools": true
},
"IsResettable": false,
"NonResettableMessage": "Switching between Linux and Windows systems is not supported in non-Chinese mainland regions."
}
],
"TotalCount": 1
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter.FilterValueLimitExceeded | Invalid parameter: the number of Values in the Filter parameter exceeds the allowed maximum number. |
| InvalidParameter.InstanceDisplayAreaNotSupportParameter | |
| InvalidParameter.InvalidFilter | Invalid parameter: the Filter parameter is invalid. |
| InvalidParameter.InvalidFilterInvalidKey | Invalid parameter: the value of Name in the Filter parameter is invalid. |
| InvalidParameter.InvalidFilterInvalidNameNotStr | Invalid parameter: the value of Name in the Filter parameter is not a string. |
| InvalidParameter.InvalidFilterNotDict | Invalid parameter: the Filter parameter is not a dictionary. |
| InvalidParameter.InvalidFilterNotSupportedName | Invalid parameter: there are unsupported Name values in the Filter parameter. |
| InvalidParameter.ParameterConflict | Invalid parameter: the parameters conflict. |
| InvalidParameterValue.BlueprintIdMalformed | Invalid parameter value: the image ID format is invalid. |
| InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
| InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
| InvalidParameterValue.InvalidBlueprintPlatformType | The type of the image OS is invalid. |
| InvalidParameterValue.InvalidBlueprintState | Invalid image status value |
| InvalidParameterValue.InvalidBlueprintType | The image type is invalid. |
| InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
| InvalidParameterValue.Negative | Invalid parametric value: it cannot be negative. |
| InvalidParameterValue.OutOfRange | Invalid parametric value: it is not within the valid range. |
| ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
| UnauthorizedOperation.NoPermission | No permission. |
피드백