Creates a media asset review task
Function
Reviews the uploaded media asset. You can call the API for Querying File Details to view the review result.
Constraints
Currently, only the VOD service in the CN North-Beijing1 and CN North-Beijing4 regions supports this function.
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 a token. |
Authorization |
No |
String |
Authentication information. This parameter is mandatory for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when the 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. This parameter can only be queried but cannot be modified. |
review |
Yes |
Review object |
Media file review parameters
NOTE:
Only the VOD service in the CN North-Beijing1 and CN North-Beijing4 regions supports this function. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
template_id |
Yes |
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 the VOD service in the CN North-Beijing1 and CN North-Beijing4 regions 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 detection. The value range is [0,100]. This parameter is ignored in request parameters. A higher confidence level indicates a more reliable review result. If this function is disabled or the value is set to 0, this check is not performed. |
terrorism |
No |
Integer |
Confidence of terrorism-related content detection. The value range is [0,100]. This parameter is ignored in request parameters. A higher confidence level indicates a more reliable review result. If this function is disabled or the value is set to 0, this check is not performed. |
porn |
No |
Integer |
Confidence of pornographic content detection. The value range is [0,100]. This parameter is ignored in request parameters. A higher confidence level indicates a more reliable review result. If this function is disabled or the value is set to 0, this check is not performed. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
asset_id |
String |
Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified. |
review |
Review object |
Media file review parameters
NOTE:
Only the VOD service in the CN North-Beijing1 and CN North-Beijing4 regions 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 the VOD service in the CN North-Beijing1 and CN North-Beijing4 regions 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 detection. The value range is [0,100]. This parameter is ignored in request parameters. A higher confidence level indicates a more reliable review result. If this function is disabled or the value is set to 0, this check is not performed. |
terrorism |
Integer |
Confidence of terrorism-related content detection. The value range is [0,100]. This parameter is ignored in request parameters. A higher confidence level indicates a more reliable review result. If this function is disabled or the value is set to 0, this check is not performed. |
porn |
Integer |
Confidence of pornographic content detection. The value range is [0,100]. This parameter is ignored in request parameters. A higher confidence level indicates a more reliable review result. If this function is disabled or the value is set to 0, this check is not performed. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Reviews an uploaded media file.
POST https://{endpoint}/v1.0/{project_id}/asset/review { "asset_id" : "3e1cd21131a94525be55acf65888bf46", "review" : { "template_id" : "c80e56dadb8542e8a1b7c2224dd6733a" } }
Example Responses
Status code: 200
The information is returned when the request succeeds.
{ "asset_id" : "ede1391f8be15b4bcf99099c8d437c00", "review" : { "template_id" : "c80e56dadb8542e8a1b7c2224dd6733a", "interval" : 5, "politics" : 0, "terrorism" : 0, "porn" : 1 } }
Status code: 400
The information is returned when the request fails.
{ "error_code" : "VOD.10062", "error_msg" : "Media asset or resource does not exist, please check." }
Status Codes
Status Code |
Description |
---|---|
200 |
The information is returned when the request succeeds. |
400 |
The information is returned when the request fails. |
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