tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstancesAttribute

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

    1. API Description

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

    This API is used to modify an instance attribute.

    • The instance name is used only for users’ convenience.
    • Batch operations are supported. The maximum number of instances in each request is 100.

    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: ModifyInstancesAttribute.
    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.
    InstanceIds.N Yes Array of String Instance ID list. Each request can contain up to 100 instances at a time. You can get an instance ID from the InstanceId returned by the DescribeInstances API.
    InstanceName No String Instance name, which is customizable and 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 Renaming instance

    This example shows you how to rename two instances.

    Input Example

    https://lighthouse.tencentcloudapi.com/?Action=ModifyInstancesAttribute
&InstanceIds.0=lhins-ruy9d2tw
&InstanceIds.1=lhins-rusdke45
&InstanceName=test
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "47421b28-de2c-486e-b244-e47e64bf7357"
    }
}

    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.DescribeInstanceStatus An error occurred when querying the instance status.
    FailedOperation.InstanceOperationFailed Failed to manipulate the instance.
    FailedOperation.ModifyResourcesAttributeFailed Failed to change the resource attribute. Try again later...
    FailedOperation.RequestError A request error occurred.
    FailedOperation.TradeCallBillingGatewayFailed Failed to call the billing gateway service. Please try again later.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InternalError.TradeCallBillingGatewayFailed Failed to call billing gateway service
    InvalidParameter.OnlyAllowModifyOneAttribute Invalid parameter: only one attribute can be modified at a time.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.InstanceNameTooLong Invalid parameter value: the length of the instance name exceeds the upper limit.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy