AISearchResourceAdd-阿里云帮助中心

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

none

*All Resource

*

None

Request syntax

POST /api/v1/aiSearch/resource/add HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body parameters.
type	string	Yes	The type of the structured element. Valid values: product : product miniapp : miniapp	miniapp
data	any	No	The structured element information corresponding to the type. You must pass parameters for this field in JSON format according to the specified format. When the type is mini program (miniapp) "miniappId": "Required. The unique identifier of the mini program." "title": "Required. The name of the mini program." "version": "Required. The version number." "description": "Required. A brief description." "detailDesc": "Optional. A detailed description." "slogan": "Optional. A slogan." "icon": "Required. The URL of the icon." "url": "Required. The URL of the mini program." When the type is product (product) "title": "Required. The name of the product." "description": "Required. The description of the product." "icon": "Required. The URL of the product icon." "url": "Required. The URL of the product." "price": "Required. The price." "extra": "Optional. Extension fields. Any key-value object."	{ "miniapp_id": "test_miniapp", "title": "testApp", "version": "1.0.5", "description": "description-mock", "slogan": "slogan-mock", "icon": "https://img.alicdn.com/test_icon.png", "detail_desc": "detail-mock" }

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

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	4A0AEC56-5C9A-5D47-93DF-7227836FFF82
data	object	The returned data.
type	string	The type of the structured element. The value is the same as the type field in the request parameters. Valid values: product : product miniapp : miniapp	miniapp
resourceId	string	The resource ID of the structured element. This is a unique and immutable identifier for the resource in the database, and is used for subsequent update, delete, and query operations.	WzMGQZwB7nQEs3Qk3ajH

Examples

Success response

JSON format

{
  "requestId": "4A0AEC56-5C9A-5D47-93DF-7227836FFF82",
  "data": {
    "type": "miniapp",
    "resourceId": "WzMGQZwB7nQEs3Qk3ajH"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.