文档

DeregisterTransitRouterMulticastGroupMembers - 删除组播成员

更新时间:

如果您不需要某个组播成员再接收组播流量,您可以调用DeregisterTransitRouterMulticastGroupMembers接口将该组播成员从组播组中删除。

接口说明

DeregisterTransitRouterMulticastGroupMembers接口属于异步接口,即系统会先返回一个 RequestId,但组播成员未被完全删除,系统后台的删除任务仍在进行。您可以调用ListTransitRouterMulticastGroups接口查询组播成员的状态。

  • 当组播成员处于 Deregistering 状态时,表示组播成员正在被删除,在该状态下,您只能对组播成员执行查询操作,不能执行其他操作。
  • ListTransitRouterMulticastGroups接口无法在组播域下查询到该组播成员的信息时,表示组播成员已被成功删除。

在调用 DeregisterTransitRouterMulticastGroupMembers 接口过程时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId,但不会删除组播成员。

调试

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

授权信息

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

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

请求参数

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

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

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

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

组播成员所属的组播域 ID。

tr-mcast-domain-91wpg6wbhchjeq****
GroupIpAddressstring

组播成员所属的组播组的 IP 地址。

239.XX.XX.2
NetworkInterfaceIdsarray

弹性网卡 ID 列表。

string

弹性网卡 ID。

一次支持删除多个弹性网卡。请确保您指定的弹性网卡个数与跨地域组播域的个数之和小于或等于 5。

eni-p0weuda3lszwzjly****
PeerTransitRouterMulticastDomainsarray

跨地域的组播域 ID 列表。

string

跨地域的组播域 ID。

一次支持删除多个跨地域组播域。请确保您指定的弹性网卡个数与跨地域组播域的个数之和小于或等于 5。

tr-mcast-domain-5mjb5gjb6dgu98****
DryRunboolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会删除组播成员。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接删除组播成员。
false

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

61D0A553-5E4E-53B5-9DA3-01CBA076A286

示例

正常返回示例

JSON格式

{
  "RequestId": "61D0A553-5E4E-53B5-9DA3-01CBA076A286"
}

错误码

HTTP status code错误码错误信息描述
400InvalidTransitRouterMulticastDomainId.NotFoundThe specified TransitRouterMulticastDomainId is not found.参数中指定的TransitRouterMulticastDomainId不存在。
400InvalidOperation.MulticastDomainStatusOperation is invalid, due to multicast domain not Active.当前组播域状态不支持该操作,请稍后重试。
400IncorrectStatus.MulticastGroupThe status of MulticastGroup is incorrect.当前MulticastGroup的状态不支持该操作,请稍后重试。
400DryRunOperationRequest validation has been passed with DryRun flag set.DryRun请求验证通过。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2024-01-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈