Queries the 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 Item Required Example Description
RegionId String Yes cn-hangzhou

The region ID of the Express Connect circuit.

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

Action String Yes DescribePhysicalConnectionLOA

The operation that you want to perform.

Set the value to DescribePhysicalConnectionLOA.

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.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
InstanceId String Yes pc-bp1ca4wca27ex****

The ID of the Express Connect circuit.

Response parameters

Parameter Item Example Description
RequestId String 318BB676-0A2B-43A0-9AD8-F1D34E93750F

The ID of the request.

PhysicalConnectionLOAType Object

The LOA information about the Express Connect circuit.

Status String Available

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.
LineLabel String bbb222

The label of the cable in the data center.

LineCode String aaa111

The circuit code provided by the connectivity provider.

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

The time when construction starts.

SI String ctcu

The on-site construction company.

LoaUrl String http://******

The download URL of the LOA file.

CompanyLocalizedName String company

The name of the construction company.

InstanceId String pc-bp1ca4wca27****

The ID of the Express Connect circuit.

LineType String FIBRE

The type of the Express Connect circuit. Valid values:

  • MSTP
  • MPLSVPN
  • FIBRE
  • Other
CompanyName String test1234

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

PMInfo Array of PMInfo

The information about the construction workers.

PMInfo
PMGender String Male

The gender of the construction worker. Valid values:

  • Male: male
  • Female: female
PMCertificateNo String 12345671****

The identity document number of the construction worker.

PMName String name

The name of the construction worker.

PMCertificateType String Other

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

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

The phone number of the construction worker.

Examples

Sample requests

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

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
    "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": [
            {
                "PMGender": "Male",
                "PMCertificateNo": "12345671****",
                "PMName": "name",
                "PMCertificateType": "Other",
                "PMContactInfo": "18910010****"
            }
        ]
    },
}

Error codes

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