全部产品
Search

搜索本产品

    云企业网：ListGrantVSwitchEnis - 查询专有网络VPC（Virtual Private Cloud）下可以成为组播源或者组播成员的弹性网卡的信息

    文档中心

    云企业网：ListGrantVSwitchEnis - 查询专有网络VPC（Virtual Private Cloud）下可以成为组播源或者组播成员的弹性网卡的信息

    更新时间：Oct 22, 2024

    调用ListGrantVSwitchEnis接口查询在一个专有网络内部，哪些弹性网卡的配置可以成为组播源或者组播成员用来进行组播通信。

    接口说明

    调用ListGrantVSwitchEnis接口前，请确保 VPC 实例已被连接至云企业网。具体操作，请参见 CreateTransitRouterVpcAttachment 。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    CenIdstring是

    VPC 实例连接的云企业网实例的 ID。

    		cen-a7syd349kne38g****
    VpcIdstring是

    VPC 实例的 ID。

    		vpc-p0w9alkte4w2htrqe****
    VSwitchIdstring是

    VPC 实例下的一个交换机 ID。

    一次仅支持查询一个交换机下的弹性网卡的信息。

    		vsw-p0w9s2ig1jnwgrbzl****
    NextTokenstring否

    是否拥有下一次查询的令牌（Token）。取值：

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

    分页查询时每页的最大条目数。取值范围：10~500。

    默认值：

    • 当不设置值时，默认值为 20。
    • 当设置的值大于 500 时，默认值为 500。
    		20
    NetworkInterfaceIdarray否

    弹性网卡 ID。

    string否

    弹性网卡的 ID。

    当前系统仅支持 ECS 实例关联的 ENI 作为组播源。系统将以该 ENI 的主私网 IP 地址向组播组发送组播流量。

    		eni-wz9a2sgsskvw69v2****
    NetworkInterfaceNamestring否

    弹性网卡的名称。

    		test-eni-name
    PrimaryIpAddressstring否

    弹性网卡主私网 IPv4 地址。

    		192.168.**.**

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		DBFE1736-2F33-5309-9954-875B11E9519D
    TotalCountstring

    列表条目数。

    注意 使用 MaxResults 和 NextToken 参数进行分页查询时，返回的 Total 参数值无意义。

    		6
    GrantVSwitchEnisarray<object>

    弹性网卡信息列表。

    GrantVSwitchEniobject

    弹性网卡信息。

    VpcIdstring

    VPC 实例 ID。

    		vpc-p0w9alkte4w2htrqe****
    VSwitchIdstring

    交换机 ID。

    		vsw-p0w9s2ig1jnwgrbzl****
    NetworkInterfaceIdstring

    弹性网卡 ID。

    		eni-p0w172vv82kxzb49****
    Descriptionstring

    弹性网卡的描述信息。

    		created by CBN
    TransitRouterFlagboolean

    当前弹性网卡是否是转发路由器创建的。

    • true：是。
    • false：否。

    转发路由器创建的弹性网卡不支持成为组播源或者组播成员。

    		false
    NetworkInterfaceNamestring

    弹性网卡的名称。

    		my-eni-name
    PrimaryIpAddressstring

    弹性网卡主私网 IPv4 地址。

    		192.168.**.**
    NextTokenstring

    本次调用返回的查询凭证值。

    		AAAAAdDWBF2****
    MaxResultslong

    本次读取的最大数据量。

    		20

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "DBFE1736-2F33-5309-9954-875B11E9519D",
  "TotalCount": "6",
  "GrantVSwitchEnis": [
    {
      "VpcId": "vpc-p0w9alkte4w2htrqe****",
      "VSwitchId": "vsw-p0w9s2ig1jnwgrbzl****",
      "NetworkInterfaceId": "eni-p0w172vv82kxzb49****",
      "Description": "created by CBN",
      "TransitRouterFlag": false,
      "NetworkInterfaceName": "my-eni-name",
      "PrimaryIpAddress": "192.168.**.**"
    }
  ],
  "NextToken": "AAAAAdDWBF2****",
  "MaxResults": 20
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidCenId.NotFoundThe specified CenId is not found.参数中指定的CenId不存在。
    400InvalidVpcId.NotFoundThe specified VpcId is not found.参数中指定的VpcId不存在。
    400InvalidOperation.MulticastDomainAssociationNotExistOperation is invalid because multicast association domain association not exist.组播域关联不存在，无法支持当前操作。
    400InvalidParameterInvalid parameter.参数不合法。
    400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

    变更历史

    变更时间变更内容概要操作
    2023-08-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情