All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveDetectPornData

Last Updated:Nov 14, 2024

Queries the usage data of content moderation.

Operation description

  • The minimum data granularity is 5 minutes. If you do not specify the StartTime parameter, data in the last 24 hours is queried.
  • You can query data in the last 90 days.
  • You can call this operation to query the bandwidth at each interval.

QPS limit

You can call this operation up to 10 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

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:DescribeLiveDetectPornDataget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The main streaming domain. Separate multiple domain names with commas (,).

example.com
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note
  • You can query data in the last 90 days.

  • The minimum data granularity is 5 minutes. If you do not specify this parameter, data in the last 24 hours is queried.

2017-12-10T08:00:00Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2017-12-10T09:00:00Z
AppstringNo

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

liveApp****
StreamstringNo

The name of the live stream.

liveStream****
FeestringNo

Specifies whether a quota of free image scanning is available. Valid values:

  • free: specifies that a quota of free image scanning is available.
  • charge: specifies that a quota of free image scanning is not available and fees are charged.
free
ScenestringNo

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
porn
RegionstringNo

The ID of the region where the domain name resides.

cn-shanghai
SplitBystringNo

The fields based on which data is grouped. Separate multiple fields with commas (,).

Note If you leave the SplitBy parameter empty, only the TimeStamp and Count parameters are returned.
liveApp****,liveStream****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B955107D-E658-4E77-B913-E0AC3D31693E
DetectPornDataarray<object>

The bandwidth consumed at each interval.

DataModuleobject
Domainstring

The main streaming domain.

example.com
Regionstring

The ID of the region where the domain name resides.

cn-shanghai
Appstring

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

liveApp****
Streamstring

The name of the live stream.

liveStream****
TimeStampstring

The timestamp of the returned data. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2017-12-10T15:00:05Z
Countlong

The number of reviewed images.

2
Scenestring

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
porn
Feestring

Indicates whether a quota of free image scanning is available. Valid values:

  • free: a quota of free image scanning is available.
  • charge: a quota of free image scanning is not available and fees are charged.
free

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified StartTime is malformed.-
400InvalidEndTime.MalformedSpecified EndTime is malformed.-
400InvalidEndTime.MismatchSpecified 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.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The value specified for the StartTime parameter is invalid.

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

Special error codes

Error codeError messageHTTP status codeDescription
ThrottlingRequest was denied due to request throttling.503The error message returned because the request was denied due to traffic throttling.
InvalidDomain.NotFoundThe domain provided does not belong to you.404The error message returned because the specified domain name does not exist or does not belong to the current account.