Enables or disables event notifications for an AI agent and configures the callback URL and event types.
Operation description
Request description
You can call this operation to configure event notifications for an AI agent. You can configure EnableNotify to enable or disable event notifications, configure CallbackUrl to specify a callback URL, and configure EventTypes to specify event types. You can also configure Token to specify an authentication token for enhanced security. The system returns a unique RequestId for subsequent tracing after a successful request.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:SetNotifyConfig | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AIAgentId | string | Yes | The ID of the AI agent. | 39f8e0bc005e4f309379701645f4**** |
| EnableNotify | boolean | Yes | Specifies whether to enable event notifications. | true |
| CallbackUrl | string | No | The URL for receiving callback notifications. By default, this parameter is left empty. | http://customer.com/callback |
| EventTypes | string | No | The event types. If you do not specify this parameter, all event types are selected.
| agent_start,agent_stop,error |
| Token | string | No | The authentication token for callback. The token is carried in the Authorization header of a callback request. By default, this parameter is left empty. | eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "771A1414-27BF-53E6-AB73-EFCB*****ACF"
}Error codes
For a list of error codes, visit the Service error codes.