接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:DescribeLivePackageConfig | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 直播域名(主播放域名)。 | example.com |
AppName | string | 否 | App 名,置空表示匹配所有名称。 | AppName |
StreamName | string | 否 | 直播流名,置空表示匹配所有流名。 | StreamName |
PageNum | integer | 否 | 当前页码。默认值:1。 | 1 |
PageSize | integer | 否 | 每页大小。默认值:10,取值范围:5~30。 | 10 |
Order | string | 否 | 排序。取值:
| asc |
返回参数
示例
正常返回示例
JSON
格式
{
"LivePackageConfigList": {
"LivePackageConfig": [
{
"AppName": "AppName",
"DomainName": "example.com",
"IgnoreTranscode": true,
"PartDuration": 0,
"Protocol": "HLS_CMAF",
"SegmentDuration": 5,
"SegmentNum": 3,
"StreamName": "StreamName"
}
]
},
"Order": "asc",
"PageNum": 1,
"PageSize": 10,
"RequestId": "1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0",
"TotalNum": 1,
"TotalPage": 10
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | MissingParam | %s |
400 | InvalidParams | %s |
400 | ConfigAlreadyExists | %s |
400 | InvalidProtocol | %s |
400 | InvalidSegmentNum | %s |
400 | InvalidSegmentDuration | %s |
400 | InvalidPartDuration | %s |
500 | InternalErr | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史