tencent cloud

Feedback

DescribeInstancesOperationLimit

Last updated: 2024-10-22 19:33:17

    1. API Description

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

    This API is used to query limitations on operations on an instance.

    • Currently you can use this API to query the maximum number of times you can modify the configuration of an instance.

    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: DescribeInstancesOperationLimit.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceIds.N Yes Array of String Query by instance ID(s). You can obtain the instance IDs from the value of InstanceId returned by the DescribeInstances API. For example, instance ID: ins-xxxxxxxx. (For the specific format, refer to section ids.N of the API Introduction.) You can query up to 100 instances in each request.
    Operation Yes String Operation on the instance(s).
  • INSTANCE_DEGRADE: downgrade the instance configurations
  • 3. Output Parameters

    Parameter Name Type Description
    InstanceOperationLimitSet Array of OperationCountLimit The maximum number of times you can modify the instance configurations (degrading the configurations)
    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.

    4. Example

    Example1 Querying the number of configuration downgrade operations allowed

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=DescribeInstancesOperationLimit
    &InstanceIds.0=ins-r8hr2upy
    &Operation=INSTANCE_DEGRADE
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "InstanceOperationLimitSet": [
                {
                    "Operation": "INSTANCE_DEGRADE",
                    "InstanceId": "ins-r8hr2upy",
                    "CurrentCount": 0,
                    "LimitCount": 5
                }
            ],
            "RequestId": "951caf78-580f-42f6-8b83-a902d051d672"
        }
    }
    

    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
    InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.