ListAdInsertions - Intelligent Media Services - Alibaba Cloud Documentation Center

Obtains ad insertion configurations.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:ListAdInsertions	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The configuration name. Fuzzy match is supported.	ad
PageNo	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10.	10
SortBy	string	No	The sorting order of the configurations by creation time. asc: ascending. desc: descending.	asc
NextToken	string	No	The token that is used in the next request to retrieve a new page of results. If this parameter is used, the pagination parameters become invalid.	****8EqYpQbZ6Eh7+Zz8DxVYoQ***
MaxResults	integer	No	The maximum number of entries to retrieve in a subsequent request. If this parameter is used, the pagination parameters become invalid. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Configs	array<object>	Array
AdInsertionConfig	object	AdInsertionConifgItemType
CreateTime	string	The time when the configuration was created.	2024-06-13T08:26:09Z
LastModified	string	The time when the configuration was last modified.	2024-06-13T08:26:09Z
Name	string	The name of the ad insertion configuration.	my_ad
ContentUrlPrefix	string	The URL prefix for the source content.	https://source.com/
AdsUrl	string	The request URL of the ad decision server (ADS).	http://ads.com/ad1?param1=[palyer_params.p1]
ConfigAliases	string	The player parameter variables and aliases.	{ "player_params.p1": { "1": "abc" } }
PersonalizationThreshold	integer	The personalization threshold that defines the maximum duration of underfilled time allowed in an ad break.	5
SlateAdUrl	string	The URL of the slate ad.	http://storage.com/slate1.mp4
CdnConfig	object	The CDN configurations.
ContentSegmentUrlPrefix	string	The CDN prefix for content segments.	http://cdn.com/
AdSegmentUrlPrefix	string	The CDN prefix for ad segments.	http://cdn.com/
AdMarkerPassthrough	string	Indicates whether ad marker passthrough is enabled.	ON
ManifestEndpointConfig	object	The playback endpoint configuration.
HlsPrefix	string	The prefix of the playback endpoint for HLS manifests.	https://**0311a423d11a5f7dee713535.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/4fda5b1a8e0d46c9bf6262a7**/my_ad/
PageNo	long	The page number.	1
PageSize	long	The number of entries per page.	10
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
SortBy	string	The sorting order of the configurations by creation time. asc: ascending. desc: descending.	asc
TotalCount	long	The total number of entries returned.	10
NextToken	string	The token that is used in the next request to retrieve a new page of results. If this parameter is used, the pagination parameters become invalid.	****8EqYpQbZ6Eh7+Zz8DxVYoQ***
MaxResults	integer	The maximum number of entries to retrieve in a subsequent request. If this parameter is used, the pagination parameters become invalid.	10

Examples

Sample success responses

JSONformat

{
  "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": {
        "player_params.p1": {
          "1": "abc"
        }
      },
      "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/"
      }
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SortBy": "asc",
  "TotalCount": 10,
  "NextToken": "******8EqYpQbZ6Eh7+Zz8DxVYoQ*****",
  "MaxResults": 10
}

Error codes

For a list of error codes, visit the Service error codes.