Updated on 2024-12-04 GMT+08:00

Deleting a Transcoded Output

Function

Deletes a transcoded output.

URI

DELETE /v1/{project_id}/asset/transcode-product

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

asset_id

No

String

Media asset ID.

delete_type

No

String

GROUP: Deletion at the template group level

PRODUCT: Deletion at the product level

delete_infos

No

Array of ProductGroupInfo objects

Information about a deleted output. Information about a maximum of 100 outputs can be transferred.

Table 4 ProductGroupInfo

Parameter

Mandatory

Type

Description

group_id

No

String

Template group ID.

products

No

Array of ProductUrlInfo objects

Product information.

Table 5 ProductUrlInfo

Parameter

Mandatory

Type

Description

url

No

String

Deleted product URL.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

asset_id

String

Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.

status

String

SUCCESS: successful

FAIL: failed

PARTIAL_SUCCESS: partially successful

deleted_products

Array of ProductGroupInfo objects

Product that has been deleted.

failed_products

Array of ProductGroupDelFailInfo objects

Product that fails to be deleted.

Table 7 ProductGroupInfo

Parameter

Type

Description

group_id

String

Template group ID.

products

Array of ProductUrlInfo objects

Product information.

Table 8 ProductUrlInfo

Parameter

Type

Description

url

String

Deleted product URL.

Table 9 ProductGroupDelFailInfo

Parameter

Type

Description

group_id

String

Template group ID.

fail_reason

String

Cause of the failure to delete a template group.

products

Array of ProductDelFailInfo objects

Information about the product that fails to be deleted.

Table 10 ProductDelFailInfo

Parameter

Type

Description

url

String

Deleted product URL.

fail_reason

String

Cause of the failure to delete a product.

Status code: 403

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

  • DELETE https://{endpoint}/v1/{project_id}/asset/transcode-product
    
    Content-Type: application/json
    {
      "asset_id": "8c53b4038ea3d8694f1a8a7ac95f612f",
      "delete_type": "PRODUCT",
      "delete_infos": [
        {
          "group_id": "9171008cca7f47909c61f61a65d4c906",
          "products": [
            {
              "url": "https://103-cn-north-4.cdn-vod.huaweicloud.com/asset/8c53b4038ea3d8694f1a8a7ac95f612f/play_multi_video/9171008cca7f47909c61f61a65d4c906/38a92b74ead764ad21aa5355bad5193e.mp4"
            }
          ]
        }
      ]
    }
  • DELETE https://{endpoint}/v1/{project_id}/asset/transcode-product
    
    Content-Type: application/json
    {
      "asset_id": "6f306b4cc58c39b2a97ad797367b88ad",
       "delete_type": "GROUP",
       "delete_infos": [
         {
            "group_id": "02e6887dd6bf48299922eec52d192115"
         }
        ]
    }

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "status" : "SUCCESS",
  "deleted_products" : [ {
    "group_id" : "9171008cca7f47909c61f61a65d4c906",
    "products" : [ {
      "url" : "https://103-cn-north-4.cdn-vod.huaweicloud.com/asset/8c53b4038ea3d8694f1a8a7ac95f612f/play_multi_video/9171008cca7f47909c61f61a65d4c906/da6613ac132eda54b2f4ab67adbf56bd.mp4"
    } ]
  } ],
  "failed_products" : [ ]
}

Status code: 403

The information is returned when the request failed.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeded.

403

The information is returned when the request failed.

Error Codes

See Error Codes.