DescribeServiceCronScaler - Platform For AI - Alibaba Cloud Documentation Center

Queries the Cron Horizontal Pod Autoscaler (CronHPA) configurations of a service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eas:DescribeServiceCronScaler

get

*Service

acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}

None

Request syntax

GET /api/v2/services/{ClusterId}/{ServiceName}/cronscaler HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region ID of the service.	cn-shanghai
ServiceName	string	Yes	The service name. For more information about how to query the service name, see ListServices.	foo

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	40325405-579C-4D82****
ServiceName	string	The service name.	foo
ExcludeDates	array	The points in time that are excluded when you schedule a CronHPA job. The points in time must be specified by using a cron expression.
	string	The cron expression.	* * * * * 0,6
ScaleJobs	array<object>	The CronHPA jobs.
	object
Schedule	string	The cron expression that is used to configure the execution time of the CronHPA job.	0 18 * * * *
TargetSize	integer	The number of instances that you expect to configure for the CronHPA job.	1
Name	string	The name of the CronHPA job.	scale-job-1
Message	string	The returned message.	"cron hpa job scale-jobs-0 executed successfully. current replicas:3, desired replicas:2."
State	string	The status of the most recent CronHPA job.	Succeed
LastProbeTime	string	The time when the most recent CronHPA job ran. The time is displayed in UTC.	2022-02-24T06:31:00Z
CreateTime	string	The time when the most recent CronHPA job was created. The time is displayed in UTC.	2020-06-24T02:11:30Z

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "ServiceName": "foo",
  "ExcludeDates": [
    "* * * * * 0,6\n"
  ],
  "ScaleJobs": [
    {
      "Schedule": "0 18 * * * *",
      "TargetSize": 1,
      "Name": "scale-job-1",
      "Message": "\"cron hpa job scale-jobs-0 executed successfully. current replicas:3, desired replicas:2.\"",
      "State": "Succeed",
      "LastProbeTime": "2022-02-24T06:31:00Z",
      "CreateTime": "2020-06-24T02:11:30Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.