调用ListTransitRouterMulticastDomains接口查询组播域的状态、组播域ID、组播域的描述等信息。
接口说明
- RegionId 必须和 CenId 组合使用，不能单独使用，否则将不会显示组播域的信息。 但 TransitRouterId 和 TransitRouterMulticastDomainId 可以单独使用。
- 调用接口时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId，但不会显示组播域的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cen:ListTransitRouterMulticastDomains | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 | 123e4567-e89b-12d3-a456-426655440000 |
| CenId | string | 否 | 云企业网实例 ID。 | cen-a7syd349kne38g**** |
| TransitRouterId | string | 否 | 转发路由器实例 ID。 | tr-p0wr9p28r92d598y6**** |
| TransitRouterMulticastDomainId | string | 否 | 组播域 ID。 | tr-mcast-domain-3r3bvbypxqheej**** |
| RegionId | string | 否 | 转发路由器实例所属地域 ID。 您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。 | cn-hangzhou |
| MaxResults | long | 否 | 分批次查询时每次显示的条目数。默认值：20。 | 20 |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| Tag | object [] | 否 | 标签信息。 一次最多支持输入 20 个标签信息。 | |
| Key | string | 否 | 资源的标签键。 一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 一次最多支持输入 20 个标签的标签键。 | TagKey |
| Value | string | 否 | 资源的标签值。 标签值可以为空或输入不超过 128 个字符的字符串，不能以 每一个标签键对应一个标签值，一次最多支持输入 20 个标签键对应的标签值。 | TagValue |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2",
"TotalCount": 1,
"MaxResults": 20,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TransitRouterMulticastDomains": [
{
"TransitRouterMulticastDomainId": "tr-mcast-domain-3r3bvbypxqheej****",
"TransitRouterMulticastDomainName": "nametest",
"TransitRouterMulticastDomainDescription": "desctest",
"Status": "Active",
"Tags": [
{
"Key": "TagKey",
"Value": "TagValue"
}
],
"TransitRouterId": "tr-bp1c23ijrl6d6c226h***",
"RegionId": "cn-hangzhou",
"CenId": "cen-h19xdb0qy2b3irka8z"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is illegal. | 参数中指定的NextToken不合法。 |
| 400 | IllegalParam.TrInstance | The specified TrInstance is illegal. | 参数中指定的TrInstance不合法。 |
| 400 | IllegalParam.CenId | The specified CenId is illegal. | 指定的cenId不合法。 |
| 400 | IllegalParam.MaxResults | The specified MaxResults is illegal. | MaxResults非法。 |
| 400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-08-04 | OpenAPI 错误码发生变更 | 看变更集 | ||||||
| ||||||||
| 2023-07-13 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|