DescribePhysicalConnectionLOA API Reference - Express Connect - Alibaba Cloud - Express Connect

Use DescribePhysicalConnectionLOA to query the LOA for a physical connection.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the physical connection is located. You can call the DescribeRegions operation to get a list of available region IDs.	cn-hangzhou
ClientToken	string	No	A client token that ensures the idempotence of the request. Your client generates this value, which must be unique for each request and have a maximum length of 64 ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. Each API request has a unique RequestId.	123e4567-e89b-12d3-a456-426655440000
InstanceId	string	Yes	The ID of the physical connection instance.	pc-bp1ca4wca27ex****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	318BB676-0A2B-43A0-9AD8-F1D34E93750F
PhysicalConnectionLOAType	object	Information about the physical connection's LOA.
Status	string	The status of the LOA. Valid values: Applying: The LOA application is in progress. Accept: The LOA application is approved. Available: The LOA is available. Rejected: The LOA application is rejected. Completing: The construction of the physical connection is in progress. Complete: The construction of the physical connection is complete. Deleted: The LOA is deleted.	Available
LineLabel	string	The line label for the in-building cable at the data center.	bbb222
LineCode	string	The line code assigned by the line service provider.	aaa111
ConstructionTime	string	The time when construction personnel enter the site.	2019-02-26T08:00:00Z
SI	string	The system integrator (SI).	ctcu
LoaUrl	string	The URL to download the LOA file.	http://******
CompanyLocalizedName	string	The localized name of the company.	company
InstanceId	string	The instance ID of the physical connection.	pc-bp1ca4wca27****
LineType	string	The line type of the physical connection. Valid values: MSTP MPLSVPN FIBRE Other	FIBRE
CompanyName	string	The name of the company that requires the physical connection.	test1234
PMInfo	object	Information about the construction personnel.
PMInfo	array<object>	A list of construction crew members.
	object	The information about a construction crew member.
PMGender	string	The gender of the construction crew member. Valid values: Male: Male. Female: Female.	Male
PMCertificateNo	string	The certificate number of the construction crew member.	12345671****
PMName	string	The name of the construction crew member.	name
PMCertificateType	string	The certificate type of the construction crew member. Valid values: IDCard: ID card. Passport: passport. Other: Other.	Other
PMContactInfo	string	The contact information of the construction crew member.	18910010****
LineServiceProvider	string	The line service provider. Valid values: China Telecom China Unicom China Mobile Other	中国其他
LineSPContactInfo	string	The contact information of the line O&M personnel.	1388888****
Description	string	The description of the LOA.

Examples

Success response

JSON format

{
  "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": "中国其他",
    "LineSPContactInfo": "1388888****",
    "Description": ""
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.