GetDataSourceOrderConfig
Retrieves configuration information for write data sources and general search data sources.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
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:GetDataSourceOrderConfig | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | Unique identifier for the workspace: AgentKey | d9a1f6146a37446495d9985c2e7b267e_p_outbound_public |
| ProductCode | string | Yes | Configuration type. Possible values:
| miaobi |
| GenerateTechnology | string | No | When productCode=miaosou, this corresponds to Miaosou: generation technology. Possible values: Valid values:
| copilotPrecise |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | PlainResult | ||
| Code | string | Status code | successful |
| Data | object | Business data | |
| UserConfigDataSourceList | array<object> | List of user-configured data source weights | |
object | |||
| Code | string | Code description | QuarkCommonNews |
| Name | string | Display name | 夸克通用搜索 |
| Number | integer | Quantity | 20 |
| Type | string | Type | SystemSearch |
| Enable | boolean | Is enabled | |
| TotalDocSize | integer | Maximum total document count | 1 |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Error description | successful |
| RequestId | string | Unique request identifier | 428DCC0D-3C63-5306-BD1B-124396AB97BE |
| Success | boolean | Is successful: true for success, false for failure | true |
Examples
Success response
JSON format
{
"Code": "successful",
"Data": {
"UserConfigDataSourceList": [
{
"Code": "QuarkCommonNews",
"Name": "夸克通用搜索",
"Number": 20,
"Type": "SystemSearch",
"Enable": false
}
],
"TotalDocSize": 1
},
"HttpStatusCode": 200,
"Message": "successful",
"RequestId": "428DCC0D-3C63-5306-BD1B-124396AB97BE",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.