Queries letter of authorization (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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribePhysicalConnectionLOA

The operation that you want to perform.

Set the value to DescribePhysicalConnectionLOA.

InstanceId String Yes pc-bp1ca4wca27ex******

The ID of the Express Connect circuit.

RegionId String Yes cn-hangzhou

The region ID of the Express Connect circuit.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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.

Response parameters

Parameter Type Example Description
PhysicalConnectionLOAType Struct

The LOA information about the Express Connect circuit.

CompanyLocalizedName String company

The name of the construction company.

CompanyName String test1234

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

ConstructionTime String 2019-02-26T08:00:00Z

The time when construction starts.

InstanceId String pc-bp1ca4wca27****

The ID of the Express Connect circuit.

LineCode String aaa111

The circuit code provided by the Internet service provider (ISP).

LineLabel String bbb222

The label of the cable in the data center.

LineType String FIBRE

The type of the Express Connect circuit.

  • MSTP
  • MPLSVPN
  • FIBRE
  • Other
LoaUrl String http://******

The download URL of the LOA file.

PMInfo Array of PMInfo

The information about the construction workers.

PMInfo
PMCertificateNo String 12345671****

The identity document number of the construction worker.

PMCertificateType String Other

The identity document type of the construction worker.

  • IDCard: identity card
  • Passport: passport
  • Other: other identity documents
PMContactInfo String 18910010****

The phone number of the construction worker.

PMGender String Male

The gender of the construction worker.

  • Male: male
  • Female: female
PMName String name

The name of the construction worker.

SI String ctcu

The construction company.

Status String Available

The status of the LOA.

  • 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.
RequestId String 318BB676-0A2B-43A0-9AD8-F1D34E93750F

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePhysicalConnectionLOA
&InstanceId=pc-bp1ca4wca27ex******
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribePhysicalConnectionLOAResponse>
      <RequestId>318BB676-0A2B-43A0-9AD8-F1D34E93750F</RequestId>
      <PhysicalConnectionLOAType>
            <Status>Available</Status>
            <CompanyName>test1234</CompanyName>
            <ConstructionTime>2019-02-26T08:00:00Z</ConstructionTime>
            <InstanceId>pc-bp1ca4wca27****</InstanceId>
            <SI>ctcu</SI>
            <CompanyLocalizedName>company</CompanyLocalizedName>
            <LoaUrl>http://******</LoaUrl>
            <LineCode>aaa111</LineCode>
            <LineType>FIBRE</LineType>
            <LineLabel>bbb222</LineLabel>
            <PMInfo>
                  <PMInfo>
                        <PMCertificateNo>12345671****</PMCertificateNo>
                        <PMCertificateType>Other</PMCertificateType>
                        <PMContactInfo>18910010****</PMContactInfo>
                        <PMGender>Male</PMGender>
                        <PMName>name</PMName>
                  </PMInfo>
            </PMInfo>
      </PhysicalConnectionLOAType>
</DescribePhysicalConnectionLOAResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.