DescribeLiveSnapshotDetectPornConfig - ApsaraVideo Live

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

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 page number. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Valid values: 5 to 30. Default value: 10.
Order	String	No	Asc	The order in which the entries are sorted based on creation time. Valid values: Asc (default): ascending order Desc: descending order

Response parameters

Parameter	Type	Example	Description
PageNum	Integer	1	The page number.
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	The request ID.
Order	String	Asc	The sort order.
TotalPage	Integer	11	The total number of pages.
PageSize	Integer	2	The number of entries per page.
TotalNum	Integer	6	The total number of entries 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 application name.
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 (default): pornography detection 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>
    <PageNum>1</PageNum>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
    <Order>Asc</Order>
    <TotalPage>11</TotalPage>
    <PageSize>2</PageSize>
    <TotalNum>6</TotalNum>
    <LiveSnapshotDetectPornConfigList>
        <LiveSnapshotDetectPornConfig>
            <OssObject> {liveApp****}/{liveStream****}/{Date}/{Hour}/{Minute}_{Second}.jpg</OssObject>
            <AppName>liveApp****</AppName>
            <Interval>80</Interval>
            <OssBucket>liveBucket****</OssBucket>
            <DomainName>example.com</DomainName>
            <OssEndpoint>cn-oss-****.aliyuncs.com</OssEndpoint>
            <Scenes>porn</Scenes>
        </LiveSnapshotDetectPornConfig>
    </LiveSnapshotDetectPornConfigList>
</DescribeLiveSnapshotDetectPornConfigResponse>

JSON format

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

{
  "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" : [ "porn" ]
    } ]
  }
}

Error codes

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