All Products
Search

This Product

    Virtual Private Cloud:DescribeEcGrantRelation

    Document Center

    Virtual Private Cloud:DescribeEcGrantRelation

    Last Updated:Mar 22, 2024

    Queries whether permissions on a virtual private cloud (VPC) are granted to a virtual border router (VBR).

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:DescribeEcGrantRelationList
    • VirtualBorderRouter
      acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceTypestringYes

    The type of instance. Valid values:

    • VBR: queries the permissions that are granted to a VBR.
    • VPC: queries the permissions that are granted from a VPC.
    		VBR
    InstanceIdstringYes

    The ID of the instance.

    • If you set InstanceType to VBR, specify a VBR ID.
    • If you set InstanceType to VPC, specify a VPC ID.
    		vbr-bp12mw1f8k3jgygk9****
    PageNumberlongNo

    The page number. Default value: 1.

    		1
    PageSizelongNo

    The number of entries per page. Maximum value: 50. Default value: 10.

    		10
    VbrRegionNostringNo

    The ID of the region where the instance is deployed.

    • If InstanceType is set to VBR, this parameter is required.
    • If InstanceType is set to VPC, you can ignore this parameter.
    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    The request ID.

    RequestIdstring

    The request ID.

    		E6E90F6B-2B41-5AAF-ABEB-236ADBAAD91D
    EcGrantRelationsobject []

    The query results.

    VbrOwnerUidlong

    The ID of the Alibaba Cloud account to which the VBR belongs.

    		1210123456123456
    VbrInstanceIdstring

    The ID of the VBR.

    		vbr-m5ex0xf63xk8s5bob****
    InstanceIdstring

    The ID of the VPC.

    		vpc-bp1brjuegjc88v3u9****
    AliUidlong

    The ID of the Alibaba Cloud account to which the VPC belongs.

    		1250123456123456
    RegionNostring

    The ID of the region where the VPC is deployed.

    		cn-hangzhou
    Statusstring

    The query result. Valid values:

    • Created: The VBR has permissions on the VPC.
    • Deleted: The VBR does not have permissions on the VPC.
    		Created
    InstanceNamestring

    The name of the VPC.

    		VPCname
    InstanceRouterIdstring

    The ID of the vRouter.

    		vrt-bp1i0yzgjd8ra05ec****
    VbrRegionNostring

    The ID of the region where the VBR is deployed.

    		cn-hangzhou
    GmtCreatestring

    The time when permissions on the VPC were granted to the VBR.

    		2022-09-02T11:46Z
    GrantTypestring

    The VBRs that have permissions on the VPC. Valid values:

    • All: VBRs that reside in the specified region and belong to the specified Alibaba Cloud account all have permissions on the VPC.
    • Specify: Only the specified VBR has permissions on the VPC.
    		All
    TotalCountinteger

    The total number of entries returned.

    		10
    Countinteger

    The total number of entries returned.

    		1
    Pageinteger

    The page number.

    		1
    PageSizeinteger

    The number of entries per page.

    		10

    Examples

    Sample success responses

    JSONformat

    {
  "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
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParam.NotNullThe parameter must not be null.A required parameter is not specified.
    400Parameter.IllegalThe parameter is illegal.The parameter is invalid.
    400Instance.StatusErrorThe status of instance error. -
    404VRouterId.NotFoundThe VRouter not found.The specified vRouter cannot be found.
    404Instance.NotExistThe instance not exist.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-25API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404