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

Queries the list of self-service moderation content.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	14.145.***.79
Lang	string	No	The language.	zh
TotalCount	integer	No	The total number of entries.	20
PageSize	integer	No	The number of entries per page.	20
CurrentPage	integer	No	The current page number.	1
StartDate	string	Yes	The start time. Format: YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2023-04-13 00:00:00 +0800
EndDate	string	Yes	The end time. Format: YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2023-05-05 23:59:59 +0800
Scene	string	No	Scenarios.	porn
Suggestion	string	No	The processing suggestion. Valid values: pass: Passed. review: Requires manual review. block: Blocked.	pass
Label	string	No	The label.	terrorism
TaskId	string	No	The task ID.	img5owu4zBQk*****6UZHP5t5-1yR@3j
DataId	string	No	The data ID.	5cb170f7689247e6a58b156b4fbc8476
BizType	string	No	The business scenario.	recommend_social_template_01
AuditResult	string	No	The moderation result.	noAudit
ResourceType	string	Yes	The resource type.	IMAGE
ImageId	string	No	The image ID.	xxx
KeywordId	string	No	The keyword.	xxx
LibType	string	No	The library type.	textKeyword

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number.	1
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	24
AuditContentList	array<object>	The list of moderation content.
	array<object>	The list of moderation content.
Suggestion	string	The moderation suggestion. Valid values: block: Violation detected. review: Suspected violation. pass: Passed.	block
Url	string	The task URL.	https://www.xxx.com/xxx.jpg
DataId	string	The data ID.	5cb170f7689247e6a58b156b4fbc8476
BizType	string	The business scenario.	recommend_social_template_01
NewUrl	string	The URL after the content is stored.	https://www.xxx.com/xxx.jpg
ScanFinishedTime	string	The time when the scan is completed. Format: YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2023-05-05 23:59:59 +0800
AuditResult	string	The moderation result.	noAudit
TaskId	string	The task ID.	img5VB@6A****5HNUkpBXyoy-1zvats
Content	string	The moderation content.	xxx
Thumbnail	string	The thumbnail URL.	https://www.xxx.com/xxx.jpg
Audit	integer	The moderation status.	0
Id	integer	The primary key ID.	22136
RequestTime	string	The request time. The value is a Unix/POSIX timestamp in milliseconds.	1710293064524
Results	array<object>	The moderation result.
	object	The moderation result.
Suggestion	string	The moderation suggestion. Valid values: block: Violation detected. review: Suspected violation. pass: Passed.	block
Label	string	The label.	bloody
Scene	string	The moderation scenario.	political
FrameResults	array<object>	The result set.
	object	The result set.
Offset	integer	The frame capture offset.	0
Url	string	URL。	https://www.xxx.com/xxx.jpg
Label	string	The label.	weapon
AuditIllegalReasons	array	The moderation remarks.
	string	The moderation remarks.	[\"terrorism\"]

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "PageSize": 10,
  "TotalCount": 24,
  "AuditContentList": [
    {
      "Suggestion": "block",
      "Url": "https://www.xxx.com/xxx.jpg",
      "DataId": "5cb170f7689247e6a58b156b4fbc8476",
      "BizType": "recommend_social_template_01",
      "NewUrl": "https://www.xxx.com/xxx.jpg\n",
      "ScanFinishedTime": "2023-05-05 23:59:59 +0800\n",
      "AuditResult": "noAudit",
      "TaskId": "img5VB@6A****5HNUkpBXyoy-1zvats",
      "Content": "xxx",
      "Thumbnail": "https://www.xxx.com/xxx.jpg\n",
      "Audit": 0,
      "Id": 22136,
      "RequestTime": "1710293064524",
      "Results": [
        {
          "Suggestion": "block",
          "Label": "bloody",
          "Scene": "political"
        }
      ],
      "FrameResults": [
        {
          "Offset": 0,
          "Url": "https://www.xxx.com/xxx.jpg\n",
          "Label": "weapon"
        }
      ],
      "AuditIllegalReasons": [
        "[\\\"terrorism\\\"]"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	Missing required parameter.	Required parameter is missing.
400	InvalidParameter.Format	Parameter format invalid.	Parameter format error
400	InvalidParameter.Value	Parameter value not supported.	The parameter value is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.