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

Retrieves the configuration of an existing inventory scan task.

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

get

*OssStockTask

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

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The primary key ID.	3744

Response elements

Element	Type	Description	Example
	object
CallbackName	string	The callback name.	xx
videoScanLimit	integer	The maximum number of videos to scan.	100
AudioAutoFreezeOpened	boolean	Indicates whether audio files need to be frozen.	false
EndDate	string	The end time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2023-10-21 16:08:38 +0800
VideoOpened	boolean	Indicates whether video scanning is enabled. Valid values: true: Enabled. false: Disabled.	true
AudioOpened	boolean	Indicates whether audio scanning is enabled. Valid values: true: Enabled. false: Disabled.	true
audioScanLimit	integer	The maximum number of audio files to scan.	11
StartDate	string	The start time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2023-08-21 16:08:38 +0800
ImageOpened	boolean	Indicates whether image scanning is enabled. Valid values: true: Enabled. false: Disabled.	true
ImageAutoFreezeOpened	boolean	Indicates whether image files need to be frozen.	true
VideoMaxFrames	integer	The maximum number of frames captured per video.	100
CallbackId	integer	The callback notification ID.	1664
ScanImageNoFileType	boolean	Indicates whether to scan files without extensions.	true
AutoFreezeType	string	The freeze method.	acl
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
VideoAutoFreezeOpened	boolean	Indicates whether video files need to be frozen.	true
VideoFrameInterval	integer	The frame capture frequency.	1
videoMaxSize	integer	The maximum size of a single video.	100
imageScanLimit	integer	The maximum number of images to scan.	100
AudioMaxSize	integer	The maximum size of a single audio file.	200
ImageScenes	array	The list of image moderation scenarios.
	string	The list of image moderation scenarios.	[\"ad\",\"terrorism\",\"live\",\"porn\"]
VideoScenes	array	The list of video moderation scenarios.
	string	The list of video moderation scenarios.	[\"ad\",\"terrorism\",\"live\",\"porn\"]
AudioScenes	array	The list of audio moderation scenarios.
	string	The list of audio moderation scenarios.	[\"antispam\"]
ImagePornFreezeConfig	object	The freeze configuration for image pornography detection.
Type	string	The type.	suggestion
Value	string	The value.	block
ImageTerrorismFreezeConfig	object	The freeze configuration for image terrorism detection.
Type	string	The type.	suggestion
Value	string	The value.	block
ImageAdFreezeConfig	object	The freeze configuration for image ad detection.
Type	string	The type.	suggestion
Value	string	The value.	block
ImageLiveFreezeConfig	object	The freeze configuration for image objectionable scene detection.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoPornFreezeConfig	object	The freeze configuration for video pornography detection.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoTerrorismFreezeConfig	object	The freeze configuration for video terrorism detection.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoAdFreezeConfig	object	The freeze configuration for video ad detection.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoLiveFreezeConfig	object	The freeze configuration for video objectionable scene detection.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoVoiceAntispamFreezeConfig	object	The freeze configuration for video voice antispam detection.
Type	string	The type.	suggestion
Value	string	The value.	block
AudioAntispamFreezeConfig	object	The list of audio antispam freeze scenarios.
Type	string	The type.	suggestion
Value	string	The value.	block
BizTypeTemplate	object	The business scenario template.
Name	string	The name.	test
Description	string	The description.	mgst
BizType	string	The business scenario.	default
ImageConfig	object	The image configuration.
Terrorism	object	The terrorism detection configuration.
Categories	array	The categories.
	string	The categories.	[]
Porn	object	The pornography detection configuration.
Categories	array	The categories.
	string	The categories.	[]
Ad	object	The advertisement detection configuration.
Categories	array	The categories.
	string	The categories.	[]
Live	object	The objectionable scene detection configuration.
Categories	array	The categories.
	string	The categories.	[]
VideoConfig	object	The video configuration.
Terrorism	object	The terrorism detection configuration.
Categories	array	The categories.
	string	The categories.	[]
Porn	object	The pornography detection configuration.
Categories	array	The categories.
	string	The categories.	[]
Ad	object	The advertisement detection configuration.
Categories	array	The categories.
	string	The categories.	[]
Live	object	The objectionable scene detection configuration.
Categories	array	The categories.
	string	The categories.	[]
VoiceConfig	object	The voice configuration.
Antispam	object	The text antispam configuration.
Categories	array	The categories.
	string	The categories.	[]
Buckets	array<object>	The storage buckets.
	object	The storage buckets.
Type	string	The filter condition type.	include
Selected	boolean	Indicates whether the OSS bucket is selected.	true
Bucket	string	The storage buckets.	tctest
Prefixes	array	The prefixes.
	string	The prefixes.	["img/test_"]

Examples

Success response

JSON format

{
  "CallbackName": "xx",
  "videoScanLimit": 100,
  "AudioAutoFreezeOpened": false,
  "EndDate": "2023-10-21 16:08:38 +0800\n",
  "VideoOpened": true,
  "AudioOpened": true,
  "audioScanLimit": 11,
  "StartDate": "2023-08-21 16:08:38 +0800\n",
  "ImageOpened": true,
  "ImageAutoFreezeOpened": true,
  "VideoMaxFrames": 100,
  "CallbackId": 1664,
  "ScanImageNoFileType": true,
  "AutoFreezeType": "acl",
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "VideoAutoFreezeOpened": true,
  "VideoFrameInterval": 1,
  "videoMaxSize": 100,
  "imageScanLimit": 100,
  "AudioMaxSize": 200,
  "ImageScenes": [
    "[\\\"ad\\\",\\\"terrorism\\\",\\\"live\\\",\\\"porn\\\"]"
  ],
  "VideoScenes": [
    "[\\\"ad\\\",\\\"terrorism\\\",\\\"live\\\",\\\"porn\\\"]"
  ],
  "AudioScenes": [
    "[\\\"antispam\\\"]"
  ],
  "ImagePornFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "ImageTerrorismFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "ImageAdFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "ImageLiveFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "VideoPornFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "VideoTerrorismFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "VideoAdFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "VideoLiveFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "VideoVoiceAntispamFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "AudioAntispamFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "BizTypeTemplate": {
    "Name": "test",
    "Description": "mgst",
    "BizType": "default",
    "ImageConfig": {
      "Terrorism": {
        "Categories": [
          "[]"
        ]
      },
      "Porn": {
        "Categories": [
          "[]"
        ]
      },
      "Ad": {
        "Categories": [
          "[]"
        ]
      },
      "Live": {
        "Categories": [
          "[]"
        ]
      }
    },
    "VideoConfig": {
      "Terrorism": {
        "Categories": [
          "[]"
        ]
      },
      "Porn": {
        "Categories": [
          "[]"
        ]
      },
      "Ad": {
        "Categories": [
          "[]"
        ]
      },
      "Live": {
        "Categories": [
          "[]"
        ]
      }
    },
    "VoiceConfig": {
      "Antispam": {
        "Categories": [
          "[]"
        ]
      }
    }
  },
  "Buckets": [
    {
      "Type": "include",
      "Selected": true,
      "Bucket": "tctest",
      "Prefixes": [
        "[\"img/test_\"]\n"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.