GetAdInsertion - Intelligent Media Services - Alibaba Cloud Documentation Center

Obtains details of an ad insertion configuration.

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:GetAdInsertion	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the ad insertion configuration that you want to query.	my_ad

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Config	object	The ad insertion configuration.
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 configuration.	my_ad
ContentUrlPrefix	string	The prefix of the source URL.	https://source.com/
AdsUrl	string	The URL of the ad decision server (ADS).	http://ads.com/ad1?param1=[palyer_params.p1]
ConfigAliases	string	The aliases for dynamic variable replacement.	{ "player_params.p1": { "1": "abc" } }
PersonalizationThreshold	integer	The personalization threshold.	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 accessing content segments.	http://cdn.com/
AdSegmentUrlPrefix	string	The CDN prefix for accessing ad segments.	http://cdn.com/
AdMarkerPassthrough	string	Indicates whether ad marker passthrough is enabled.	ON
ManifestEndpointConfig	object	The playback endpoint prefix for accessing manifests.
HlsPrefix	string	The playback endpoint prefix for accessing HLS manifests.	https://**0311a423d11a5f7dee713535.weaverpull-ssai.ap-southeast-1.ice.alibabacloudcs.com/v1/master/4fda5b1a8e0d46c9bf6262a7**/my_ad/
RequestId	string	The ID of the request.	****3B-0E1A-586A-AC29-742247****

Examples

Sample success responses

JSONformat

{
  "Config": {
    "CreateTime": "2024-06-13T08:26:09Z\t",
    "LastModified": "2024-06-13T08:26:09Z\t",
    "Name": "my_ad",
    "ContentUrlPrefix": "https://source.com/\n",
    "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/"
    }
  },
  "RequestId": "******3B-0E1A-586A-AC29-742247******"
}

Error codes

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