All Products
Search
Document Center

Intelligent Media Services:GetLiveEditingIndexFile

Last Updated:Dec 16, 2024

Queries the index file of a live stream. The index file is used to preview an editing project in the console.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetLiveEditingIndexFile
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppNamestringNo

The application name of the live stream.

testrecord
DomainNamestringNo

The domain name of the live stream.

test.alivecdn.com
StreamNamestringNo

The name of the live stream.

teststream
ProjectIdstringNo

The ID of the live stream editing project.

*****cb6307a4edea614d8b3f3c*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

4E84BE44-58A7-****-****-FBEBEA16EF94
IndexFilestring

The URL of the index file.

Examples

Sample success responses

JSONformat

{
  "RequestId": "4E84BE44-58A7-****-****-FBEBEA16EF94",
  "IndexFile": ""
}

Error codes

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