Queries video moderation configurations.

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 API 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 limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeLiveSnapshotDetectPornConfig

The operation that you want to perform. Set the value to DescribeLiveSnapshotDetectPornConfig.

DomainName String Yes example.com

The main streaming domain.

AppName String No liveApp****

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

PageNum Integer No. 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 5 to 30. Default value: 10.

Order String No Asc

The order in which the entries are sorted. Valid values:

  • Asc: The entries are sorted in ascending order. This is the default value.
  • Desc: The entries are sorted in descending order.

Response parameters

Parameter Type Example Description
PageNum Integer 1

The page number of the returned page.

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Order String Asc

The order in which the entries are sorted.

TotalPage Integer 11

The total number of pages returned.

PageSize Integer 2

The number of entries returned per page.

TotalNum Integer 6

The total number of video moderation configurations that meet the specified conditions.

LiveSnapshotDetectPornConfigList Array of LiveSnapshotDetectPornConfig

The list of video moderation configurations.

LiveSnapshotDetectPornConfig
OssObject String {liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg

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

AppName String liveApp****

The name of the application.

Interval Integer 80

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

OssBucket String liveBucket****

The name of the OSS bucket.

DomainName String example.com

The main streaming domain.

OssEndpoint String cn-oss-****.aliyuncs.com

The endpoint of the OSS bucket.

Scenes Array of String porn

The moderation scenario. Valid values:

  • porn: pornography detection. This is the default value.
  • terrorism: terrorism detection
  • ad: ad violation detection
  • live: undesirable scene detection
  • logo: logo detection

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveSnapshotDetectPornConfig
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.