Queries letter of authorization (LOA) information about a physical connection.

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 physical connection.
RegionId String Yes cn-hangzhou

The ID of the region where the physical connection is deployed.
ClientToken String No 318BB676-0A2B-43A0-9AD8-F1D34E93750F

The client token that is used for authentication.

Response parameters

Parameter Type Example Description
PhysicalConnectionLOAType Struct

The LOA information about the physical connection.
CompanyLocalizedName String company

The name of the construction company.
CompanyName String test1234

The name of the organization that requires the physical connection.
ConstructionTime String 2019-02-26T08:00:00Z

The time when construction starts.
InstanceId String pc-bp1ca4wca27******

The ID of the physical connection.
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 MSTP

The type of the physical connection.

Valid values:

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

The download URL of the LOA file.
PMInfo Array

The information about the construction personnel.
PMInfo
PMCertificateNo String 12345671****

The identity number of the construction personnel.
PMCertificateType String Other

The type of the identity document. Valid values:

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

The phone number of the construction personnel.
PMGender String Male

The gender of the construction personnel.
PMName String name

The name of the construction personnel.
SI String ctcu

The construction company.
Status String Available

The state of the physical connection.
RequestId String 318BB676-0A2B-43A0-9AD8-F1D34E93750F

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribePhysicalConnectionLOAResponse>
	  <code>200</code>
	  <data>
		    <companyName>test1234</companyName>
		    <constructionTime>2019-02-26T08:00:00Z</constructionTime>
		    <instanceId>pc-bp1ca4wca27ert****</instanceId>
		    <lineType>MSTP</lineType>
		    <loaUrl>http://********</loaUrl>
		    <pmInfo>
			      <nextPMIndex>1</nextPMIndex>
			      <pmCertificateNo>12345**</pmCertificateNo>
			      <pmCertificateType>Other</pmCertificateType>
			      <pmContactInfo>189100100**0</pmContactInfo>
			      <pmGender>Male</pmGender>
			      <pmName>test</pmName>
		    </pmInfo>
		    <si>ctcu</si>
		    <status>Available</status>
	  </data>
	  <message>successful</message>
	  <requestId>318BB676-0A2B-43A0-9AD8-F1D34E93750F</requestId>
	  <success>true</success>
    </DescribePhysicalConnectionLOAResponse>

JSON format 

{
    "code": "200",
    "data": {
        "companyName": "test1234",
        "constructionTime": "2019-02-26T08:00:00Z",
        "instanceId": "pc-bp1ca4wca27erts****",
        "lineType": "MSTP",
        "loaUrl":"http://*******",
        "pmInfo": [
            {
                "nextPMIndex": 1,
                "pmCertificateNo": "1234567",
                "pmCertificateType": "Other",
                "pmContactInfo": "18910010***",
                "pmGender": "Male",
                "pmName": "test"
            }
        ],
        "si": "ctcu",
        "status": "Available"
    },
    "message": "successful",
    "requestId": "318BB676-0A2B-43A0-9AD8-F1D34E93750F",
    "success": true
}

Error codes

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