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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
live:DescribeLiveDetectPornData | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DomainName | string | No | The main streaming domain. Separate multiple domain names with commas (,). | example.com |
StartTime | string | No | 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
| 2017-12-10T08:00:00Z |
EndTime | string | No | 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 |
App | string | No | The name of the application to which the live stream belongs. | liveApp**** |
Stream | string | No | The name of the live stream. | liveStream**** |
Fee | string | No | Specifies whether a quota of free image scanning is available. Valid values:
| free |
Scene | string | No | The moderation scenario. Valid values:
| porn |
Region | string | No | The ID of the region where the domain name resides. | cn-shanghai |
SplitBy | string | No | 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
Examples
Sample success responses
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. |
For a list of error codes, visit the Service error codes.
Special error codes
Error code | Error message | HTTP status code | Description |
---|---|---|---|
Throttling | Request was denied due to request throttling. | 503 | The error message returned because the request was denied due to traffic throttling. |
InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | The error message returned because the specified domain name does not exist or does not belong to the current account. |