Obtains the running state data of jobs that are in the running state in a specified period of time.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
odps:GetRunningJobs | list | *All Resources * |
| none |
Request syntax
GET /api/v1/jobs/runningJobs HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
from | long | Yes | The time when the query starts. This parameter specifies the time when a job is submitted.
| 1683785928 |
to | long | Yes | The time when the query ends. This parameter specifies the time when a job is submitted.
| 1683612946 |
jobOwnerList | array | No | The list of job executors. | |
item | string | No | The list of job executors. | ALIYUN$xxx@test.aliyunid.com |
quotaNicknameList | array | No | The list of nicknames of quotas that are used by jobs. | |
item | string | No | The list of nicknames of quotas that are used by jobs. | my_quota |
pageNumber | long | No | The page number. | 1 |
pageSize | long | No | The number of entries per page. Default value: 10. Maximum value: 20. | 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"requestId": "0bc3b4ab16684833172127321e2c25",
"httpCode": 200,
"errorCode": "success",
"errorMsg": "0A3B1FD2006A24C8D8BE65CDAC028298",
"data": {
"runningJobInfoList": [
{
"instanceId": "2023050206371544gomgtp3ljcr4",
"jobOwner": "ALIYUN$xxx@test.aliyunid.com",
"project": "project_20221021123044_981b",
"quotaNickname": "my_quota",
"cuSnapshot": 0.45,
"memorySnapshot": 0.45,
"submittedAtTime": 1689746864,
"runningAtTime": 1689746864,
"progress": 0
}
],
"totalCount": 64,
"pageNumber": 2,
"pageSize": 10
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-08-26 | The internal configuration of the API is changed, but the call is not affected | View Change Details |