DocsICP FilingConsole
Documentation
Home Page Intelligent Media Services Developer Reference API Reference API catalog Media services Media advertising ListAdInsertions

ListAdInsertions

Updated at:
Copy as MD
Product
My Favorites

Retrieves a list of ad insertion configurations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListAdInsertions

list

*All Resource

*

 None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
Keyword

string

No

The keyword used to query ad insertion configurations by name. Fuzzy match is supported.

ad
PageNo

integer

No

The page number. Default value: 1.

1
PageSize

integer

No

The number of entries per page. Default value: 10.

10
SortBy

string

No

The sort order. Valid values: asc (ascending order by creation time) and desc (descending order by creation time).

Valid values:

  • asc :

    Ascending order by creation time.

  • desc :

    Descending order by creation time.

asc
NextToken

string

No

The token used to retrieve the next page of results. When this parameter is specified, pagination parameters are ignored.

******8EqYpQbZ6Eh7+Zz8DxVYoQ*****
MaxResults

integer

No

The maximum number of entries to return for the next page of results. When this parameter is specified, pagination parameters are ignored. Default value: 10.

10

Response elements

Element

Type

Description

Example

object

Schema of Response

Configs

array<object>

The list of ad insertion configurations.

array<object>

AdInsertionConifgItemType

CreateTime

string

The creation time. The time follows the ISO 8601 standard in UTC (ending with Z).

2024-06-13T08:26:09Z
LastModified

string

The last modified time.

2024-06-13T08:26:09Z

Name

string

The name of the ad insertion configuration.

my_ad
ContentUrlPrefix

string

The prefix of the content URL.

https://source.com/
AdsUrl

string

The URL of the ad decision server.

http://ads.com/ad1?param1=[palyer_params.p1]
ConfigAliases

string

The aliases of the dynamic configuration.

{ "player_params.p1": { "1": "abc" } }
PersonalizationThreshold

integer

The threshold for personalization configuration.

5
SlateAdUrl

string

The URL of the slate ad.

http://storage.com/slate1.mp4
CdnConfig

object

The CDN configuration.

ContentSegmentUrlPrefix

string

The CDN prefix for video content segments.

http://cdn.com/
AdSegmentUrlPrefix

string

The CDN prefix for ad segments.

http://cdn.com/
AdMarkerPassthrough

string

The ad marker passthrough settings.

ON
ManifestEndpointConfig

object

The manifest endpoint configuration.

HlsPrefix

string

The prefix of the HLS manifest endpoint.

https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/
DashPrefix

string

The prefix of the DASH manifest endpoint.

https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/
PageNo

integer

The page number.

1
PageSize

integer

The number of entries per page.

10
RequestId

string

Id of the request

******11-DB8D-4A9A-875B-275798******
SortBy

string

The sort order. Valid values: asc (ascending order by creation time) and desc (descending order by creation time).

asc
TotalCount

integer

The total number of entries.

10
NextToken

string

The token used to retrieve the next page of results. When this parameter is specified, pagination parameters are ignored.

******8EqYpQbZ6Eh7+Zz8DxVYoQ*****
MaxResults

integer

The maximum number of entries to return for the next page of results. When this parameter is specified, pagination parameters are ignored.

10

Examples

Success response

JSON format

{
  "Configs": [
    {
      "CreateTime": "2024-06-13T08:26:09Z",
      "LastModified": "2024-06-13T08:26:09Z\n",
      "Name": "my_ad",
      "ContentUrlPrefix": "https://source.com/",
      "AdsUrl": "http://ads.com/ad1?param1=[palyer_params.p1]",
      "ConfigAliases": "{\n      \"player_params.p1\": {\n            \"1\": \"abc\"\n      }\n}",
      "PersonalizationThreshold": 5,
      "SlateAdUrl": "http://storage.com/slate1.mp4",
      "CdnConfig": {
        "ContentSegmentUrlPrefix": "http://cdn.com/",
        "AdSegmentUrlPrefix": "http://cdn.com/"
      },
      "AdMarkerPassthrough": "ON",
      "ManifestEndpointConfig": {
        "HlsPrefix": "https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/****4fda5b1a8e0d46c9bf6262a7****/my_ad/",
        "DashPrefix": "https://****0311a423d11a5f7dee713535****.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/dash/****4fda5b1a8e0d46c9bf6262a7****/my_ad/"
      }
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SortBy": "asc",
  "TotalCount": 10,
  "NextToken": "******8EqYpQbZ6Eh7+Zz8DxVYoQ*****",
  "MaxResults": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Previous：GetAdInsertionNext：DeleteAdInsertion