GetOverview-阿里云帮助中心

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

edas:ReadSchedulerxOverviewQuery

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
Namespace	string	No	The unique identifier (UID) of the namespace.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
GroupId	string	No	The application group ID.	testSchedulerx.defaultGroup
Operate	string	Yes	The query type. Valid values: query: queries data in a time range. query_range: queries time series data in a time range.	query
MetricType	integer	Yes	The metric type. Valid values: 0: the basic job data. 1: the job running data.	0
StartTime	integer	Yes	The beginning of the time range to query. The value must be a UNIX timestamp (in seconds).	1684166400
EndTime	integer	No	The end of the time range to query. The value must be a UNIX timestamp (in seconds). If left empty, the current time is used.	1684166400

当前接口查询数据信息对应控制台概览的三块信息内容，相应请求参数配置要求如下

任务基础信息：请求参数配置说明如下，Operate 设置“query”，MetricType 设置为“0”，StartTime 设置为当前时间戳
时间区间任务运行信息：请求参数配置说明如下，Operate 设置“query”，MetricType 设置为“1”，StartTime 设置为业务需要的查询起始时间（不得早于 15 天，当前时序数据存储有效期为 15 天）
时间区间任务运行时序信息：请求参数配置说明如下，Operate 设置“query_range”，MetricType 设置为“1”，StartTime 设置为业务需要的查询起始时间（默认推荐当前 1 小时前，因返回每个时点信息量大不建议设置过早）

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	The status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	Additional information. Returned only if an error occurs.	No access permission for the namespace [***]
Data	string	The data returned in JSON format. Valid data types: Basic job data. Job running data. Time series data for job execution: includes triggering statistics, records of successful and failed executions, and their associated timestamps within a specific time range.	Basic info: {"schedulerx_job_counter_disable": "4","schedulerx_job_trigger_counter_running": "0","schedulerx_job_counter_enable": "70","schedulerx_job_counter_all": "74","schedulerx_worker_counter": "2"}

Data 信息会根据三种数据读取，返回不同格式的 JSON 内容，参考如下：

基础信息：

{
  "schedulerx_job_counter_disable": "4",  // 禁用任务数
  "schedulerx_job_counter_enable": "70", // 启用任务数
  "schedulerx_job_counter_all": "74", // 总任务数
  "schedulerx_worker_counter": "2", // 在线机器数
  "schedulerx_job_trigger_counter_running": "0" // 任务运行中实例数
}

时间区间任务运行信息：

{
    "schedulerx_job_trigger_counter_success": "227",  // 
    "schedulerx_job_trigger_counter_all": "225",
    "schedulerx_job_trigger_counter_failed": "0"
}

时间区间任务运行时序信息：返回对应区间任务触发、运行成功、运行失败三个数据项对应时点的统计信息

[
    {
      "data": [
        [
          1686110400000, 
          4
        ],
        [
          1686110460000,
          5
        ]
      ],
      "name": "触发次数"
    },
    {
      "data": [
        [
          1686110400000,
          0
        ],
        [
          1686110460000,
          0
        ]
      ],
      "name": "执行失败"
    },
    {
      "data": [
        [
          1686110400000,
          4
        ],
        [
          1686110460000,
          5
        ]
      ],
      "name": "执行成功"
    }
  ]

Examples

Success response

JSON format

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "No access permission for the namespace [***]",
  "Data": "Basic info: {\"schedulerx_job_counter_disable\": \"4\",\"schedulerx_job_trigger_counter_running\": \"0\",\"schedulerx_job_counter_enable\": \"70\",\"schedulerx_job_counter_all\": \"74\",\"schedulerx_worker_counter\": \"2\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.