CDN Cache Refresh
Function
For media assets in completed, deleted, or published status, you can call this API to update their information in CDN by specifying the corresponding asset IDs or URLs. This operation forcibly expires the cached resources on CDN PoPs. When a user accesses a resource, CDN pulls the latest version from the origin server, returns it to the user, and caches it on CDN PoPs. One tenant can update a maximum of 1,000 media assets per day.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
vod:asset:createRefreshTask
Write
assets *
vod:AssetLabel
-
-
URI
POST /v1/{project_id}/asset/refresh
|
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_list |
No |
Array of strings |
ID list of media assets in the completed, deleted, or published status. A maximum of 10 media asset IDs can be refreshed at a time. |
|
urls |
No |
Array of strings |
Streaming URL list of media assets in the completed, deleted, or published status. A maximum of 10 media asset URLs can be refreshed at a time. A single URL can contain up to 10,240 characters. |
Response Parameters
Status code: 202
|
Parameter |
Type |
Description |
|---|---|---|
|
task_id |
String |
Refresh task ID. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
-
This example updates media assets by media asset ID.
POST https://{endpoint}/v1/{project_id}/asset/refresh { "asset_id_list" : [ "f488337c31c8e4622f1590735b134c65", "f360035c0f5833cf8e8b83e6df845187" ] } -
This example updates media assets by media asset URL.
POST https://{endpoint}/v1/{project_id}/asset/refresh { "urls" : [ "https://example.com/asset/9db42f5e08c15edecd99a98da241994a/313bfd52a75f95ff48e8bf02eca2ab20.flv", "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/68b1241af3bf58bcde9914626e07f5af.mp4", "https://example.com/asset/9e455adb02295aa123809e8dc7ca51c1/play_video/68b1241af3bf58bcde9914626e07f5af_H.264_480X270_HEAACV1_300.mp4" ] }
Example Responses
Status code: 202
Returned when the request succeeded.
{
"task_id" : "5199337c31c8e4622f1590735b13a263"
}
Status code: 400
Returned when the request failed.
{
"error_code" : "VOD.10053",
"error_msg" : "The request parameter is illegal, illegal field: {xx}."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
202 |
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