如果您不需要某个组播源再发送组播流量,您可以调用DeregisterTransitRouterMulticastGroupSources接口将该组播源从组播组中删除。
接口说明
DeregisterTransitRouterMulticastGroupSources
接口属于异步接口,即系统会先返回一个 RequestId,但组播源未被完全删除,系统后台的删除任务仍在进行。您可以调用ListTransitRouterMulticastGroups
接口查询组播源的状态。
- 当组播源处于 Deregistering 状态时,表示组播源正在被删除,在该状态下,您只能对组播源执行查询操作,不能执行其他操作。
- 当
ListTransitRouterMulticastGroups
接口无法在组播域下查询到该组播源的信息时,表示组播源已被成功删除。
在调用 DeregisterTransitRouterMulticastGroupSources 接口过程时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId,但不会删除组播源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:DeregisterTransitRouterMulticastGroupSources | delete | *TransitRouterMulticastDomain acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 | 123e4567-e89b-12d3-a456-4266**** |
TransitRouterMulticastDomainId | string | 是 | 组播源所属的组播域 ID。 | tr-mcast-domain-91wpg6wbhchjeq**** |
GroupIpAddress | string | 是 | 组播源所属的组播组的 IP 地址。 | 239.XX.XX.2 |
NetworkInterfaceIds | array | 否 | 组播源 ID 列表。 | |
string | 否 | 组播源 ID。 当前一个组播组一次最多支持删除五个组播源。 说明
当前本参数为必填参数。
| eni-p0weuda3lszwzjly**** | |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "53E7E8BE-7F4E-5458-ACCA-9B5C1D6A642D"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTransitRouterMulticastDomainId.NotFound | The specified TransitRouterMulticastDomainId is not found. | 参数中指定的TransitRouterMulticastDomainId不存在。 |
400 | InvalidOperation.MulticastDomainStatus | Operation is invalid, due to multicast domain not Active. | 当前组播域状态不支持该操作,请稍后重试。 |
400 | IncorrectStatus.MulticastGroup | The status of MulticastGroup is incorrect. | 当前MulticastGroup的状态不支持该操作,请稍后重试。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | DryRun请求验证通过。 |
400 | OperationUnsupported.NotAllowedDeleteIgmpv2Member | You cannot delete a multicast source or multicast member of the igmpv2 type. | 不允许删除igmpv2类型的组播源或组播成员。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-25 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-01-19 | OpenAPI 错误码发生变更 | 查看变更详情 |