GetAvailableAuditNotes
Query the rule libraries that are currently available for audit. This operation returns only rule libraries that are active for auditing. To view the contents of a custom rule library, use the DownloadAuditNote API.
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:GetAvailableAuditNotes | get | *All Resource
| None | None |
Request syntax
POST HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The unique identifier of your Alibaba Cloud Model Studio workspace. Get your workspace ID. | llm-xx |
| NoteId | string | No | The rule library ID. If not specified, defaults to Default. |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | Schema of Response | ||
| RequestId | string | Id of the request | F2F366D6-E9FE-1006-BB70-2C650896AAB5 |
| Success | boolean | Indicates whether the request succeeded. | true |
| Code | string | Status code | DataNotExists |
| Message | string | Error message | success |
| HttpStatusCode | integer | HTTP status code | 200 |
| Data | object | Response data | |
| Id | string | Primary ID of the rule library storage. | 1 |
| NoteId | string | Rule library ID. | Default |
| UpdateTime | string | Rule library update time. | 2025-07-07 11:56:30 |
| FileSize | integer | Rule library file size in bytes. | 23333 |
| NoteName | string | Parsed rule library name. | 错题本2025-07-07_解析结果 |
Examples
Success response
JSON format
{
"RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
"Success": true,
"Code": "DataNotExists",
"Message": "success",
"HttpStatusCode": 200,
"Data": {
"Id": "1",
"NoteId": "Default",
"UpdateTime": "2025-07-07 11:56:30",
"FileSize": 23333,
"NoteName": "错题本2025-07-07_解析结果"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.