tencent cloud



Last updated: 2022-09-26 17:00:22

1. API Description

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

This API is used to modify an image attribute.

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.

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: ModifyBlueprintAttribute.
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.
BlueprintId Yes String Image ID, which can be obtained from the BlueprintId returned by the DescribeBlueprints API.
BlueprintName No String New image name, which can contain up to 60 characters.
Description No String New image description, which can contain up to 60 characters.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying image name and description

Input Example

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

    "BlueprintId": "lhbp-1ynlfst1",
    "BlueprintName": "new-blueprint",
    "Description": "new-blueprint"

Output Example

    "Response": {
        "RequestId": "896682bb-fb47-4fce-94d9-9a4f2abbfaac"

5. Developer Resources


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.
InvalidParameterValue.BlueprintIdMalformed Invalid parameter value: the image ID format is invalid.
InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.TooLong The length of the parameter value exceeds the upper limit.
MissingParameter Missing parameter.
ResourceNotFound.BlueprintIdNotFound The image ID does not exist.
ResourceNotFound.PrivateBlueprintNotFound The custom image does not exist.
UnsupportedOperation.BlueprintCurStateInvalid The current status of the image does not support this operation.
UnsupportedOperation.NotSupportSharedBlueprint The shared image does not support this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support