CreateErAttachment

更新时间:
复制 MD 格式

Create a network instance connection.

Operation description

When you call this operation to create a network instance connection, note that:

  • Make sure that you have created a Lingjun HUB instance.

  • Make sure that you have sufficient quota for network instance connections.

  • This operation is an asynchronous operation. After you call this operation, the system returns the ID of the network instance connection. In this case, the network instance connection may not be created yet, and the system is still creating the network instance in the background. You can query the connection status of a network instance by ListErAttachments or GetErAttachment:

    • If the connection status of the network instance is Executing, the network instance is being created.

    • If the connection status of the network instance is Available, the network instance is created.

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

eflo:CreateErAttachment

create

*ErAttachment

acs:eflo:{#regionId}:{#accountId}:Er_Attachment/*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceType

string

Yes

The category of the instance. Valid values:

  • VPD: indicates the Lingjun CIDR block.

  • VCC: indicates a Lingjun connection.

VPD

ErAttachmentName

string

Yes

The name of the network instance connection.

er-attachemnt-vpd-xksd2obl

InstanceId

string

Yes

The ID of the network instance. Valid values: VPD and VCC.

For more information, see What is Lingjun?

You can query Lingjun CIDR Block and Lingjun Connection by ListVpds and ListVccs respectively.

vpd-xksd****

AutoReceiveAllRoute

boolean

Yes

Indicates whether to automatically receive all routes from all instances under the Lingjun HUB. Valid values:

  • true: received automatically.

  • false: Not received.

Valid values:

  • true :
  • false :

true

ResourceTenantId

string

No

The ID of the tenant to which the resource belongs. This parameter is required for cross-account resources.

162093955616****

RegionId

string

Yes

The region ID.

cn-wulanchabu

ErId

string

Yes

Lingjun HUB ID.

er-kkop****

Response elements

Element

Type

Description

Example

object

The response entity.

Code

integer

The response status code.

0

Message

string

The error message. (If the instance is in the Exception state, the exception cause is displayed.)

成功

RequestId

string

The request ID.

DBAD15D6-3F47-5B36-8A92-57C2919D13D0

Content

object

The response data.

ErAttachmentId

string

The ID of the network connection instance.

er-attachment-ggjb****

AccessDeniedDetail

string

The detailed information about the failed permission verification.

None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "DBAD15D6-3F47-5B36-8A92-57C2919D13D0",
  "Content": {
    "ErAttachmentId": "er-attachment-ggjb****"
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.