You need to enable JavaScript to run this app.
文档中心
中转路由器

中转路由器

复制全文
下载 pdf
组播
DescribeTransitRouterMulticastGroups-查询组播组列表
复制全文
下载 pdf
DescribeTransitRouterMulticastGroups-查询组播组列表
调用DescribeTransitRouterMulticastGroups接口,查询指定组播域中的组播源和组播成员。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeTransitRouterMulticastGroups​
接口名称。当前 API 的名称为DescribeTransitRouterMulticastGroups。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为2020-04-01。​
​
TransitRouterMulticastDomainId String 可选 示例值:tr-md-hy13n2l4c6c0v****​
组播域的ID。您可以调用DescribeTransitRouterMulticastDomains接口获取组播域的ID。​
说明​
该参数与TransitRouterMulticastDomainId、ResourceId参数必须至少传入1个。​
​
GroupIpAddress String 可选 示例值:224.0.1.0​
组播组的IP地址。取值范围为224.0.1.0~239.255.255.254。​
​
TransitRouterAttachmentId String 可选 示例值:tr-attach-a*******​
网络实例连接的ID。您可以调用DescribeTransitRouterVpcAttachments接口获取VPC类型网络实例连接的ID。​
​
ResourceType String 可选 示例值:VPC​
组播资源的类型。​
  • VPC:私有网络。​
​
ResourceId String 可选 示例值:vpc-bp1aevy8sofi8mh1****​
组播资源的ID。您可以调用DescribeVpcs接口获取VPC的ID。​
​
SubnetIds.N String 可选 示例值:subnet-123456​
子网的ID。​
  • N:表示子网ID的序号,取值范围为1~100。​
  • 多个子网ID之间使用&分隔。​
​
NetworkInterfaceIds.N String 可选 示例值:eni-123456​
网卡的ID。​
  • N:表示网卡ID的序号,取值范围为1~100。​
  • 多个网卡ID之间使用&分隔。​
​
IsGroupSource Boolean 可选 示例值:true​
是否查询组播源。​
  • true:是。​
  • false:否。​
​
IsGroupMember Boolean 可选 示例值:true​
是否查询组播成员。​
  • true:是。​
  • false:否。​
​
SourceType String 可选 示例值:Static​
组播源的类型。​
  • Static:静态组播源,表示组播源通过手动方式指定。​
​
MemberType String 可选 示例值:Static​
组播成员的类型。​
  • Static:静态组播成员,表示组播成员通过手动方式指定。​
​
PageNumber Integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TransitRouterMulticastGroups Object[] 示例值:-​
符合条件的组播组资源信息。​
CreationTime String 示例值:2021-04-09T08:36:47+08:00​
组播组的创建时间。​
​
UpdateTime String 示例值:2021-04-10T09:18:28+08:00​
组播组的最近操作时间。​
​
Status String 示例值:Available​
组播资源的状态。​
  • Creating: 创建中。​
  • Deleting: 删除中。​
  • Pending:配置中。​
  • Available:可用。​
​
TransitRouterMulticastDomainId String 示例值:tr-md-3t6b1n60vg4jks0txrs8****​
组播域的ID。​
​
GroupIpAddress String 示例值:224.0.1.0​
组播组的IP地址。​
​
TransitRouterAttachmentId String 示例值:tr-attach-16b4ks6wd****​
网络实例连接的ID。​
​
ResourceType String 示例值:VPC​
网络实例的类型。​
  • VPC:私有网络。​
​
ResourceId String 示例值:vpc-bp1aevy8sofi8mh1****​
网络实例的ID。​
​
SubnetId String 示例值:subnet-1wdfv3tfh6****​
子网的ID。​
​
NetworkInterfaceId String 示例值:eni-wsdfgg5wrf****​
网卡的ID。​
​
GroupSource Boolean 示例值:true​
当前组播资源是否是组播源。​
  • true:是。​
  • false:否。​
​
GroupMember Boolean 示例值:true​
当前组播资源是否是组播成员。​
  • true:是。​
  • false:否。​
​
SourceType String 示例值:Static​
组播源的类型。​
  • Static:静态组播源,表示组播源通过手动方式指定。​
​
MemberType String 示例值:Static​
组播成员的类型。​
  • Static:静态组播成员,表示组播成员通过手动方式指定。​
​
TransitRouterId String 示例值:tr-1aadrf4cgh****​
中转路由器实例的ID。​
​
​
PageNumber Integer 示例值:1​
当前返回的组播组列表的页码,表示查询结果的分页信息。​
​
PageSize Integer 示例值:10​
每页显示的组播组数量。​
​
TotalCount Integer 示例值:2​
符合条件的组播组资源的总数量。​
​
​
请求示例​
​
GET /?Action=DescribeTransitRouterMulticastGroups&Version=2020-04-01 HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250721T122158Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250721/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeTransitRouterMulticastGroups",​
"Version": "2020-04-01",​
"Service": "transitrouter",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 10,​
"TotalCount": 2,​
"TransitRouterMulticastGroups": [​
{​
"Status": "Available",​
"SubnetId": "subnet-1wdfv3tfh6****",​
"MemberType": "Static",​
"ResourceId": "vpc-bp1aevy8sofi8mh1****",​
"SourceType": "Static",​
"UpdateTime": "2021-04-10T09:18:28+08:00",​
"GroupMember": true,​
"GroupSource": true,​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"ResourceType": "VPC",​
"GroupIpAddress": "224.0.1.0",​
"TransitRouterId": "tr-1aadrf4cgh****",​
"NetworkInterfaceId": "eni-wsdfgg5wrf****",​
"TransitRouterAttachmentId": "tr-attach-16b4ks6wd****",​
"TransitRouterMulticastDomainId": "tr-md-3t6b1n60vg4jks0txrs8****"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
LimitExceeded.ResourceIds​
You've reached the limit of 100 resource IDs that can be specified in this request.​
该请求传入了非法或不支持的参数。资源查询数目最大限制100。​
​
最近更新时间:2025.12.31 12:18:47
这个页面对您有帮助吗?
有用
有用
无用
无用