DescribeTransitRouterMulticastDomains - 查询组播域列表--中转路由器-火山引擎

文档中心

立即注册

导航

DescribeTransitRouterMulticastDomains - 查询组播域列表

最近更新时间：2025.05.13 08:43:10首次发布时间：2025.05.13 08:43:10

调用DescribeTransitRouterMulticastDomains接口，查询满足指定条件的组播域列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeTransitRouterMulticastDomains	要执行的操作，取值：DescribeTransitRouterMulticastDomains。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
TransitRouterId	String	是	tr-7qthudw0ll6jmc****	中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。
TransitRouterMulticastDomainIds	Array of String	否	tr-md-hy13n2l4c6c0v****	组播域的ID。参数 - N：表示组播域的序号，取值范围为1～100。多个组播域ID之间使用“&”分隔。
TransitRouterMulticastDomainName	String	否	tr-multicast-name	组播域的名称。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（\_）和短横线（-）。长度限制为1 ~ 128个字符。不传入该参数或该参数不传入数值时，默认为组播域的ID。
TagFilters.N.Key	Array of String	否	k1	标签的标签键。 N：表示标签键的序号，取值范围1~10。多个标签键之间使用&分隔。指定多个标签键时，表示查询同时包含所有指定标签键的组播域。
TagFilters.N.Values.N	Array of String	否	v1	标签的标签值。第一个N：表示标签键的序号，取值范围1~10。第二个N：表示标签值的序号，取值范围1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的资源。多个标签值之间使用&分隔。说明如果传入该参数，则必须先传入TagFilters.N.Key。该参数传入空值时，表示查询指定标签键下标签值为空的资源。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TransitRouterMulticastDomains	Object		符合条件的组播域的详细信息。
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	1	符合条件的组播域的总数。

请求示例

GET /?Action=DescribeTransitRouterMulticastDomains&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20250509T093533Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250509/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202505091735381191960140142D****",
    "Action": "DescribeTransitRouterMulticastDomains",
    "Version": "2020-04-01",
    "Service": "transitrouter",
    "Region": "cn-beijing"
  },
  "Result": {
    "TransitRouterMulticastDomains": {
      "CreationTime": "2021-04-09T08:36:47+08:00",
      "Description": "description",
      "UpdateTime": "2021-04-10T09:18:28+08:00",
      "TransitRouterMulticastDomainName": "name",
      "TransitRouterMulticastDomainId": "tr-md-hy13n2l4c6c0v****",
      "Status": "Available",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ]
    },
    "PageSize": 20,
    "PageNumber": 1,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter	The request is missing a required parameter.	该请求缺少必要参数。
400	InvalidParameter	A parameter specified in the request is not valid, is unsupported or cannot be used.	该请求传入了非法或不支持的参数。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	该请求传入了非法或不支持的参数。资源查询数目最大限制100。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
500	InternalError	An internal error has occurred.	发生内部错误。