ListGeneralConfigs
Lists the general configurations.
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:ListGeneralConfigs | list | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The unique identifier of the Model Studio workspace. For more information, see Get a workspaceId. | llm- |
| PageSize | integer | No | The number of entries per page. | 1 |
| PageNumber | integer | No | The current page number. The default value is 1. | 1 |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The response. | ||
| Data | array<object> | The query results. | |
object | The query results. | ||
| ConfigKey | string | The unique identifier of the configuration item. | xxx |
| ConfigValue | string | The value of the configuration item. | xxx |
| ConfigValueType | string | The type of the configuration item. | CustomSemanticSearch |
| ConfigDesc | string | The description of the configuration item. | xxx |
| PageNumber | integer | The current page number. | 1 |
| RequestId | string | The unique identifier of the request. | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Indicates whether the request was successful. A value of `true` indicates success. A value of `false` indicates failure. | true |
| Code | string | The status code. | NoData |
| Message | string | The fault description. | success |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| TotalCount | integer | The total number of entries. | 100 |
| PageSize | integer | The number of entries per page. | 10 |
Examples
Success response
JSON format
{
"Data": [
{
"ConfigKey": "xxx",
"ConfigValue": "xxx",
"ConfigValueType": "CustomSemanticSearch",
"ConfigDesc": "xxx"
}
],
"PageNumber": 1,
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"Code": "NoData",
"Message": "success",
"HttpStatusCode": 200,
"TotalCount": 100,
"PageSize": 10
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.