DocsICP FilingConsole
Documentation
Home Page AI Guardrails Content Moderation 1.0 Developer Reference API Reference (Configuration Management) API catalog DescribeViewContent

DescribeViewContent

Updated at:
Copy as MD
Product
My Favorites

Retrieves a list of detection results.

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

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
TotalCount

integer

No

The total number of entries.

10
PageSize

integer

No

The number of entries per page.

10
CurrentPage

integer

No

The current page number.

1
StartDate

string

Yes

The start time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).

2023-10-25 15:59:17 +0800

EndDate

string

Yes

The end time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).

2023-10-25 15:59:17 +0800

Scene

string

No

The moderation scenario.

porn
Suggestion

string

No

The suggestion.

block
Label

string

No

The label.

abuse
TaskId

string

No

The task ID.

xxxx-xxx

DataId

string

No

The data ID.

4f3fa36f77174c0985e400c1a02a8f4c
BizType

string

No

The business scenario.

ext
AuditResult

string

No

The moderation result.

noAudit
ResourceType

string

Yes

The resource type.

IMAGE
ImageId

string

No

The image ID.

xx
KeywordId

string

No

The keyword ID.

14341124
LibType

string

No

The keyword library type.

textKeyword
Keyword

string

No

The keyword.

xx

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.

75
ViewContentList

array<object>

The list of video detection content.

array<object>

Suggestion

string

The processing suggestion.

pass
ScanResult

string

The result details.

{}
Url

string

The task URL.

https://www.xx.com
DataId

string

The data ID.

4f3fa36f77174c0985e400c1a02a8f4c
BizType

string

The business type.

recommend_standard_template_01
NewUrl

string

The URL of the original file.

xx
ScanFinishedTime

string

The scan end time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).

2023-10-25 15:59:17 +0800

TaskId

string

The task ID.

xxx-xx
Content

string

The text content.

xx
Thumbnail

string

The thumbnail URL.

https://xxx.png
Id

integer

The primary key ID.

3744
RequestTime

string

The request time. The value is a Unix timestamp in milliseconds.

1708911502123
Results

array<object>

The detection results.

object

Suggestion

string

Processing suggestion.

block
Label

string

Label.

abuse
Scene

string

Moderation scenario.

porn
FrameResults

array<object>

The result set.

object

Offset

integer

Frame capture offset value.

0
Url

string

Link of this frame.

https://xxx.jpg
Label

string

Video frame label.

politics
FaceResults

array<object>

The face detection results.

array<object>

Bualified

boolean

Indicates whether the modification is successful. Valid values: -true: successful. -false: failed.

true
Location

object

Location information.

Y

integer

The distance from the upper-left corner of the text area to the x-axis, with the upper-left corner of the image as the coordinate origin. Unit: pixels.

11
W

integer

The width of the text area. Unit: pixels.

22
H

integer

The height of the text area. Unit: pixels.

33
X

integer

The distance from the upper-left corner of the text area to the y-axis, with the upper-left corner of the image as the coordinate origin. Unit: pixels.

44
Gender

object

Gender.

Value

string

Gender value. Valid values: -female: female. -male: male.

female
Rate

number

Confidence score.

99.01
Glasses

object

Glasses type.

Value

string

Score.

None
Rate

number

Confidence score.

0.99
Age

object

Age.

Value

integer

Age value.

35
Rate

number

Age range confidence score.

0.99
Smile

object

Smile information.

Value

number

Smile score.

1
Rate

number

Confidence score.

0.99
Quality

object

Quality score.

Roll

number

Roll angle.

1
Pitch

number

Pitch angle.

1
Yaw

number

Yaw angle.

1
Blur

number

Face blur.

1
Respirator

object

Respirator information.

Value

string

Score.

1
Rate

number

Confidence score.

0.99
Hat

object

Hat information.

Value

string

Score.

1
Rate

number

Confidence score.

0.99

Mustache

object

Mustache information.

Value

string

Score.

None
Rate

number

Confidence score.

0.99
Bang

object

Bangs information.

Value

string

Score.

None
Rate

number

Confidence score.

0.99

Hairstyle

object

Hairstyle information.

Value

string

Score.

None
Rate

number

Confidence score.

0.99
Image

object

Image information.

Width

integer

Image width.

720
Height

integer

Image height.

720

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****\n",
  "PageSize": 10,
  "TotalCount": 75,
  "ViewContentList": [
    {
      "Suggestion": "pass",
      "ScanResult": "{}",
      "Url": "https://www.xx.com",
      "DataId": "4f3fa36f77174c0985e400c1a02a8f4c",
      "BizType": "recommend_standard_template_01",
      "NewUrl": "xx",
      "ScanFinishedTime": "2023-10-25 15:59:17 +0800\n",
      "TaskId": "xxx-xx",
      "Content": "xx",
      "Thumbnail": "https://xxx.png",
      "Id": 3744,
      "RequestTime": "1708911502123",
      "Results": [
        {
          "Suggestion": "block",
          "Label": "abuse",
          "Scene": "porn"
        }
      ],
      "FrameResults": [
        {
          "Offset": 0,
          "Url": "https://xxx.jpg",
          "Label": "politics"
        }
      ],
      "FaceResults": [
        {
          "Bualified": true,
          "Location": {
            "Y": 11,
            "W": 22,
            "H": 33,
            "X": 44
          },
          "Gender": {
            "Value": "female",
            "Rate": 99.01
          },
          "Glasses": {
            "Value": "None",
            "Rate": 0.99
          },
          "Age": {
            "Value": 35,
            "Rate": 0.99
          },
          "Smile": {
            "Value": 1,
            "Rate": 0.99
          },
          "Quality": {
            "Roll": 1,
            "Pitch": 1,
            "Yaw": 1,
            "Blur": 1
          },
          "Respirator": {
            "Value": "1",
            "Rate": 0.99
          },
          "Hat": {
            "Value": "1",
            "Rate": 0.99
          },
          "Mustache": {
            "Value": "None",
            "Rate": 0.99
          },
          "Bang": {
            "Value": "None",
            "Rate": 0.99
          },
          "Hairstyle": {
            "Value": "None",
            "Rate": 0.99
          },
          "Image": {
            "Width": 720,
            "Height": 720
          }
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：DescribeUserStatusNext：DescribeWebsiteIndexPageBaseline