Creating a Media Asset Review Task
Function
This API is used to review uploaded media assets. You can call the API for querying a media asset to view the review result.
Constraints
This function is supported only in the CN North-Beijing1 and CN North-Beijing4 regions.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
POST /v1.0/{project_id}/asset/review
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
|
X-Sdk-Date |
No |
String |
Time when a request is sent. This parameter is mandatory for AK/SK authentication. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
asset_id |
Yes |
String |
Media asset ID assigned by VOD. It can only be queried but cannot be modified. |
|
review |
Yes |
Review object |
Media asset review parameters.
NOTE:
Only VOD in AP-Singapore supports this function.
|
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
template_id |
No |
String |
Review template ID. You can obtain the value after configuring the review template on the VOD console. For details, see "Review Settings" in VOD User Guide.
NOTE:
Only VOD in AP-Singapore supports this function.
|
|
interval |
No |
Integer |
Snapshot check interval. The value range is (0,100]. This parameter is ignored in request parameters. |
|
politics |
No |
Integer |
Confidence of politically sensitive content moderation. The value can be -1 or range from 0 to 100. This parameter is ignored in request parameters. A higher confidence score indicates a more reliable moderation result. If this function is disabled or the value is set to 0, this check is not performed. politics, terrorism, and porn cannot be set to 0 simultaneously. |
|
terrorism |
No |
Integer |
Confidence of terrorism-related content moderation. The value can be -1 or range from 0 to 100. This parameter is ignored in request parameters. A higher confidence score indicates a more reliable moderation result. If this function is disabled or the value is set to 0, this check is not performed. politics, terrorism, and porn cannot be set to 0 simultaneously. |
|
porn |
No |
Integer |
Confidence of pornographic content moderation. The value can be -1 or range from 0 to 100. This parameter is ignored in request parameters. A higher confidence score indicates a more reliable moderation result. If this function is disabled or the value is set to 0, this check is not performed. politics, terrorism, and porn cannot be set to 0 simultaneously. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
asset_id |
String |
Media asset ID assigned by VOD. It can only be queried but cannot be modified. |
|
review |
Review object |
Media asset review parameters.
NOTE:
Only VOD in AP-Singapore supports this function.
|
|
Parameter |
Type |
Description |
|---|---|---|
|
template_id |
String |
Review template ID. You can obtain the value after configuring the review template on the VOD console. For details, see "Review Settings" in VOD User Guide.
NOTE:
Only VOD in AP-Singapore supports this function.
|
|
interval |
Integer |
Snapshot check interval. The value range is (0,100]. This parameter is ignored in request parameters. |
|
politics |
Integer |
Confidence of politically sensitive content moderation. The value can be -1 or range from 0 to 100. This parameter is ignored in request parameters. A higher confidence score indicates a more reliable moderation result. If this function is disabled or the value is set to 0, this check is not performed. politics, terrorism, and porn cannot be set to 0 simultaneously. |
|
terrorism |
Integer |
Confidence of terrorism-related content moderation. The value can be -1 or range from 0 to 100. This parameter is ignored in request parameters. A higher confidence score indicates a more reliable moderation result. If this function is disabled or the value is set to 0, this check is not performed. politics, terrorism, and porn cannot be set to 0 simultaneously. |
|
porn |
Integer |
Confidence of pornographic content moderation. The value can be -1 or range from 0 to 100. This parameter is ignored in request parameters. A higher confidence score indicates a more reliable moderation result. If this function is disabled or the value is set to 0, this check is not performed. politics, terrorism, and porn cannot be set to 0 simultaneously. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
This example reviews an uploaded media file.
POST https://{endpoint}/v1.0/{project_id}/asset/review
Content-Type: application/json
{
"asset_id": "3e1cd21131a94525be55acf65888bf46",
"review": {
"template_id": "c80e56dadb8542e8a1b7c2224dd6733a"
}
}
Example Responses
Status code: 200
Returned when the request succeeded.
{
"asset_id" : "ede1391f8be15b4bcf99099c8d437c00",
"review" : {
"template_id" : "c80e56dadb8542e8a1b7c2224dd6733a",
"interval" : 5,
"politics" : 0,
"terrorism" : 0,
"porn" : 1
}
}
Status code: 400
Returned when the request failed.
{
"error_code" : "VOD.10062",
"error_msg" : "Media asset or resource does not exist, please check."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Returned when the request succeeded. |
|
400 |
Returned when the request failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot