AISearchResourceGetList-阿里云帮助中心

Queries AISearch structured resources. Currently supported resource types include mini programs (miniapp) and products (product). The resource type is a required parameter. If a resource ID is provided, the specified resource is queried. If no resource ID is provided, all resources of the specified type are queried in a paginated manner.

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

energy:AISearchResourceGetList

get

*All Resource

*

None

Request syntax

GET /api/v1/aiSearch/resource/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
type	string	Yes	The structured element type. Valid values: product : product miniapp : miniapp	miniapp
resourceIds	array	No	The list of resources to query. If this parameter is empty, all resources of the specified type are queried in a paginated manner.
	string	No	The structured element resource ID, which is the unique and immutable identifier of the resource in the database.	WzMGQZwB7nQEs3Qk3ajH
pageSize	integer	No	The page size. Default value: 20.	20
currentPage	integer	No	The page number. Pages start from 1.	1

The type field is essentially an enumeration type and only supports specified valid values. Values outside the valid range cause the API to fail. More structured content will be added based on future requirements.

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	A8AEC6D9-A359-5169-BD1A-BD848BA60D65
data	object	The returned result.
total	integer	The total number of resources.	68
currentPage	string	The current page number.	1
pageSize	string	The page size.	20
items	array	The list of resources.
	any	The item details.	{"type":"miniapp","score":0.4571971,"resourceId":"1512004139024243527680","miniappId":"","title":"Electronic Invoice","version":"1.0.0","description":"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.","slogan":"E-Invoice mini-app","icon":"https://gw.alicdn.com/6000000000498-2-tps-200-200.png","url":"https://app-intl.com/release/6592_v1.6.16_poc.zip","detailDescription":null}

Examples

Success response

JSON format

{
  "requestId": "A8AEC6D9-A359-5169-BD1A-BD848BA60D65",
  "data": {
    "total": 68,
    "currentPage": "1",
    "pageSize": "20",
    "items": [
      "  {\"type\":\"miniapp\",\"score\":0.4571971,\"resourceId\":\"1512004139024243527680\",\"miniappId\":\"\",\"title\":\"Electronic Invoice\",\"version\":\"1.0.0\",\"description\":\"The E-Invoice mini-app supports setting up email/SMS delivery, querying issuance records, requesting and reissuing invoices, and downloading or printing PDF files.\",\"slogan\":\"E-Invoice mini-app\",\"icon\":\"https://gw.alicdn.com/6000000000498-2-tps-200-200.png\",\"url\":\"https://app-intl.com/release/6592_v1.6.16_poc.zip\",\"detailDescription\":null}"
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.