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

Retrieves usage statistics 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:DescribeOpenApiUsage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	183.***.210.253
StartDate	string	Yes	The start time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-03-05 00:00:00 +0800
EndDate	string	Yes	The end time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-12-15 10:22:45 +0800
ResourceType	string	Yes	The resource type.	IMAGE
BizType	string	No	The business scenario.	default

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	364
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
OpenApiUsageList	array<object>	The returned list.
	object	The returned list.
PassDuration	integer	The duration of passed content.	1
ReviewDuration	integer	The duration of suspected content.	1
Date	string	The date. Format: `YYYYMMDD`.	20240712
OuterTotalCount	integer	The number of video frames captured by external users.	1
TotalCount	integer	The total number of entries.	3
ReviewCount	integer	The number of suspected items.	1
InnerTotalCount	integer	The number of video frames captured by the internal system.	12
ResourceType	string	The resource type.	IMAGE
PassCount	integer	The number of passed items.	2
BlockDuration	integer	The duration of blocked content.	1
Scene	string	The moderation scenario.	porn
BlockCount	integer	The number of blocked items.	11
TotalDuration	integer	The total usage duration.	22

Examples

Success response

JSON format

{
  "TotalCount": 364,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "OpenApiUsageList": [
    {
      "PassDuration": 1,
      "ReviewDuration": 1,
      "Date": "20240712",
      "OuterTotalCount": 1,
      "TotalCount": 3,
      "ReviewCount": 1,
      "InnerTotalCount": 12,
      "ResourceType": "IMAGE",
      "PassCount": 2,
      "BlockDuration": 1,
      "Scene": "porn",
      "BlockCount": 11,
      "TotalDuration": 22
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.