GetRealtimeConcurrencyReport

Updated at:

Queries the current concurrency list.

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:GetRealtimeConcurrencyReport

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

No

The instance ID.

85bf7efa-a07c-498a-850e-99a5849b8589

JobGroupId

string

No

The job group ID.

c62e6789-28a8-41db-941e-171a01d3b3b9

PageNumber

integer

No

The page number.

1

PageSize

integer

No

The number of entries per page.

10

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID.

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Success

boolean

Indicates whether the request is successful.

true

Code

string

The API status code.

OK

Message

string

The response message.

Success

Reports

object

The report details.

TotalCount

integer

The total number of entries.

16

PageNumber

integer

The page number.

2

PageSize

integer

The number of entries per page.

10

List

array<object>

The list of reports.

object

The report information.

ReportDate

integer

The time when the report was generated. The value is a UNIX timestamp in milliseconds.

1743474900488

InstanceId

string

The instance ID.

85bf7efa-a07c-498a-850e-99a5849b8589

InstanceName

string

The instance name.

Intelligent outbound call scenario

JobGroupId

string

The job ID.

c62e6789-28a8-41db-941e-171a01d3b3b9

JobGroupName

string

The job name.

First job group

OccupiedConcurrencyCount

integer

The occupied concurrency.

1

MaxConcurrencyLimit

integer

The configured maximum concurrency limit.

2

MinConcurrencyLimit

integer

The minimum concurrency limit for the job.

0

ReportDate

integer

The time when the report was generated. The value is a UNIX timestamp in milliseconds.

1743474900488

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "Reports": {
    "TotalCount": 16,
    "PageNumber": 2,
    "PageSize": 10,
    "List": [
      {
        "ReportDate": 1743474900488,
        "InstanceId": "85bf7efa-a07c-498a-850e-99a5849b8589",
        "InstanceName": "智能外呼场景",
        "JobGroupId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
        "JobGroupName": "第一个作业组\n",
        "OccupiedConcurrencyCount": 1,
        "MaxConcurrencyLimit": 2,
        "MinConcurrencyLimit": 0
      }
    ]
  },
  "ReportDate": 1743474900488
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.