首页 云企业网 API参考 API目录 组播 组播域 ListTransitRouterMulticastDomains - 查询组播域的信息

ListTransitRouterMulticastDomains - 查询组播域的信息

查询组播域的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:ListTransitRouterMulticastDomainsRead
  • CEN
    acs:cen:*:{#accountId}:centransitroutermulticast/*
  • CEN
    acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

请求参数

名称类型必填描述示例值
ClientTokenstring

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

123e4567-e89b-12d3-a456-426655440000
CenIdstring

云企业网实例ID。

cen-a7syd349kne38g****
TransitRouterIdstring

转发路由器实例ID。

tr-p0wr9p28r92d598y6****
TransitRouterMulticastDomainIdstring

组播域ID。

tr-mcast-domain-3r3bvbypxqheej****
RegionIdstring

转发路由器实例所属地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

ap-southeast-2
MaxResultslong

分批次查询时每次显示的条目数。默认值:20

20
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
FFmyTO70tTpLG6I3FmYAXGKPd****
Tagarray

标签信息。

一次最多支持输入20个标签信息。

object
Keystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入20个标签的标签键。

TagKey
Valuestring

资源的标签值。

标签值可以为空或输入不超过128个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入20个标签键对应的标签值。

TagValue

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求ID。

8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2
TotalCountinteger

列表条目数。

1
MaxResultsinteger

分批次查询时每次显示的条目数。

20
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastDomainsarray

组播域信息列表。

object

组播域的信息。

TransitRouterMulticastDomainIdstring

组播域ID。

tr-mcast-domain-3r3bvbypxqheej****
TransitRouterMulticastDomainNamestring

组播域的名称。

nametest
TransitRouterMulticastDomainDescriptionstring

组播域的描述信息。

desctest
Statusstring

组播域的状态。

仅取值:Active,表示组播域当前可用。

Active
Tagsarray

标签列表。

object
Keystring

标签键。

TagKey
Valuestring

标签值。

TagValue
TransitRouterIdstring

转发路由器实例ID。

tr-bp1c23ijrl6d6c226h***

示例

正常返回示例

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***"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenThe specified NextToken is illegal.参数中指定的NextToken不合法。
400IllegalParam.TrInstanceThe specified TrInstance is illegal.参数中指定的TrInstance不合法。
400IllegalParam.CenIdThe specified CenId is illegal.指定的cenId不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 云企业网 相关技术圈