All Products
Search

This Product

    Express Connect:CreatePhysicalConnectionSetupOrder

    Document Center

    Express Connect:CreatePhysicalConnectionSetupOrder

    Last Updated:Aug 30, 2024

    Creates an order for initial installation of an Express Connect circuit.

    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:CreatePhysicalConnectionSetupOrdercreate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the Express Connect circuit.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-beijing
    AccessPointIdstringYes

    The ID of the access point.

    		ap-cn-beijing-ft-A
    LineOperatorstringYes

    The connectivity provider of the Express Connect circuit. Valid values:

    • CT: China Telecom
    • CU: China Unicom
    • CM: China Mobile
    • CO: other connectivity providers in the Chinese mainland
    • Equinix: Equinix
    • Other: other connectivity providers outside the Chinese mainland
    		CT
    PortTypestringNo

    The port type of the Express Connect circuit. Valid values:

    • 100Base-T: 100 Mbit/s copper Ethernet port
    • 1000Base-T (default): 1,000 Mbit/s copper Ethernet port
    • 1000Base-LX: 1,000 Mbit/s single-mode optical port (10 km)
    • 10GBase-T: 10,000 Mbit/s copper Ethernet port
    • 10GBase-LR: 10,000 Mbit/s single-mode optical port (10 km)
    • 40GBase-LR: 40,000 Mbit/s single-mode optical port
    • 100GBase-LR: 100,000 Mbit/s single-mode optical port
    Note Whether 40GBase-LR and 100GBase-LR ports can be created depends on resource supplies. For more information, contact your account manager.
    		100Base-T
    RedundantPhysicalConnectionIdstringNo

    The ID of the redundant physical connection. The redundant physical connection must be in the Allocated, Confirmed, or Enabled state.

    		pc-bp10zsv5ntp****
    AutoPaybooleanNo

    Specifies whether to enable automatic payments. Valid values:

    • false (default): disables automatic payment.
    • true
    		false
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		318BB676-0A2B-43A0-9AD8-F1D34E93750F

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		F7A6301A-64BA-41EC-8284-8F4838C15D1F
    OrderIdstring

    The order ID.

    		202844382740728
    PhysicalConnectionIdstring

    The ID of the Express Connect circuit.

    		pc-2zegmc02v7ss4****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "F7A6301A-64BA-41EC-8284-8F4838C15D1F",
  "OrderId": "202844382740728",
  "PhysicalConnectionId": "pc-2zegmc02v7ss4****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidPrice.NotFoundPricing plan result not found.The Price parameter is set to an invalid value.
    400QuotaExceeded.PerAccessPointPhysical connection count per ap quota exceed.-
    400InvalidPhysicalConnectionOperator.MalformedSpecified PhysicalConnection Operator is not valid.The operation on the Express Connect circuit is invalid.
    400InvalidPhysicalConnectionPortType.MalformedSpecified PhysicalConnection PortType is not valid.The port type of the Express Connect circuit is invalid.
    400InvalidPortType.NotFound%s-
    400InvalidInstance.NotFound%s-
    400IncorrectStatus.AccessPoint%s-

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

    Change history

    Change timeSummary of changesOperation
    2024-06-26API Description Update. The Error code has changedView Change Details