DescribeOssConfiguration - 查询 OSS 检测配置

更新时间:
复制 MD 格式

获取oss检测配置

接口说明

  • 计费信息:该接口不计费。

  • 查询超时:建议您将查询间隔设置为 480 秒(即在提交异步检测任务 480 秒之后查询结果),最长不能超出 3 天,否则结果将会自动删除。

  • 本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-greenweb:DescribeOssConfiguration

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

Schema of Response

Code

integer

返回码。返回 200 代表成功。

200

Msg

string

错误码的进一步描述。

OK

Data

object

返回数据。

RequestId

string

请求 ID。

AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****

InvalidTaskIds

string

无效的任务 ID

oss-task-20230720-001

ValidIncScanUsers

array<object>

有效的用户扫描配置列表

array<object>

扫描配置对象

Uid

string

用户 uid

123xxxxxxxx

Buckets

array

buckt 列表

string

bucket 名称

test_bucket

Scenes

array

扫描场景列表

string

扫描场景

porn

ImageScenes

array

图片扫描场景

string

图片扫描场景

porn

ImageConf

object

图片扫描配置

Interval

integer

截帧间隔

1

MaxFrames

integer

最大帧数

3

ScanImageNoFileType

boolean

扫描无后缀图片文件

true

VideoScenes

array

视频扫描场景

string

视频扫描场景

porn

VideoConf

object

视频扫描配置

Interval

integer

截帧频率,单位:秒/帧

3

MaxFrames

integer

单视频截帧上限

999

MaxSize

integer

单视频大小上限

104857600

AudioScenes

array

语音扫描场景列表

string

语音扫描场景

antispam

AudioConf

object

语音检测配置

Interval

integer

截帧间隔

10

MaxFrames

integer

最大帧数

10

MaxSize

integer

单音频大小上限

10485760

BucketInfos

array<object>

bucket 信息列表

object

bucket 信息对象

BucketName

string

Bucket 名称

test_bucket

Prefixes

array

前缀匹配配置

string

前缀

test/

Region

string

区域

cn-shanghai

Type

string

前缀匹配规则,exclude:不包含,include:包含

include

BizType

string

业务类型标识。

recommend_standard_template_01

RequestId

string

请求 ID。

AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Msg": "OK",
  "Data": {
    "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
    "InvalidTaskIds": "oss-task-20230720-001",
    "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****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。