All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveSnapshotDetectPornConfig

Last Updated:Nov 14, 2024

Queries video moderation configurations.

Operation description

Usage notes

  • Obtain the main streaming domain, and then call this operation to query video moderation configurations. The configurations can be sorted in ascending or descending order.
  • Only some live centers support the automated review feature. For more information, see Supported regions.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:DescribeLiveSnapshotDetectPornConfigget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The main streaming domain.

example.com
AppNamestringNo

The name of the application to which the live stream belongs.

liveApp****
PageNumintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 5 to 30. Default value: 10.

10
OrderstringNo

The sort order. Valid values:

  • Asc (default): ascending order
  • Desc: descending order

Enumerated values:

  • asc
  • desc
Asc

Response parameters

ParameterTypeDescriptionExample
object
PageNuminteger

The page number.

1
RequestIdstring

The request ID.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Orderstring

The sort order.

Asc
TotalPageinteger

The total number of pages.

11
PageSizeinteger

The number of entries per page.

2
TotalNuminteger

The total number of entries that meet the specified conditions.

6
LiveSnapshotDetectPornConfigListarray<object>

The list of video moderation configurations.

LiveSnapshotDetectPornConfigobject
OssObjectstring

The name of the storage file in Object Storage Service (OSS).

{liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg
AppNamestring

The application name.

liveApp****
Intervalinteger

The interval at which snapshots are captured from the live stream. Unit: seconds.

80
OssBucketstring

The name of the OSS bucket.

liveBucket****
DomainNamestring

The main streaming domain.

example.com
OssEndpointstring

The endpoint of the OSS bucket.

cn-oss-****.aliyuncs.com
Scenesarray
scenestring

The moderation scenario. Valid values:

  • porn (default): pornography
  • terrorism: terrorism or politically sensitive content
  • ad: ad violation
  • live: undesirable scene
  • logo
porn

Examples

Sample success responses

JSONformat

{
  "PageNum": 1,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "Order": "Asc",
  "TotalPage": 11,
  "PageSize": 2,
  "TotalNum": 6,
  "LiveSnapshotDetectPornConfigList": {
    "LiveSnapshotDetectPornConfig": [
      {
        "OssObject": " {liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg",
        "AppName": "liveApp****",
        "Interval": 80,
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "OssEndpoint": "cn-oss-****.aliyuncs.com",
        "Scenes": {
          "scene": [
            "porn"
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.