DescribeOpenApiMonitorData-AI Guardrails(AI Guardrails)-阿里云帮助中心

Retrieves real-time monitoring data for machine-assisted moderation.

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.

Test

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

yundun-greenweb:DescribeOpenApiMonitorData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ReportName	string	Yes	The report name.	qps
Scene	string	No	The moderation scenario.	terrorism
BizType	string	No	The business scenario.	default
ResourceType	string	Yes	The resource type.	IMAGE
StartDate	string	Yes	The start time. Format: YYYY-MM-DD HH:mm:ss ±HHMM. Default time zone: UTC+08:00.	2023-08-07 09:22:41 +0800
EndDate	string	Yes	The end time. Format: YYYY-MM-DD HH:mm:ss ±HHMM. Default time zone: UTC+08:00.	2023-12-02 09:59:53 +0800

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
RtItemList	array<object>	The returned result data.
	array<object>	The returned result data.
Scene	string	The moderation scenario.	terrorism
ItemList	array<object>	The returned data list.
	object	The returned data list.
Rt	number	Rt。	1
Minute	string	The minute.	2023-07-13 10:26:00
QpsItemList	array<object>	The queries per second (QPS) for images.
	array<object>	The queries per second (QPS) for images.
Scene	string	The moderation scenario.	porn
ItemList	array<object>	The returned data list.
	object	The returned data list.
Qps	integer	The QPS data.	1
Minute	string	The minute.	2023-07-13 10:26:00
PathItems	array<object>	The path list of the returned results.
	object	The path list of the returned results.
Path	integer	The path.	1
Minute	string	The minute.	2023-07-13 10:26:00

Examples

Success response

JSON format

{
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****\n",
  "RtItemList": [
    {
      "Scene": "terrorism",
      "ItemList": [
        {
          "Rt": 1,
          "Minute": "2023-07-13 10:26:00"
        }
      ]
    }
  ],
  "QpsItemList": [
    {
      "Scene": "porn",
      "ItemList": [
        {
          "Qps": 1,
          "Minute": "2023-07-13 10:26:00"
        }
      ]
    }
  ],
  "PathItems": [
    {
      "Path": 1,
      "Minute": "2023-07-13 10:26:00"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.