All Products
Search
Document Center

Virtual Private Cloud:DescribePhysicalConnectionLOA

Last Updated:Mar 04, 2024

Queries the LOA information about 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:DescribePhysicalConnectionLOARead
  • 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-hangzhou
ClientTokenstringNo

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

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
123e4567-e89b-12d3-a456-426655440000
InstanceIdstringYes

The ID of the Express Connect circuit.

pc-bp1ca4wca27ex****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

318BB676-0A2B-43A0-9AD8-F1D34E93750F
PhysicalConnectionLOATypeobject

The LOA information about the Express Connect circuit.

Statusstring

The status of the LOA. Valid values:

  • Applying: The LOA is pending for approval.
  • Accept: The LOA is approved.
  • Available: The LOA is available.
  • Rejected: The LOA is rejected.
  • Completing: The Express Connect circuit is under construction.
  • Complete: The Express Connect circuit is installed.
  • Deleted: The LOA is deleted.
Available
LineLabelstring

The label of the cable in the data center.

bbb222
LineCodestring

The circuit code provided by the connectivity provider.

aaa111
ConstructionTimestring

The time when construction starts.

2019-02-26T08:00:00Z
SIstring

The on-site construction company.

ctcu
LoaUrlstring

The download URL of the LOA file.

http://******
CompanyLocalizedNamestring

The name of the construction company.

company
InstanceIdstring

The ID of the Express Connect circuit.

pc-bp1ca4wca27****
LineTypestring

The type of the Express Connect circuit. Valid values:

  • MSTP
  • MPLSVPN
  • FIBRE
  • Other
FIBRE
CompanyNamestring

The name of the organization that requires the Express Connect circuit.

test1234
PMInfoobject []

The information about the construction workers.

PMGenderstring

The gender of the construction worker. Valid values:

  • Male
  • Female
Male
PMCertificateNostring

The identity document number of the construction worker.

12345671****
PMNamestring

The name of the construction worker.

name
PMCertificateTypestring

The identity document type of the construction worker. Valid values:

  • IDCard
  • Passport
  • Other
Other
PMContactInfostring

The phone number of the construction worker.

18910010****
LineServiceProviderstring

The ISP. Valid values:

  • China Telecom
  • China Unicom
  • China Mobile
  • Other ISPs in China
Other ISPs in China
LineSPContactInfostring

The contact information about line O&M.

1388888****

Examples

Sample success responses

JSONformat

{
  "RequestId": "318BB676-0A2B-43A0-9AD8-F1D34E93750F",
  "PhysicalConnectionLOAType": {
    "Status": "Available",
    "LineLabel": "bbb222",
    "LineCode": "aaa111",
    "ConstructionTime": "2019-02-26T08:00:00Z",
    "SI": "ctcu",
    "LoaUrl": "http://******",
    "CompanyLocalizedName": "company",
    "InstanceId": "pc-bp1ca4wca27****",
    "LineType": "FIBRE",
    "CompanyName": "test1234",
    "PMInfo": {
      "PMInfo": [
        {
          "PMGender": "Male",
          "PMCertificateNo": "12345671****",
          "PMName": "name",
          "PMCertificateType": "Other",
          "PMContactInfo": "18910010****"
        }
      ]
    },
    "LineServiceProvider": "Other ISPs in China\n",
    "LineSPContactInfo": "1388888****"
  }
}

Error codes

HTTP status codeError codeError message
400MissingParam.AliUid%s
400MissingParam.InstanceId%s
400MissingParam.RegionNo%s
400InvalidInstanceId.NotFound%s

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

Change history

Change timeSummary of changesOperation
2023-09-11API 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
2023-09-07API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2022-09-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2022-09-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400