diff --git a/docs/plas/api-ref/ALL_META.TXT.json b/docs/plas/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..e9d09069 --- /dev/null +++ b/docs/plas/api-ref/ALL_META.TXT.json @@ -0,0 +1,122 @@ +[ + { + "uri":"en-us_topic_0218811267.html", + "product_code":"plas", + "code":"1", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811261.html", + "product_code":"plas", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Common Message Headers", + "title":"Common Message Headers", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811262.html", + "product_code":"plas", + "code":"3", + "des":"For details about other parameters in the message header, see the HTTP protocol documentation.", + "doc_type":"api", + "kw":"Common Request Headers,Common Message Headers,API Reference", + "title":"Common Request Headers", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811263.html", + "product_code":"plas", + "code":"4", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Common Response Headers,Common Message Headers,API Reference", + "title":"Common Response Headers", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811264.html", + "product_code":"plas", + "code":"5", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"PLAS APIs", + "title":"PLAS APIs", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811265.html", + "product_code":"plas", + "code":"6", + "des":"This API is used to create a PLAS connector. Based on the URL returned, you can query the creation progress.URI formatPOST /v1.0/plasconnector/connectorsPOST /v1.0/plasco", + "doc_type":"api", + "kw":"Creating a PLAS Connector,PLAS APIs,API Reference", + "title":"Creating a PLAS Connector", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811266.html", + "product_code":"plas", + "code":"7", + "des":"This API is used to query PLAS connectors.URI formatGET /v1.0/plasconnector/connectorsGET /v1.0/plasconnector/connectorsExample/v1.0/plasconnector/connectors?name=plascon", + "doc_type":"api", + "kw":"Querying PLAS Connectors,PLAS APIs,API Reference", + "title":"Querying PLAS Connectors", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811268.html", + "product_code":"plas", + "code":"8", + "des":"This API is used to query details about a PLAS connector based on the connector ID.URI formatGET /v1.0/plasconnector/connectors/{connector_id}GET /v1.0/plasconnector/conn", + "doc_type":"api", + "kw":"Querying Details About a PLAS Connector,PLAS APIs,API Reference", + "title":"Querying Details About a PLAS Connector", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811269.html", + "product_code":"plas", + "code":"9", + "des":"This API is used to modify a PLAS connector based on the connector ID. Based on the URL returned, you can query the modification progress.URI formatPUT /v1.0/plasconnecto", + "doc_type":"api", + "kw":"Modifying a PLAS Connector,PLAS APIs,API Reference", + "title":"Modifying a PLAS Connector", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811270.html", + "product_code":"plas", + "code":"10", + "des":"This API is used to delete a PLAS connector based on the connector ID. The deletion is asynchronous. Based on the URL returned, you can query the deletion progress.URI fo", + "doc_type":"api", + "kw":"Deleting a PLAS Connector,PLAS APIs,API Reference", + "title":"Deleting a PLAS Connector", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811271.html", + "product_code":"plas", + "code":"11", + "des":"This API is used to query asynchronous operation results.URI formatGET /v1.0/plasconnector/connectors/{connector_id}/operations/{operation_id}GET /v1.0/plasconnector/conn", + "doc_type":"api", + "kw":"Querying Asynchronous Operation Results,PLAS APIs,API Reference", + "title":"Querying Asynchronous Operation Results", + "githuburl":"" + }, + { + "uri":"en-us_topic_0218811272.html", + "product_code":"plas", + "code":"12", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/plas/api-ref/CLASS.TXT.json b/docs/plas/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..67d1e0b6 --- /dev/null +++ b/docs/plas/api-ref/CLASS.TXT.json @@ -0,0 +1,110 @@ +[ + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"plas", + "title":"API Usage Guidelines", + "uri":"en-us_topic_0218811267.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"plas", + "title":"Common Message Headers", + "uri":"en-us_topic_0218811261.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"For details about other parameters in the message header, see the HTTP protocol documentation.", + "product_code":"plas", + "title":"Common Request Headers", + "uri":"en-us_topic_0218811262.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"plas", + "title":"Common Response Headers", + "uri":"en-us_topic_0218811263.html", + "doc_type":"api", + "p_code":"2", + "code":"4" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"plas", + "title":"PLAS APIs", + "uri":"en-us_topic_0218811264.html", + "doc_type":"api", + "p_code":"", + "code":"5" + }, + { + "desc":"This API is used to create a PLAS connector. Based on the URL returned, you can query the creation progress.URI formatPOST /v1.0/plasconnector/connectorsPOST /v1.0/plasco", + "product_code":"plas", + "title":"Creating a PLAS Connector", + "uri":"en-us_topic_0218811265.html", + "doc_type":"api", + "p_code":"5", + "code":"6" + }, + { + "desc":"This API is used to query PLAS connectors.URI formatGET /v1.0/plasconnector/connectorsGET /v1.0/plasconnector/connectorsExample/v1.0/plasconnector/connectors?name=plascon", + "product_code":"plas", + "title":"Querying PLAS Connectors", + "uri":"en-us_topic_0218811266.html", + "doc_type":"api", + "p_code":"5", + "code":"7" + }, + { + "desc":"This API is used to query details about a PLAS connector based on the connector ID.URI formatGET /v1.0/plasconnector/connectors/{connector_id}GET /v1.0/plasconnector/conn", + "product_code":"plas", + "title":"Querying Details About a PLAS Connector", + "uri":"en-us_topic_0218811268.html", + "doc_type":"api", + "p_code":"5", + "code":"8" + }, + { + "desc":"This API is used to modify a PLAS connector based on the connector ID. Based on the URL returned, you can query the modification progress.URI formatPUT /v1.0/plasconnecto", + "product_code":"plas", + "title":"Modifying a PLAS Connector", + "uri":"en-us_topic_0218811269.html", + "doc_type":"api", + "p_code":"5", + "code":"9" + }, + { + "desc":"This API is used to delete a PLAS connector based on the connector ID. The deletion is asynchronous. Based on the URL returned, you can query the deletion progress.URI fo", + "product_code":"plas", + "title":"Deleting a PLAS Connector", + "uri":"en-us_topic_0218811270.html", + "doc_type":"api", + "p_code":"5", + "code":"10" + }, + { + "desc":"This API is used to query asynchronous operation results.URI formatGET /v1.0/plasconnector/connectors/{connector_id}/operations/{operation_id}GET /v1.0/plasconnector/conn", + "product_code":"plas", + "title":"Querying Asynchronous Operation Results", + "uri":"en-us_topic_0218811271.html", + "doc_type":"api", + "p_code":"5", + "code":"11" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"plas", + "title":"Change History", + "uri":"en-us_topic_0218811272.html", + "doc_type":"api", + "p_code":"", + "code":"12" + } +] \ No newline at end of file diff --git a/docs/plas/api-ref/PARAMETERS.txt b/docs/plas/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/plas/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/plas/api-ref/en-us_topic_0218811261.html b/docs/plas/api-ref/en-us_topic_0218811261.html new file mode 100644 index 00000000..df7ac59d --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811261.html @@ -0,0 +1,14 @@ + + +

Common Message Headers

+

This chapter describes common request and response REST message headers.

+
+
+ +
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811262.html b/docs/plas/api-ref/en-us_topic_0218811262.html new file mode 100644 index 00000000..26207b5b --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811262.html @@ -0,0 +1,98 @@ + + +

Common Request Headers

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Common request headers

Parameter

+

Description

+

Mandatory

+

Example Value

+

x-sdk-date

+

Time when the request is sent. The time is in YYYYMMDD'T'HHMMSS'Z' format.

+

The value is the current GMT time of the system.

+

No

+

This parameter is mandatory for AK/SK authentication.

+

20150907T101459Z

+

Authorization

+

Authentication information.

+

The value can be obtained from the request signing result.

+

For details, see Signing a Request.

+

No

+

This parameter is mandatory for AK/SK authentication.

+

SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994

+

Host

+

Server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is hostname[:port]. If the port number is not specified, the default port is used. The default port number for https is 443.

+

No

+

This parameter is mandatory for AK/SK authentication.

+

code.test.com

+

or

+

code.test.com:443

+

Content-type

+

Request body MIME type.

+

Yes

+

application/json

+

Content-Length

+

Length of the request body, expressed in bytes.

+

This parameter is mandatory for POST and PUT requests but must be left blank for GET requests.

+

3495

+

X-Project-Id

+

Project ID. This parameter is used to obtain the token for the project.

+

No

+

e9993fc787d94b6c886cbaa340f9c0f4

+

X-Auth-Token

+

User token.

+

Yes

+

This parameter is mandatory for token authentication.

+

None

+
+
+

For details about other parameters in the message header, see the HTTP protocol documentation.

+
+
+
+
+
Parent topic: Common Message Headers
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811263.html b/docs/plas/api-ref/en-us_topic_0218811263.html new file mode 100644 index 00000000..04e89720 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811263.html @@ -0,0 +1,35 @@ + + +

Common Response Headers

+
+
+ + + + + + + + + + + + + +
Table 1 Common response headers

Name

+

Description

+

Content-Length

+

Specifies the length of the response body. The unit is byte.

+

Date

+

Specifies the time when a request response is returned.

+

Content-type

+

Specifies the response body MIME type.

+
+
+
+
+
+
Parent topic: Common Message Headers
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811264.html b/docs/plas/api-ref/en-us_topic_0218811264.html new file mode 100644 index 00000000..5b53937e --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811264.html @@ -0,0 +1,21 @@ + + +

PLAS APIs

+
+
+ +
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811265.html b/docs/plas/api-ref/en-us_topic_0218811265.html new file mode 100644 index 00000000..4c1b1bbe --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811265.html @@ -0,0 +1,375 @@ + + +

Creating a PLAS Connector

+

Function

This API is used to create a PLAS connector. Based on the URL returned, you can query the creation progress.

+
+

URI

+
+

Request

+

The PlasConnectorCreateReq object has the following attributes.

+ +
+ + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

connector

+

Yes

+

PlasConnectorBaseModel object

+

Indicates the request for creating a PLAS connector.

+
+
+

The PlasConnectorBaseModel object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Indicates the PLAS Connector name. The name can consist of letters, digits, underscores (_), and hyphens (-).

+

The value is a string of 1 to 64 characters.

+

description

+

No

+

String

+

Indicates the PLAS Connector description.

+

The value is a string of 0 to 255 characters.

+

bandwidth

+

Yes

+

int32

+

Indicates the bandwidth in Mbit/s.

+

Value range:

+
  • 10
  • 50
  • 100
  • 150
  • 200
  • 300
  • 400
  • 500
  • 600
  • 1000
+

cloudInfo

+

Yes

+

CloudInfo object

+

Indicates the cloud interconnected with the PLAS connector.

+

networkInfo

+

Yes

+

NetworkInfo object

+

Indicates the network interconnected with the PLAS connector.

+
+
+

The CloudInfo object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

provider

+

Yes

+

String

+

Indicates the cloud provider.

+

Only OTC is currently supported.

+

The value is a string of 1 to 64 characters.

+

masterLocation

+

Yes

+

String

+

Indicates the primary area that the PCCE in the PLAS Connector connects to. This area corresponds to the area of the PLGW in the cloud.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

masterDirectConnectId

+

Yes

+

String

+

Indicates the ID of the Direct Connect link connected to the primary area.

+

The value is a string of 1 to 36 characters.

+

slaveLocation

+

Yes

+

String

+

Indicates the secondary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

slaveDirectConnectId

+

Yes

+

String

+

Indicates the ID of the Direct Connect link connected to the secondary area.

+

The value is a string of 1 to 36 characters.

+
+
+

The NetworkInfo object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

provider

+

Yes

+

String

+

Indicates the network provider.

+

Only Telekom is currently supported.

+

The value is a string of 1 to 64 characters.

+

networkDomain

+

Yes

+

String

+

Indicates the network domain.

+

Only IPLS is currently supported.

+

The value is a string of 1 to 128 characters.

+

masterLocation

+

Yes

+

String

+

Indicates the primary area that the PCCE in the PLAS Connector connects to. This area corresponds to the area of the PLGW in the cloud.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

slaveLocation

+

Yes

+

String

+

Indicates the secondary area that the PCCE in the PLAS Connector connects to. This area corresponds to the area of the PLGW in the cloud.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

lineId

+

No

+

String

+

Indicates the line ID, which is assigned by the CCR.

+

The value is a string of 1 to 36 characters.

+

popLocation

+

Yes

+

String

+

Indicates the PoP that the PCNE in the PLAS Connector connects to. This PoP corresponds to the area of the PCNE in the network.

+

At present, the value can only be Berlin or Frankfurt.

+

Value range: 1-128 charactersAt present, the value can only be Berlin or Frankfurt.

+

Value range: 1-128 characters

+
+
+ +
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: PLAS APIs
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811266.html b/docs/plas/api-ref/en-us_topic_0218811266.html new file mode 100644 index 00000000..4b1c4375 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811266.html @@ -0,0 +1,442 @@ + + +

Querying PLAS Connectors

+

Function

This API is used to query PLAS connectors.

+
+

URI

+
+

Request

+
+

Response

+

The PlasConnectorDetailModel object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Indicates the PLAS connector ID.

+

The value is a string of 1 to 36 characters.

+

tenantId

+

Yes

+

String

+

Indicates the tenant ID.

+

The value is a string of 1 to 36 characters.

+

name

+

Yes

+

String

+

Indicates the PLAS connector name. The name can consist of letters, digits, underscores (_), and hyphens (-).

+

The value is a string of 1 to 128 characters.

+

description

+

No

+

String

+

Indicates the PLAS connector description.

+

The value is a string of 0 to 255 characters.

+

bandwidth

+

Yes

+

int32

+

Indicates the bandwidth in Mbit/s.

+

Value range:

+
  • 10
  • 50
  • 100
  • 150
  • 200
  • 300
  • 400
  • 500
  • 600
  • 1000
+

cloudInfo

+

Yes

+

CloudInfo object

+

Indicates the cloud interconnected with the PLAS connector.

+

networkInfo

+

Yes

+

NetworkInfo object

+

Indicates the network interconnected with the PLAS connector.

+

status

+

No

+

String

+

Indicates the PLAS Connector status.

+

Value range:

+
  • Pending
  • Available
  • Failed
  • Deleting
+

createTime

+

No

+

String

+

Indicates the creation time. The time must be a UNIX timestamp accurate to milliseconds.

+

The value is a string of 1 to 36 characters.

+
+
+

The CloudInfo object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

provider

+

Yes

+

String

+

Indicates the cloud provider.

+

Only OTC is currently supported.

+

The value is a string of 1 to 64 characters.

+

masterLocation

+

Yes

+

String

+

Indicates the primary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

masterDirectConnectId

+

Yes

+

String

+

Indicates the ID of the Direct Connect link connected to the primary area.

+

The value is a string of 1 to 36 characters.

+

slaveLocation

+

Yes

+

String

+

Indicates the secondary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

slaveDirectConnectId

+

Yes

+

String

+

Indicates the ID of the Direct Connect link connected to the secondary area.

+

The value is a string of 1 to 36 characters.

+
+
+

The NetworkInfo object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

provider

+

Yes

+

String

+

Indicates the network provider.

+

Only Telekom is currently supported.

+

The value is a string of 1 to 64 characters.

+

networkDomain

+

Yes

+

String

+

Indicates the network domain.

+

Only IPLS is currently supported.

+

The value is a string of 1 to 128 characters.

+

masterLocation

+

Yes

+

String

+

Indicates the primary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

slaveLocation

+

Yes

+

String

+

Indicates the secondary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

lineId

+

No

+

String

+

Indicates the line ID, which is assigned by the CCR.

+

The value is a string of 1 to 36 characters.

+
+
+ +
+

Returned Value

+
+
+
+
+
Parent topic: PLAS APIs
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811267.html b/docs/plas/api-ref/en-us_topic_0218811267.html new file mode 100644 index 00000000..ca4ebce9 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811267.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811268.html b/docs/plas/api-ref/en-us_topic_0218811268.html new file mode 100644 index 00000000..6061905b --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811268.html @@ -0,0 +1,380 @@ + + +

Querying Details About a PLAS Connector

+

Function

This API is used to query details about a PLAS connector based on the connector ID.

+
+

URI

+
+

Request

+
+

Response

+

The PlasConnectorDetailModel object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

Yes

+

String

+

Indicates the PLAS connector ID.

+

The value is a string of 1 to 36 characters.

+

tenantId

+

Yes

+

String

+

Indicates the tenant ID.

+

The value is a string of 1 to 36 characters.

+

name

+

Yes

+

String

+

Indicates the name of the PLAS Connector. The name can consist of letters, digits, underscores (_), and hyphens (-).

+

The value is a string of 1 to 128 characters.

+

description

+

No

+

String

+

Indicates the PLAS connector description.

+

The value is a string of 0 to 255 characters.

+

bandwidth

+

Yes

+

int32

+

Indicates the bandwidth in Mbit/s.

+

Value range:

+
  • 10
  • 50
  • 100
  • 150
  • 200
  • 300
  • 400
  • 500
  • 600
  • 1000
+

cloudInfo

+

Yes

+

CloudInfo object

+

Indicates the cloud interconnected with the PLAS connector.

+

networkInfo

+

Yes

+

NetworkInfo object

+

Indicates the network interconnected with the PLAS connector.

+

status

+

No

+

String

+

Indicates the PLAS connector status.

+

Value range:

+
  • Pending
  • Available
  • Failed
  • Deleting
+

createTime

+

No

+

String

+

Indicates the creation time. The time must be a UNIX timestamp accurate to milliseconds.

+

The value is a string of 1 to 36 characters.

+
+
+

The CloudInfo object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

provider

+

Yes

+

String

+

Indicates the cloud provider.

+

Only OTC is currently supported.

+

The value is a string of 1 to 64 characters.

+

masterLocation

+

Yes

+

String

+

Indicates the primary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

masterDirectConnectId

+

Yes

+

String

+

Indicates the ID of the Direct Connect link connected to the primary area.

+

The value is a string of 1 to 36 characters.

+

slaveLocation

+

Yes

+

String

+

Indicates the secondary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

slaveDirectConnectId

+

Yes

+

String

+

Indicates the ID of the Direct Connect link connected to the secondary area.

+

The value is a string of 1 to 36 characters.

+
+
+

The NetworkInfo object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

provider

+

Yes

+

String

+

Indicates the network provider.

+

Only Telekom is currently supported.

+

The value is a string of 1 to 64 characters.

+

networkDomain

+

Yes

+

String

+

Indicates the network domain.

+

Only IPLS is currently supported.

+

The value is a string of 1 to 128 characters.

+

masterLocation

+

Yes

+

String

+

Indicates the primary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

slaveLocation

+

Yes

+

String

+

Indicates the secondary area that the PCCE connects to.

+

Only Biere and Magdeburg are currently supported.

+

The value is a string of 1 to 128 characters.

+

lineId

+

No

+

String

+

Indicates the line ID, which is assigned by the CCR.

+

The value is a string of 1 to 36 characters.

+
+
+ +
+

Returned Value

+
+
+
+
+
Parent topic: PLAS APIs
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811269.html b/docs/plas/api-ref/en-us_topic_0218811269.html new file mode 100644 index 00000000..b11e8d78 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811269.html @@ -0,0 +1,238 @@ + + +

Modifying a PLAS Connector

+

Function

This API is used to modify a PLAS connector based on the connector ID. Based on the URL returned, you can query the modification progress.

+
+

URI

+
+

Request

+

The PlasConnectorUpdateReq object has the following attributes.

+ +
+ + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

connector

+

Yes

+

PlasConnectorUpdateModel object

+

Indicates the request for modifying a PLAS connector.

+
+
+

The PlasConnectorUpdateModel object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Indicates the name of the PLAS connector name. The name can consist of letters, digits, underscores (_), and hyphens (-).

+

The value is a string of 1 to 128 characters.

+

description

+

No

+

String

+

Indicates the connector description.

+

The value is a string of 0 to 255 characters.

+

bandwidth

+

No

+

int32

+

Indicates the bandwidth in Mbit/s.

+

Value range:

+
  • 10
  • 50
  • 100
  • 150
  • 200
  • 300
  • 400
  • 500
  • 600
  • 1000
+

lineId

+

No

+

String

+

Indicates the line ID, which is assigned by the CCR.

+

The value is a string of 1 to 36 characters.

+
+
+ +
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: PLAS APIs
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811270.html b/docs/plas/api-ref/en-us_topic_0218811270.html new file mode 100644 index 00000000..cb514182 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811270.html @@ -0,0 +1,124 @@ + + +

Deleting a PLAS Connector

+

Function

This API is used to delete a PLAS connector based on the connector ID. The deletion is asynchronous. Based on the URL returned, you can query the deletion progress.

+
+

URI

+
+

Request

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: PLAS APIs
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811271.html b/docs/plas/api-ref/en-us_topic_0218811271.html new file mode 100644 index 00000000..da95b1a2 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811271.html @@ -0,0 +1,222 @@ + + +

Querying Asynchronous Operation Results

+

Function

This API is used to query asynchronous operation results.

+
+

URI

+
+

Request

+
+

Response

+

The Result object has the following attributes.

+ +
+ + + + + + + + + + + + + + + + +

Parameter

+

Mandatory

+

Type

+

Description

+

result

+

No

+

String

+

Indicates the operation result.

+

Value range:

+
  • success
  • failed
+

reason

+

No

+

String

+

Indicates the reason.

+

The value is a string of 0 to 255 characters.

+
+
+ +
+

Returned Value

+
+
+
+
+
Parent topic: PLAS APIs
+
+
+ diff --git a/docs/plas/api-ref/en-us_topic_0218811272.html b/docs/plas/api-ref/en-us_topic_0218811272.html new file mode 100644 index 00000000..d77a1441 --- /dev/null +++ b/docs/plas/api-ref/en-us_topic_0218811272.html @@ -0,0 +1,55 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + +

Released On

+

What's New

+

2020-07-01

+

This release incorporates the following changes:

+ +

1.1 Service Usage

+

1.2 Request Methods

+

1.3 Request Authentication Methods

+

1.4 Token Authentication

+

1.5 AK/SK Authentication

+

1.5.1 AK and SK Generation

+

1.5.2 Request Signing Procedure

+

1.5.3 Sample Codes

+

1.6 Obtaining a Project ID

+

2020-05-28

+

This release incorporates the following changes:

+

Modified the section name from Make an API Call to Calling an API in Token Authentication.

+

Modified the section name from Sign a Request to Signing a Request in Request Signing Procedure.

+

Modified the title from PLAS to PLAS APIs in PLAS APIs.

+

2019-01-04

+

This release incorporates the following changes:

+

Modified the range of name in Creating a PLAS Connector.

+

2018-09-06

+

This release incorporates the following changes:

+

Modified the range of name in Creating a PLAS Connector.

+

2018-03-29

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/plas/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/plas/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/plas/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/plas/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/plas/api-ref/public_sys-resources/delta.gif b/docs/plas/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/deltaend.gif b/docs/plas/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/plas/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..84eec9be Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/plas/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..39583d16 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-caution.gif b/docs/plas/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-danger.gif b/docs/plas/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-huawei.gif b/docs/plas/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-note.gif b/docs/plas/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-notice.gif b/docs/plas/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-tip.gif b/docs/plas/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/icon-warning.gif b/docs/plas/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/plas/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/plas/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/plas/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/plas/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/plas/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/plas/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/plas/api-ref/public_sys-resources/warning_3.0-en-us.png differ