Disable an Express Connect Circuit with TerminatePhysicalConnection API - Express Connect - Alibaba Cloud - Express Connect

Operation description

After you call the TerminatePhysicalConnection operation, the Express Connect circuit enters the Terminating state. After the processing is complete, the circuit enters the Terminated state. When you call this operation to terminate an Express Connect circuit, take note of the following items:

You can terminate only an Express Connect circuit that is in the Enabled state.
Before you terminate an Express Connect circuit, you must delete the virtual border routers (VBRs) associated with the circuit.

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

vpc:TerminatePhysicalConnection

update

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Express Connect circuit. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
PhysicalConnectionId	string	Yes	The instance ID of the Express Connect circuit instance.	pc-119mfjzm****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	02fb3da4-130e-11e9-8e44-0016e04115b

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Success response

JSON format

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.NotAllowedInState	The request does not allow in this state.
400	Forbidden.VbrAttached	Cannot terminate physical connection when virtual border routers are still attached.
400	OperationFailed.VpconnAttached	Cannot terminate physical connection when vpconn are still attached.	The shared port still exists and the physical port cannot be disabled.
400	OperationDenied.MacsecAttached	The operation is not allowed because of MacsecAttached.	The current operation is rejected because there is still a MACSec key binding on the physical connection.
400	OperationFailed.ResourceLockedBySystem	The specified resource is locked by system.	The operating resource is locked by the system and cannot be operated temporarily.
400	IncorrectBusinessStatus.PhysicalConnection	Invalid physical connection business status.	The current business status of the physical connection does not support operations.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidPhysicalConnectionId.NotFound	The PhysicalConnectionId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.