dadrobna/enterprise-router
1
0
Fork 0
forked from docs/enterprise-router
Code Pull Requests Activity
enterprise-router/api-ref/source/api_usage_guidelines.rst
proposalbot bdabc93498 Changes to er_api-ref from docs/doc-exports#716 (ER API 20230411 version 
For de

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2024-01-16 12:51:15 +00:00

4.6 KiB
Raw Blame History

original_name

er_02_0001.html

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 by using JSON messages, with media type represented by application/json.

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

Network instances can be attached to an enterprise router as its attachments. The attachment type varies depending on the network instance.

Figure 1 Attachments
Table 1 Enterprise Router attachments
Attachment Type Network Instance Creating an Attachment Querying Attachment Details Deleting an Attachment
VPC attachment VPC Creating a VPC Attachment <createvpcattachment> Querying Details About a VPC Attachment <showvpcattachment> Deleting a VPC Attachment <deletevpcattachment>
Virtual gateway attachment Virtual gateway of Direct Connect Create a virtual gateway by referring to Creating a Virtual Gateway and then attach it to an enterprise router. Querying Details About an Attachment <showattachment> Deleting a Virtual Gateway