DescribeNetworkInterfacePermissions - Elastic Compute Service

Queries the list of Elastic Network Interface (ENI) permissions that you have granted to an Alibaba Cloud partner (certified ISV) or an individual user.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeNetworkInterfacePermissions

get

NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region of the network interface controller (NIC) permissions. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
RegionId	string	Yes	The region of the network interface controller (NIC) permissions. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
NetworkInterfaceId	string	No	The ID of the network interface controller (NIC). You must specify `NetworkInterfaceId` or `NetworkInterfacePermissionId.N` to determine the query scope.	eni-bp17pdijfczax****
PageNumber	integer	No	The page number of the NIC permission list. Minimum value: 1 Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 100 Default value: 10.	10
NetworkInterfacePermissionId	array	No	The list of NIC permission IDs. Number of elements in the list: 1 to 100.	eni-perm-bp1cs4lwn56lfb****
	string	No	The ID of the NIC permission.	eni-perm-bp1cs4lwn56lfb****

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page in a paging query.	10
RequestId	string	The request ID.	0FCD3DEF-63D3-4605-A818-805C8BD7DB87
PageNumber	integer	The page number of the list.	1
TotalCount	integer	The total number of entries returned.	1
NetworkInterfacePermissions	object
NetworkInterfacePermission	array<object>	The collection of NIC permissions.
	object
Permission	string	The network interface controller (NIC) permission.	InstanceAttach
NetworkInterfaceId	string	The ID of the network interface controller (NIC).	eni-bp14v2sdd3v8htln****
AccountId	integer	The ID of the Alibaba Cloud partner (certified ISV) account or individual user.	1234567890
NetworkInterfacePermissionId	string	The ID of the network interface controller (NIC) permission.	eni-perm-bp1cs4lwn56lfb****
ServiceName	string	The service name of the Alibaba Cloud service.	Elastic Compute Service
PermissionState	string	The status of the network interface controller (NIC) permission. Valid values: Pending: Authorization in progress. Granted: Authorization granted. Revoking: Authorization being revoked. Revoked: Authorization revoked.	Granted

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "0FCD3DEF-63D3-4605-A818-805C8BD7DB87",
  "PageNumber": 1,
  "TotalCount": 1,
  "NetworkInterfacePermissions": {
    "NetworkInterfacePermission": [
      {
        "Permission": "InstanceAttach",
        "NetworkInterfaceId": "eni-bp14v2sdd3v8htln****",
        "AccountId": 1234567890,
        "NetworkInterfacePermissionId": "eni-perm-bp1cs4lwn56lfb****",
        "ServiceName": "Elastic Compute Service",
        "PermissionState": "Granted"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s	A parameter is not specified.
400	UnsupportedParameter	%s	The parameter is not supported.
400	InvalidParameter	%s	The specified parameter is invalid.
400	InvalidInstanceID.Malformed	%s	The specified InstanceId parameter is invalid.
400	InvalidOperation.InvalidEniState	%s
400	NotBelongUser	%s	You are not authorized to manage the specified resource.
400	InvalidOperation.PermissionExisted	%s	This NetworkInterfacePermission already exists.
403	InvalidUserType.NotSupported	%s	Your account does not support this operation.
403	Abs.InvalidAccount.NotFound	%s	Your Alibaba Cloud account does not exist or your AccessKey pair has expired.
403	Forbidden.NotSupportRAM	%s	RAM users are not authorized to perform this operation.
403	Forbidden.SubUser	%s	You are not authorized to manage this resource. Contact the owner of the Alibaba Cloud account for authorization.
404	InvalidOperation.PermissionNotExisted	%s	The operation is invalid. First apply for permissions to perform the operation.
404	InvalidEniId.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.