GetStreamTagList API for Live Stream Tag Retrieval - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

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:GetStreamTagList

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	No	The name of the search library.	Stream_xxx
Namespace	string	No	The namespace.	name-1
MediaId	string	No	The ID of the media asset.	****b48fb04483915d4f2cd8****
StartTime	string	No	The beginning of the time range to query, based on the tagging timestamp. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC (ISO 8601).	2025-04-23T02:26:00Z
EndTime	string	No	The end of the time range to query, based on the tagging timestamp. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format in UTC (ISO 8601).	2017-12-22T08:00:00Z
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
SortBy	string	No	The sorting order for the results. Valid values: StartTime:Desc (default): Sort by creation time in descending order. StartTime:Asc: Sort by creation time in ascending order.	StartTime:Asc
NextToken	string	No	A pagination token. Use this token in the next request to retrieve a new page of results.	**73f33c91-d59383e8280b**

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	****11-DB8D-4A9A-875B-275798****
Success	string	Whether the request was successful. Valid values: true false	true
Code	string	The response code.	200
NextToken	string	A pagination token. Use this token in the next request to retrieve a new page of results.	**73f33c91-d59383e8280b**
Total	integer	The total number of entries returned.	163
StreamTagList	array<object>	The tag information.
	object
StartTime	string	The start time, in yyyy-MM-ddTHH:mm:ssZ format in UTC (ISO 8601).	2025-04-26T16:00:00Z
EndTime	string	The end time, in yyyy-MM-ddTHH:mm:ssZ format in UTC (ISO 8601).	2025-02-25T02:24:00Z
UserData	string	The user-defined data.	{"result":"xxx"}

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": "true",
  "Code": "200",
  "NextToken": "****73f33c91-d59383e8280b****",
  "Total": 163,
  "StreamTagList": [
    {
      "StartTime": "2025-04-26T16:00:00Z",
      "EndTime": "2025-02-25T02:24:00Z",
      "UserData": "{\"result\":\"xxx\"}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.