yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

vpn_api_20250707

Browse Source 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
This commit is contained in:
Hongwei, King Wang
2025-08-19 13:38:54 +00:00
committed by zuul
parent 0110b557aa
commit 708fdb2d21
78 changed files with 4992 additions and 3257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

631
docs/vpn/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

537
docs/vpn/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

15
docs/vpn/api-ref/classic_vpn_0055.html
View File

@ -1,15 +0,0 @@
<a name="EN-US_TOPIC_0000001988911265"></a><a name="EN-US_TOPIC_0000001988911265"></a>
<h1 class="topictitle1">Permissions and Supported Actions</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="classic_vpn_0056.html">Introduction</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1002.html">API Reference - Classic VPN</a></div>
</div>
</div>

21
docs/vpn/api-ref/classic_vpn_0056.html
View File

@ -1,21 +0,0 @@
<a name="EN-US_TOPIC_0000001954032050"></a><a name="EN-US_TOPIC_0000001954032050"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p678596154011">You can use Identity and Access Management (IAM) for fine-grained permissions management of your VPN resources. If your account does not need individual IAM users, you can skip this section.</p>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p1178518611406">New IAM users do not have any permissions assigned by default. You need to first add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups and can perform specified operations on cloud services based on the permissions they have been assigned.</p>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p1878616610408">You can grant users permissions using and . Roles are provided by IAM to define service-based permissions that match users' job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_note214910487429"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p1149548164214">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p878613604015">An account has permissions to call all APIs. An IAM user under the account can call specific APIs only after being assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the VPN gateway list using an API, the user must be granted permissions that allow the <strong id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_b10443123711376">vpn:vpnGateways:list</strong> action.</p>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p19786860400"><strong id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_b17830163953713">Supported Actions</strong></p>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p167861769403">VPN provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_ul578619614010"><li id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_li137861610403">Permissions controlling the operations that users can perform</li><li id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_li11786867405">APIs called by policies</li><li id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_li6786156164013">Actions supported by policies. They are specific operations that are allowed or denied.</li><li id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_li87867664020">IAM or enterprise projects on which actions take effect. Policies that contain actions supporting both IAM and enterprise projects can be used and take effect in both IAM and Enterprise Management. Policies that contain actions supporting only IAM projects can be assigned to user groups and take effect only in IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. For details about the differences between IAM and enterprise management, see .</li></ul>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p157867615409">VPN supports the following actions that can be defined in custom policies:</p>
<p id="EN-US_TOPIC_0000001954032050__en-us_topic_0000001854281014_p278620613406">[Example] <a href="vpn_api_0013.html#EN-US_TOPIC_0000001807370456">VPN gateway</a>, including actions supported by VPN gateway APIs, such as the APIs for creating, querying, updating, and deleting VPN gateways.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="classic_vpn_0055.html">Permissions and Supported Actions</a></div>
</div>
</div>

BIN
docs/vpn/api-ref/figure/en-us_image_0000001594578277.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 19 KiB

23
docs/vpn/api-ref/vpn_api_0001.html
View File

@ -1,23 +0,0 @@
<a name="EN-US_TOPIC_0000001807370444"></a><a name="EN-US_TOPIC_0000001807370444"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="vpn_api_0002.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0003.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0004.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0005.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0006.html">Basic Concepts</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1001.html">API Reference - Enterprise Edition VPN</a></div>
</div>
</div>

13
docs/vpn/api-ref/vpn_api_0002.html
View File

@ -1,13 +0,0 @@
<a name="EN-US_TOPIC_0000001854169121"></a><a name="EN-US_TOPIC_0000001854169121"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001854169121__en-us_topic_0000001543673220_p3745430174616">A Virtual Private Network (VPN) establishes an encrypted, Internet-based communication tunnel between your network and a Virtual Private Cloud (VPC). By default, Elastic Cloud Servers (ECSs) in a VPC cannot communicate with devices in your on-premises data center or private network. To enable communication between them, you can enable a VPN.</p>
<p id="EN-US_TOPIC_0000001854169121__en-us_topic_0000001543673220_p6580184441615">This document describes how to use application programming interfaces (APIs) to perform operations on VPNs, such as creating, querying, deleting, and updating VPNs. For details about all supported operations, see <a href="vpn_api_0007.html#EN-US_TOPIC_0000001854089173">API Overview</a>.</p>
<p id="EN-US_TOPIC_0000001854169121__en-us_topic_0000001543673220_p1958054415163">If you plan to use APIs of the VPN service, ensure that you are familiar with concepts of VPN. </p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/vpn/api-ref/vpn_api_0003.html
View File

@ -1,11 +0,0 @@
<a name="EN-US_TOPIC_0000001854089169"></a><a name="EN-US_TOPIC_0000001854089169"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001854089169__en-us_topic_0000001594352989_p1886414824811">VPN supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/vpn/api-ref/vpn_api_0004.html
View File

@ -1,11 +0,0 @@
<a name="EN-US_TOPIC_0000001807530272"></a><a name="EN-US_TOPIC_0000001807530272"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001807530272__en-us_topic_0000001594472965_p1812118106110">An endpoint is the request address for calling an API. Endpoints vary according to services and regions.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0001.html">Before You Start</a></div>
</div>
</div>

12
docs/vpn/api-ref/vpn_api_0005.html
View File

@ -1,12 +0,0 @@
<a name="EN-US_TOPIC_0000001807370448"></a><a name="EN-US_TOPIC_0000001807370448"></a>
<h1 class="topictitle1">Constraints</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001807370448__en-us_topic_0000001594193213_p59051911205119">The number of VPN resources that you can create is determined by your quota. You can view or increase the quota.</p>
<p id="EN-US_TOPIC_0000001807370448__en-us_topic_0000001594193213_p990511118512">For more constraints, see description of each API.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0001.html">Before You Start</a></div>
</div>
</div>

41
docs/vpn/api-ref/vpn_api_0006.html
View File

@ -1,22 +1,35 @@
<a name="EN-US_TOPIC_0000001854169125"></a><a name="EN-US_TOPIC_0000001854169125"></a>
<a name="EN-US_TOPIC_0000002381767761"></a><a name="EN-US_TOPIC_0000002381767761"></a>
<h1 class="topictitle1">Basic Concepts</h1>
<div id="body8662426"><ul id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_ul1330484685417"><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li83041046185420">Account<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p15304154612543"><a name="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li83041046185420"></a><a name="en-us_topic_0000001594578261_li83041046185420"></a>An account is created upon successful registration. The account has full access permissions on all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, and using it to perform routine management is not recommended. Instead, you are advised to create Identity and Access Management (IAM) users and grant routine management permissions to the users.</p>
</li><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li23042046175413">User<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p1130424625414"><a name="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li23042046175413"></a><a name="en-us_topic_0000001594578261_li23042046175413"></a>You can use your account to create IAM users for routine management of specific cloud services. These users have their own identity credentials (such as passwords and access keys).</p>
<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p193041346195412">To view your account ID and IAM user ID, log in to the console, click your account in the upper right corner, and choose <span class="uicontrol" id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_uicontrol114011595133"><b>My Credentials</b></span>. The account name, username, and password will be required for API authentication.</p>
</li><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li13304124610540">Region<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p461694716413"><a name="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li13304124610540"></a><a name="en-us_topic_0000001594578261_li13304124610540"></a>Regions are divided based on geographical locations and network latency. Public services, such as ECS, Elastic Volume Service (EVS), Object Storage Service (OBS), VPC, Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region.</p>
<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p1342965510410">Regions are classified into universal regions and dedicated regions.</p>
<ul id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_ul1572619310512"><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li203791159945">A universal region provides universal cloud services for common tenants.</li><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li127658561949">A dedicated region provides specific services for specific tenants.</li></ul>
</li><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li11304184605419">Availability zone (AZ)<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p103041146155412"><a name="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li11304184605419"></a><a name="en-us_topic_0000001594578261_li11304184605419"></a>An AZ comprises one or more physical data centers equipped with independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Compute, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers, allowing you to build highly available systems across AZs.</p>
</li><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li47692591654">Project<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p18304124645414"><a name="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li47692591654"></a><a name="en-us_topic_0000001594578261_li47692591654"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then, you can assign users the permissions to access resources only in the specific subprojects.</p>
<div class="fignone" id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_fig12266818185713"><span class="figcap"><b>Figure 1 </b>Project isolation model</span><br><span><img id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_image1026611855716" src="figure/en-us_image_0000001594352997.png"></span></div>
<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p6304546175410">To view a project ID, log in to the console, click your account in the upper right corner, and choose <span class="uicontrol" id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_uicontrol20791223101320"><b>My Credentials</b></span>.</p>
</li><li id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li4304164612545">Enterprise project<p id="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_p103047464545"><a name="EN-US_TOPIC_0000001854169125__en-us_topic_0000001594578261_li4304164612545"></a><a name="en-us_topic_0000001594578261_li4304164612545"></a>Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources across multiple regions, and resources can be added to or removed from enterprise projects.</p>
<h1 class="topictitle1">Before You Start</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_section22271636145616"><h4 class="sectiontitle">Overview</h4><p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p4974114495616">A Virtual Private Network (VPN) establishes an encrypted, Internet-based communication tunnel between your network and a Virtual Private Cloud (VPC). By default, Elastic Cloud Servers (ECSs) in a VPC cannot communicate with devices in your on-premises data center or private network. To enable communication between them, you can enable a VPN. S2C VPN allows you to establish secure, reliable, and cost-effective encrypted connections between your on-premises network or data center and a virtual cloud network.</p>
</div>
<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p6580184441615">This document describes how to use application programming interfaces (APIs) to perform operations on VPNs, such as creating, querying, deleting, and updating VPNs. For details about all supported operations, see <a href="vpn_api_0007.html#EN-US_TOPIC_0000001854089173">API Overview</a>.</p>
<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p1958054415163">If you plan to use APIs of the VPN service, ensure that you are familiar with concepts of VPN. </p>
<div class="section" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_section1925101618427"><h4 class="sectiontitle">API Calling</h4><p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p1886414824811">VPN supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see <a href="vpn_api_0008.html#EN-US_TOPIC_0000001807530276">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_section161783854210"><h4 class="sectiontitle">Endpoints</h4><p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p1812118106110">An endpoint is the request address for calling an API. Endpoints vary according to services and regions.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_section15410313431"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p59051911205119">The number of VPN resources that you can create is determined by your quota. You can view or increase the quota.</p>
<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p990511118512">For more constraints, see description of each API.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_section14441315184316"><h4 class="sectiontitle">Basic Concepts</h4><ul id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_ul1753521383"><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li375052788">Account<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p15304154612543"><a name="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li375052788"></a><a name="en-us_topic_0000001594578261_li375052788"></a>An account is created upon successful registration. The account has full access permissions on all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, and using it to perform routine management is not recommended. Instead, you are advised to create Identity and Access Management (IAM) users and grant routine management permissions to the users.</p>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_ul1330484685417"><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li23042046175413">User<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p1130424625414"><a name="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li23042046175413"></a><a name="en-us_topic_0000001594578261_li23042046175413"></a>You can use your account to create IAM users for routine management of specific cloud services. These users have their own identity credentials (such as passwords and access keys).</p>
<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p193041346195412">To view your account ID and IAM user ID, log in to the console, click your account in the upper right corner, and choose <span class="uicontrol" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_uicontrol171801320194919"><b>My Credentials</b></span>. The account name, username, and password will be required for API authentication.</p>
</li><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li13304124610540">Region<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p461694716413"><a name="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li13304124610540"></a><a name="en-us_topic_0000001594578261_li13304124610540"></a>Regions are divided based on geographical locations and network latency. Public services, such as ECS, Elastic Volume Service (EVS), Object Storage Service (OBS), VPC, Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region.</p>
<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p1342965510410">Regions are classified into universal regions and dedicated regions.</p>
<ul id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_ul1572619310512"><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li203791159945">A universal region provides universal cloud services for common tenants.</li><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li127658561949">A dedicated region provides specific services for specific tenants.</li></ul>
</li><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li11304184605419">Availability zone (AZ)<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p103041146155412"><a name="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li11304184605419"></a><a name="en-us_topic_0000001594578261_li11304184605419"></a>An AZ comprises one or more physical data centers equipped with independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Compute, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers, allowing you to build highly available systems across AZs.</p>
</li><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li47692591654">Project<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p18304124645414"><a name="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li47692591654"></a><a name="en-us_topic_0000001594578261_li47692591654"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region. Users can be granted permissions to access all resources in a specific project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then, you can assign users the permissions to access resources only in the specific subprojects.</p>
<div class="fignone" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_fig12266818185713"><span class="figcap"><b>Figure 1 </b>Project isolation model</span><br><span><img id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_image1026611855716" src="figure/en-us_image_0000001594352997.png" width="NaN" height="NaN"></span></div>
<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p6304546175410">To view a project ID, log in to the console, click your account in the upper right corner, and choose <span class="uicontrol" id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_uicontrol7761616508"><b>My Credentials</b></span>.</p>
</li><li id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li4304164612545">Enterprise project<p id="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_p103047464545"><a name="EN-US_TOPIC_0000002381767761__en-us_topic_0000001594578261_li4304164612545"></a><a name="en-us_topic_0000001594578261_li4304164612545"></a>Enterprise projects group and manage resources across regions. Resources in different enterprise projects are logically isolated. An enterprise project can contain resources across multiple regions, and resources can be added to or removed from enterprise projects.</p>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0001.html">Before You Start</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_1001.html">API Reference - Enterprise Edition VPN</a></div>
</div>
</div>

32
docs/vpn/api-ref/vpn_api_0007.html
View File

@ -3,40 +3,44 @@
<h1 class="topictitle1">API Overview</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p209534481449"><a href="#EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_table394214474109">Table 1</a> lists the APIs provided by the VPN service. For details about API permissions, see <a href="vpn_api_0044.html#EN-US_TOPIC_0000001854169173">Permission Policies and Supported Actions</a>.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_table394214474109"></a><a name="en-us_topic_0000001543513472_table394214474109"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_table394214474109" frame="border" border="1" rules="all"><caption><b>Table 1 </b>VPN APIs</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row694294751011"><th align="left" class="cellrowborder" valign="top" width="27.36%" id="mcps1.3.2.2.3.1.1"><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p29421447141012">API Type</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_table394214474109"></a><a name="en-us_topic_0000001543513472_table394214474109"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_table394214474109" frame="border" border="1" rules="all"><caption><b>Table 1 </b>VPN APIs</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row694294751011"><th align="left" class="cellrowborder" colspan="2" valign="top" id="mcps1.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p55141336185717">API Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72.64%" id="mcps1.3.2.2.3.1.2"><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p179421647161014">Description</p>
<th align="left" class="cellrowborder" valign="top" id="mcps1.3.2.2.4.1.2"><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p179421647161014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row7413749132715"><td class="cellrowborder" valign="top" width="27.36%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p182711354102718"><a href="vpn_api_0013.html#EN-US_TOPIC_0000001807370456">VPN Gateway</a></p>
<tbody><tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row7413749132715"><td class="cellrowborder" rowspan="4" valign="top" width="11.5%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p14920167125816">S2C VPN APIs</p>
</td>
<td class="cellrowborder" valign="top" width="72.64%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p941344952713">APIs for creating, querying, updating, and deleting VPN gateways, and querying AZs of VPN gateways.</p>
<td class="cellrowborder" valign="top" width="21.32%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p182711354102718"><a href="vpn_api_0013.html#EN-US_TOPIC_0000001807370456">VPN Gateway</a></p>
</td>
<td class="cellrowborder" valign="top" width="67.17999999999999%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p941344952713">APIs for creating, querying, updating, and deleting S2C VPN gateways, and querying AZs of S2C VPN gateways.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row1942547171019"><td class="cellrowborder" valign="top" width="27.36%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p12942747131013"><a href="vpn_api_0020.html#EN-US_TOPIC_0000001854089189">Customer Gateway</a></p>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row1942547171019"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p12942747131013"><a href="vpn_api_0020.html#EN-US_TOPIC_0000001854089189">Customer Gateway</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.64%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p39421747111014">APIs for creating, querying, updating, and deleting customer gateways.</p>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p39421747111014">APIs for creating, querying, updating, and deleting customer gateways.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row794234751010"><td class="cellrowborder" valign="top" width="27.36%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p994394721010"><a href="vpn_api_0026.html#EN-US_TOPIC_0000001807370472">VPN Connection</a></p>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row794234751010"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p994394721010"><a href="vpn_api_0026.html#EN-US_TOPIC_0000001807370472">VPN Connection</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.64%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p11943547131015">APIs for creating, querying, updating, and deleting VPN connections.</p>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p11943547131015">APIs for creating, querying, updating, and deleting VPN connections.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row11943184781020"><td class="cellrowborder" valign="top" width="27.36%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p1494313478106"><a href="vpn_api_0032.html#EN-US_TOPIC_0000001854089201">VPN Connection Monitoring</a></p>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row11943184781020"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p1494313478106"><a href="vpn_api_0032.html#EN-US_TOPIC_0000001854089201">VPN Connection Monitor</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.64%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p1194394711014">APIs for creating, querying, and deleting VPN connection health checks.</p>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p1194394711014">APIs for creating, querying, and deleting VPN connection health checks.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row169436474106"><td class="cellrowborder" valign="top" width="27.36%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p1594344791019"><a href="vpn_api_0037.html#EN-US_TOPIC_0000001807530308">Quota</a></p>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row169436474106"><td class="cellrowborder" rowspan="2" valign="top" width="11.5%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p12792193195919">Public Service APIs</p>
</td>
<td class="cellrowborder" valign="top" width="72.64%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p6943647181016">API for querying quotas.</p>
<td class="cellrowborder" valign="top" width="21.32%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p1594344791019"><a href="vpn_api_0037.html#EN-US_TOPIC_0000001807530308">VPN Quota</a></p>
</td>
<td class="cellrowborder" valign="top" width="67.17999999999999%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p6943647181016">API for querying quotas.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row628118168509"><td class="cellrowborder" valign="top" width="27.36%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p10281161645013"><a href="vpn_api_0060.html#EN-US_TOPIC_0000001854169161">Tags</a></p>
<tr id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_row628118168509"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p10281161645013"><a href="vpn_api_0060.html#EN-US_TOPIC_0000001854169161">VPN Tag</a></p>
</td>
<td class="cellrowborder" valign="top" width="72.64%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p228141665019">APIs for querying tag information.</p>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089173__en-us_topic_0000001543513472_p228141665019">APIs for querying, adding, and deleting tags.</p>
</td>
</tr>
</tbody>

167
docs/vpn/api-ref/vpn_api_0009.html
View File

File diff suppressed because it is too large Load Diff

12
docs/vpn/api-ref/vpn_api_0010.html
View File

@ -9,7 +9,7 @@
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p7811113317112">A token is used to acquire temporary permissions. During API authentication using a token, the token is added to the request header to get permissions for calling the API. You can obtain a token by calling the API used to obtain a user token.</p>
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p118115336117">A cloud service can be deployed as either a project-level service or global service.</p>
<ul id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_ul14811153312119"><li id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_li8811123381112">For a project-level service, you need to obtain a project-level token by setting <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b208221657145812">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b138221857165812">project</strong>.</li><li id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_li1681118333117">For a global service, you need to obtain a global token by setting <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b5231174217215">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b723184211213">domain</strong>.</li></ul>
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p158111033141119">A project-level token is required for calling APIs of the VPN service. As such, set <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b041544616599">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b13416446185918">project</strong> when you call the API for obtaining a user token.</p>
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p158111033141119">A project-level token is required for calling APIs of the VPN service. As such, set <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b10947185283615">auth.scope</strong> in the request body to <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b8947052173612">project</strong> when you call the API for obtaining a user token.</p>
<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_screen13273815102419"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
@ -57,12 +57,16 @@
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p15934153242113">After obtaining a token, add the <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b156512520612">X-Auth-Token</strong> field specifying the token to the request header when calling other APIs. For example, when the token is <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b146281658128">ABCDEFJ...</strong>, add <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b56288571214">X-Auth-Token: ABCDEFJ...</strong> to the request header as follows:</p>
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p15934153242113">After obtaining a token, add the <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b156512520612">X-Auth-Token</strong> field specifying the token to the request header when calling other APIs. For example, when the token is <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b14339143959">ABCDEFG....</strong>, add <strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b933914433512">X-Auth-Token: ABCDEFG....</strong> to the request header as follows:</p>
<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_screen448826102316"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">POST</span><span class="w"> </span><span class="err">h</span><span class="kc">tt</span><span class="err">ps</span><span class="p">:</span><span class="c1">//iam.eu-de.otc.t-systems.com/v3/auth/tokens</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">POST</span><span class="w"> </span><span class="err">h</span><span class="kc">tt</span><span class="err">ps</span><span class="p">:</span><span class="c1">//iam.eu-de.otc.t-systems.com/v3/auth/tokens</span>
<span class="err">Co</span><span class="kc">ntent</span><span class="mi">-</span><span class="err">Type</span><span class="p">:</span><span class="w"> </span><span class="err">applica</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="err">/jso</span><span class="kc">n</span>
<span class="err">X</span><span class="mi">-</span><span class="err">Au</span><span class="kc">t</span><span class="err">h</span><span class="mi">-</span><span class="err">Toke</span><span class="kc">n</span><span class="p">:</span><span class="w"> </span><span class="err">ABCDEFJ....</span>
<span class="err">X</span><span class="mi">-</span><span class="err">Au</span><span class="kc">t</span><span class="err">h</span><span class="mi">-</span><span class="err">Toke</span><span class="kc">n</span><span class="p">:</span><span class="w"> </span><span class="err">ABCDEFG....</span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_p893413320212"><strong id="EN-US_TOPIC_0000001854169129__en-us_topic_0000001594352985_b20934732132118">AK/SK Authentication</strong></p>

69
docs/vpn/api-ref/vpn_api_0011.html
View File

@ -4,47 +4,42 @@
<div id="body8662426"><p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p56381426296"><strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b263872112913">Status Code</strong></p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p1463842162920">After sending a request, you can receive a response, including a status code, response header, and response body.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p16389262913">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a response. For more information, see <a href="vpn_api_0052.html#EN-US_TOPIC_0000001807370508">Status Codes</a>.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p176380272911">For example, if status code <strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b573918414020">201</strong> is returned after you call the API for obtaining a user token, the request is successful.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p176380272911">If status code 201 is returned after the API used to create an IAM user as an administrator is called, the request is successful.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p96384217292"><strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b563819292915">Response Header</strong></p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p1263814216291">Like a request, a response also has a header, for example, <strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b768715852313">Content-Type</strong>.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p663820202917"><a href="#EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_fig10238149134019">Figure 1</a> shows the response header for the API used to obtain a user token. The <strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b922211013015">x-subject-token</strong> field carries a user token. You can use this token to authenticate the calling of other APIs.</p>
<div class="fignone" id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_fig10238149134019"><a name="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_fig10238149134019"></a><a name="en-us_topic_0000001543673232_fig10238149134019"></a><span class="figcap"><b>Figure 1 </b>Response header for the API used to obtain a user token</span><br><span><img id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_image8840548519" src="figure/en-us_image_0000001594578277.png" title="Click to enlarge" class="imgResize"></span></div>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p663820202917">The response header shown in <a href="#EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_fig10238149134019">Figure 1</a> is returned for the API used to create an IAM user as an administrator.</p>
<div class="fignone" id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_fig10238149134019"><a name="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_fig10238149134019"></a><a name="en-us_topic_0000001543673232_fig10238149134019"></a><span class="figcap"><b>Figure 1 </b>Response header for the API used to create an IAM user as an administrator</span><br><span><img id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_image8840548519" src="figure/en-us_image_0000001594578277.png" height="223.44" width="523.6875" title="Click to enlarge" class="imgResize"></span></div>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p20697174513305"><strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b1024841323716">Response Body</strong></p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p269794514306">This part is optional. A response body is generally returned in a structured format (for example, JSON or XML), which is specified by <strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b01771811153918">Content-Type</strong> in the response header. It is used to transfer content other than the response header.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p1269712454305">The following is part of a response body for the API used to obtain a user token.</p>
<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_screen71528815314"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;token&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;expires_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2022-09-10T06:52:13.855000Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;methods&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;password&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;catalog&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;endpoints&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="err">......</span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p269794514306">The response body is optional. A response body is generally returned in a structured format (for example, JSON or XML), which is specified by <strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b01771811153918">Content-Type</strong> in the response header. It is used to transfer content other than the response header.</p>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p1269712454305">The following provides part of the response body returned for the API used to create an IAM user as an administrator.</p>
<pre class="screen" id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_screen78283613173">{
"user": {
"id": "c131886aec...",
"name": "IAMUser",
"description": "IAM User Description",
"areacode": "",
"phone": "",
"email": "***@***.com",
"status": null,
"enabled": true,
"pwd_status": false,
"access_mode": "default",
"is_domain_owner": false,
"xuser_id": "",
"xuser_type": "",
"password_expires_at": null,
"create_time": "2024-05-21T09:03:41.000000",
"domain_id": "d78cbac1..........",
"xdomain_id": "30086000........",
"xdomain_type": "",
"default_project_id": null
}
}</pre>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p6471132310">If an error occurs during API calling, an error code and an error message will be displayed. The following is an example of an error response body.</p>
<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_screen1321510482317"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;error_msg&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;The format of message is error&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;error_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;AS.0001&quot;</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
<pre class="screen" id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_screen122532509188">{
"error_msg": "Request body is invalid.",
"error_code": "IAM.0011"
}</pre>
<p id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_p178031137310"><strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b098819485452">error_code</strong> specifies an error code, and <strong id="EN-US_TOPIC_0000001854089177__en-us_topic_0000001543673232_b1298964813453">error_msg</strong> describes the error.</p>
</div>
<div>

8
docs/vpn/api-ref/vpn_api_0012.html
View File

@ -1,10 +1,10 @@
<a name="EN-US_TOPIC_0000001807530280"></a><a name="EN-US_TOPIC_0000001807530280"></a>
<h1 class="topictitle1">APIs of Enterprise Edition VPN</h1>
<h1 class="topictitle1">API</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="vpn_api_0013.html">VPN Gateway</a></strong><br>
<li class="ulchildlink"><strong><a href="vpn_api_0013.html">S2C VPN Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0020.html">Customer Gateway</a></strong><br>
</li>
@ -12,9 +12,9 @@
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0032.html">VPN Connection Monitoring</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0037.html">Quota</a></strong><br>
<li class="ulchildlink"><strong><a href="vpn_api_0037.html">VPN Quota</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0060.html">Tags</a></strong><br>
<li class="ulchildlink"><strong><a href="vpn_api_0060.html">VPN Tag</a></strong><br>
</li>
</ul>

6
docs/vpn/api-ref/vpn_api_0013.html
View File

@ -1,6 +1,6 @@
<a name="EN-US_TOPIC_0000001807370456"></a><a name="EN-US_TOPIC_0000001807370456"></a>
<h1 class="topictitle1">VPN Gateway</h1>
<h1 class="topictitle1">S2C VPN Gateway</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
@ -12,6 +12,8 @@
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0017.html">Updating a VPN Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0069.html">Changing the Specification of a Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0018.html">Deleting a VPN Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0019.html">Querying the AZs of VPN Gateways</a></strong><br>
@ -19,7 +21,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">APIs of Enterprise Edition VPN</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">API</a></div>
</div>
</div>

307
docs/vpn/api-ref/vpn_api_0014.html
View File

File diff suppressed because it is too large Load Diff

139
docs/vpn/api-ref/vpn_api_0015.html
View File

File diff suppressed because it is too large Load Diff

392
docs/vpn/api-ref/vpn_api_0016.html
View File

File diff suppressed because it is too large Load Diff

494
docs/vpn/api-ref/vpn_api_0017.html
View File

File diff suppressed because it is too large Load Diff

2
docs/vpn/api-ref/vpn_api_0018.html
View File

@ -57,7 +57,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0013.html">VPN Gateway</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0013.html">S2C VPN Gateway</a></div>
</div>
</div>

31
docs/vpn/api-ref/vpn_api_0019.html
View File

@ -137,27 +137,28 @@
</div>
</li><li id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_li10266184018544">Example response<pre class="screen" id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_screen678017232489">{
"availability_zones": {
"basic": {
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph16967115735318"> "vpc": ["eu-de-01", "eu-de-02"],</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph660114017530"> "basic": {</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph16967115735318"> "vpc": ["eu-de-01"],</span>
"er": []
},
"professional1": {
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph06316166518">,</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph865141675110"> "vpc": ["eu-de-01", "eu-de-02"],</span><span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph06551635118"></span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph366181625111"> "er": ["eu-de-01", "eu-de-02"]</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph865141675110"> "vpc": ["eu-de-01", "eu-de-02"],</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph366181625111"> "er": ["eu-de-01"]</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph838428434"> "er": ["az1"]</span>
},
"professional2": {
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph12503192185115"> "vpc": ["eu-de-01", "eu-de-02"],</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph950592118513"> "er": ["eu-de-01", "eu-de-02"]</span>
},
"Professional1-NonFixedIP": {
"vpc": [],
"er": []
},
"Professional2-NonFixedIP": {
"vpc": [],
"er": []
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph950592118513"> "er": ["eu-de-01"]</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph87191934104710"> "er": ["az1"]</span>
},
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph899119164417"> "Professional1-NonFixedIP": {</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph1765921612441"> "vpc": [],</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph9660101654419"> "er": []</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph1666141644417"> },</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph7662916114416"> "Professional2-NonFixedIP": {</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph196629164448"> "vpc": [],</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph10663216124414"> "er": []</span>
<span id="EN-US_TOPIC_0000001854089185__en-us_topic_0000001543354004_ph0118537184416"> },</span>
"gm": {
"vpc": [],
"er": []
@ -172,7 +173,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0013.html">VPN Gateway</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0013.html">S2C VPN Gateway</a></div>
</div>
</div>

2
docs/vpn/api-ref/vpn_api_0020.html
View File

@ -17,7 +17,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">APIs of Enterprise Edition VPN</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">API</a></div>
</div>
</div>

18
docs/vpn/api-ref/vpn_api_0021.html
View File

@ -79,7 +79,7 @@
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p96071726374">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul961219349376"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li186123345379">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1726815246612">Value range:<ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul55935513618"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li17883658563">ip</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li159311511767">fqdn (currently not supported)</li></ul>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul961219349376"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li186123345379">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1726815246612">Value range:<ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul55935513618"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li17883658563"><strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b143312164387">ip</strong>: The customer gateway is identified by an IP address.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li159311511767"><strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b1748984723813">fqdn</strong> (currently not supported): The customer gateway is identified by a full qualified domain name (FQDN).</li></ul>
</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1612113412376">The default value is <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b10904125910711">ip</strong>.</li></ul>
</td>
</tr>
@ -89,7 +89,7 @@
</td>
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1151317915389">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul28313114110"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li38311194114">Specifies the identifier of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li38311111412">The value is a string of 1 to 128 characters. When <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b1886650171620">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b886612014165">ip</strong>, the value is an IPv4 address in dotted decimal notation, for example, 192.168.45.7. When <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b5866305163">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b7867140161620">fqdn</strong>, the value is a string of characters that can contain uppercase letters, lowercase letters, digits, and special characters. Spaces and the following special characters are not supported: &amp; &lt; &gt; [ ] \ ?.</li></ul>
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul28313114110"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li38311194114">Specifies the identifier of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li38311111412">The value is a string of 1 to 128 characters. When <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b13333145612298">id_type</strong> is set to <strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b12333175620291">ip</strong>, the value is an IPv4 address in dotted decimal notation, for example, 192.168.45.7. </li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row10982311114417"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p19985141134410">bgp_asn</p>
@ -197,21 +197,21 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p1599714115446">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul4510103818305"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul4510103818305"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li156736439303">Specifies the ID of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row899515112444"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p11998111174414">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p20998611184415">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul4955105118115"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul4955105118115"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li7955551161115">Specifies the name of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row1767123085111"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p18721658125115">id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p2072358145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul151101711181511"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1511017115151">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li16110111131514">Value range:<ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul1811012111159"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li151102115157">ip</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1211071141518">fqdn (currently not supported)</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul151101711181511"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1511017115151">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li16110111131514">Value range:<ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul1811012111159"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li151102115157"><strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b121441012193912">ip</strong>: The customer gateway is identified by an IP address.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1211071141518"><strong id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_b1571073833918">fqdn</strong> (currently not supported): The customer gateway is identified by an FQDN.</li></ul>
</li></ul>
</td>
</tr>
@ -233,14 +233,14 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p16061216443">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul137621456192816"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li176281122918">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li6762125612819">The UTC time format is <em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i190407511133924">yyyy-MM-ddTHH:mm:ss.SSS+02:00</em>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul137621456192816"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li176281122918">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li6762125612819">The UTC time format is <em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i190407511133924">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row159951311134419"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p111181254416">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p14181213448">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul6106151392213"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li491725462212">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i927614370483">yyyy-MM-ddTHH:mm:ss.SSS+02:00</em>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_ul6106151392213"><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li491725462212">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_i188734431533924">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_row750811114379"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530292__en-us_topic_0000001594578249_p14785225145413">tags</p>
@ -286,8 +286,8 @@
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65000,
"created_at": "2024-06-25T13:19:37.335+02:00",
"updated_at": "2024-06-25T13:19:37.335+02:00"
"created_at": "2025-08-13T02:34:56.784574762Z",
"updated_at": "2025-08-13T02:34:56.784574762Z"
},
"request_id": "7e0383bf-a7fb-461b-a926-baa8a795bf1a"
}</pre>

21
docs/vpn/api-ref/vpn_api_0022.html
View File

@ -83,21 +83,21 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p591910250283">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul4510103818305"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul4510103818305"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li156736439303">Specifies the ID of a customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row12916152552813"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p1391952512818">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p391922552810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul4955105118115"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul4955105118115"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li7955551161115">Specifies the name of a customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row2098716504538"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p18721658125115">id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p2072358145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul192612345211"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li665012020497">Value range:<ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul1911816484918"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li236335984813">ip</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li122673135214">fqdn (currently not supported)</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul192612345211"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li665012020497">Value range:<ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul1911816484918"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li236335984813"><strong id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_b149224135533913">ip</strong>: The customer gateway is identified by an IP address.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li122673135214"><strong id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_b44922025184011">fqdn</strong> (currently not supported): The customer gateway is identified by an FQDN.</li></ul>
</li></ul>
</td>
</tr>
@ -119,14 +119,14 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p149220255281">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul513957142318"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li102171311102320">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1139167182311">The UTC time format is <em id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_i80808587533926">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul513957142318"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li102171311102320">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1139167182311">The UTC time format is <em id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_i19635987283167">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row20917102512813"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p3923122511285">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p8923202562810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul6106151392213"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li6217011202319">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_i209856832933926">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul6106151392213"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li6217011202319">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_i12579808883167">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_row27651616193811"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p14785225145413">tags</p>
@ -150,7 +150,7 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p112761132403">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul57421722105011"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li7742162205010">Specifies the IP address of the customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li574292217508">The value is an IPv4 address, for example, 10.***.***.21.<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p85381336165016"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li574292217508"></a><a name="en-us_topic_0000001594193229_li574292217508"></a>This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_ul57421722105011"><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li7742162205010">Specifies the IP address of the customer gateway.</li><li id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li574292217508">The value is an IPv4 address, for example, 10.111.222.21.<p id="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_p655423163520"><a name="EN-US_TOPIC_0000001807370468__en-us_topic_0000001594193229_li574292217508"></a><a name="en-us_topic_0000001594193229_li574292217508"></a>This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
</li></ul>
</td>
</tr>
@ -187,11 +187,14 @@
"customer_gateway": {
"id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
"name": "cgw-ba08",
"bgp_asn": 65000,
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65000,
"created_at": "2021-12-21T16:49:28.108Z",
"updated_at": "2021-12-21T16:49:28.108Z"
"created_at": "2025-08-13T02:38:05.09035Z",
"updated_at": "2025-08-13T02:38:05.09035Z"
"tags": [],
"route_mode": "bgp",
"ip": "10.***.***.21"
},
"request_id": "8111d315-5024-45c9-8ee3-5ef676edb0d1"
}</pre>

26
docs/vpn/api-ref/vpn_api_0023.html
View File

@ -121,21 +121,21 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p591910250283">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul4510103818305"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul4510103818305"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li156736439303">Specifies the ID of a customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row813342616288"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1391952512818">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p391922552810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul4955105118115"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul4955105118115"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7955551161115">Specifies the name of a customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row108151827195517"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p18721658125115">id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p2072358145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul192612345211"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li183961224204311">Value range:<ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul191973212436"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li2604152816439">ip</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li122673135214">fqdn (currently not supported)</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul192612345211"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li183961224204311">Value range:<ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul191973212436"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li2604152816439"><strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b94219400733914">ip</strong>: The customer gateway is identified by an IP address.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li122673135214"><strong id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_b77984447408">fqdn</strong> (currently not supported): The customer gateway is identified by an FQDN.</li></ul>
</li></ul>
</td>
</tr>
@ -157,14 +157,14 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p149220255281">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul133112028172316"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li13781131142310">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li153111528132315">The UTC time format is <em id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_i120956133733927">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul133112028172316"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li13781131142310">Specifies the time when the customer gateway is created.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li153111528132315">The UTC time format is <em id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_i9286047713169">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row1013412616288"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p3923122511285">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p8923202562810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul6106151392213"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7781631182313">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_i26456225933927">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul6106151392213"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7781631182313">Specifies the last update time.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li1277785732017">The UTC time format is <em id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_i15823573193169">yyyy-MM-ddTHH:mm:ss.SSSZ</em>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_row18723192919393"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p14785225145413">tags</p>
@ -188,7 +188,7 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p112761132403">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul57421722105011"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7742162205010">Specifies the IP address of the customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li574292217508">The value is an IPv4 address, for example, 10.***.***.21.<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p182991511105111"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li574292217508"></a><a name="en-us_topic_0000001543354000_li574292217508"></a>This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_ul57421722105011"><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li7742162205010">Specifies the IP address of the customer gateway.</li><li id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li574292217508">The value is an IPv4 address, for example, 10.111.222.21.<p id="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_p1733341551018"><a name="EN-US_TOPIC_0000001854169145__en-us_topic_0000001543354000_li574292217508"></a><a name="en-us_topic_0000001543354000_li574292217508"></a>This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended.</p>
</li></ul>
</td>
</tr>
@ -254,18 +254,22 @@
"id_type": "ip",
"id_value": "100.***.***.81",
"bgp_asn": 65588,
"created_at": "2022-11-28T07:36:24.923Z",
"updated_at": "2022-11-28T07:36:24.923Z"
"created_at": "2025-08-13T02:38:05.09035Z",
"updated_at": "2025-08-13T02:38:05.09035Z",
"tags": [],
"route_mode": "bgp",
"ip": "100.***.***.81"
}, {
"id": "312067bb-demo-a8df-va86-09dc941bbffc",
"name": "cgw-21a3",
"id_value": "123******456",
"created_at": "2022-11-28T06:25:01.937Z",
"updated_at": "2022-11-28T06:25:01.937Z"
"created_at": "2025-08-13T02:48:56.995988Z",
"updated_at": "2025-08-13T02:48:56.995988Z",
"tags": []
}],
"total_count": 2,
"page_info": {
"next_marker": "2022-11-28T06:25:01.937Z",
"next_marker": "2025-04-17T07:11:55.045Z",
"current_count": 2
},
"request_id": "82a108d9-0929-42e9-adb7-e146c04c587c"

13
docs/vpn/api-ref/vpn_api_0024.html
View File

@ -134,21 +134,21 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p591910250283">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4510103818305"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li156736439303">Specifies a customer gateway ID.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4510103818305"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li156736439303">Specifies the ID of a customer gateway.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1525265511233">The value is a UUID containing 36 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row197513253287"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p1391952512818">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p391922552810">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4955105118115"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li7955551161115">Specifies a customer gateway name. If no customer gateway name is specified, the system automatically generates one.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul4955105118115"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li7955551161115">Specifies the name of a customer gateway.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li1987916110130">The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_row2088992035714"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p18721658125115">id_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_p2072358145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul192612345211"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li122673135214">Value range:<ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul5641183054411"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li2604152816439">ip</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li59351785513">fqdn (currently not supported)</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul192612345211"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li2266317525">Specifies the identifier type of a customer gateway.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li122673135214">Value range:<ul id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_ul5641183054411"><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li2604152816439"><strong id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_b75396942633915">ip</strong>: The customer gateway is identified by an IP address.</li><li id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_li59351785513"><strong id="EN-US_TOPIC_0000001854089193__en-us_topic_0000001543513476_b632912235429">fqdn</strong> (currently not supported): The customer gateway is identified by an FQDN.</li></ul>
</li></ul>
</td>
</tr>
@ -220,11 +220,12 @@
"customer_gateway": {
"id": "03c0aa3d-demo-a8df-va86-9d82473765d4",
"name": "cgw-f846",
"bgp_asn": 65533,
"id_type": "ip",
"id_value": "10.***.***.21",
"bgp_asn": 65533,
"created_at": "2021-12-21T16:49:28.108Z",
"updated_at": "2021-12-21T16:49:28.108Z"
"created_at": "2025-08-13T02:38:05.09035Z",
"updated_at": "2025-08-13T02:58:44.30276Z",
"tags": []
},
"request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90"
}</pre>

6
docs/vpn/api-ref/vpn_api_0026.html
View File

@ -6,6 +6,8 @@
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="vpn_api_0027.html">Creating a VPN Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0150.html">Creating VPN Connections in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0028.html">Querying a Specified VPN Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0029.html">Querying the VPN Connection List</a></strong><br>
@ -14,10 +16,12 @@
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0031.html">Deleting a VPN Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0145.html">Querying VPN Connection Logs</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">APIs of Enterprise Edition VPN</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">API</a></div>
</div>
</div>

267
docs/vpn/api-ref/vpn_api_0027.html
View File

File diff suppressed because it is too large Load Diff

64
docs/vpn/api-ref/vpn_api_0028.html
View File

File diff suppressed because it is too large Load Diff

192
docs/vpn/api-ref/vpn_api_0029.html
View File

File diff suppressed because it is too large Load Diff

727
docs/vpn/api-ref/vpn_api_0030.html
View File

File diff suppressed because it is too large Load Diff

2
docs/vpn/api-ref/vpn_api_0032.html
View File

@ -15,7 +15,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">APIs of Enterprise Edition VPN</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">API</a></div>
</div>
</div>

6
docs/vpn/api-ref/vpn_api_0033.html
View File

@ -140,7 +140,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p1679314408558">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_ul1779344045519"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li27934401558">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1679314015515">The value can only be <strong id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_b8891143182219">gateway</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_ul1779344045519"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li27934401558">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li166301813354">Value range:<p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p16722919153914"><a name="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li166301813354"></a><a name="en-us_topic_0000001543513464_li166301813354"></a><strong id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_b18315962718">gateway</strong>: VPN gateway</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_row20831181216819"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p139822044124213">source_ip</p>
@ -161,7 +162,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p0983184417427">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_ul1178312588143"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li156188711153">The value can only be <strong id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_b105071354162215">icmp</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_ul1178312588143"><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li650610591618">Value range:<p id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_p1262841823914"><a name="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_li650610591618"></a><a name="en-us_topic_0000001543513464_li650610591618"></a><strong id="EN-US_TOPIC_0000001807530304__en-us_topic_0000001543513464_b61291488288">icmp</strong>: ICMP protocol</p>
</li></ul>
</td>
</tr>
</tbody>

6
docs/vpn/api-ref/vpn_api_0034.html
View File

@ -107,7 +107,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_p2463114011567">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_ul3463134016561"><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li946314045617">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li846374095617">The value can only be <strong id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_b15070192275">gateway</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_ul3463134016561"><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li946314045617">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li12209325113617">Value range:<p id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_p1462531013012"><a name="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li12209325113617"></a><a name="en-us_topic_0000001594472957_li12209325113617"></a><strong id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_b1746123054112">gateway</strong>: VPN gateway</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_row1033210592310"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_p139822044124213">source_ip</p>
@ -128,7 +129,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_p0983184417427">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_ul1178312588143"><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li156188711153">The value can only be <strong id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_b4429113412711">icmp</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_ul1178312588143"><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li10843201613818">Value range:<p id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_p04407219393"><a name="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_li10843201613818"></a><a name="en-us_topic_0000001594472957_li10843201613818"></a><strong id="EN-US_TOPIC_0000001807370480__en-us_topic_0000001594472957_b1585143604114">icmp</strong>: ICMP protocol</p>
</li></ul>
</td>
</tr>
</tbody>

6
docs/vpn/api-ref/vpn_api_0035.html
View File

@ -132,7 +132,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_p2463114011567">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_ul3463134016561"><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li946314045617">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li846374095617">The value can only be <strong id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_b197725245811228">gateway</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_ul3463134016561"><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li946314045617">Specifies the type of objects to be monitored.</li><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li846374095617">Value range:<p id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_p1510133274118"><a name="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li846374095617"></a><a name="en-us_topic_0000001543354020_li846374095617"></a><strong id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_b152127177635034">gateway</strong>: VPN gateway</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_row16603159438"><td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_p139822044124213">source_ip</p>
@ -153,7 +154,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_p0983184417427">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_ul1178312588143"><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li156188711153">The value can only be <strong id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_b183182022911232">icmp</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><ul id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_ul1178312588143"><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li1176782131516">Specifies the protocol used by NQA.</li><li id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li123838461986">Value range:<p id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_p44904360417"><a name="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_li123838461986"></a><a name="en-us_topic_0000001543354020_li123838461986"></a><strong id="EN-US_TOPIC_0000001854169157__en-us_topic_0000001543354020_b1343091332289">icmp</strong>: ICMP protocol</p>
</li></ul>
</td>
</tr>
</tbody>

4
docs/vpn/api-ref/vpn_api_0037.html
View File

@ -1,6 +1,6 @@
<a name="EN-US_TOPIC_0000001807530308"></a><a name="EN-US_TOPIC_0000001807530308"></a>
<h1 class="topictitle1">Quota</h1>
<h1 class="topictitle1">VPN Quota</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
@ -9,7 +9,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">APIs of Enterprise Edition VPN</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">API</a></div>
</div>
</div>

2
docs/vpn/api-ref/vpn_api_0038.html
View File

@ -144,7 +144,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0037.html">Quota</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0037.html">VPN Quota</a></div>
</div>
</div>

4
docs/vpn/api-ref/vpn_api_0039.html
View File

@ -4,11 +4,11 @@
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="vpn_api_0040.html">Example 1: Creating a VPN Gateway</a></strong><br>
<li class="ulchildlink"><strong><a href="vpn_api_0040.html">Example 1: Creating an S2C VPN Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0041.html">Example 2: Creating a Customer Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0042.html">Example 3: Creating a VPN Connection</a></strong><br>
<li class="ulchildlink"><strong><a href="vpn_api_0042.html">Example 3: Creating Dual VPN Connections</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0043.html">Example 4: Creating a VPN Connection Monitor</a></strong><br>
</li>

25
docs/vpn/api-ref/vpn_api_0040.html
View File

@ -1,10 +1,11 @@
<a name="EN-US_TOPIC_0000001854169169"></a><a name="EN-US_TOPIC_0000001854169169"></a>
<h1 class="topictitle1">Example 1: Creating a VPN Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_section12746625155310"><h4 class="sectiontitle">Scenario</h4><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p0579103005312">This section describes how to create a VPN gateway by calling APIs.</p>
<h1 class="topictitle1">Example 1: Creating an S2C VPN Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_section12746625155310"><h4 class="sectiontitle">Scenario</h4><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p0579103005312">This section describes how to create an S2C VPN gateway by calling an API.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_section18485140165314"><h4 class="sectiontitle">Prerequisites</h4><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p8881251215">You have determined the region where the VPN gateway is to be deployed and obtained the endpoint for calling APIs based on the region.</p>
<p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p1288759216">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_b360110227418">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_i174359341834">Virtual Private Cloud API Reference</em>.</p>
<div class="section" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_section18485140165314"><h4 class="sectiontitle">Prerequisites</h4><ul id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ul193138175126"><li id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_li231316175124">You have determined the region where the VPN gateway is to be deployed and obtained the endpoint for calling APIs based on the region.</li><li id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_li2313121751215">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_b360110227418">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_i150548161210">Virtual Private Cloud API Reference</em>.</li></ul>
<div class="note" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_note1214720291548"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p83099302416">The token obtained through IAM is valid for only 24 hours. When using a token for authentication, cache it to avoid frequent calling.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_section56198192543"><h4 class="sectiontitle">Data Preparation</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_table444111294349" width="100%" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Key parameters in the request for creating a VPN gateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_row3459182917345"><th align="left" class="cellrowborder" valign="top" width="21.68%" id="mcps1.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p194595291340">Parameter</p>
@ -24,7 +25,7 @@
</tr>
<tr id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_row337514017345"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p18375840133418">local_subnets</p>
</td>
<td class="cellrowborder" valign="top" width="35.9%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p83751440153410">Specifies a local subnet.</p>
<td class="cellrowborder" valign="top" width="35.9%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p83751440153410">Specifies the local CIDR block.</p>
</td>
<td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_p1337564019342">192.168.0.0/24,192.168.1.0/24</p>
</td>
@ -123,7 +124,7 @@
"bgp_asn": 64512,
"flavor": "Professional1",
"availability_zone_ids": [
<span id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ph1114415436191"> "eu-de-01", "eu-de-02"</span>
<span id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ph1944015197817"> "eu-de-01", "eu-de-02"</span>
],
"used_connection_number": 0,
"used_connection_group": 0,
@ -133,8 +134,8 @@
"ip_version": 4,
"type": "5_bgp",
"ip_address": "88.***.***.8",
<span id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ph5400104664219"> "charge_mode": "traffic",</span>
"bandwidth_id": "593a1a79-demo-a8df-va86-64ec45fb23f6",
"charge_mode": "bandwidth",
<span id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ph1766273164111"> "bandwidth_id": "593a1a79-demo-a8df-va86-64ec45fb23f6",</span>
"bandwidth_size": 300,
"bandwidth_name": "vpngw-bandwidth-1391"
},
@ -143,13 +144,13 @@
"ip_version": 4,
"type": "5_bgp",
"ip_address": "88.***.***.6",
<span id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ph1041919111437"> "charge_mode": "traffic",</span>
"bandwidth_id": "0abb9d55-demo-a8df-va86-b7500ac2a338",
"charge_mode": "bandwidth",
<span id="EN-US_TOPIC_0000001854169169__en-us_topic_0000001543673208_ph1655612108413"> "bandwidth_id": "0abb9d55-demo-a8df-va86-b7500ac2a338",</span>
"bandwidth_size": 300,
"bandwidth_name": "vpngw-bandwidth-1392"
},
"created_at": "2022-09-15T08:56:09.386Z",
"updated_at": "2022-09-15T11:13:13.677Z"
"created_at": "2025-06-15T08:56:09.386Z",
"updated_at": "2022-06-15T11:13:13.677Z"
},
"request_id": "d099a7dc-ea71-45a6-a75b-dccbfe17d438"
} </pre>

23
docs/vpn/api-ref/vpn_api_0041.html
View File

@ -3,7 +3,9 @@
<h1 class="topictitle1">Example 2: Creating a Customer Gateway</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section827723815517"><h4 class="sectiontitle">Scenario</h4><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p17518164418559">This section describes how to create a customer gateway by calling APIs.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section3353257135516"><h4 class="sectiontitle">Prerequisites</h4><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p66733617566">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b34353317280">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_i369318443319">Virtual Private Cloud API Reference</em>.</p>
<div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section3353257135516"><h4 class="sectiontitle">Prerequisites</h4><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p66733617566">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_b34353317280">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_i202267355586">Virtual Private Cloud API Reference</em>.</p>
<div class="note" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_note172319593487"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p72315912489">The token obtained through IAM is valid for only 24 hours. When using a token for authentication, cache it to avoid frequent calling.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_section96477188567"><h4 class="sectiontitle">Data Preparation</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_table444111294349" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Key parameters in the request for creating a customer gateway</caption><thead align="left"><tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row3459182917345"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p194595291340">Parameter</p>
@ -21,16 +23,9 @@
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p645910291347">stub-customer-gateway-id-1</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row983893718349"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p12677338484">route_mode</p>
<tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row337514017345"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p18375840133418">id_value</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p1283814373343">Specifies the gateway routing mode.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p5838133711347">static</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_row337514017345"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p18375840133418">ip</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p83751440153410">Specifies the IP address of the customer gateway.</p>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p1683151144111">Specifies the identifier of a customer gateway.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001854089217__en-us_topic_0000001543354012_p1337564019342">10.12.13.21</p>
</td>
@ -62,8 +57,8 @@
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cgw-3ebf&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ip&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;10.***.***.21&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335+02:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335+02:00&quot;</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-07-17T16:49:28.108+08:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-07-17T16:49:28.108+08:00&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;request_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;e55783ba-5cc8-40c1-ad81-12cce6f773d2&quot;</span>
<span class="p">}</span>
@ -87,8 +82,8 @@
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cgw-3ebf&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ip&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;id_value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;10.***.***.21&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-06-25T13:19:37.335Z&quot;</span>
<span class="w"> </span><span class="nt">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-07-17T16:49:28.108+08:00&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2025-07-17T16:49:28.108+08:00&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;request_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;8cf476c4-c3d4-4516-bfbc-01e2473e549b&quot;</span>
<span class="p">}</span>

264
docs/vpn/api-ref/vpn_api_0042.html
View File

File diff suppressed because it is too large Load Diff

6
docs/vpn/api-ref/vpn_api_0043.html
View File

@ -4,7 +4,9 @@
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_section3366124216585"><h4 class="sectiontitle">Scenario</h4><p id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_p1525144825813">This section describes how to create a VPN connection monitor by calling APIs.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_section58820918592"><h4 class="sectiontitle">Prerequisites</h4><ul id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ul148861650152820"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li10886165012816">You have created a VPN connection. For details, see <a href="vpn_api_0027.html#EN-US_TOPIC_0000001854169149">Creating a VPN Connection</a>.</li></ul>
<ul id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ul124612035154812"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li184618358484">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b134700942803336">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_i1713818812418">Virtual Private Cloud API Reference</em>.</li></ul>
<ul id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ul124612035154812"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li184618358484">You have obtained a user token if you need to use token authentication. In addition, you need to add <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b134700942803336">X-Auth-Token</strong> to the request header when calling an API. For details about token authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_i11756192145919">Virtual Private Cloud API Reference</em>.<div class="note" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_note172319593487"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_p72315912489">The token obtained through IAM is valid for only 24 hours. When using a token for authentication, cache it to avoid frequent calling.</p>
</div></div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_section4141642175915"><h4 class="sectiontitle">Data Preparation</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_table444111294349" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Key parameters in the request for creating a VPN connection monitor</caption><thead align="left"><tr id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_row3459182917345"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_p194595291340">Parameter</p>
@ -44,7 +46,7 @@
}</pre>
</li></ul>
</li></ol>
</li><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li1355101465012">Query details about the VPN connection monitor.<ol type="a" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ol95722017111819"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li557281720184">Send <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b2770149327">GET https://{endpoint}/v5/{project_id}/connection-monitors/{connection_monitor_id}</strong>.</li><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li1457214173183">Add <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b679343160515">X-Auth-Token</strong> to the request header.</li><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li15572717141815">Check the response.<ul id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ul1057214178189"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li155727173189">The request is successful if the following response is displayed. In the response, <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b692809169">id</strong> indicates the ID of a VPN connection monitor.<pre class="screen" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_screen17982737153017">{
</li><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li1355101465012">Query details about the VPN connection monitor.<ol type="a" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ol95722017111819"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li557281720184">Send <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b2770149327">GET https://{endpoint}/v5/{project_id}/connection-monitors/{connection_monitor_id}</strong>.</li><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li1457214173183">Add <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b679343160515">X-Auth-Token</strong> to the request header.</li><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li15572717141815">Check the response.<ul id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_ul1057214178189"><li id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_li155727173189">The request is successful if the following response is displayed. In the response, <strong id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_b42468210">id</strong> indicates the ID of a VPN connection monitor.<pre class="screen" id="EN-US_TOPIC_0000001807370496__en-us_topic_0000001594472941_screen17982737153017">{
"connection_monitor": {
"id": "76f64229-demo-a8df-va86-3907e2815b6d",
"status": "ACTIVE",

4
docs/vpn/api-ref/vpn_api_0044.html
View File

@ -4,9 +4,7 @@
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="vpn_api_0045.html">Introduction</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0114.html">Actions Supported by Enterprise Edition VPN</a></strong><br>
<li class="ulchildlink"><strong><a href="vpn_api_0114.html">Actions Supported by S2C VPN</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="vpn_api_0124.html">Actions Supported by Public Service APIs</a></strong><br>
</li>

21
docs/vpn/api-ref/vpn_api_0045.html
View File

@ -1,21 +0,0 @@
<a name="EN-US_TOPIC_0000001854089221"></a><a name="EN-US_TOPIC_0000001854089221"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p678596154011">You can use Identity and Access Management (IAM) for fine-grained permissions management of your VPN resources. If your account does not need individual IAM users, you can skip this section.</p>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p1178518611406">New IAM users do not have any permissions assigned by default. You need to first add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups and can perform specified operations on cloud services based on the permissions they have been assigned.</p>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p1878616610408">You can grant users permissions using and . Roles are provided by IAM to define service-based permissions that match users' job responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_note214910487429"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p1149548164214">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p878613604015">An account has permissions to call all APIs. An IAM user under the account can call specific APIs only after being assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the VPN gateway list using an API, the user must be granted permissions that allow the <strong id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_b39443624811">vpn:vpnGateways:list</strong> action.</p>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p19786860400"><strong id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_b154210248490">Supported Actions</strong></p>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p167861769403">VPN provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_ul578619614010"><li id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_li137861610403">Permissions controlling the operations that users can perform</li><li id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_li11786867405">APIs called by policies</li><li id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_li6786156164013">Actions supported by policies. They are specific operations that are allowed or denied.</li><li id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_li87867664020">IAM or enterprise projects on which actions take effect. Policies that contain actions supporting both IAM and enterprise projects can be used and take effect in both IAM and Enterprise Management. Policies that contain actions supporting only IAM projects can be assigned to user groups and take effect only in IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. For details about the differences between IAM and enterprise management, see .</li></ul>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p157867615409">VPN supports the following actions that can be defined in custom policies:</p>
<p id="EN-US_TOPIC_0000001854089221__en-us_topic_0000001594472961_p278620613406">[Example] <a href="vpn_api_0013.html#EN-US_TOPIC_0000001807370456">VPN gateway</a>, including actions supported by VPN gateway APIs, such as the APIs for creating, querying, updating, and deleting VPN gateways.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0044.html">Permissions and Supported Actions</a></div>
</div>
</div>

2
docs/vpn/api-ref/vpn_api_0051.html
View File

@ -5,7 +5,7 @@
<ul id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_ul09692025141815"><li id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_li596920254183">Obtaining the project ID by calling an API</li><li id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_li796992513186">Obtaining the project ID from the console</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_section06336312013"><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_p199691525171815">You can obtain the project ID by calling the API used to query project information.</p>
<p id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_p1096920253180">The API for obtaining the project ID is <strong id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_b178622548153">GET https://{<em id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_i7102141961620">IAM endpoint</em>}/v3/projects</strong>. For details about API authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_i4476234511">Virtual Private Cloud API Reference</em>.</p>
<p id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_p1096920253180">The API for obtaining the project ID is <strong id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_b1713620549466">GET https://{<em id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_i413510541469">IAM endpoint</em>}/v3/projects</strong>. For details about API authentication, see "Authentication" in the <em id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_i82221744111716">Virtual Private Cloud API Reference</em>.</p>
<p id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_p12969172512182">The following is an example response. The value of <strong id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_b68401819121710">id</strong> is the project ID.</p>
<div class="codecoloring" codetype="Json" id="EN-US_TOPIC_0000001807530332__en-us_topic_0000001543673224_screen18473105171910"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>

4
docs/vpn/api-ref/vpn_api_0060.html
View File

@ -1,6 +1,6 @@
<a name="EN-US_TOPIC_0000001854169161"></a><a name="EN-US_TOPIC_0000001854169161"></a>
<h1 class="topictitle1">Tags</h1>
<h1 class="topictitle1">VPN Tag</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
@ -19,7 +19,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">APIs of Enterprise Edition VPN</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0012.html">API</a></div>
</div>
</div>

7
docs/vpn/api-ref/vpn_api_0061.html
View File

@ -32,7 +32,10 @@
</td>
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p152315585286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul93453614117"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li43451661818">Specifies the resource type.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li16527151316115">The value can be <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b27561481476">vpn-gateway</strong>, <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b19340165104712">customer-gateway</strong>, or <strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b94701953194718">vpn-connection</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_ul93453614117"><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li43451661818">Specifies the resource type.</li><li id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li4124054913">Value range:<p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p134972209495"><a name="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_li4124054913"></a><a name="en-us_topic_0000001759396186_li4124054913"></a><strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b818212511512">vpn-gateway</strong>: S2C VPN gateway</p>
<p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1914412317505"><strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b2169165635113">customer-gateway</strong>: customer gateway</p>
<p id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_p1350331015507"><strong id="EN-US_TOPIC_0000001854089209__en-us_topic_0000001759396186_b49641615218">vpn-connection</strong>: VPN connection</p>
</li></ul>
</td>
</tr>
</tbody>
@ -312,7 +315,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0060.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0060.html">VPN Tag</a></div>
</div>
</div>

7
docs/vpn/api-ref/vpn_api_0062.html
View File

@ -32,7 +32,10 @@
</td>
<td class="cellrowborder" valign="top" width="11.798820117988202%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_p152315585286">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_ul93453614117"><li id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_li43451661818">Specifies the resource type.</li><li id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_li16527151316115">The value can be <strong id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_b203145399864757">vpn-gateway</strong>, <strong id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_b159073629364757">customer-gateway</strong>, or <strong id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_b82568073764757">vpn-connection</strong>.</li></ul>
<td class="cellrowborder" valign="top" width="48.555144485551445%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_ul93453614117"><li id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_li43451661818">Specifies the resource type.</li><li id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_li17252615155316">Value range:<p id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_p134972209495"><a name="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_li17252615155316"></a><a name="en-us_topic_0000001759791750_li17252615155316"></a><strong id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_b151226166435153">vpn-gateway</strong>: S2C VPN gateway</p>
<p id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_p1914412317505"><strong id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_b11065671613525">customer-gateway</strong>: customer gateway</p>
<p id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_p1350331015507"><strong id="EN-US_TOPIC_0000001807530312__en-us_topic_0000001759791750_b6539038993529">vpn-connection</strong>: VPN connection</p>
</li></ul>
</td>
</tr>
</tbody>
@ -200,7 +203,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0060.html">Tags</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpn_api_0060.html">VPN Tag</a></div>
</div>
</div>

Some files were not shown because too many files have changed in this diff Show More