DescribeLiveDetectPornData - ApsaraVideo Live - Alibaba Cloud Documentation Center

You can call the DescribeLiveDetectPornData operation to query usage data for live stream moderation.

Operation description

The minimum data granularity is 5 minutes. If the StartTime parameter is empty, the service queries data from the last 24 hours by default.
You can query data from the last 90 days.
You can query network bandwidth data for each time interval.

QPS limits

The queries per second (QPS) limit for a single user is 10. If you exceed this limit, API calls are throttled. This may affect your business. Plan your calls accordingly.

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:DescribeLiveDetectPornData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain to query. You can query one or more domain names. To query multiple domain names, separate them with commas (,). If you do not specify this parameter, the service returns the merged data for all streaming domains.	example.com
StartTime	string	No	The start of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note You can query data from the last 90 days. The minimum data granularity is 5 minutes. If you leave this parameter empty, the service queries data from the last 24 hours by default.	2017-12-10T08:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-10T09:00:00Z
App	string	No	The name of the application to which the stream belongs.	liveApp****
Stream	string	No	The stream name.	liveStream****
Fee	string	No	You have a daily free quota for image scans. Valid values: free charge	free
Scene	string	No	The detection scenario. Valid values: porn (default): pornography detection. terrorism: terrorism and political content detection. ad: ad and text violation detection. live: undesirable live streaming scenario detection. logo: logo detection.	porn
Region	string	No	The region where the domain name is located.	cn-shanghai
SplitBy	string	No	The list of grouping fields. Separate multiple fields with commas (,). Note If you leave this parameter empty, the service returns only TimeStamp and Count.	liveApp**,liveStream**

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DetectPornData	object
DataModule	array<object>	The moderation data for each time interval.
	object	The moderation data for each time interval.
Domain	string	The streaming domain name.	example.com
Region	string	The region where the domain name is located.	cn-shanghai
App	string	The name of the application to which the stream belongs.	liveApp****
Stream	string	The stream name.	liveStream****
TimeStamp	string	The start time of the time slice. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2017-12-10T15:00:05Z
Count	integer	The number of moderated items.	2
Scene	string	The detection scenario. Valid values: porn (default): pornography detection. terrorism: terrorism and political content detection. ad: ad and text violation detection. live: undesirable live streaming scenario detection. logo: logo detection.	porn
Fee	string	You have a daily free quota for image scans. Valid values: free charge	free

Examples

Success response

JSON format

{
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DetectPornData": {
    "DataModule": [
      {
        "Domain": "example.com",
        "Region": "cn-shanghai",
        "App": "liveApp****",
        "Stream": "liveStream****",
        "TimeStamp": "2017-12-10T15:00:05Z",
        "Count": 2,
        "Scene": "porn",
        "Fee": "free"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.