Skip to main content

ListVariable

Getting the variable 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.

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

list

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

BusinessUnitId

string

No

The Model Studio workspace ID.

llm-zop7ukgtksltamo4

PageNumber

integer

No

The page number.

1

PageSize

integer

No

The page size.

10

SearchPattern

string

No

A keyword for a fuzzy search on the variable name or display name.

age

Response elements

Element

Type

Description

Example

object

Response schema

RequestId

string

The request ID.

CF6D3484-19A1-5C77-863B-AC8B5754D37C

Code

string

The error code.

OK

HttpStatusCode

integer

The HTTP status code.

200

Message

string

The error message.

Instance llm-rj6aqmctjcit4acy does not exist.

Data

object

Paginated data for the variable list.

PageNumber

integer

The page number.

1

PageSize

integer

The page size.

10

TotalCount

integer

The total number of variables.

50

Variables

array<object>

An array of variable objects.

object

A variable object.

VariableId

string

The variable ID.

af81a389-91f0-4157-8d82-720edd02b66b

CreatedTime

integer

The time when the variable was created, specified as a Unix timestamp in milliseconds.

1754013825102

UpdatedTime

integer

The time when the variable was last updated, specified as a Unix timestamp in milliseconds.

1754013825102

Name

string

The variable name.

age

DisplayName

string

The display name.

Age

Description

string

The description of the variable.

User's current age

InstanceId

string

The Model Studio workspace ID.

llm-zop7ukgtksltamo4

TenantId

string

The tenant ID.

1308144684576655

Params

array

An array of values that provide context for the error message.

string

A value that provides context for the error message.

llm-zop7ukgtksltamo4

Examples

Success response JSON format
{
  "RequestId": "CF6D3484-19A1-5C77-863B-AC8B5754D37C",
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "Instance llm-rj6aqmctjcit4acy does not exist.",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 50,
    "Variables": [
      {
        "VariableId": "af81a389-91f0-4157-8d82-720edd02b66b",
        "CreatedTime": 1754013825102,
        "UpdatedTime": 1754013825102,
        "Name": "age",
        "DisplayName": "年龄",
        "Description": "用户当前年龄",
        "InstanceId": "llm-zop7ukgtksltamo4",
        "TenantId": "1308144684576655"
      }
    ]
  },
  "Params": [
    "llm-zop7ukgtksltamo4"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.