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

Retrieves the OSS scan task configuration.

Operation description

Billing: This operation is free of charge.
Query timeout: Set the query interval to 480 seconds (query results 480 seconds after submitting an asynchronous scan task). The maximum query period is 3 days. Results are automatically deleted after 3 days.
The queries per second (QPS) limit for a single user is 100. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.

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

none

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	integer	The return code. A value of 200 indicates success.	200
Msg	string	The description of the error code.	OK
Data	object	The returned data.
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
InvalidTaskIds	string	The invalid task IDs.	xxx
ValidIncScanUsers	array<object>	The list of valid user scan configurations.
	array<object>	The scan configuration object.
Uid	string	User UID	123xxxxxxxx
Buckets	array	Bucket list
	string	Bucket name	test_bucket
Scenes	array	List of scan scenarios
	string	Scan scenario	porn
ImageScenes	array	Image scan scenarios
	string	Image scan scenario	porn
ImageConf	object	Image scan configuration
Interval	integer	Frame interval	1
MaxFrames	integer	Maximum number of frames	3
ScanImageNoFileType	boolean	Scan image files without file extensions	true
VideoScenes	array	Video scanning scenarios
	string	Video scanning scenario	porn
VideoConf	object	Video scanning configuration
Interval	integer	Frame capture frequency, unit: seconds per frame	3
MaxFrames	integer	Maximum number of frames per video	999
MaxSize	integer	Maximum size of a single video	104857600
AudioScenes	array	List of audio scanning scenarios
	string	Audio scanning scenario	antispam
AudioConf	object	Audio detection configuration
Interval	integer	Frame capture interval	10
MaxFrames	integer	Maximum number of frames	10
MaxSize	integer	Maximum size of a single audio file	10485760
BucketInfos	array<object>	List of bucket information
	object	Bucket information object
BucketName	string	Bucket name	test_bucket
Prefixes	array	Prefix matching configuration
	string	Prefix	test/
Region	string	Region	cn-shanghai
Type	string	Prefix matching rule, exclude: does not include, include: includes	include
BizType	string	Biz type	recommend_standard_template_01
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****

Examples

Success response

JSON format

{
  "Code": 200,
  "Msg": "OK",
  "Data": {
    "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
    "InvalidTaskIds": "xxx",
    "ValidIncScanUsers": [
      {
        "Uid": "123xxxxxxxx",
        "Buckets": [
          "test_bucket"
        ],
        "Scenes": [
          "porn"
        ],
        "ImageScenes": [
          "porn"
        ],
        "ImageConf": {
          "Interval": 1,
          "MaxFrames": 3,
          "ScanImageNoFileType": true
        },
        "VideoScenes": [
          "porn"
        ],
        "VideoConf": {
          "Interval": 3,
          "MaxFrames": 999,
          "MaxSize": 104857600
        },
        "AudioScenes": [
          "antispam"
        ],
        "AudioConf": {
          "Interval": 10,
          "MaxFrames": 10,
          "MaxSize": 10485760
        },
        "BucketInfos": [
          {
            "BucketName": "test_bucket",
            "Prefixes": [
              "test/"
            ],
            "Region": "cn-shanghai",
            "Type": "include"
          }
        ],
        "BizType": "recommend_standard_template_01"
      }
    ]
  },
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.