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.
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 | No | String | Common Params. This parameter is not required for this API. |
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. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify the name and description of an image.
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBlueprintAttribute
<Common request parameters>
{
"BlueprintId": "lhbp-1ynlfst1",
"BlueprintName": "new-blueprint",
"Description": "new-blueprint"
}
{
"Response": {
"RequestId": "896682bb-fb47-4fce-94d9-9a4f2abbfaac"
}
}
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.ModifyResourcesAttributeFailed | Failed to change the resource attribute. Try again later... |
InternalError | Internal error. |
InvalidParameter.MustSpecifyOneAttributeToModify | Please specify at least one attribute to modify. |
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. |
Was this page helpful?