DescribeTimerScalingPolicies

Last updated: 2021-06-23 17:07:03

1. API Description

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

This API (DescribeTimerScalingPolicies) is used to query the scheduled scaling policies of a fleet. You can query the policies by fleetID or the fleet name. The returned results are paged.

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 parameter. The value used for this API: DescribeTimerScalingPolicies.
Version Yes String Common parameter. The value used for this API: 2019-11-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
FleetId No String ID of the fleet to be bound with the policy
TimerName No String Scheduled scaling policy name
BeginTime No String Start time of the scheduled scaling policy
EndTime No String End time of the scheduled scaling policy
Offset No Integer Pagination offset
Limit No Integer Number of entries per page

3. Output Parameters

Parameter Name Type Description
TimerScalingPolicies Array of TimerScalingPolicy Configuration of the scheduled scaling policy
Note: this field may return null, indicating that no valid value is obtained.
TotalCount Integer Total number of scheduled scaling policies
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the timer list

Input Example

POST / HTTP/1.1
Host: gse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimerScalingPolicies
<Common request parameters>

{
    "FleetId": "fleet-qp3g3caa-mg4w88ho",
    "Limit": 10,
    "Offset": 0
}

Output Example

{
  "Response": {
    "RequestId": "s1611556817860590511",
    "TimerScalingPolicies": [
      {
        "TimerId": "",
        "TimerStatus": 1,
        "TimerName": "11111111",
        "TimerFleetCapacity": {
          "FleetId": "fleet-qp3g3caa-mkurlvoa",
          "DesiredInstances": 1,
          "MinSize": 0,
          "MaxSize": 1,
          "ScalingInterval": 10,
          "ScalingType": "ScalingTypeAuto",
          "TargetConfiguration": {
            "TargetValue": 23
          }
        },
        "TimerConfiguration": {
          "TimerType": "TimerTypeDay",
          "TimerValue": {
            "Day": 1,
            "WeekDays": [],
            "FromDay": 0,
            "ToDay": 0
          },
          "BeginTime": "2021-01-14T14:04:29.496Z",
          "EndTime": "2022-01-14T14:04:29.496Z"
        }
      }
    ],
    "TotalCount": 0
  }
}

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
AuthFailure.UnauthorizedOperation The resource is unauthorized.
FailedOperation Operation failed.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.ServiceNotOpened The service is not activated.