Help & DocumentationAPIsCloud Virtual MachineInstance APIsDescribeInstancesOperationLimit

DescribeInstancesOperationLimit

Last updated: 2020-03-16 18:27:26

Contents：

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeInstancesOperationLimit.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. The instance ID format is ins-xxxxxxxx. For more information on the format of this parameter, see the id.N section of API Introduction). The maximum number of instance IDs in each request is 100.
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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying 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

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.