DescribeLiveSnapshotDetectPornConfig

Updated at:
Copy as MD

Queries the content moderation configurations for live streaming.

Operation description

  • Obtain the streamer streaming domain first, and then invoke this operation to query the content moderation configurations for live streaming. This operation supports sorting in ascending and descending order.

  • Currently, only some live centers support intelligent content moderation for live streaming. For information about the live centers that support this feature, see Service regions.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation as needed.

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

live:DescribeLiveSnapshotDetectPornConfig

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

DomainName

string

Yes

The streamer streaming domain.

example.com

AppName

string

No

The name of the application to which the stream belongs.

liveApp****

PageNum

integer

No

The page number. Default value: 1.

1

PageSize

integer

No

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

10

Order

string

No

The order in which entries are sorted by creation time. Valid values:

  • Asc (default): ascending order.

  • Desc: descending order.

Valid values:

  • asc :

    ascending order.

  • desc :

    descending order.

Asc

Response elements

Element

Type

Description

Example

object

PageNum

integer

The page number.

1

RequestId

string

The request ID.

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

Order

string

The sort order.

Asc

TotalPage

integer

The total number of pages.

11

PageSize

integer

The number of entries per page.

2

TotalNum

integer

The total number of entries that meet the specified conditions.

6

LiveSnapshotDetectPornConfigList

object

LiveSnapshotDetectPornConfig

array<object>

The list of content moderation configurations.

array<object>

OssObject

string

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

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

AppName

string

The application name.

liveApp****

Interval

integer

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

80

OssBucket

string

The name of the OSS bucket.

liveBucket****

DomainName

string

The main streaming domain.

example.com

OssEndpoint

string

The endpoint of the OSS bucket.

cn-oss-****.aliyuncs.com

Scenes

object

scene

array

The moderation scenario array.

string

The moderation scenario. Valid values:

  • porn (default): pornography

  • terrorism: terrorism or politically sensitive content

  • ad: ad violation

  • live: undesirable scene

  • logo

porn

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.