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

Queries the list of OSS stock scan tasks.

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

get

*OssStockTask

acs:yundun-greenweb:*:{#accountId}:ossstocktask/*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The page size.	10
CurrentPage	integer	No	The current page number.	1
StartDate	string	No	The start time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-11-12 10:26:57 +0800
EndDate	string	No	The end time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-12-12 10:26:57 +0800

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 page size.	10
TotalCount	integer	The total number of entries.	10
TaskList	array<object>	The list of scan tasks.
	array<object>
ImageScanLimit	integer	The maximum number of images to scan.	100
VideoScanLimit	integer	The maximum number of videos to scan.	10
CreateTime	string	The creation time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-09-26 11:38:08 +0800
VideoResultFileDownloadUrl	string	The download URL of the video moderation result file.	xx
ResultFileStatus	string	The file status.	finished
ImageResultFileDownloadUrl	string	The download URL of the result file.	oss_result_file/img/result_xx.txt
BizType	string	The business scenario.	recommend_social_template_01
FinishedTime	string	The end time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-10-12 18:15:00 +0800
AudioResultFileDownloadUrl	string	The download URL of the audio result file.	xx
Name	string	The task name.	test889
AudioScanLimit	integer	The maximum number of audio files to scan.	1000
taskScanStatus	string	The task status.	finished
Id	integer	The primary key ID.	1769
ModifyTime	string	The modification time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-10-11 18:15:00 +0800
BizTypeName	string	The business type name.	default
Buckets	array<object>	The storage spaces.
	object
Type	string	The filter condition type.	include
Selected	boolean	Indicates whether the bucket is selected.	true
Bucket	string	The storage spaces.	gj-bucket1
Prefixes	array	The prefixes.
	string	The prefixes.	["img/test_"]
ImageScenes	array	The list of image scan scenarios.
	string	The list of image scan scenarios.	[\"ad\",\"terrorism\",\"live\",\"porn\"]
VideoScenes	array	The list of video scan scenarios.
	string	The list of video scan scenarios.	[\"ad\",\"terrorism\",\"live\",\"porn\"]
AudioScenes	array	The list of audio scan scenarios.
	string	The list of audio scan scenarios.	[\"antispam\"]
StatData	object	The statistical data.
VideoTotalFrameCount	integer	The total number of video frames captured.	11
AudioDurations	integer	The total audio duration. Unit: seconds.	22
ImageSum	object	The image summary.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
ImagePorn	object	The number of images detected in the pornography detection scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
ImageTerrorism	object	The number of images detected in the terrorism and political content scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
ImageAd	object	The number of images detected in the image-text violation scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
ImageLive	object	The number of images detected in the undesirable content scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VideoSum	object	The total number of videos.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VideoPorn	object	The number of videos detected in the pornography detection scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VideoTerrorism	object	The number of videos detected in the terrorism and political content scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VideoAd	object	The number of videos detected in the image-text violation scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VideoLive	object	The number of videos detected in the undesirable content scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VoiceSum	object	The total number of audio files.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
VideoVoiceAntispam	object	The number of video audio files detected in the antispam scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
AudioSum	object	The total number of audio files.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
AudioAntispam	object	The number of audio files detected in the antispam scenario.
totalCount	integer	The total count.	10
blockCount	integer	The number of violations.	1
normalCount	integer	The number of normal items.	1
reviewCount	integer	The number of suspected items.	1
ScanFileSum	integer	The total number of scanned files.	1000

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "PageSize": 10,
  "TotalCount": 10,
  "TaskList": [
    {
      "ImageScanLimit": 100,
      "VideoScanLimit": 10,
      "CreateTime": "2023-09-26 11:38:08 +0800",
      "VideoResultFileDownloadUrl": "xx",
      "ResultFileStatus": "finished",
      "ImageResultFileDownloadUrl": "oss_result_file/img/result_xx.txt",
      "BizType": "recommend_social_template_01",
      "FinishedTime": "2023-10-12 18:15:00 +0800",
      "AudioResultFileDownloadUrl": "xx",
      "Name": "test889",
      "AudioScanLimit": 1000,
      "taskScanStatus": "finished",
      "Id": 1769,
      "ModifyTime": "2023-10-11 18:15:00 +0800\n",
      "BizTypeName": "default",
      "Buckets": [
        {
          "Type": "include",
          "Selected": true,
          "Bucket": "gj-bucket1",
          "Prefixes": [
            "[\"img/test_\"]\n"
          ]
        }
      ],
      "ImageScenes": [
        "[\\\"ad\\\",\\\"terrorism\\\",\\\"live\\\",\\\"porn\\\"]"
      ],
      "VideoScenes": [
        "[\\\"ad\\\",\\\"terrorism\\\",\\\"live\\\",\\\"porn\\\"]"
      ],
      "AudioScenes": [
        "[\\\"antispam\\\"]"
      ],
      "StatData": {
        "VideoTotalFrameCount": 11,
        "AudioDurations": 22,
        "ImageSum": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "ImagePorn": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "ImageTerrorism": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "ImageAd": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "ImageLive": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VideoSum": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VideoPorn": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VideoTerrorism": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VideoAd": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VideoLive": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VoiceSum": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "VideoVoiceAntispam": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "AudioSum": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "AudioAntispam": {
          "totalCount": 10,
          "blockCount": 1,
          "normalCount": 1,
          "reviewCount": 1
        },
        "ScanFileSum": 1000
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.