From 46435e6aeec5e5e5901d676599b19ef1196f6912 Mon Sep 17 00:00:00 2001 From: "Mei, Sai" Date: Tue, 29 Nov 2022 13:00:08 +0000 Subject: [PATCH] PLAS API version1 Reviewed-by: Hasko, Vladimir Co-authored-by: Mei, Sai Co-committed-by: Mei, Sai --- docs/plas/api-ref/ALL_META.TXT.json | 122 +++++ docs/plas/api-ref/CLASS.TXT.json | 110 +++++ docs/plas/api-ref/PARAMETERS.txt | 3 + docs/plas/api-ref/en-us_topic_0218811261.html | 14 + docs/plas/api-ref/en-us_topic_0218811262.html | 98 ++++ docs/plas/api-ref/en-us_topic_0218811263.html | 35 ++ docs/plas/api-ref/en-us_topic_0218811264.html | 21 + docs/plas/api-ref/en-us_topic_0218811265.html | 375 +++++++++++++++ docs/plas/api-ref/en-us_topic_0218811266.html | 442 ++++++++++++++++++ docs/plas/api-ref/en-us_topic_0218811267.html | 8 + docs/plas/api-ref/en-us_topic_0218811268.html | 380 +++++++++++++++ docs/plas/api-ref/en-us_topic_0218811269.html | 238 ++++++++++ docs/plas/api-ref/en-us_topic_0218811270.html | 124 +++++ docs/plas/api-ref/en-us_topic_0218811271.html | 222 +++++++++ docs/plas/api-ref/en-us_topic_0218811272.html | 55 +++ .../caution_3.0-en-us.png | Bin 0 -> 2752 bytes .../public_sys-resources/danger_3.0-en-us.png | Bin 0 -> 2771 bytes .../api-ref/public_sys-resources/delta.gif | Bin 0 -> 836 bytes .../api-ref/public_sys-resources/deltaend.gif | Bin 0 -> 834 bytes .../public_sys-resources/icon-arrowdn.gif | Bin 0 -> 68 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 0 -> 70 bytes .../public_sys-resources/icon-caution.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-danger.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-huawei.gif | Bin 0 -> 2767 bytes .../public_sys-resources/icon-note.gif | Bin 0 -> 983 bytes .../public_sys-resources/icon-notice.gif | Bin 0 -> 962 bytes .../api-ref/public_sys-resources/icon-tip.gif | Bin 0 -> 879 bytes .../public_sys-resources/icon-warning.gif | Bin 0 -> 1086 bytes .../public_sys-resources/note_3.0-en-us.png | Bin 0 -> 1080 bytes .../public_sys-resources/notice_3.0-en-us.png | Bin 0 -> 1672 bytes .../warning_3.0-en-us.png | Bin 0 -> 3164 bytes 31 files changed, 2247 insertions(+) create mode 100644 docs/plas/api-ref/ALL_META.TXT.json create mode 100644 docs/plas/api-ref/CLASS.TXT.json create mode 100644 docs/plas/api-ref/PARAMETERS.txt create mode 100644 docs/plas/api-ref/en-us_topic_0218811261.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811262.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811263.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811264.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811265.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811266.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811267.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811268.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811269.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811270.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811271.html create mode 100644 docs/plas/api-ref/en-us_topic_0218811272.html create mode 100644 docs/plas/api-ref/public_sys-resources/caution_3.0-en-us.png create mode 100644 docs/plas/api-ref/public_sys-resources/danger_3.0-en-us.png create mode 100644 docs/plas/api-ref/public_sys-resources/delta.gif create mode 100644 docs/plas/api-ref/public_sys-resources/deltaend.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-arrowdn.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-arrowrt.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-caution.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-danger.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-huawei.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-note.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-notice.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-tip.gif create mode 100644 docs/plas/api-ref/public_sys-resources/icon-warning.gif create mode 100644 docs/plas/api-ref/public_sys-resources/note_3.0-en-us.png create mode 100644 docs/plas/api-ref/public_sys-resources/notice_3.0-en-us.png create mode 100644 docs/plas/api-ref/public_sys-resources/warning_3.0-en-us.png 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.

+
+
+
+ +
+ 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.

+
+
+
+
+ +
+ 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

  • URI format

    POST /v1.0/plasconnector/connectors

    +
  • Parameter description

    None

    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    PlasConnectorService

    +

    Yes

    +

    PlasConnectorCreateReq object

    +

    Indicates information about the PLAS connector.

    +
    +
    +
+

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

+
+
+
  • Sample request
    POST /v1.0/plasconnector/connectors HTTP/1.1  
    +
    Content-Type:application/json  
    +
    Accept:application/json;  
    +
    X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB  
    +
    
    +
    {  
    +
     "connector": {  
    +
            "name": "plasconnector-1",  
    +
            "bandwidth": 50,  
    +
            "cloudInfo": {  
    +
                "provider": "OTC",  
    +
                "masterLocation": "Biere",  
    +
                "masterDirectConnectId": "uuid1",  
    +
                "slaveLocation": "Magdeburg",  
    +
                "slaveDirectConnectId": "uuid2"  
    +
            },  
    +
            "networkInfo": {  
    +
                "provider": "Telekom",  
    +
                "networkDomain": "IPLS",  
    +
                "masterLocation": "Biere",  
    +
                "slaveLocation":"Magdeburg",  
    +
                "lineId":"UUID",
    +
            "popLocation":"popLocationID"
    +
            }  
    +
     }  
    +
    }     
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    location

    +

    Yes

    +

    String

    +

    Indicates the URL, through which you can query the operation progress.

    +

    The value is a string of 1 to 255 characters.

    +
    +
    +
  • Sample response
    HTTP/1.1 202 OK  
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache  
    +
    
    +
    {  
    +
      "location":"/v1.0/plasconnector/connector/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51"  
    +
    }     
    +
+
+

Returned Value

  • Normal +
    + + + + + + + +

    Returned Value

    +

    Description

    +

    202 Accepted

    +

    The request has been accepted for processing, but the processing has not been completed.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    500 Internal Server Error

    +

    The server encountered an unexpected condition which prevented it from fulfilling the request.

    +
    +
    +
+
+
+
+ +
+ 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

  • URI format

    GET /v1.0/plasconnector/connectors

    +
  • Example
    /v1.0/plasconnector/connectors?name=plasconnector-1&pageSize=10&pageNum=1
    +
  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    name

    +

    No

    +

    String

    +

    Indicates the PLAS connector name, which can be used for fuzzy match.

    +

    The value is a string of 1 to 128 characters.

    +

    ID

    +

    No

    +

    String

    +

    Indicates the PLAS connector id, which can be used for fuzzy match.

    +

    The value is a string of 1 to 36 characters.

    +

    pageSize

    +

    Yes

    +

    int32

    +

    Indicates the number of records on each page. pageSize and pageNum determine a specific page.

    +

    Value range: 10–100

    +

    pageNum

    +

    Yes

    +

    int32

    +

    Indicates the number of the current page. pageSize and pageNum determine a specific page.

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
  • Sample request
    GET /v1.0/plasconnector/connectors HTTP/1.1  
    +
    Content-Type:application/json  
    +
    Accept:application/json;  
    +
    X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    totalNum

    +

    Yes

    +

    int32

    +

    Indicates the total number of records.

    +

    pageSize

    +

    Yes

    +

    int32

    +

    Indicates the number of records on each page.

    +

    Value range: 10–100

    +

    currentPage

    +

    Yes

    +

    int32

    +

    Indicates the number of the current page.

    +

    data

    +

    Yes

    +

    List<PlasConnectorDetailModel>

    +

    Indicates the list of PLAS connector.

    +
    +
    +
+

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.

+
+
+
  • Sample response
    HTTP/1.1 200 OK  
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache  
    +
    
    +
    {  
    +
     "totalNum": 1,  
    +
     "pageSize": 10,  
    +
     "currentPage": 1,  
    +
     "data": [{  
    +
                "id": "uuid",  
    +
                "tenantId": "uuid",  
    +
                "name": "plasconnector-1",  
    +
                "description":"connector description",  
    +
                "bandwidth": 50,  
    +
                "cloudInfo": {  
    +
                    "provider": "OTC",  
    +
                    "masterLocation": "Biere",  
    +
                    "masterDirectConnectId": "uuid1",  
    +
                    "slaveLocation": "Magdeburg",  
    +
                    "slaveDirectConnectId": "uuid2"  
    +
                },  
    +
                "networkInfo": {  
    +
                    "provider": "Telekom",  
    +
                    "networkDomain": "IPLS",  
    +
                    "masterLocation": "Biere",  
    +
                    "slaveLocation":"Magdeburg",  
    +
                    "lineId":"UUID"  
    +
                },  
    +
                "status": "Available",  
    +
                "createTime":"1223445454"  
    +
            }  
    +
     ]  
    +
    }     
    +
+
+

Returned Value

  • Normal +
    + + + + + + + +

    Returned Value

    +

    Description

    +

    200 OK

    +

    PLAS connectors are returned in a list.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    500 Internal Server Error

    +

    The server encountered an unexpected condition which prevented it from fulfilling the request.

    +
    +
    +
+
+
+
+ +
+ 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

  • URI format

    GET /v1.0/plasconnector/connectors/{connector_id}

    +
  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    connector_id

    +

    Yes

    +

    String

    +

    Indicates the PLAS connector ID.

    +

    The value is a string of 1 to 36 characters.

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
  • Sample request
    GET /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a HTTP/1.1  
    +
    Content-Type:application/json  
    +
    Accept:application/json;  
    +
    X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    connector

    +

    Yes

    +

    PlasConnectorDetailModel object

    +

    Indicates information about the PLAS connector.

    +
    +
    +
+

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.

+
+
+
  • Sample response
    HTTP/1.1 200 OK  
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache  
    +
    
    +
    {  
    +
     "connector": {  
    +
            "id": "uuid",  
    +
            "tenantId": "uuid",  
    +
            "name": "plasconnector-1",  
    +
            "description":"connector description",  
    +
            "bandwidth": 50,  
    +
            "cloudInfo": {  
    +
                "provider": "OTC",  
    +
                "masterLocation": "Biere",  
    +
                "masterDirectConnectId": "uuid1",  
    +
                "slaveLocation": "Magdeburg",  
    +
                "slaveDirectConnectId": "uuid2"  
    +
            },  
    +
            "networkInfo": {  
    +
                "provider": "Telekom",  
    +
                "networkDomain": "IPLS",  
    +
                "masterLocation": "Biere",  
    +
                "slaveLocation":"Magdeburg",  
    +
                "lineId":"UUID"  
    +
            },  
    +
            "status": "Available",  
    +
            "createTime": "1223445454"  
    +
     }  
    +
    }     
    +
+
+

Returned Value

  • Normal +
    + + + + + + + +

    Returned Value

    +

    Description

    +

    200 OK

    +

    Details about the PLAS connector are returned.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    500 Internal Server Error

    +

    The server encountered an unexpected condition which prevented it from fulfilling the request.

    +
    +
    +
+
+
+
+ +
+ 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

  • URI format

    PUT /v1.0/plasconnector/connectors/{connector_id}

    +
  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    connector_id

    +

    Yes

    +

    String

    +

    Indicates the PLAS connector ID.

    +

    The value is a string of 1 to 36 characters.

    +
    +
    +
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    PlasConnector

    +

    Yes

    +

    PlasConnectorUpdateReq object

    +

    Indicates information about the PLAS connector.

    +
    +
    +
+

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.

+
+
+
  • Sample request
    PUT /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a HTTP/1.1 
    +
    Content-Type:application/json 
    +
    Accept:application/json; 
    +
    X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB 
    +
    {  
    +
          "connector" : {  
    +
              "name" :"modifyLiu", 
    +
              "description" : "modifyLiu", 
    +
              "bandwidth" : 11, 
    +
              "networkInfo": { 
    +
                    "lineId":"UUID" 
    +
                } 
    +
           } 
    +
     }     
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    location

    +

    Yes

    +

    String

    +

    Indicates the URL, through which you can query the operation progress.

    +

    The value is a string of 1 to 255 characters.

    +
    +
    +
  • Sample response
    HTTP/1.1 200 OK 
    +
    Content-Type:application/json 
    +
    Cache-Control:no-cache  
    +
    
    +
    HTTP/1.1 202 OK  
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache  
    +
    
    +
    {  
    +
      "location":"/v1.0/plasconnector/connector/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51"  
    +
    }  
    +
+
+

Returned Value

  • Normal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    200 OK

    +

    The PLAS connector is successfully modified.

    +

    202 OK

    +

    The request has been accepted for processing, but the processing has not been completed.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    500 Internal Server Error

    +

    The server encountered an unexpected condition which prevented it from fulfilling the request.

    +
    +
    +
+
+
+
+ +
+ 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

  • URI format

    DELETE /v1.0/plasconnector/connectors/{connector_id}

    +
  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    connector_id

    +

    Yes

    +

    String

    +

    Indicates the PLAS connector ID.

    +

    The value is a string of 1 to 36 characters.

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
  • Sample request
    DELETE /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a HTTP/1.1  
    +
    Content-Type:application/json  
    +
    Accept:application/json;  
    +
    X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    location

    +

    Yes

    +

    String

    +

    Indicates the URL, through which you can query the operation progress.

    +

    The value is a string of 1 to 255 characters.

    +
    +
    +
  • Sample response
    HTTP/1.1 200 OK 
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache     
    +
    HTTP/1.1 202 OK  
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache  
    +
    
    +
    {  
    +
      "location":"/v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51"  
    +
    } 
    +
+
+

Returned Value

  • Normal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    200 OK

    +

    The PLAS connector is successfully deleted.

    +

    202 OK

    +

    The request has been accepted for processing, but the processing has not been completed.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    500 Internal Server Error

    +

    The server encountered an unexpected condition which prevented it from fulfilling the request.

    +
    +
    +
+
+
+
+ +
+ 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

  • URI format

    GET /v1.0/plasconnector/connectors/{connector_id}/operations/{operation_id}

    +
  • Parameter description +
    + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    connector_id

    +

    Yes

    +

    String

    +

    Indicates the PLAS connector ID.

    +

    The value is a string of 1 to 36 characters.

    +

    operation_id

    +

    Yes

    +

    String

    +

    Indicates the operation ID.

    +

    The value is a string of 1 to 36 characters.

    +
    +
    +
+
+

Request

  • Parameter description

    None

    +
  • Sample request
    GET /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51 HTTP/1.1  
    +
    Content-Type:application/json  
    +
    Accept:application/json;  
    +
    X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    operationId

    +

    Yes

    +

    String

    +

    Indicates the operation ID.

    +

    The value is a string of 1 to 36 characters.

    +

    operationType

    +

    Yes

    +

    String

    +

    Indicates the operation type.

    +

    Value range:

    +
    • Create
    • Delete
    • Update
    +

    finished

    +

    Yes

    +

    boolean

    +

    Specifies whether the operation is successful.

    +

    Value range:

    +
    • true
    • false
    +

    operateAt

    +

    No

    +

    String

    +

    Indicates the operation time in UNIX time format.

    +

    The value is a string of 1 to 36 characters.

    +

    finishedAt

    +

    No

    +

    String

    +

    Indicates the completion time in UNIX time format.

    +

    The value is a string of 1 to 36 characters.

    +

    result

    +

    No

    +

    Result object

    +

    Indicates the operation result.

    +
    +
    +
+

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.

+
+
+
  • Sample response
    HTTP/1.1 200 OK  
    +
    Content-Type:application/json  
    +
    Cache-Control:no-cache  
    +
    
    +
    {  
    +
      "operationId": "95a44e38-5d61-44ca-a5c4-f241812fbd51",  
    +
      "operationType": "create",  
    +
      "operateAt": "1517274000",  
    +
      "finishedAt": "1517274020"  
    +
      "finished": true,  
    +
      "result": {  
    +
          "result": "success",  
    +
      "reason": ""  
    +
      }  
    +
    }     
    +
+
+

Returned Value

  • Normal +
    + + + + + + + +

    Returned Value

    +

    Description

    +

    200 OK

    +

    The operation is successfully returned.

    +
    +
    +
  • Abnormal +
    + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    500 Internal Server Error

    +

    The server encountered an unexpected condition which prevented it from fulfilling the request.

    +
    +
    +
+
+
+
+ +
+ 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 0000000000000000000000000000000000000000..60f60762138fe7d98fa081415cf26a4943897779 GIT binary patch literal 2752 zcmV;x3P1IUP)pPa!Eu%RCwC$n`u~-F-BFk{0Y@>jH&Wt02T)4n7aXBssVicB` zOX`JaF2{q_2~&#?rkP8$id|Xfs23G(+0lTGT0tnFxgZFMIx;xG$R>Lr2ng2sFhB=q zSd{Td_5QEx{V+WDJooe7@Bg{)|8u`XpV~`~ZvvYTAfN{@5<(zAAd&!qNCE^R2@oI< zNq|5k0e^NPrRGdyW8`F%MH7XH|3P8=s2${2dg49z003YAM?%tm1!4=85P2aZJs3WS zG6CT8kCv0C(eT;v!9vu9jP&3oZEw^8HmnQ6+clMCL4mv(zK?)Ob8&M#`$%sr@v0v& z@zoUHs-n619H>uFER~Aj==ntk06q~XtAWrX`-(7l=)GLjQP?!@q z{@ZTZw0`amLgo~4vvd&0Pxryp)QHy>ob2%4P9)V*SX4zr!(BuoQ>IK9!d&k>z1cqI z{8L;})njUE#LIJj>h%6Q^ZVF{wB;i;Qi+5h9}NJn%x@raKm6;fW+Fl#T`67idLh|4 zu~b$4-1hhHTVfMtV@>p)0G=3ns@?Zq+;oGKv z*YE#+n>`1!`TpdYF4yhs&w)&meoVo}#+v$ur`WVKNyq<%YnFsZMC$eXSc!Bf$)AMeNOrxm z98up?0IbZ4d1uoLyuSG}0{xcY?H+G%68SDpqp0{6ZmtR(?ChBNKk$ZxK&chd%Fub9B!C3$z*oSdfKP$^R+Au*=jW--Q5@}8T8wOFz(A> z+jPJi0CSN!@M}8~J+m~H+qJd0$mL8L?}^W38D?fiTvJtZ_QG{CGOx1j!^2co2eNIY zE_th}e&*28WCEs4)4Ngh`F*TJs&5jrEg}J*$>Ry|NTs@Q5S4XS*jiLGYupV!l}OmJ zCkyWg!}|T(8zmGK-@ggmTpXX4Lzd^H6d8Ibpk8+o_km$bMW>TS}&FY)P96F+{d%+84 z0FbR#^Wj0eUL$0WrHtk7-A3#N4!~oiv))WDwoq|!rza!b-MC#_%g6i5bZq+f?}v+A z&dvOM*6oz`?o(Suoq{*R_pvM}5O;^mT)Ww?Z7fftAwAED0FP9BCXZ)ZL<03qVuSdN zP8xtRONCq}V{LHL13e@F7rC5Q7nL%1)>HuEPG%TvZ9T=8(JF40lp-DCMCkm>9oo4$ zp2gbI0)X_(**fDB#*QLr-bCyM4&cnWE2QR3>%BzUvd0>L#Q|n|$1Tk60kC$33wat1 zyP`b|;`hpR?G6;%TDEA7?qPdG5~XG3DCEwFEmXV^*atUP1r?Q*Z6tf#C@HG~z|7R7 z%W^bSHmKdEz8|Y+XCNKoj5;@$;5Eqx+bjkplCo$bd!u65ur3Iht+xK#S>J1CGr+PQ z0C$JWZS8>kO3xnquB&Tk(E(-;v|eN5zDOk!LKaKgc6D>}Jxa^U*&dP9D~M#(l4Wdd zEW5NF>oE`jQ&SV}G+O8_@4Ge+!`aD+oB8?teVaq?BU0GA1xO_l=1nQrAx&+WdOB8S#d?X;+5%{W zL%$q0tP5gqR7{WS^|&#ETLM_$tqfODr{F@Wvh7$L9&xbkIv%IZL`G<~%z?=et2Z8l(~lTRu|vXblrbH{CQq;M*jC6P7 zAFJjO7P_e26);09x-VYJYSS8{M>uNB=$!_=`UBu*VJQICR{ab{qy@7TIM~}!cc+es zuSRv+yK8E024LzW_fF?DH>qIv7JK9}8Okgb+deq(_=yx1KZZPwhLE7)i2By(j4ulc zZ0X+G=!}W_*0i+)j$M5C6#K-`Q^PI#NC$_uZf2|)Q-QCDmtJxjn1b~m%uQ)q7k*!v<@zee~^S^yy8n;SIv9h!z@F~L` zuV;E)#MIP`TP3BWq~-E)te=ie;#EKP>`x<4qruHp!K;f(yPS8hZ8~d0reR}ajZ`A( z(HeW)kgTXvuy(`eEDH)`tWfsw@ySLcm z71)pX#Is~7?MOOfjY2*gfad0Vq-SPfE=p#UyBs4UBW!G}*%&$+h}RorbCI@}bUZGD z(D`DX7<2A;EnO+wSMkI5S3ZiysJKOPz zXHjNr`1+U~!-i@z2TQevhO_F+9anqo4qDp6*s z{^#^#iMhy}=wm-XjcU;ayd~S zjKa+^{((2(%#||Kxw$%iyNf&$A}5<97d+PwF{vJcqF5t}K17 zWA47SPe$ba7&NE7d;EGLztWTQN_%qi?{fFvpbejgc;mTn%wk=QtX`o_PVsJpPg-Jv~RCwC$oO@7HS02Ydnp$REOA{(Mow8*Mm>A3h9MeO=6 zYU>mmT}9emv9DQm*RJeXc5T5Q!v0 zB$5b`NFqdtL=w?OklwC|&JB*_kR*g*P1STeQY~6uB+{*;B2i1mw!HxCh>m7?uX_kB zZW668hPGS7cBvYGjjLu-T2{ta(MHkoqDQ**khXqXE?M&}B*qkwZb{|!wVV0PLl1U( zh|@k2Pt@e8KI2W7%cc| zO7%;oh!GEaKI?~$MKHY5t{0Ps=^60OI`;KR@k?HRh+XkChOueL!}QpzFXL=(zz|LUxf|B{Fmxd{EXn6tyV1mZmG!*PMf2b20p#%- z`o8%ZVfQ~su(20?SHHrs3D0@S-1|flxSZIlFT0HsqCq!dAXirJ4@lTnmkYTz0`t-t zoL%_-P1mIvW2W1<$B}7tG*?~Z^s+@a=y&VTO-%?Gh7Jy#@{?>}D?H+5hs1sBQ0R>W z$rPxPB0JS9by>2#BO!*;vNGmn#B$c!n|>2>7?JiN4?lg9=9Ul^WTvn;zkmZNJ#I@f zXfLYayW|WUHCNr9F<}t$c#W4#+=3U8s&%wF9keEQnyx}+}N<*(D-{;R$ zaL&lM{`n*i9mMK`CvfP6+g4qiUbYCAy$P8{NBGDGJ>#mRNP+|zE_)NFmo4(hwYIv@ zj4}Jw)#_@YXz^U^wkl+5Ed$yU@(x$pVxcJ-ZmXBjPZHcyBPNTQ@jT3znFTMzB|S?h0gxfpz6m)AA4I1f{{Z$&2y zk3ciVjBaWI{dcTHs?p)HH*sm#raQmUz>fucJ<0Wt1$&7Yo{Gv8hdf^6w-o?Tw&YWcsTM+dBoLi8 zm#bgrQM3K5ud%~av^tvIiFi|^-&R4OlHQ{uGz@8In6F1rD1F94&As{c8*2bi=#8{A z)KIlQhtnC$?tCJxvO0({nRs+qm1oR!Z=IKnF2v^f{N$t{)~t1Vv2?ngNK$nuGEKO< zzf@ihKvc#!1ci#0h8lzrHSz1+9!LmL<7})$rq&Yk)GWTA^F~0u-~E0TNjvu-Q)}t} z)&}+s8s@*>B2&1%Q%tPac=st8NJG2{;%siGF;7#NJH;& zhtmrs6i)v0ou4BeO^#u2egO+IQwUR3_$5wT3!n{#&@*Jsx3K<;Tq+W^T~4H!KR$~@ zu5|Zlat{Mw&iD(0QiW8dAv|#;hS6ylMyC;;I1(Y)o!@mEZ@FnQU-ZJ$IBKhr$d&Y3 z@~n?c&GxedN!C@{=B92P%iuKA4P5P zF?T5M7UQl=?_?r5^a9HdpCWnaAVwy9ACNdxCO+iz-A9L25o0p3%IfG+5=G4$jjDT3 z_rX_P#9mZ`W{jEERu|5u25kR1=sC=`>*|qQT57FGWQv;}!j;wgsVgZ&P^ySbnS#<_ z@{wsQcZWQgM(3rkuisR2@ddhKm zm>y`QU}}cvFx#%9zncRR0f}5m+=3T>`k`rb(CYH78vp)0Ee*BEwGqTVll7BY1|4qD zR@y0eaw?7*EAlWsiJLyTGjpW6UP@ltw4HQIDv2=#er2YNQnNeHL|TgfF7e2O?@1my zh~&SD2{!g(;QB4N?2Xi&J%utn0;xtv zkRbctK7@An=2gu(9Ra)bZS!9G@?)aLPe-neAnxr2otkuaibwkB-UtAuk5dGci8mbQ zpHD?%2tDKXzEY@Rj-@xHWo6{`Gk44bDS}ZNOehT|CG6gP2Ggpt~a%lW$PyZ(R zi8N$tEzX8o&aMocNSD04oR)@K6nZ1(%xk%iRHX^nOsp#j+)(^s?wgdX$fl*dQ#vN{kQBLN_&` z(}>jJm$ns&TBh$jOxAo08KVLl?;k50S@-!F7S4`i=H$SR@bCXNvu5pPHYX!BHAMhH=PbZLgf2GrXYPBlYfJrz}; z)`4zn0@|b`lo3(5nj87CARk+Pp-;mw(B7`!W7{6u*6MHG>-993S9MlnGP}b>T0X$Q z*4=p=+dA4SslE}Gg;&WhtYpG)6U!Ea29!H%?ahd^54+^o0V28#9s2{xQ^UKnb$1>s zUY^}9i2&9v4QJu(xOPbdVAh?wt?d92zi^J^&vgoySb1+qmmi0B}` Z`Y-il7nw201!5QImN;7^FeRDuvlieQm$nqSgH2#ST^0cx)=Dn zcnY!FJo_HPt-fVW+YdiB+UT#;6V;vF(d}+cR@IeV(d8~pF{?8>qtl(5 z-l&f3hz@sXMqTY}N84?I)T&mtqU9C|*g%8DFx{Fx6Im5iuF|X}%dCt_S87;LjI4+X zS7=Dl>numvWx_9&xPzYqFMxz!h@dKJnV+WiNj6zrg25Bat1rHX34YcM&(@mM25EsKp^s$!A zn#VD|u6s{$op5YkSDD^r^tisfo6%**9APOOq(ypevUm*eg627JCCoz;t2Wm=9wHzA zIZpn)d?D?0K6~e%(5n+Y{``IW_383vZ~ype`|Z!iyVvi|9^OBm{E(}2>Xh(M9J1dY2CIYT07X)PL*D{uoU3SWSe zM5)Z@cZj(9E!*Rn@%yj8UtL_@?zGcisVAyCyQACPnyjiTyQ0fonqpRGc1EW=HN8j060m^=i($GodnU3fs$8X6OO{y~m9EsVpcq*Z6|T^b zqSslDvde-aqopiG$tAYJ8Zb!15?a()3^veUF{}|ZIT4x8)aYX^Swx02G;(1<(UEpq zsD~82sYp46Jp6zr)7XK2NT3kbfI%9Tw8DeMU;_=7#;04Wd;7XW>CRXi!yzvnE_|I|r wZ*w5M>1_7SKcT}DJ@4vn|M>OS_UPly>%-H_{r>p;)5Xs}-+pgDf7s~DJ6{D>Q~&?~ literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..84eec9be2f2ce458e888f8a9b803f9387247726a GIT binary patch literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..39583d168d6db303b366b5b8c1780698a6bb6017 GIT binary patch literal 70 zcmZ?wbhEHbEMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..079c79b263f4b48089f3b3256154c73e7699593f GIT binary patch literal 1086 zcmW+#YfRQ<6hA3LZMyP?V}KhnEtF{Q4vGxS52AozEVM85nq$#%tv8gRF!3GhgM?_) zd5Luv3SKrXFTGCpn$y>EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..a31d60f895af919d33855217ca02daf4093136d7 GIT binary patch literal 2767 zcmV;=3NZCYNk%w1VaEV40Oo%H*MEWRpQG)+!RUX6`tR@RDKg4%aM+KK_}}3B+S#H2 z0rt<*_Nl4!k%7|y4fwgY^uNNg00pZ61NzIz@q2NyEiLIHE%S?g^NEbfKt%9!YU?yQ z^qh&+U}WbD8{q&E?Mq9<013DN2H5})@N8$u01CkX3Fs9f^{bWHKuGLFOZ1kS)=*aD z01@p=RQ9r(>pemK^YiUeQPU6`>94W!hk53YleQ2Q>_SB7aCr2fj@; z@a|n&?qX^0W?<$J9`9pa@`8Bj9VzWnT-qQk!yqQl01W6ECF?mp=LHtlFgo|Iv-PHs z+HiFBprpVM7yReuz5od5zrUyu5$;)5@{gDATVup9HOgRO=U{2(0u;*t3-Hg-^OuGE z;N9vkH}7a--=Co1Fg#jPP{_r^k&B8kCM0%mZLFxL@$v9KH8SJk;?~sDy0^BTnwV%{ zUQ9zlgnfM9U}wHiP~xwz{`dCrZ*%7e7{X9d^{Afom69VE761SLA^8LW004ggEC2ui z0LK6@000O7fPaF6goTEOh>41ejE#|lU+C8$A-c{-jb1$W_sAqMbtN`+RZ#DGFR(dnrcRE3N%f+!F;*y7(oOv#1FPiAwy#YP$z^Q7U<_8BLs** zMSr>_(L`oBgxA?;z>x3<218xJ;14v)$l4!yG&Wrk_I1$$0*;vB$B=#`at4uppizkb zkVG1Zq>_oSkp_`a7SaZiZXiMjk!m2q29j+I!X%PpB5B5wO%5V}2qJRl1%NsHfxr&G z=|x^!dAKu_41Dql0y7LOA)N(0dcZ^rABfh-m_;ITB$a5UdB~$fR(S{-NTzYfmPE#Z z$dyBCddM0`(jjJQ3^=Hu0tmpW@WUTds1O^W zCv4aPqTVsWsFRSgiX^m^Dgr8zYZ&qdl5-rgEs}5?A_tOhoSJHxtD4)WAg_+-CV)r$ z0l^3=PP3O0e*huI221P;!@n>Lqi=>hZs_9&J75vyw2nR*>5$YWnFy(5hH1$EwSHt- z2&Y^c@+FZL3&QBRsy<8z0uiv;-+usJMIdJZ34w1G1pu?}1~|L$M-&7rk*ppEBV3oW z3{UE?w2~S^sl>(pGc6ETQUgwH}48uSiAJo0SA(QX~FrGzYvq#TC0!EGVmk{K=`YG64w z*^4Iq2N`U_YT26(@Ww;iA6V3a3V*n8!U;+!QN-&o;K;WJKrdVR4kI*6wC0H)Z8+gt z8&Y|wjA~4X(?lBohtwStGUbrnULHxSg=BE{y8s3-FXI^_2KJ7l* zPUi?^WVSHxgDj2s;6@ith~r!?-DM$hAerqT7$efv{s0FgQSEnvBN74j@P$DTKnvHC zONlTuy0+nk2Y*mO7rMX%Cg?#AOZY{0)h5f{2_S7&W;+3~xxv`varUz{DmpF%e^`f&wJ41t9(5fhwzv1mBc| z0U*EuBM2j%FvtTFnh*k5Fk|UZh`TZf2my8Qf){uKMUtgzel#qE{5o z`T+owlz=pEZ~#HrKnm`Pm2OzzgBhrem4EOJodD;_ahfxf-U+}Ak|4_v=x&*|EE67c z`G;K+;#whFp8pE*u^;}yhknQwAj5S;KNQlDsB)$xqbbb@AmI*w_<|O)xy2+vAOLDp z8yCVE${l#|oS_`S5dZ^$BP4;HUf`rVX&Fy4%@bn4W7;49dBA^~$q>dQOL?8kgXdnQvsYOnDfj24t0FVQ&GJsH);SXF0X(+eq z0|aFCq_QkQ2uwgnL@)|$U)!lnaS7A<-BO9Aav~Zq1~shtZ;*=2X&Qw1zoAY~flO_x zQ=i%a0w5p*o16;-5U|cJ{sE(En`{^}sx}@hzy~=vDN0qkRui}|sdcU4U8UAnL&&wT ze-NTA73oVe_41G0LefE{2Z>hMA+geI=u@QtfIkQT2`1nUZwBxt8^}v-apD4J9dHDm z*r2j$RqI-*fP_WBP>(V+WFp;)q}Cd-rO7KqPBT@AJ}!>D^n`Dbmde!NE;eOIpur!e zT2+HIfiCh&!V$`4~D_J+6+9nP?X4+~QQR3Nd6O>yUni+~O!R{(#Yf%|x3 zV=w6V57*_SoPYe_5lO*{ETyMCXS!kI{qmTJC@5?}tYs@Z`Gp%cnIOCjX8WdC#YjMN znOSg%0i?hn3uwZe>0DG@D8{!L9NVviU!0?6(AlZm;xWpa)Zb-c0Yf<`I615cvC$3@R|NPo+jf8PRu)%BB zhMd<%u5!4#ylXATHvtr$a54bk<~ZL%26n#lMX-S98Gr)LaZUq?L;OQXHv|E!0Ok|h zR|}ywHv~IJbrC%JsW+&2(zpJHJ2XAlm3#yMI(PL)OS76>Px~OC`E{mNAnK0zLI%qI z)ZlJG?RXaiuD@;tv`>NzH;90J?Vk56!rvj>leB^Xjy?$j0N@7pwE`ImPx(Jo;pSvu Vyd?-=a{xfJ@}LjB=qC{f06U7uGEOJ7jGVWt0R$WZ8s=je-u*DOe&kq9}!i z4KyN^y7WUtlMt&*F%bljtRbDEJamX6>@vOi{twMwE+=kqtJr%yLc-a1j}Z>-)`f9GBO%WDhy=L0>5=eLzUZCI?G``P_| zXl3c^-NL}=_M!Zh=FG7pU)shB58htr9~}O0uVbq2_rt-Fxv_(zmmdB7)lfOReyZ>D zrqum6#Z#+~moGM-oS4Ziby(A(@4L&ZrWcR4wV&_mTide#$G4kXKF-|cGp}2pJe$2t GE&l)<3Z_>8 literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..409070650a49518feb1624c624d814c3bfa63d2e GIT binary patch literal 962 zcmb7D&r8&C5S<{wSd_qn6)U)w5LOaRh!N}_*49lD)S!dZp@M<3gPIX|@UR9-fz+X3 zAaT9)OY{xZtO-;RC85Vab;JEUNIMS5f^r$7-e%-XK`j{0+N$CsgpRd6B1wp z8dw-cH^rU^H4`&7qgabf)l^K`l!66{q9$U(CKRO5%W5pfY)s&YQ6n`HBR0ZTum%`N zgC%I8hQ+`JG_WvCAt-W$sIn@BKCDG1qQWW^a=`*c7G+i@s0S(ZDv1&+K_2`7O-#cM z=m!ZX1Z#kSG+3e)Jg^wpfCd(Yb5TZ)U=a!DwsG z)Z`|1ejMK4ap%CHj;%+>T6=D++5I=uBbQ$fZ48cf{hV1}9&Njl-I}i7e0#6Hdug@s zsr-57_=gLr&9Ros$k}}M>tJ77=hEJ}iPaZ%8|P+gUbS|Oj}5I{|5nZZc)C1$e*Rj` d`09hYXJ4M@PhCx)dHK8WZo1*|*q+^V@*ncduk8Q; literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..c47bae05c9fd17c02a851d96cfac67bf194498d8 GIT binary patch literal 879 zcmchWKWmj?48@OdDOZPr)a61!OE4yGD)salg#|^Ix$qIEF#uk)V>D{95e^!2r`i+9t# zTMu5YtUcd+@#gp0tDE;9ug>oLIzL$6dOx4-t#2PKExu1KulwoYeD?Os#mVO%AMWih HO|EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..57a0e1f53377b28fd80ceb393b035f8d9b8b392a GIT binary patch literal 1080 zcmV-81jqY{P)pI>PbXFRA}Dqnq7z+RTRg6r`*v5D@IBmL~4s5$SN3-f`YICkrqS^ z3O*?4J{4psT?>Nv;P$DA4|YKmeJd1v=!+{-P(e)MT23E4 zfpM5g?!;YNyXOywggfWv-aG#}pA%7499KRz`7Lmw98Q!I<#3`LPLvbnaH1TQ5UMEG zlVk_b1{y%CK&5Na8Kh~iV1CQyHSIUD=$Ui|Y1(mW{t2nlnW!hpqTT3)%#9tQ2@Hwc z4!jG@4brq%Pm%+`OlEvYXy4{GY5awd{We?gCpulWuT{Z9`oN)jk~9ZtI#ba@Tm#IC$eXI#i?GB7 z@C|Siuxi7{ffK+jzyrW_z5t&id2Xi{7fGOZ7RUNhF z=`q(YYu4B2zr}fA1-My6UW~A&C(H`Z0J{sqLLYb>ST?)$UTJH~j4 z)U5D`kx~@HyTBjADBwh`9UcOHGnaO3gx+o=^sFTdqcDs&7cD!S1Y1R9DJQENmMBXi zUX68u7SqPL=oS0?tDydiCJNY=lMCxo@cxg;Iw&H0tZv&cB5#jSkGc8v45{4-xAi@+ zH#c^6Llb3aTk2cp0#8`%*2*ZSb3DivIwje71|rV*JnwHI2e{V0 z?L}VtT_k|}D>qFKHz^_)cUMxtxkDBWXzz2D1oirfKkqs5Z>m~O`i+$JJR1>-NN>fsG-Q5hHbmeou}1??2@ zp;^{uvz{qy3k557pH|h^|K(Paf~;?wS^K(J)S`9Ki+p;|vZBS3*BostG+QG&8PgN& z=@C2h$ubuxBJTs&=XH#%UFPZrh=oAMNN{DPG_uReuDWcPESRPGOKD;{Otwcu3X@*QY`k0+@}-e yxT4{IZgHXpLI!Q!9RCwC$n{8}UWfaGMW8J;IUE8&LY1fUhGLTVa3!QBW+ZA*L=y*M3rfr5il?z?dJZieJ#47>M$@*mD4$1ecadv1qsU1#wR$;qu4Bmh4yS`Hi)ReG=4*#e zajgEV5YlLPaKTMvrW)|6L6Y@JtlU|tX}9u@d<^;|8a!TJ`kRn8mKIZX-z)%<^+`jn z738I}>P{CwooQ#@mc8ItdHsQ6rsk%O$iLY)*x7Zcj%}lwEK@`-=;otzSyX+&p9{kzQYbgSF@Q=2Qy+?#VW0=Vy|cYT&lQ@%;A2YQ{hH z9%ov+34{hBa~SnWOw39F;7p5`9$z4G?cJ)An*I*rb~&khdI=d8h1SkK)If-j5C2TB z8p4%r<<^31tR|Tw4Xs1QHMjMk20}yD8f4p%dXd_$me9Z-SWPlj8%nUOe;>LpUUAI& z1+$nxI~Q3>q`9q!{1-nPlEMa4o@e_SGSdvCrzn))J%_ut?ipfIn4e4CD=Pq4zT@D? zqk$|@wV{L*qfBG7mtFghv-Lntl$pcnz~kwNI)BUSUuvgmQEXp5=UThz?DmmjlsW$V z@)3#dyh6UbBYa%QD%n4gom-Glu20@0My{Xs3VRpaU9=0QxbJP-J)Pz^`?kOW30Tn z@ufYqb@gL4$<)8N0%S?kG%v#(IqvH7UvcW1v+a@N8!}9Baks0-uUUYP1beE1+)Q)S zUobczB2ql)J>S90pM1~e2X4k70q-59;@Rj(Ixc6Ok_Z$V@dbE+GNTrV;HlFQ=lRMeN%CX^J*|inqrfX$fdWuECU& zYE~#M%8xCgqI||*N`--7Xw)BgEZ#bB0-qYhW>q--LhLmBU*r0E*5+4PP+l2n2}rtV z_qXh+#jl32SrvAyo2R)OD=o_BoyYIMW>x6y_Tety7r)3^eF8`TK$3KP{`eA2F}YpN zxa|~0YP$+*PB&3e-M~W&UFbFHknL5q%yVT?GB=Ox3?p^VEh7*N@$03nevU0%RA*Qe zy8Bd~e78Ejsl=~x+vYF$e)B!#In3BC3Kw>)rNi4F>6}lnndnzTghB(1f9&nZP({}9 z<_Y#X?@5R5*rUdbm zZ9zPQB)-@t_#f`t1VTsxAtZr72uUD>BoIOp2q6gsLP&yt3mvdY+y=oIIs7M?<}pwN SX0_=60000pR4oO5oRCwC$oPSW0cb>;zfj~mSuLKN~5E4Ot2?$cVg1bfW*MgmP zwXW?r{^)GC>z&@*cI;fk*-bA_)*65J|u{1o1b~sY9&bgB!&FtPHC|>aqwkEf8t)sIV8a zy`l<$fv1-750WZjrUfER4&AbBw(qRs>9xxN*j}-pMOzA)VQ&y-TOiWJv9nVR=-IGB zL`2wi-rWtmJCwYrnwtLq8d^@54N{_E#qc2?d98FYUt9|#UM6CV$k!5{lNa$(kHW9K zOnWgQF}`S;)25`yKPRE0?;CL9SWtgolNa zrBRX}cY`9==aUXcrj$ru%8RMoU&9MOUrS=-S8j{+s~_?FOYc$kFAFFdtPOe${ncT1 z{rLzf8V%)-DtvDE-wqmRZ8xCPYAJtA<5`q3{Ob`bjZO9Fv|84D-@EVUj$Eg)=@6=E z@#L*7W|qCq*W!xRyz%}azq+NTrIL{{k5{wx9=$&5QFz+d73A@UdA>TE#nbrfC(X3B z8(6fZ$fI-Rsms(id`VH^EXwBij$f6Q%6pGy`z7a}PPWn1d>+=6lPmX*Un}gz{Ox!v z`WEl|IDGSOT%3|O*G+D{rZj7N?NbLjt(LV5jh=HqnA?U z8mrYxV|c!gMHxe<(a3REu1^wRwhaLAc*#s3m+W-80O+~e%iEuijH}D~<%`(7rkqDg z=TTZb2dmA-!DFZR&9(3NZQo)rQeiLlD~pmzCp{Of?FN2YE1pz;Th3*$^KYlnx3rR& zpyJ_&X0!Fj%Xs-G%lKj0eA3fW0mv9`|G!E9Ya~lJ`Po^X-Lx2KsErPD79Hj+q@gxm z{Mlkoes-3_qjQ5Er(oy{Vq#*j+H8D$A>2z=-J3vbyTSAQk0(04Sglr))oM!O z`@CekFQuSwX(c8)8igX37UN~i63tz8`Qdaso8^aiGyN2A&2A@2H4T81Uv&6wZ?)Oj zTifJC_?WSn~TqB!^hRw*Ad4e7J~3dFR=6G>_8NdnsMLm)G}au^{sd3m-1x^#e`g zF3xz6x-4W*PjVBduE|UGaf6#U1-aQM6tVOT40?@sz!ZhmW+Or>@p4-Zv4VXye+OW7 zc`+d&A#@sz?CP00DZSLHz!o=IttMHmrqgKTxg*zuw$4$Jkz99N$7-|j*1@mnmSvB7 zO=WExR-28GkWk(!3-#*~r7p`oB}P+1qz`Ts(`7QTajn||ZQHTiBYWfRy#Q?8q@~Mb zVxKK9=<$~3C;^C&N<0(TEz8Di8z5P&W>aZ0G0`z}8jaMCZ=XmZMWeykeJP-en=p}N zQr=uQi}bWqx=f~kF79@>Z|%3c-P>cc{E{db1WhEfM8nqKxzqiJbY}y$o33o;>9xz* zUQson-E%k07oQ_VqoK9kz%l!D08Tq~beT*pkf^ z4(PF1`pDEKqI8;gLeoonS}MI}GariryW_5*SlZ-;)XNs|tUjBo*UTssvHYZ9)NlJ) z_By_sKLd-UZ%SNTyvWApvWyA2xbs6QE?m4wVctygq*taq{STT*zcFP3uVFUm(>{fsnY2byQucdN-4PVNGGwlltbpW(qxPn=t@v%0g@(xlo8u|zNX$;Tj zL~B0)v5_*bKys%(iq>`m{r&x%z8c|~$V_b_07FC0fQu6zCMG;gOl!LV)wFmvmglg* zQ8R8V_1h;>NK8;+wORT1?%)IOmvT)cCaCB#nI=Te-qC2U(nDqS8QysRkk_a3)aCm} zq?bP(MW@xWs-)NJe1QW+nJCD~rsrxeyN)(b$ZgNE*Rg8RgYE+A=jS;+kQlUu{`Kmaq-Zo)ZC1bW*X)SP zB&*dleDyW$_FJ1<>AK4LvN>#CQ_ki!<><89`&-$rmo4DrXSKYw{l~;e&UndGvBREY zdBhz%GStSin-=p=&;OneA1vbs!`1gR{w#YP5zt^s>sevrzAfWX_)uEYBrfUeBv}`^qrW~HGWfKsmsDE zOQ*BGS9P4Wl`RF-yksh zy60FsZNNwVNWragKrk^ve!4rg7mMBdVO@#NOI{X#h4i#kMn*=saPcD79Zs)o<((?G z^^%CiJRf_Q&GJKDpRI*9vNO}^G#dG@zTAL%%&<4GWyKs~qN8as7&HHba-?wT_zK+{<0Kls4ZZI zwt3@|Ua`~d_}Me*beT*+rNNJ9iBKqFak*TiXf(`~bowmtSfv`EtT@NZqPks+{a z5!JMKPh8~>&n-znE|bw}==6Ccb0>biz(smmDwnVHu}ZPEji zzW45)-n*6<0^#-C^K4pKLR_4Zk&zJ&pEynB{*O3#>=aGS=dlkuD9FiX!}lillwCC0 z-?hEgU&dQ|syVhNu(h$+M6CR&JD%9FMMGhZ|GG+tIg8TOds)AHF)ylW?m2UG5RP)x z8t}<_w^)soA(EXPo(HDmU3a@1zaW|JX{#K%Oq;}A@|fXl@p%B-Ez8C%ib2W{N|$?g zkBuLwVmzkfoqdk=b-RuZv4S>9rqBJ{sq>hQNv?~2V>^dfL1TD6U)yB#J4cCkVw)_#|7FHwSFj&?I903+@}Q+?E}XNC3Nz=CN(ZZjK1= zEPb1Cd{SB4f1Go_kMMN4^{(v-b4ID$mhCyd8&;L{vU{JFmp>h)qCi-YZ!0DoBh||m zu>a`Eo9X_gaoZQ>jE+kpfEdXop55erJD^6gL|Bn;DJE=@t~lNAw+sx9aIkUClqxYW z=nj}aF^#ZTB`nJSYa&gTT1nApc>bmLzAo-6E0000