全部产品
Search
文档中心

专有网络 VPC:DescribeEcGrantRelation - 查询跨账号创建VBR上连场景下VPC实例对VBR实例的授权关系

更新时间:Nov 13, 2024

调用DescribeEcGrantRelation接口查询跨账号创建VBR上连场景下VPC实例对VBR实例的授权关系。

调试

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

授权信息

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

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

请求参数

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

要查询授权关系的实例类型。取值:

  • VBR:边界路由器 VBR(Virtual border router)实例,表示查询 VBR 实例拥有哪些 VPC 实例的授权。
  • VPC:专有网络 VPC(Virtual Private Cloud)实例,表示查询 VPC 实例对哪些 VBR 实例进行了授权。
VBR
InstanceIdstring

要查询授权关系的实例 ID。

  • InstanceType 取值为 VBR 时,此处配置为 VBR 实例 ID。

  • InstanceType 取值为 VPC 时,此处配置为 VPC 实例 ID。

vbr-bp12mw1f8k3jgygk9****
PageNumberlong

列表的页码。默认值:1

1
PageSizelong

分页查询时每页的行数。最大值:50。默认值:10

10
VbrRegionNostring

要查询授权关系的 VBR 实例所在地域 ID。

  • InstanceTypeVBR 时,该参数需要配置。

  • InstanceTypeVPC 时,该参数不需要配置。

cn-hangzhou

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

E6E90F6B-2B41-5AAF-ABEB-236ADBAAD91D
EcGrantRelationsarray<object>

查询授权关系的结果列表。

EcGrantRelationModelobject

查询授权关系的结果列表。

VbrOwnerUidlong

VBR 实例所属的阿里云账号(主账号)ID。

1210123456123456
VbrInstanceIdstring

查询的授权关系的 VBR 实例 ID。

vbr-m5ex0xf63xk8s5bob****
InstanceIdstring

查询的授权关系的 VPC 实例 ID。

vpc-bp1brjuegjc88v3u9****
AliUidlong

查询的授权关系的 VPC 所属阿里云账号(主账号)ID。

1250123456123456
RegionNostring

查询的授权关系 VPC 所在地域 ID。

cn-hangzhou
Statusstring

查询授权关系的结果。取值:

  • Created:VPC 实例与 VBR 实例已有授权关系。
  • Deleted:VPC 实例与 VBR 实例没有授权关系。
Created
InstanceNamestring

查询的授权关系的 VPC 名称。

VPCname
InstanceRouterIdstring

查询的授权关系的 VPC 路由器 ID。

vrt-bp1i0yzgjd8ra05ec****
VbrRegionNostring

查询的授权关系的 VBR 实例所在地域 ID。

cn-hangzhou
GmtCreatestring

VPC 实例对 VBR 实例的授权时间。

2022-09-02T11:46Z
GrantTypestring

接受授权的 VBR 实例的范围。取值:

  • All:将 VPC 实例授权给指定地域和阿里云账号(主账号)下的所有 VBR 实例。
  • Specify:将 VPC 实例授权给指定 VBR 实例。
All
TotalCountinteger

列表条目数。

10
Countinteger

查询的结果数。

1
Pageinteger

列表的页码。

1
PageSizeinteger

分页查询时每页的行数。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "E6E90F6B-2B41-5AAF-ABEB-236ADBAAD91D",
  "EcGrantRelations": [
    {
      "VbrOwnerUid": 1210123456123456,
      "VbrInstanceId": "vbr-m5ex0xf63xk8s5bob****",
      "InstanceId": "vpc-bp1brjuegjc88v3u9****",
      "AliUid": 1250123456123456,
      "RegionNo": "cn-hangzhou",
      "Status": "Created",
      "InstanceName": "VPCname",
      "InstanceRouterId": "vrt-bp1i0yzgjd8ra05ec****",
      "VbrRegionNo": "cn-hangzhou",
      "GmtCreate": "2022-09-02T11:46Z",
      "GrantType": "All"
    }
  ],
  "TotalCount": 10,
  "Count": 1,
  "Page": 1,
  "PageSize": 10
}

错误码

HTTP status code错误码错误信息描述
400InvalidParam.NotNullThe parameter must not be null.参数不能为空。
400Parameter.IllegalThe parameter is illegal.参数非法
400Instance.StatusErrorThe status of instance error. -
404VRouterId.NotFoundThe VRouter not found.此VRouter实例未找到。
404Instance.NotExistThe instance not exist.实例不存在。

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

变更历史

变更时间变更内容概要操作
2024-11-12OpenAPI 错误码发生变更查看变更详情
2024-08-16OpenAPI 错误码发生变更查看变更详情
2023-09-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情