GetAuditNotePostProcessingStatus

Updated at:

Queries the progress of a post-processing task for a rule library. Use this operation together with the ConfirmAndPostProcessAuditNote operation to check the status of the current post-processing task.

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

aimiaobi:GetAuditNotePostProcessingStatus

get

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see Get a Workspace ID.

llm-xx

TaskId

string

Yes

The task ID returned by the SubmitAuditNote operation. This is the unique identifier for the task index of the custom rule library. Save this ID for future use.

xxx_Default_12847192741412

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 was successful.

true

Code

string

The status code.

DataNotExists

Message

string

The error details.

success

HttpStatusCode

integer

The HTTP status code.

200

Data

object

The returned data.

NoteId

string

The ID of the rule library. The default value in the current version is "Default".

Default

Status

string

The status of the post-processing task. Valid values: PENDING, RUNNING, SUCCEEDED, and FAILED.

RUNNING

TotalLines

integer

The total number of lines in the structured rule library.

666

ProcessedLines

integer

The number of lines that have been post-processed.

233

ErrorMessage

string

The error message. This is returned only when the post-processing task fails.

error

CreateTime

string

The time when the post-processing task was created. The format is YYYY-MM-DD HH:mm:ss.

1970-01-01 12:34:56

CompletionTime

string

The time when the post-processing task was completed. The format is YYYY-MM-DD HH:mm:ss.

1970-01-01 23:34:45

Examples

Success response

JSON format

{
  "RequestId": "F2F366D6-E9FE-1006-BB70-2C650896AAB5",
  "Success": true,
  "Code": "DataNotExists",
  "Message": "success",
  "HttpStatusCode": 200,
  "Data": {
    "NoteId": "Default",
    "Status": "RUNNING",
    "TotalLines": 666,
    "ProcessedLines": 233,
    "ErrorMessage": "error",
    "CreateTime": "1970-01-01 12:34:56",
    "CompletionTime": "1970-01-01 23:34:45"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.