tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBlueprints

Last updated: 2023-12-04 16:31:59

    1. API Description

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

    This API is used to query the information of an image.

    A maximum of 10 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 Params. The value used for this API: DescribeBlueprints.
    Version Yes String Common Params. The value used for this API: 2020-03-24.
    Region No String Common Params. This parameter is not required for this API.
    BlueprintIds.N No Array of String Image ID list.
    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.
  • blueprint-id
    • Filter by the image ID.
    Type: String
    Required: no
  • blueprint-type
    • Filter by the image type.
    Valid values: APP_OS (application image), PURE_OS (system image), DOCKER (Docker container image), PRIVATE (custom image), SHARED (shared image)
    Type: String
    Required: no
  • platform-type
    • Filter by the image operating system.
    Valid values: LINUX_UNIX (Linux or Unix), WINDOWS (Windows)
    Type: String
    Required: no
  • blueprint-name
    • Filter by the image name.
    Type: String
    Required: no
  • blueprint-state
    • Filter by the image status.
    Type: String
    Required: no
  • scene-id
    • Filter by the scene ID.
    Type: String
    Required: no

    Each request can contain up to 10 Filters, each of which can contain up to 100 Filter.Values. BlueprintIds and Filters cannot be specified at the same time.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible images.
    BlueprintSet Array of Blueprint Image details list.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying image information

    This example shows you how to query image information.

    Input Example

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

{
    "BlueprintIds": [
        "lhbp-5e8807sc"
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "BlueprintSet": [
            {
                "BlueprintId": "lhbp-5e8807sc",
                "DisplayTitle": "wordpress",
                "DisplayVersion": "5.3.2",
                "Description": "Personal blog website construction",
                "OsName": "CentOS-7.6-64bit",
                "Platform": "CENTOS",
                "PlatformType": "LINUX_UNIX",
                "BlueprintType": "APP_OS",
                "ImageUrl": "http://www.wordpress.com/image",
                "RequiredSystemDiskSize": 50,
                "BlueprintState": "NORMAL",
                "CreatedTime": "2020-04-28T03:46:09Z",
                "BlueprintName": "Wordpress",
                "SupportAutomationTools": true,
                "RequiredMemorySize": 1,
                "ImageId": "",
                "SceneIdSet": [],
                "CommunityUrl": "CommunityUrl_test",
                "GuideUrl": "GuideUrl_test"
            }
        ],
        "RequestId": "3df9cd92-cec1-4864-a2a1-358084f41551"
    }
}

    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
    FailedOperation Operation failed.
    FailedOperation.DescribeBlueprintsFailed Failed to query the image. Try again later.
    InternalError.InvalidCommandNotFound The command is not found.
    InvalidParameter.FilterValueLimitExceeded Invalid parameter: the number of Values in the Filter parameter exceeds the allowed maximum number.
    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.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.
    InvalidParameterValue.TooLong The length of the parameter value exceeds the upper limit.
    ResourceNotFound.RoleNotFound The service role does not exist. Please add it to the account.
    ResourceNotFound.SceneIdNotFound Scene ID not found.
    UnauthorizedOperation.NoPermission No permission
    UnauthorizedOperation.TokenInvalid
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy