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

Retrieves the OSS incremental scan settings.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	218.17.***.226
Lang	string	No	The language.	zh

Response elements

Element	Type	Description	Example
	object
CallbackName	string	The callback name.	xx
ImageScanLimit	integer	The daily image scan limit.	10000
VideoScanLimit	integer	The daily video scan limit.	100
AudioAutoFreezeOpened	boolean	Indicates whether audio freezing is enabled.	false
VideoMaxSize	integer	The maximum size of a single video.	100
ImageEnableLimit	boolean	Indicates whether the image scan limit is enabled.	true
BizType	string	The business scenario.	default
EndTime	string	The end time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-10-21 16:08:38 +0800
ImageAutoFreezeOpened	boolean	Indicates whether image freezing is enabled.	true
VideoMaxFrames	integer	The maximum number of frames captured from a single video.	100
StartTime	string	The start time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00).	2023-08-21 16:08:38 +0800
CallbackId	string	The callback notification ID.	1664
ScanImageNoFileType	boolean	Indicates whether files without extensions are scanned.	true
AutoFreezeType	string	The freeze method.	acl
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
VideoAutoFreezeOpened	boolean	Indicates whether video freezing is enabled.	true
VideoFrameInterval	integer	The frame capture frequency.	1
AudioScanLimit	integer	The daily audio scan limit.	1000
AudioMaxSize	integer	The maximum size of a single audio file.	200
AudioSceneList	array	The list of audio scenarios.
	string	The list of audio scenarios.	[\"antispam\"]
VideoAutoFreezeSceneList	array	The list of video freeze scenarios.
	string	The list of video freeze scenarios.	[]
VideoSceneList	array	The list of video scenarios.
	string	The list of video scenarios.	[\"porn\",\"terrorism\",\"ad\",\"live\"]
ImageSceneList	array	The list of image scenarios.
	string	The list of image scenarios.	[\"porn\"]
ImageAutoFreeze	object	The image auto-freeze configuration.
Live	string	The undesirable scene.	99.01
Porn	string	The pornography detection.	99.01
Ad	string	The advertisement detection.	99.01
Terrorism	string	The terrorism detection.	99.01
Enabled	boolean	Indicates whether the feature is enabled.	True
AudioAntispamFreezeConfig	object	The list of audio freeze scenarios.
Type	string	The type.	suggestion
Value	string	The value.	block
BizTypeTemplate	object	The business scenario template.
Name	string	The name.	test88899
Description	string	The description.	created by eventbridge
BizType	string	The business scenario.	default
ImageConfig	object	The image configuration.
Terrorism	object	The terrorism detection.
Categories	array	The categories.
	string	The categories.	[]
Porn	object	The pornography detection.
Categories	array	The categories.
	string	The categories.	[]
Ad	object	The advertisement detection.
Categories	array	The categories.
	string	The categories.	[]
Live	object	The undesirable scene detection.
Categories	array	The categories.
	string	The categories.	[]
VideoConfig	object	The video configuration.
Terrorism	object	The terrorism detection.
Categories	array	The categories.
	string	The categories.	[]
Porn	object	The pornography detection.
Categories	array	The categories.
	string	The categories.	[]
Ad	object	The advertisement detection.
Categories	array	The categories.
	string	The categories.	[]
Live	object	The undesirable scene detection.
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.	[]
IncludeChannel	integer	Indicates whether algorithms from third-party channels are included. Valid values: 0: not included. 1: included.	false
ImagePornFreezeConfig	object	The image pornography freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
ImageTerrorismFreezeConfig	object	The image terrorism freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
ImageAdFreezeConfig	object	The image advertisement freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
ImageLiveFreezeConfig	object	The image undesirable scene freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoPornFreezeConfig	object	The video pornography freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoTerrorismFreezeConfig	object	The video terrorism freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoAdFreezeConfig	object	The video advertisement freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoLiveFreezeConfig	object	The video undesirable scene freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
VideoVoiceAntispamFreezeConfig	object	The video voice antispam freeze configuration.
Type	string	The type.	suggestion
Value	string	The value.	block
BucketConfigList	array<object>	The list of OSS bucket configurations.
	object	The list of OSS bucket configurations.
Type	string	The filter condition type.	include
Selected	boolean	Indicates whether the bucket is selected.	true
Bucket	string	The OSS bucket.	gj-bucket1
Prefixes	array	The prefixes.
	string	The prefixes.	["img/test_"]

Examples

Success response

JSON format

{
  "CallbackName": "xx",
  "ImageScanLimit": 10000,
  "VideoScanLimit": 100,
  "AudioAutoFreezeOpened": false,
  "VideoMaxSize": 100,
  "ImageEnableLimit": true,
  "BizType": "default",
  "EndTime": "2023-10-21 16:08:38 +0800",
  "ImageAutoFreezeOpened": true,
  "VideoMaxFrames": 100,
  "StartTime": "2023-08-21 16:08:38 +0800\n",
  "CallbackId": "1664",
  "ScanImageNoFileType": true,
  "AutoFreezeType": "acl",
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "VideoAutoFreezeOpened": true,
  "VideoFrameInterval": 1,
  "AudioScanLimit": 1000,
  "AudioMaxSize": 200,
  "AudioSceneList": [
    "[\\\"antispam\\\"]"
  ],
  "VideoAutoFreezeSceneList": [
    "[]"
  ],
  "VideoSceneList": [
    "[\\\"porn\\\",\\\"terrorism\\\",\\\"ad\\\",\\\"live\\\"]"
  ],
  "ImageSceneList": [
    "[\\\"porn\\\"]"
  ],
  "ImageAutoFreeze": {
    "Live": "99.01\n",
    "Porn": "99.01\n",
    "Ad": "99.01\n",
    "Terrorism": "99.01\n",
    "Enabled": true
  },
  "AudioAntispamFreezeConfig": {
    "Type": "suggestion",
    "Value": "block"
  },
  "BizTypeTemplate": {
    "Name": "test88899",
    "Description": "created by eventbridge",
    "BizType": "default",
    "ImageConfig": {
      "Terrorism": {
        "Categories": [
          "[]"
        ]
      },
      "Porn": {
        "Categories": [
          "[]"
        ]
      },
      "Ad": {
        "Categories": [
          "[]"
        ]
      },
      "Live": {
        "Categories": [
          "[]"
        ]
      }
    },
    "VideoConfig": {
      "Terrorism": {
        "Categories": [
          "[]"
        ]
      },
      "Porn": {
        "Categories": [
          "[]"
        ]
      },
      "Ad": {
        "Categories": [
          "[]"
        ]
      },
      "Live": {
        "Categories": [
          "[]"
        ]
      }
    },
    "VoiceConfig": {
      "Antispam": {
        "Categories": [
          "[]"
        ]
      }
    },
    "IncludeChannel": 0
  },
  "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"
  },
  "BucketConfigList": [
    {
      "Type": "include",
      "Selected": true,
      "Bucket": "gj-bucket1",
      "Prefixes": [
        "[\"img/test_\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.