Skip to main content

ListApplications

Lists Intelligent Speech Interaction applications.

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.

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

bailianvoicebot:ListApplications

none

*All Resource

*

NoneNone

Request parameters

Parameter

Type

Required

Description

Example

BusinessUnitId

string

Yes

The ID of the Model Studio business unit.

llm-c11iig67g863rih8

SearchPattern

string

No

The name of the template. Supports fuzzy search.

General

PageNumber

integer

Yes

The page number.

1

PageSize

integer

Yes

The number of entries per page.

10

Response elements

Element

Type

Description

Example

object

Code

string

The status of the request. OK indicates success. If an error occurs, a POP error code is returned.

OK

HttpStatusCode

integer

The HTTP status code.

200

Message

string

A message that provides details about the response.

successful

RequestId

string

The request ID.

D771A1B6-3D5F-174A-BEE1-98CE1000D337

Data

object

The data payload returned by the operation.

PageNumber

integer

The page number.

1

PageSize

integer

The number of entries per page.

1000

TotalCount

integer

The total number of entries.

6

Applications

array<object>

A list of applications.

object

Details of a single application.

CreatedTime

integer

The time when the application was created, represented as a UNIX timestamp.

1729909690

UpdatedTime

integer

The time when the application was last updated, represented as a UNIX timestamp.

1729909348

ApplicationId

string

The application ID.

a395011f-a247-400f-bc69-28796749fd52

Name

string

The application name.

Test 001

Description

string

The application description.

Describe this application

Concurrency

integer

The number of concurrent requests allowed.

10

NluEngine

string

The Natural Language Understanding (NLU) engine.

PROMPTS

NluAccessType

string

The NLU access type.

MANAGED

DraftVersionId

string

The draft version ID.

20904943-f711-494f-9f1f-e7f340f37707

PublishedVersionId

string

The published version ID.

20904943-f711-494f-9f1f-e7f340f37707

Examples

Success response JSON format
{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "successful",
  "RequestId": "D771A1B6-3D5F-174A-BEE1-98CE1000D337",
  "Data": {
    "PageNumber": 1,
    "PageSize": 1000,
    "TotalCount": 6,
    "Applications": [
      {
        "CreatedTime": 1729909690,
        "UpdatedTime": 1729909348,
        "ApplicationId": "a395011f-a247-400f-bc69-28796749fd52\n",
        "Name": "测试001\n",
        "Description": "描述一下这个应用",
        "Concurrency": 10,
        "NluEngine": "PROMPTS",
        "NluAccessType": "MANAGED",
        "DraftVersionId": "20904943-f711-494f-9f1f-e7f340f37707\n",
        "PublishedVersionId": "20904943-f711-494f-9f1f-e7f340f37707\n"
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400Parameter.EnumerationThe parameter %s must be one of the value of enumeration %s.
400Parameter.BlankThe parameter %s must not be null or empty.
400Parameter.EmptyThe parameter %s may not be null or empty.
400Parameter.NullThe parameter %s may not be null.
403Permission.UnauthorizedYou are not authorized to perform this action. %s privileges are required.
404NotExists.InstanceIdThe specified instance %s does not exist.
See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.