ListSearchTasks

更新时间:
复制 MD 格式

Queries the list of historical tasks generated by Miaosou Search.

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

aimiaobi:ListSearchTasks

list

*All Resource

*

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see Obtain workspaceId.

llm-xx

DialogueTypes

array

No

Task type

24

integer

No

Task type

24

PageNumber

integer

No

Current page number

1

PageSize

integer

No

Number of items per page. Default is 10.

10

Response elements

Element

Type

Description

Example

object

Response result

Data

array<object>

Business data

object

Business data

TaskId

string

Unique task identifier

xxxx

TaskName

string

Task name

xxx

CreateTime

string

Creation time

2024-11-25 11:40:50

UpdateTime

string

Modification time

2024-11-25 11:40:50

DialogueType

integer

Task type

24

Username

string

Creator name

xxxx

PageNumber

integer

Current page number

1

PageSize

integer

Number of records per page

10

TotalCount

integer

Total number of records

100

RequestId

string

Unique request identifier

1813ceee-7fe5-41b4-87e5-982a4d18cca5

Success

boolean

Indicates whether the request was successful. True for success, false for failed.

true

Code

string

Status code

NoData

Message

string

Fault description

success

HttpStatusCode

integer

HTTP status code

200

Examples

Success response

JSON format

{
  "Data": [
    {
      "TaskId": "xxxx",
      "TaskName": "xxx",
      "CreateTime": "2024-11-25 11:40:50",
      "UpdateTime": "2024-11-25 11:40:50",
      "DialogueType": 24,
      "Username": "xxxx"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100,
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.