ListJobGroupsAsync-阿里云帮助中心

Asynchronously retrieves the list of outbound call task groups. When the Async parameter is specified in the ListJobGroup operation, use this operation to retrieve the results of the asynchronous ListJobGroup call.

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

outboundbot:ListJobGroupsAsync

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AsyncTaskId	string	Yes	The value of AsyncTaskId returned by ListJobGroup when the Async mode is used. You can use this ID to retrieve the results of the asynchronous query.	6243d904-939d-42ce-a8e4-886a139e77a3

Response elements

Element	Type	Description	Example
	object
Timeout	boolean	Indicates whether the request timed out.	true
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
Vaild	boolean	Indicates whether the result is valid.	true
Code	string	The status code.	OK
Message	string	The response message.	Success
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	100
JobGroups	array<object>	The task list.
	array<object>
Status	string	The task status.	Scheduling
CreationTime	integer	The creation time.	1640316786259
JobGroupId	string	The task ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
JobGroupName	string	The task name.	xxx
TotalCallNum	integer	The total number of calls.	100
ScriptId	string	The script ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
JobGroupDescription	string	The task description.	xxx
JobDataParsingTaskId	string	The ID of the jobFile parsing task. [Deprecated]	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
ScriptName	string	The script name.	xxxx
ScriptVersion	string	The script version.	111
ModifyTime	string	The modification time, in milliseconds.	1640316786259
Strategy	object	The strategy. [Deprecated] Note To view the task strategy information, call the DescribeJobGroup operation.	{}
EndTime	integer	The end time of the scheduling policy.	1640316786259
StartTime	integer	The start time of the scheduling policy.	1640316786259
Progress	object	The node statistics information.	{}
TotalNotAnswered	integer	This parameter is deprecated. The number of unanswered calls.	1
Status	string	The execution state. Valid values: `Draft`: The job group is a draft. `Scheduling`: The job group is being scheduled. `Executing`: The job group is running. `Completed`: The job group is complete. `Paused`: The job group is paused. `Failed`: The job group has failed. `Cancelled`: The job group is canceled. `Initializing`: The job group is being initialized.	Scheduling
StartTime	integer	This parameter is deprecated. The time when the job group started.	1640316786259
FailedNum	integer	The number of failed jobs.	10
PausedNum	integer	The number of paused jobs.	10
CancelledNum	integer	The number of canceled jobs.	10
TotalCompleted	integer	The number of completed jobs.	10
TotalJobs	integer	The total number of jobs.	100
Duration	integer	This parameter is deprecated. The total duration of the execution.	1000
Scheduling	integer	The number of jobs that are being scheduled.	20
ExecutingNum	integer	The number of jobs that are being executed.	20
ExportProgress	object	The export progress.	{}
Status	string	The status of the export.	PENDING
FileHttpUrl	string	This parameter is deprecated. The download URL of the file.	http://www.xxx.com/xxx
Progress	string	The progress of the export.	50
MinConcurrency	integer	The minimum concurrency.	1

Examples

Success response

JSON format

{
  "Timeout": true,
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Vaild": true,
  "Code": "OK",
  "Message": "Success",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 100,
  "JobGroups": [
    {
      "Status": "Scheduling",
      "CreationTime": 1640316786259,
      "JobGroupId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "JobGroupName": "xxx",
      "TotalCallNum": 100,
      "ScriptId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "JobGroupDescription": "xxx",
      "JobDataParsingTaskId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "ScriptName": "xxxx",
      "ScriptVersion": "111",
      "ModifyTime": "1640316786259",
      "Strategy": {
        "EndTime": 1640316786259,
        "StartTime": 1640316786259
      },
      "Progress": {
        "TotalNotAnswered": 1,
        "Status": "Scheduling",
        "StartTime": 1640316786259,
        "FailedNum": 10,
        "PausedNum": 10,
        "CancelledNum": 10,
        "TotalCompleted": 10,
        "TotalJobs": 100,
        "Duration": 1000,
        "Scheduling": 20,
        "ExecutingNum": 20
      },
      "ExportProgress": {
        "Status": "PENDING",
        "FileHttpUrl": "http://www.xxx.com/xxx\n",
        "Progress": "50"
      },
      "MinConcurrency": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.