查询用户名下所有的直播域名。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:DescribeLiveUserDomains | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
LiveDomainType | string | 否 | 直播域名业务类型。取值:
说明
如果不设置此参数,则请求参数 DomainName 默认查询用户所有直播推流和播流域名。
| liveVideo |
PageSize | integer | 否 | 分页大小。默认值为 20,最大值为 50。 | 20 |
PageNumber | integer | 否 | 当前页码。取值范围:1~100000。 | 1 |
DomainName | string | 否 | 域名模糊匹配过滤。 说明
| *.aliyundoc.com |
RegionName | string | 否 | 域名所属地域。 | cn-beijing |
DomainSearchType | string | 否 | 域名查询类型。取值:
| fuzzy_match |
DomainStatus | string | 否 | 域名状态。取值:
| online |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | 标签列表。 | ||
Key | string | 否 | 标签健。 | TestKey |
Value | string | 否 | 标签值。 | TestValue |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-**kzvyjetyjjm** |
返回参数
示例
正常返回示例
JSON
格式
{
"Domains": {
"PageData": [
{
"Cname": "learn.developer.aliyundoc.com",
"Description": "test",
"DomainName": "demo.aliyundoc.com",
"GmtCreated": "2017-08-29T12:15:36Z",
"GmtModified": "2017-12-29T12:15:36Z",
"LiveDomainStatus": "online",
"LiveDomainType": "liveVideo",
"RegionName": "cn-beijing",
"ResourceGroupId": "rg-**kzvyjetyjjm**"
}
]
},
"PageNumber": 1,
"PageSize": 100,
"RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B15267",
"TotalCount": 1
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidPageNumber.ValueNotSupported | The specified value of parameter PageNumber is not supported. | 指定的PageNumber参数的值不支持。 |
400 | InvalidPageSize.ValueNotSupported | The specified value of parameter PageSize is not supported. | - |
400 | InvalidDomainStatus.ValueNotSupported | The specified value of parameter DomainStatus is not supported. | - |
400 | InvalidDomainName.Malformed | The specific value of parameter DomainName is malformed. | - |
400 | InvalidDomainSearchType.ValueNotSupported | The specified value of parameter DomainSearchType is not supported. | - |
400 | InvalidDomainSearchType.Malformed | he specified value of parameter DomainSearchType is invalid. | - |
400 | InvalidLiveDomainType.ValueNotSupported | The specified value of parameter LiveDomainType is not supported. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-27 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |