diff --git a/docs/vpn/api-ref/.placeholder b/docs/vpn/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/vpn/api-ref/ALL_META.TXT.json b/docs/vpn/api-ref/ALL_META.TXT.json index c6e5863b..634f66ba 100644 --- a/docs/vpn/api-ref/ALL_META.TXT.json +++ b/docs/vpn/api-ref/ALL_META.TXT.json @@ -1,492 +1,2228 @@ [ { - "uri":"en_topic_0093011471.html", + "dockw":"API Reference" + }, + { + "uri":"vpn_api_1001.html", + "node_id":"en-us_topic_0000001854089165.xml", "product_code":"vpn", "code":"1", - "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"API Usage Guidelines,API Reference", - "title":"API Usage Guidelines", + "kw":"API Reference - Enterprise Edition VPN", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API Reference - Enterprise Edition VPN", "githuburl":"" }, { - "uri":"en_topic_0093011472.html", + "uri":"vpn_api_0001.html", + "node_id":"en-us_topic_0000001807370444.xml", "product_code":"vpn", "code":"2", - "des":"VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.A combination of these two types of APIs allows you to use all functions provided by the ", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"API Overview,API Reference", + "kw":"Before You Start", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"vpn_api_0002.html", + "node_id":"en-us_topic_0000001854169121.xml", + "product_code":"vpn", + "code":"3", + "des":"A Virtual Private Network (VPN) establishes an encrypted, Internet-based communication tunnel between your network and a Virtual Private Cloud (VPC). By default, Elastic ", + "doc_type":"api", + "kw":"Overview,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Overview", + "githuburl":"" + }, + { + "uri":"vpn_api_0003.html", + "node_id":"en-us_topic_0000001854089169.xml", + "product_code":"vpn", + "code":"4", + "des":"VPN supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see Calling APIs.", + "doc_type":"api", + "kw":"API Calling,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"vpn_api_0004.html", + "node_id":"en-us_topic_0000001807530272.xml", + "product_code":"vpn", + "code":"5", + "des":"An endpoint is the request address for calling an API. Endpoints vary according to services and regions.", + "doc_type":"api", + "kw":"Endpoints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Endpoints", + "githuburl":"" + }, + { + "uri":"vpn_api_0005.html", + "node_id":"en-us_topic_0000001807370448.xml", + "product_code":"vpn", + "code":"6", + "des":"The number of VPN resources that you can create is determined by your quota. You can view or increase the quota.For more constraints, see description of each API.", + "doc_type":"api", + "kw":"Constraints,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"vpn_api_0006.html", + "node_id":"en-us_topic_0000001854169125.xml", + "product_code":"vpn", + "code":"7", + "des":"AccountAn 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 use", + "doc_type":"api", + "kw":"Basic Concepts,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Basic Concepts", + "githuburl":"" + }, + { + "uri":"vpn_api_0007.html", + "node_id":"en-us_topic_0000001854089173.xml", + "product_code":"vpn", + "code":"8", + "des":"Table 1 lists the APIs provided by the VPN service. For details about API permissions, see Permission Policies and Supported Actions.", + "doc_type":"api", + "kw":"API Overview,API Reference - Enterprise Edition VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], "title":"API Overview", "githuburl":"" }, { - "uri":"en_topic_0093011479.html", - "product_code":"vpn", - "code":"3", - "des":"The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the s", - "doc_type":"api", - "kw":"VPN API Usage Instructions,API Reference", - "title":"VPN API Usage Instructions", - "githuburl":"" - }, - { - "uri":"en_topic_0093011480.html", - "product_code":"vpn", - "code":"4", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"API", - "title":"API", - "githuburl":"" - }, - { - "uri":"en_topic_0093011481.html", - "product_code":"vpn", - "code":"5", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"API Version Information", - "title":"API Version Information", - "githuburl":"" - }, - { - "uri":"en_topic_0093011482.html", - "product_code":"vpn", - "code":"6", - "des":"This API is used to query all available versions of a native OpenStack API.GETRequest parameterNoneExample requestResponse parameterExample responseSee Status Codes.See E", - "doc_type":"api", - "kw":"Querying API Versions,API Version Information,API Reference", - "title":"Querying API Versions", - "githuburl":"" - }, - { - "uri":"en_topic_0093011483.html", - "product_code":"vpn", - "code":"7", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"api", - "kw":"Tag Management", - "title":"Tag Management", - "githuburl":"" - }, - { - "uri":"en_topic_0093011484.html", - "product_code":"vpn", - "code":"8", - "des":"This interface is used to query VPN resource instances by tag.Tag Management Service (TMS) uses this API to filter out service resources and display them in a list. These", - "doc_type":"api", - "kw":"Querying VPN Resource Instances by Tag,Tag Management,API Reference", - "title":"Querying VPN Resource Instances by Tag", - "githuburl":"" - }, - { - "uri":"en_topic_0093011485.html", + "uri":"vpn_api_0008.html", + "node_id":"en-us_topic_0000001807530276.xml", "product_code":"vpn", "code":"9", - "des":"This interface is used to add multiple tags to or delete multiple tags from a VPN resource instance at a time.This API is idempotent.If there are duplicate keys in the re", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Batch Creating or Deleting VPN Resource Tags,Tag Management,API Reference", - "title":"Batch Creating or Deleting VPN Resource Tags", + "kw":"Calling APIs", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Calling APIs", "githuburl":"" }, { - "uri":"en_topic_0093011486.html", + "uri":"vpn_api_0009.html", + "node_id":"en-us_topic_0000001807370452.xml", "product_code":"vpn", "code":"10", - "des":"This interface is used to create a tag for a VPN resource.POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_idindicates the project ID,", + "des":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ", "doc_type":"api", - "kw":"Creating a Tag for a VPN Resource,Tag Management,API Reference", - "title":"Creating a Tag for a VPN Resource", + "kw":"Request,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Request", "githuburl":"" }, { - "uri":"en_topic_0093011487.html", + "uri":"vpn_api_0010.html", + "node_id":"en-us_topic_0000001854169129.xml", "product_code":"vpn", "code":"11", - "des":"This interface is used to query tags of a specified VPN resource.GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_idindicates the proje", + "des":"Requests for calling an API can be authenticated using either of the following methods:Token authentication: Requests are authenticated using tokens.AK/SK authentication:", "doc_type":"api", - "kw":"Querying VPN Resource Tags,Tag Management,API Reference", - "title":"Querying VPN Resource Tags", + "kw":"Authentication,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Authentication", "githuburl":"" }, { - "uri":"en_topic_0093011488.html", + "uri":"vpn_api_0011.html", + "node_id":"en-us_topic_0000001854089177.xml", "product_code":"vpn", "code":"12", - "des":"This interface is used to delete a VPN resource tag.DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}In the URI, project_idindicates the project I", + "des":"Status CodeAfter sending a request, you can receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging fr", "doc_type":"api", - "kw":"Deleting a VPN Resource Tag,Tag Management,API Reference", - "title":"Deleting a VPN Resource Tag", + "kw":"Response,Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Response", "githuburl":"" }, { - "uri":"en_topic_0093011489.html", + "uri":"vpn_api_0012.html", + "node_id":"en-us_topic_0000001807530280.xml", "product_code":"vpn", "code":"13", - "des":"This interface is used to query all tags of a VPN in a specified region.GET /v2.0/{project_id}/ipsec-site-connections/tagsIn the URI, project_idindicates the project ID.N", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Querying VPN Tags in a Specified Project,Tag Management,API Reference", - "title":"Querying VPN Tags in a Specified Project", + "kw":"APIs of Enterprise Edition VPN", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"APIs of Enterprise Edition VPN", "githuburl":"" }, { - "uri":"en_topic_0093011490.html", + "uri":"vpn_api_0013.html", + "node_id":"en-us_topic_0000001807370456.xml", "product_code":"vpn", "code":"14", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Native OpenStack APIs", - "title":"Native OpenStack APIs", + "kw":"VPN Gateway", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011491.html", + "uri":"vpn_api_0014.html", + "node_id":"en-us_topic_0000001854169133.xml", "product_code":"vpn", "code":"15", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"This API is used to create a VPN gateway.For details, see Calling APIs.POST /v5/{project_id}/vpn-gatewaysParameter descriptionParameterTypeMandatoryDescriptionproject_idS", "doc_type":"api", - "kw":"IPsec Connection Management", - "title":"IPsec Connection Management", + "kw":"Creating a VPN Gateway,VPN Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating a VPN Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011492.html", + "uri":"vpn_api_0015.html", + "node_id":"en-us_topic_0000001854089181.xml", "product_code":"vpn", "code":"16", - "des":"This interface is used to create an IPsec VPN connection.POST /v2.0/vpn/ipsec-site-connectionsTable 1 lists the request parameters for creating an IPsec site connection.T", + "des":"This API is used to query a VPN gateway with a specified gateway ID.For details, see Calling APIs.GET /v5/{project_id}/vpn-gateways/{vgw_id}Request parametersNoneNoneExam", "doc_type":"api", - "kw":"Creating an IPsec VPN Connection,IPsec Connection Management,API Reference", - "title":"Creating an IPsec VPN Connection", + "kw":"Querying a Specified VPN Gateway,VPN Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying a Specified VPN Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011493.html", + "uri":"vpn_api_0016.html", + "node_id":"en-us_topic_0000001807530284.xml", "product_code":"vpn", "code":"17", - "des":"This interface is used to query details about an IPsec VPN connection.GET /v2.0/vpn/ipsec-site-connections/{connection_id}NoneTable 2 describes the response parameters.Ex", + "des":"This API is used to query the VPN gateway list.For details, see Calling APIs.GET /v5/{project_id}/vpn-gatewaysRequest parametersNoneNoneExample requestsQuery all VPN gate", "doc_type":"api", - "kw":"Querying Details About an IPsec VPN Connection,IPsec Connection Management,API Reference", - "title":"Querying Details About an IPsec VPN Connection", + "kw":"Querying the VPN Gateway List,VPN Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the VPN Gateway List", "githuburl":"" }, { - "uri":"en_topic_0093011494.html", + "uri":"vpn_api_0017.html", + "node_id":"en-us_topic_0000001807370460.xml", "product_code":"vpn", "code":"18", - "des":"This interface is used to query IPsec VPN connections.GET /v2.0/vpn/ipsec-site-connectionsTable 1 describes the request parameters.The project_id, peer_id, dpd, and local", + "des":"This API is used to update a VPN gateway with a specified gateway ID.For details, see Calling APIs.PUT /v5/{project_id}/vpn-gateways/{vgw_id}Request parametersRequest par", "doc_type":"api", - "kw":"Querying IPsec VPN Connections,IPsec Connection Management,API Reference", - "title":"Querying IPsec VPN Connections", + "kw":"Updating a VPN Gateway,VPN Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating a VPN Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011495.html", + "uri":"vpn_api_0018.html", + "node_id":"en-us_topic_0000001854169137.xml", "product_code":"vpn", "code":"19", - "des":"This interface is used to update an IPsec VPN connection.PUT /v2.0/vpn/ipsec-site-connections/{connection_id}Table 2 describes the request parameters.The project_id, peer", + "des":"This API is used to delete a VPN gateway with a specified gateway ID.For details, see Calling APIs.DELETE /v5/{project_id}/vpn-gateways/{vgw_id}Request parametersNoneNone", "doc_type":"api", - "kw":"Updating an IPsec VPN Connection,IPsec Connection Management,API Reference", - "title":"Updating an IPsec VPN Connection", + "kw":"Deleting a VPN Gateway,VPN Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting a VPN Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011496.html", + "uri":"vpn_api_0019.html", + "node_id":"en-us_topic_0000001854089185.xml", "product_code":"vpn", "code":"20", - "des":"This interface is used to delete an IPsec VPN connection.DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}NoneNoneExample RequestDELETE /v2.0/vpn/ipsec-site-connect", + "des":"This API is used to query the AZs of VPN gateways.For details, see Calling APIs.GET /v5/{project_id}/vpn-gateways/availability-zonesRequest parametersNoneNoneExample requ", "doc_type":"api", - "kw":"Deleting an IPsec VPN Connection,IPsec Connection Management,API Reference", - "title":"Deleting an IPsec VPN Connection", + "kw":"Querying the AZs of VPN Gateways,VPN Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the AZs of VPN Gateways", "githuburl":"" }, { - "uri":"en_topic_0093011497.html", + "uri":"vpn_api_0020.html", + "node_id":"en-us_topic_0000001854089189.xml", "product_code":"vpn", "code":"21", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"VPN Service Management", - "title":"VPN Service Management", + "kw":"Customer Gateway", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Customer Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011498.html", + "uri":"vpn_api_0021.html", + "node_id":"en-us_topic_0000001807530292.xml", "product_code":"vpn", "code":"22", - "des":"This interface is used to create a VPN service.Only one VPN service can be created for each VPC.POST /v2.0/vpn/vpnservicesTable 1 describes the request parameters.The pro", + "des":"This API is used to create a customer gateway to which a VPN gateway connects.For details, see Calling APIs.POST /v5/{project_id}/customer-gatewaysRequest parametersReque", "doc_type":"api", - "kw":"Creating a VPN Service,VPN Service Management,API Reference", - "title":"Creating a VPN Service", + "kw":"Creating a Customer Gateway,Customer Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating a Customer Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011499.html", + "uri":"vpn_api_0022.html", + "node_id":"en-us_topic_0000001807370468.xml", "product_code":"vpn", "code":"23", - "des":"This interface is used to query details about a VPN service.GET /v2.0/vpn/vpnservices/{service_id}NoneTable 2 describes the response parameters.Example RequestGET /v2.0/v", + "des":"This API is used to query a customer gateway with a specified gateway ID.For details, see Calling APIs.GET /v5/{project_id}/customer-gateways/{customer_gateway_id}Request", "doc_type":"api", - "kw":"Querying Details About a VPN Service,VPN Service Management,API Reference", - "title":"Querying Details About a VPN Service", + "kw":"Querying a Specified Customer Gateway,Customer Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying a Specified Customer Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011500.html", + "uri":"vpn_api_0023.html", + "node_id":"en-us_topic_0000001854169145.xml", "product_code":"vpn", "code":"24", - "des":"This interface is used to query VPN services.GET /v2.0/vpn/vpnservicesTable 1 describes the request parameters.The project_idparameter is not supported.Table 2 describes ", + "des":"This API is used to query the customer gateway list.For details, see Calling APIs.GET /v5/{project_id}/customer-gatewaysRequest parametersNoneNoneExample requestGET https", "doc_type":"api", - "kw":"Querying VPN Services,VPN Service Management,API Reference", - "title":"Querying VPN Services", + "kw":"Querying the Customer Gateway List,Customer Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the Customer Gateway List", "githuburl":"" }, { - "uri":"en_topic_0093011501.html", + "uri":"vpn_api_0024.html", + "node_id":"en-us_topic_0000001854089193.xml", "product_code":"vpn", "code":"25", - "des":"This interface is used to update a VPN service.PUT /v2.0/vpn/vpnservices/{service_id}Table 2 describes the request parameters.The project_idparameter is not supported.The", + "des":"This API is used to update a customer gateway with a specified gateway ID. Only the gateway name and certificate can be updated. To modify other parameters, you need to c", "doc_type":"api", - "kw":"Updating a VPN Service,VPN Service Management,API Reference", - "title":"Updating a VPN Service", + "kw":"Updating a Customer Gateway,Customer Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating a Customer Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011502.html", + "uri":"vpn_api_0025.html", + "node_id":"en-us_topic_0000001807530296.xml", "product_code":"vpn", "code":"26", - "des":"This interface is used to delete a VPN service.This interface cannot be used to delete a VPN service in the active-active VPN scenarios.DELETE /v2.0/vpn/vpnservices/{serv", + "des":"This API is used to delete a customer gateway with a specified gateway ID.For details, see Calling APIs.DELETE /v5/{project_id}/customer-gateways/{customer_gateway_id}Req", "doc_type":"api", - "kw":"Deleting a VPN Service,VPN Service Management,API Reference", - "title":"Deleting a VPN Service", + "kw":"Deleting a Customer Gateway,Customer Gateway,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting a Customer Gateway", "githuburl":"" }, { - "uri":"en_topic_0093011503.html", + "uri":"vpn_api_0026.html", + "node_id":"en-us_topic_0000001807370472.xml", "product_code":"vpn", "code":"27", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"IPsec Policy Management", - "title":"IPsec Policy Management", + "kw":"VPN Connection", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Connection", "githuburl":"" }, { - "uri":"en_topic_0093011504.html", + "uri":"vpn_api_0027.html", + "node_id":"en-us_topic_0000001854169149.xml", "product_code":"vpn", "code":"28", - "des":"This interface is used to create an IPsec policy.POST /v2.0/vpn/ipsecpoliciesThe project_idparameter is not supported.The value of tenant_idcan contain a maximum of 255 c", + "des":"This API is used to create a VPN connection that connects a VPN gateway to a customer gateway.For details, see Calling APIs.POST /v5/{project_id}/vpn-connectionRequest pa", "doc_type":"api", - "kw":"Creating an IPsec Policy,IPsec Policy Management,API Reference", - "title":"Creating an IPsec Policy", + "kw":"Creating a VPN Connection,VPN Connection,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating a VPN Connection", "githuburl":"" }, { - "uri":"en_topic_0093011505.html", + "uri":"vpn_api_0028.html", + "node_id":"en-us_topic_0000001854089197.xml", "product_code":"vpn", "code":"29", - "des":"This interface is used to query details about an IPsec policy.GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}The project_idparameter is not supported.The ipsecpolicy_idparam", + "des":"This API is used to query a VPN connection with a specified connection ID.For details, see Calling APIs.GET /v5/{project_id}/vpn-connection/{vpn_connection_id}Request par", "doc_type":"api", - "kw":"Querying Details About an IPsec Policy,IPsec Policy Management,API Reference", - "title":"Querying Details About an IPsec Policy", + "kw":"Querying a Specified VPN Connection,VPN Connection,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying a Specified VPN Connection", "githuburl":"" }, { - "uri":"en_topic_0093011506.html", + "uri":"vpn_api_0029.html", + "node_id":"en-us_topic_0000001807530300.xml", "product_code":"vpn", "code":"30", - "des":"This interface is used to query IPsec policies.GET /v2.0/vpn/ipsecpoliciesTable 1 describes the request parameters.The project_idparameter is not supported.Table 2 descri", + "des":"This API is used to query the VPN connection list.For details, see Calling APIs.GET /v5/{project_id}/vpn-connectionRequest parametersNoneNoneExample requestsQuery all VPN", "doc_type":"api", - "kw":"Querying IPsec Policies,IPsec Policy Management,API Reference", - "title":"Querying IPsec Policies", + "kw":"Querying the VPN Connection List,VPN Connection,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the VPN Connection List", "githuburl":"" }, { - "uri":"en_topic_0093011507.html", + "uri":"vpn_api_0030.html", + "node_id":"en-us_topic_0000001807370476.xml", "product_code":"vpn", "code":"31", - "des":"This interface is used to update an IPsec policy.If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ipsecpolicies/{ipsecpolic", + "des":"This API is used to update a VPN connection with a specified connection ID.For details, see Calling APIs.PUT /v5/{project_id}/vpn-connection/{vpn_connection_id}Request pa", "doc_type":"api", - "kw":"Updating an IPsec Policy,IPsec Policy Management,API Reference", - "title":"Updating an IPsec Policy", + "kw":"Updating a VPN Connection,VPN Connection,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating a VPN Connection", "githuburl":"" }, { - "uri":"en_topic_0093011508.html", + "uri":"vpn_api_0031.html", + "node_id":"en-us_topic_0000001854169153.xml", "product_code":"vpn", "code":"32", - "des":"This interface is used to delete an IPsec policy.DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}NoneNoneExample RequestDELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}Exam", + "des":"This API is used to delete a VPN connection with a specified connection ID.For details, see Calling APIs.DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id}Request", "doc_type":"api", - "kw":"Deleting an IPsec Policy,IPsec Policy Management,API Reference", - "title":"Deleting an IPsec Policy", + "kw":"Deleting a VPN Connection,VPN Connection,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting a VPN Connection", "githuburl":"" }, { - "uri":"en_topic_0093011509.html", + "uri":"vpn_api_0032.html", + "node_id":"en-us_topic_0000001854089201.xml", "product_code":"vpn", "code":"33", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"IKE Policy Management", - "title":"IKE Policy Management", + "kw":"VPN Connection Monitoring", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Connection Monitoring", "githuburl":"" }, { - "uri":"en_topic_0093011510.html", + "uri":"vpn_api_0033.html", + "node_id":"en-us_topic_0000001807530304.xml", "product_code":"vpn", "code":"34", - "des":"This interface is used to create an IKE policy.POST /v2.0/vpn/ikepoliciesTable 1 describes the request parameters.The project_idparameter is not supported.The value of te", + "des":"This API is used to create a VPN connection monitor to perform health check between gateways. After a VPN connection monitor is created, the VPN gateway sends probe packe", "doc_type":"api", - "kw":"Creating an IKE Policy,IKE Policy Management,API Reference", - "title":"Creating an IKE Policy", + "kw":"Creating a VPN Connection Monitor,VPN Connection Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating a VPN Connection Monitor", "githuburl":"" }, { - "uri":"en_topic_0093011511.html", + "uri":"vpn_api_0034.html", + "node_id":"en-us_topic_0000001807370480.xml", "product_code":"vpn", "code":"35", - "des":"This interface is used to query details about an IKE policy.GET /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneTable 2 describes the response parameters.Example RequestGET /v2.0", + "des":"This API is used to query a VPN connection monitor with a specified ID.For details, see Calling APIs.GET /v5/{project_id}/connection-monitors/{connection_monitor_id}Reque", "doc_type":"api", - "kw":"Querying Details About an IKE Policy,IKE Policy Management,API Reference", - "title":"Querying Details About an IKE Policy", + "kw":"Querying a VPN Connection Monitor,VPN Connection Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying a VPN Connection Monitor", "githuburl":"" }, { - "uri":"en_topic_0093011512.html", + "uri":"vpn_api_0035.html", + "node_id":"en-us_topic_0000001854169157.xml", "product_code":"vpn", "code":"36", - "des":"This interface is used to query IKE policies.GET /v2.0/vpn/ikepoliciesTable 1 describes the request parameters.The project_idparameter is not supported.Table 2 describes ", + "des":"This API is used to query the list of VPN connection monitors.For details, see Calling APIs.GET /v5/{project_id}/connection-monitorsRequest parametersNoneNoneExample requ", "doc_type":"api", - "kw":"Querying IKE Policies,IKE Policy Management,API Reference", - "title":"Querying IKE Policies", + "kw":"Querying the List of VPN Connection Monitors,VPN Connection Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the List of VPN Connection Monitors", "githuburl":"" }, { - "uri":"en_topic_0093011513.html", + "uri":"vpn_api_0036.html", + "node_id":"en-us_topic_0000001854089205.xml", "product_code":"vpn", "code":"37", - "des":"This interface is used to update an IKE policy.If the IKE policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}Tab", + "des":"This API is used to delete a VPN connection monitor with a specified ID.For details, see Calling APIs.DELETE /v5/{project_id}/connection-monitors/{connection_monitor_id}R", "doc_type":"api", - "kw":"Updating an IKE Policy,IKE Policy Management,API Reference", - "title":"Updating an IKE Policy", + "kw":"Deleting a VPN Connection Monitor,VPN Connection Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting a VPN Connection Monitor", "githuburl":"" }, { - "uri":"en_topic_0093011514.html", + "uri":"vpn_api_0037.html", + "node_id":"en-us_topic_0000001807530308.xml", "product_code":"vpn", "code":"38", - "des":"This interface is used to delete an IKE policy.DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneNoneExample RequestDELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}Example Respon", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Deleting an IKE Policy,IKE Policy Management,API Reference", - "title":"Deleting an IKE Policy", + "kw":"Quota", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Quota", "githuburl":"" }, { - "uri":"en_topic_0093011515.html", + "uri":"vpn_api_0038.html", + "node_id":"en-us_topic_0000001807370484.xml", "product_code":"vpn", "code":"39", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"This API is used to query VPN resource quotas of a tenant, including VPN gateways, customer gateways, and VPN connections.For details, see Calling APIs.GET /v5/{project_i", "doc_type":"api", - "kw":"VPN Endpoint Group Management", - "title":"VPN Endpoint Group Management", + "kw":"Querying Quotas,Quota,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Quotas", "githuburl":"" }, { - "uri":"en_topic_0093011516.html", + "uri":"vpn_api_0060.html", + "node_id":"en-us_topic_0000001854169161.xml", "product_code":"vpn", "code":"40", - "des":"This interface is used to create a VPN endpoint group.POST /v2.0/vpn/endpoint-groupsTable 1 describes the request parameters.The project_idparameter is not supported.The ", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Creating a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", - "title":"Creating a VPN Endpoint Group", + "kw":"Tags", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Tags", "githuburl":"" }, { - "uri":"en_topic_0093011517.html", + "uri":"vpn_api_0061.html", + "node_id":"en-us_topic_0000001854089209.xml", "product_code":"vpn", "code":"41", - "des":"This interface is used to query details about a VPN endpoint group.GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneTable 2 describes the response parameters.Example ", + "des":"This API is used to query resource instances based on tags.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/resource-instances/filterRequest parameters", "doc_type":"api", - "kw":"Querying Details About a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", - "title":"Querying Details About a VPN Endpoint Group", + "kw":"Querying the Resource Instance List,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the Resource Instance List", "githuburl":"" }, { - "uri":"en_topic_0093011518.html", + "uri":"vpn_api_0062.html", + "node_id":"en-us_topic_0000001807530312.xml", "product_code":"vpn", "code":"42", - "des":"This interface is used to query VPN endpoint groups.GET /v2.0/vpn/endpoint-groupsTable 1 describes the request parameters.The project_idparameter is not supported.Table 2", + "des":"This API is used to query the number of resource instances based on tags.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/resource-instances/countReque", "doc_type":"api", - "kw":"Querying VPN Endpoint Groups,VPN Endpoint Group Management,API Reference", - "title":"Querying VPN Endpoint Groups", + "kw":"Querying the Number of Resource Instances,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying the Number of Resource Instances", "githuburl":"" }, { - "uri":"en_topic_0093011519.html", + "uri":"vpn_api_0063.html", + "node_id":"en-us_topic_0000001807370488.xml", "product_code":"vpn", "code":"43", - "des":"This interface is used to update a VPN endpoint group.PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}Table 2 describes the request parameters.The endpoint_group_idparam", + "des":"This API is used to add tags to a specified instance in batches.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/{resource_id}/tags/createRequest param", "doc_type":"api", - "kw":"Updating a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", - "title":"Updating a VPN Endpoint Group", + "kw":"Adding Resource Tags in Batches,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Adding Resource Tags in Batches", "githuburl":"" }, { - "uri":"en_topic_0093011520.html", + "uri":"vpn_api_0064.html", + "node_id":"en-us_topic_0000001854169165.xml", "product_code":"vpn", "code":"44", - "des":"This interface is used to delete a VPN endpoint group.DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneNoneExample RequestDELETE /v2.0/vpn/endpoint-groups/{endpoin", + "des":"This API is used to delete tags from a specified instance in batches.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/{resource_id}/tags/deleteRequest ", "doc_type":"api", - "kw":"Deleting a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", - "title":"Deleting a VPN Endpoint Group", + "kw":"Deleting Resource Tags in Batches,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting Resource Tags in Batches", "githuburl":"" }, { - "uri":"en_topic_0093011521.html", + "uri":"vpn_api_0065.html", + "node_id":"en-us_topic_0000001854089213.xml", "product_code":"vpn", "code":"45", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"This API is used to query tags of a specified instance.For details, see Calling APIs.GET /v5/{project_id}/{resource_type}/{resource_id}/tagsRequest parametersNoneNoneExam", "doc_type":"api", - "kw":"Common Parameters", - "title":"Common Parameters", + "kw":"Querying Resource Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Resource Tags", "githuburl":"" }, { - "uri":"en_topic_0093011522.html", + "uri":"vpn_api_0066.html", + "node_id":"en-us_topic_0000001807530316.xml", "product_code":"vpn", "code":"46", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"This API is used to query all tags of a specified resource type in a specified project of a tenant.For details, see Calling APIs.GET /v5/{project_id}/{resource_type}/tags", "doc_type":"api", - "kw":"Common Returned Values,Common Parameters,API Reference", - "title":"Common Returned Values", + "kw":"Querying Project Tags,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Project Tags", "githuburl":"" }, { - "uri":"en_topic_0093011523.html", + "uri":"vpn_api_0039.html", + "node_id":"en-us_topic_0000001807370492.xml", "product_code":"vpn", "code":"47", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Error Codes,Common Parameters,API Reference", - "title":"Error Codes", + "kw":"Application Examples", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Application Examples", "githuburl":"" }, { - "uri":"en_topic_0093011524.html", + "uri":"vpn_api_0040.html", + "node_id":"en-us_topic_0000001854169169.xml", "product_code":"vpn", "code":"48", + "des":"This section describes how to create a VPN gateway by calling APIs.You have determined the region where the VPN gateway is to be deployed and obtained the endpoint for ca", + "doc_type":"api", + "kw":"Example 1: Creating a VPN Gateway,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Example 1: Creating a VPN Gateway", + "githuburl":"" + }, + { + "uri":"vpn_api_0041.html", + "node_id":"en-us_topic_0000001854089217.xml", + "product_code":"vpn", + "code":"49", + "des":"This section describes how to create a customer gateway by calling APIs.You have obtained a user token if you need to use token authentication. In addition, you need to a", + "doc_type":"api", + "kw":"Example 2: Creating a Customer Gateway,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Example 2: Creating a Customer Gateway", + "githuburl":"" + }, + { + "uri":"vpn_api_0042.html", + "node_id":"en-us_topic_0000001807530320.xml", + "product_code":"vpn", + "code":"50", + "des":"This section describes how to create a VPN connection by calling APIs.You have created a VPN gateway. For details, see Creating a VPN Gateway.You have created a customer ", + "doc_type":"api", + "kw":"Example 3: Creating a VPN Connection,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Example 3: Creating a VPN Connection", + "githuburl":"" + }, + { + "uri":"vpn_api_0043.html", + "node_id":"en-us_topic_0000001807370496.xml", + "product_code":"vpn", + "code":"51", + "des":"This section describes how to create a VPN connection monitor by calling APIs.You have created a VPN connection. For details, see Creating a VPN Connection.You have obtai", + "doc_type":"api", + "kw":"Example 4: Creating a VPN Connection Monitor,Application Examples,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Example 4: Creating a VPN Connection Monitor", + "githuburl":"" + }, + { + "uri":"vpn_api_0044.html", + "node_id":"en-us_topic_0000001854169173.xml", + "product_code":"vpn", + "code":"52", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"Status Codes,Common Parameters,API Reference", + "kw":"Permissions and Supported Actions", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Permissions and Supported Actions", + "githuburl":"" + }, + { + "uri":"vpn_api_0045.html", + "node_id":"en-us_topic_0000001854089221.xml", + "product_code":"vpn", + "code":"53", + "des":"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 ca", + "doc_type":"api", + "kw":"Introduction,Permissions and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"vpn_api_0114.html", + "node_id":"en-us_topic_0000002018352073.xml", + "product_code":"vpn", + "code":"54", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Actions Supported by Enterprise Edition VPN", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Actions Supported by Enterprise Edition VPN", + "githuburl":"" + }, + { + "uri":"vpn_api_0115.html", + "node_id":"en-us_topic_0000001981592688.xml", + "product_code":"vpn", + "code":"55", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Gateway,Actions Supported by Enterprise Edition VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Gateway", + "githuburl":"" + }, + { + "uri":"vpn_api_0116.html", + "node_id":"en-us_topic_0000001981752416.xml", + "product_code":"vpn", + "code":"56", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Customer Gateway,Actions Supported by Enterprise Edition VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Customer Gateway", + "githuburl":"" + }, + { + "uri":"vpn_api_0117.html", + "node_id":"en-us_topic_0000002018192593.xml", + "product_code":"vpn", + "code":"57", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Connection,Actions Supported by Enterprise Edition VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Connection", + "githuburl":"" + }, + { + "uri":"vpn_api_0118.html", + "node_id":"en-us_topic_0000002018352077.xml", + "product_code":"vpn", + "code":"58", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Connection Monitor,Actions Supported by Enterprise Edition VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Connection Monitor", + "githuburl":"" + }, + { + "uri":"vpn_api_0124.html", + "node_id":"en-us_topic_0000001981592692.xml", + "product_code":"vpn", + "code":"59", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Actions Supported by Public Service APIs", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Actions Supported by Public Service APIs", + "githuburl":"" + }, + { + "uri":"vpn_api_0125.html", + "node_id":"en-us_topic_0000001981752420.xml", + "product_code":"vpn", + "code":"60", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Quota,Actions Supported by Public Service APIs,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Quota", + "githuburl":"" + }, + { + "uri":"vpn_api_0126.html", + "node_id":"en-us_topic_0000002018192597.xml", + "product_code":"vpn", + "code":"61", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Tag,Actions Supported by Public Service APIs,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Tag", + "githuburl":"" + }, + { + "uri":"vpn_api_0050.html", + "node_id":"en-us_topic_0000001854089229.xml", + "product_code":"vpn", + "code":"62", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Appendixes", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Appendixes", + "githuburl":"" + }, + { + "uri":"vpn_api_0051.html", + "node_id":"en-us_topic_0000001807530332.xml", + "product_code":"vpn", + "code":"63", + "des":"A project ID is required by some URLs used for calling APIs. You can obtain the project ID using either of the following methods:Obtaining the project ID by calling an AP", + "doc_type":"api", + "kw":"Obtaining the Project ID,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Obtaining the Project ID", + "githuburl":"" + }, + { + "uri":"vpn_api_0052.html", + "node_id":"en-us_topic_0000001807370508.xml", + "product_code":"vpn", + "code":"64", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Status Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], "title":"Status Codes", "githuburl":"" }, { - "uri":"en_topic_0093011528.html", + "uri":"vpn_api_0067.html", + "node_id":"en-us_topic_0000001854169185.xml", "product_code":"vpn", - "code":"49", + "code":"65", + "des":"If an error occurs when an API is called, error information is returned. This section describes the error information for VPN APIs (excluding native OpenStack APIs).", + "doc_type":"api", + "kw":"Error Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"vpn_api_1002.html", + "node_id":"en-us_topic_0000001807530268.xml", + "product_code":"vpn", + "code":"66", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"A Change History,API Reference", - "title":"A Change History", + "kw":"API Reference - Classic VPN", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API Reference - Classic VPN", + "githuburl":"" + }, + { + "uri":"vpn_api_1003.html", + "node_id":"en-us_topic_0000001807530336.xml", + "product_code":"vpn", + "code":"67", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference - Classic VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"vpn_api_1004.html", + "node_id":"en-us_topic_0000001807370512.xml", + "product_code":"vpn", + "code":"68", + "des":"VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.A combination of these two types of APIs allows you to use all functions provided by the ", + "doc_type":"api", + "kw":"API Overview,API Reference - Classic VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"vpn_api_1011.html", + "node_id":"en-us_topic_0000001807530344.xml", + "product_code":"vpn", + "code":"69", + "des":"The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the s", + "doc_type":"api", + "kw":"VPN API Usage Instructions,API Reference - Classic VPN,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN API Usage Instructions", + "githuburl":"" + }, + { + "uri":"vpn_api_1012.html", + "node_id":"en-us_topic_0000001807370520.xml", + "product_code":"vpn", + "code":"70", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API", + "githuburl":"" + }, + { + "uri":"vpn_api_1013.html", + "node_id":"en-us_topic_0000001854169197.xml", + "product_code":"vpn", + "code":"71", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API Version Information", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"API Version Information", + "githuburl":"" + }, + { + "uri":"vpn_api_1014.html", + "node_id":"en-us_topic_0000001854089245.xml", + "product_code":"vpn", + "code":"72", + "des":"This API is used to query all available versions of a native OpenStack API.GETRequest parameterNoneExample requestResponse parameterExample responseSee Status Codes.See E", + "doc_type":"api", + "kw":"Querying API Versions,API Version Information,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"vpn_api_1015.html", + "node_id":"en-us_topic_0000001807530348.xml", + "product_code":"vpn", + "code":"73", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Tag Management", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"vpn_api_1016.html", + "node_id":"en-us_topic_0000001807370524.xml", + "product_code":"vpn", + "code":"74", + "des":"This API is used to query VPNs by tag.Tag Management Service (TMS) filters service resource instances by tag and displays them in a list.POST /v2.0/{project_id}/ipsec-sit", + "doc_type":"api", + "kw":"Querying VPNs by Tag,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying VPNs by Tag", + "githuburl":"" + }, + { + "uri":"vpn_api_1017.html", + "node_id":"en-us_topic_0000001854169201.xml", + "product_code":"vpn", + "code":"75", + "des":"This API is used to batch create or delete VPN tags.This API is idempotent.If there are duplicate keys in the request body when you add tags, an error is reported.During ", + "doc_type":"api", + "kw":"Batch Creating or Deleting VPN Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Batch Creating or Deleting VPN Tags", + "githuburl":"" + }, + { + "uri":"vpn_api_1018.html", + "node_id":"en-us_topic_0000001854089249.xml", + "product_code":"vpn", + "code":"76", + "des":"This API is used to create tags for a VPN.POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_id indicates the project ID, and resource_i", + "doc_type":"api", + "kw":"Creating Tags for a VPN,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating Tags for a VPN", + "githuburl":"" + }, + { + "uri":"vpn_api_1019.html", + "node_id":"en-us_topic_0000001807530352.xml", + "product_code":"vpn", + "code":"77", + "des":"This API is used to query tags of a specified VPN.GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_id indicates the project ID, and res", + "doc_type":"api", + "kw":"Querying VPN Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying VPN Tags", + "githuburl":"" + }, + { + "uri":"vpn_api_1020.html", + "node_id":"en-us_topic_0000001807370528.xml", + "product_code":"vpn", + "code":"78", + "des":"This API is used to delete VPN tags.DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}In the URI, project_id indicates the project ID, resource_id ", + "doc_type":"api", + "kw":"Deleting VPN Tags,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting VPN Tags", + "githuburl":"" + }, + { + "uri":"vpn_api_1021.html", + "node_id":"en-us_topic_0000001854169205.xml", + "product_code":"vpn", + "code":"79", + "des":"This API is used to query all tags of a VPN in a specified project.GET /v2.0/{project_id}/ipsec-site-connections/tagsIn the URI, project_id indicates the project ID.NoneT", + "doc_type":"api", + "kw":"Querying VPN Tags in a Specified Project,Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying VPN Tags in a Specified Project", + "githuburl":"" + }, + { + "uri":"vpn_api_1022.html", + "node_id":"en-us_topic_0000001854089253.xml", + "product_code":"vpn", + "code":"80", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Native OpenStack APIs", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Native OpenStack APIs", + "githuburl":"" + }, + { + "uri":"vpn_api_1023.html", + "node_id":"en-us_topic_0000001807530356.xml", + "product_code":"vpn", + "code":"81", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"IPsec Connection Management", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"IPsec Connection Management", + "githuburl":"" + }, + { + "uri":"vpn_api_1024.html", + "node_id":"en-us_topic_0000001807370532.xml", + "product_code":"vpn", + "code":"82", + "des":"This API is used to create an IPsec VPN connection.POST /v2.0/vpn/ipsec-site-connectionsTable 1 lists the request parameters for creating an IPsec site connection.route_m", + "doc_type":"api", + "kw":"Creating an IPsec VPN Connection,IPsec Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating an IPsec VPN Connection", + "githuburl":"" + }, + { + "uri":"vpn_api_1025.html", + "node_id":"en-us_topic_0000001854169209.xml", + "product_code":"vpn", + "code":"83", + "des":"This API is used to query details about an IPsec VPN connection.GET /v2.0/vpn/ipsec-site-connections/{connection_id}NoneTable 2 describes the response parameters.Example ", + "doc_type":"api", + "kw":"Querying Details About an IPsec VPN Connection,IPsec Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Details About an IPsec VPN Connection", + "githuburl":"" + }, + { + "uri":"vpn_api_1026.html", + "node_id":"en-us_topic_0000001854089257.xml", + "product_code":"vpn", + "code":"84", + "des":"This API is used to query IPsec VPN connections.GET /v2.0/vpn/ipsec-site-connectionsTable 1 describes the request parameter.Table 2 describes the response parameters.For ", + "doc_type":"api", + "kw":"Querying IPsec VPN Connections,IPsec Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying IPsec VPN Connections", + "githuburl":"" + }, + { + "uri":"vpn_api_1027.html", + "node_id":"en-us_topic_0000001807530360.xml", + "product_code":"vpn", + "code":"85", + "des":"This API is used to update an IPsec VPN connection.PUT /v2.0/vpn/ipsec-site-connections/{connection_id}Table 2 describes the request parameters.Table 4 describes the resp", + "doc_type":"api", + "kw":"Updating an IPsec VPN Connection,IPsec Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating an IPsec VPN Connection", + "githuburl":"" + }, + { + "uri":"vpn_api_1028.html", + "node_id":"en-us_topic_0000001807370536.xml", + "product_code":"vpn", + "code":"86", + "des":"This interface is used to delete an IPsec VPN connection.DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}NoneNoneExample RequestDELETE /v2.0/vpn/ipsec-site-connect", + "doc_type":"api", + "kw":"Deleting an IPsec VPN Connection,IPsec Connection Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting an IPsec VPN Connection", + "githuburl":"" + }, + { + "uri":"vpn_api_1029.html", + "node_id":"en-us_topic_0000001854169213.xml", + "product_code":"vpn", + "code":"87", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Service Management", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Service Management", + "githuburl":"" + }, + { + "uri":"vpn_api_1030.html", + "node_id":"en-us_topic_0000001854089261.xml", + "product_code":"vpn", + "code":"88", + "des":"This API is used to create a VPN service.Only one VPN service can be created for each VPC.POST /v2.0/vpn/vpnservicesTable 1 describes the request parameters.Parameter pro", + "doc_type":"api", + "kw":"Creating a VPN Service,VPN Service Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating a VPN Service", + "githuburl":"" + }, + { + "uri":"vpn_api_1031.html", + "node_id":"en-us_topic_0000001807530368.xml", + "product_code":"vpn", + "code":"89", + "des":"This API is used to query details about a VPN service.GET /v2.0/vpn/vpnservices/{service_id}NoneTable 2 describes the response parameters.Example requestGET /v2.0/vpn/vpn", + "doc_type":"api", + "kw":"Querying Details About a VPN Service,VPN Service Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Details About a VPN Service", + "githuburl":"" + }, + { + "uri":"vpn_api_1032.html", + "node_id":"en-us_topic_0000001807370544.xml", + "product_code":"vpn", + "code":"90", + "des":"This API is used to query VPN services.GET /v2.0/vpn/vpnservicesTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes the respon", + "doc_type":"api", + "kw":"Querying VPN Services,VPN Service Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying VPN Services", + "githuburl":"" + }, + { + "uri":"vpn_api_1033.html", + "node_id":"en-us_topic_0000001854169217.xml", + "product_code":"vpn", + "code":"91", + "des":"This API is used to update a VPN service.PUT /v2.0/vpn/vpnservices/{service_id}Table 2 describes the request parameters.Parameter project_id is not supported.Table 3 desc", + "doc_type":"api", + "kw":"Updating a VPN Service,VPN Service Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating a VPN Service", + "githuburl":"" + }, + { + "uri":"vpn_api_1034.html", + "node_id":"en-us_topic_0000001854089265.xml", + "product_code":"vpn", + "code":"92", + "des":"This interface is used to delete a VPN service.This interface cannot be used to delete a VPN service in the active-active VPN scenarios.DELETE /v2.0/vpn/vpnservices/{serv", + "doc_type":"api", + "kw":"Deleting a VPN Service,VPN Service Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting a VPN Service", + "githuburl":"" + }, + { + "uri":"vpn_api_1035.html", + "node_id":"en-us_topic_0000001807530376.xml", + "product_code":"vpn", + "code":"93", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"IPsec Policy Management", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"IPsec Policy Management", + "githuburl":"" + }, + { + "uri":"vpn_api_1036.html", + "node_id":"en-us_topic_0000001807370548.xml", + "product_code":"vpn", + "code":"94", + "des":"This API is used to create an IPsec policy.POST /v2.0/vpn/ipsecpoliciesParameter project_id is not supported.Table 2 describes the response parameters.Example requestPOST", + "doc_type":"api", + "kw":"Creating an IPsec Policy,IPsec Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating an IPsec Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1037.html", + "node_id":"en-us_topic_0000001854169221.xml", + "product_code":"vpn", + "code":"95", + "des":"This API is used to query details about an IPsec policy.GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}Parameter project_id is not supported.NoneTable 2 describes the respon", + "doc_type":"api", + "kw":"Querying Details About an IPsec Policy,IPsec Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Details About an IPsec Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1038.html", + "node_id":"en-us_topic_0000001854089269.xml", + "product_code":"vpn", + "code":"96", + "des":"This API is used to query IPsec policies.GET /v2.0/vpn/ipsecpoliciesTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes the re", + "doc_type":"api", + "kw":"Querying IPsec Policies,IPsec Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying IPsec Policies", + "githuburl":"" + }, + { + "uri":"vpn_api_1039.html", + "node_id":"en-us_topic_0000001807530380.xml", + "product_code":"vpn", + "code":"97", + "des":"This API is used to update an IPsec policy.If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}T", + "doc_type":"api", + "kw":"Updating an IPsec Policy,IPsec Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating an IPsec Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1040.html", + "node_id":"en-us_topic_0000001807370552.xml", + "product_code":"vpn", + "code":"98", + "des":"This interface is used to delete an IPsec policy.DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}NoneNoneExample RequestExample ResponseNoneNoneFor details, see section Co", + "doc_type":"api", + "kw":"Deleting an IPsec Policy,IPsec Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting an IPsec Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1041.html", + "node_id":"en-us_topic_0000001854169225.xml", + "product_code":"vpn", + "code":"99", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"IKE Policy Management", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"IKE Policy Management", + "githuburl":"" + }, + { + "uri":"vpn_api_1042.html", + "node_id":"en-us_topic_0000001854089273.xml", + "product_code":"vpn", + "code":"100", + "des":"This API is used to create an IKE policy.POST /v2.0/vpn/ikepoliciesTable 1 describes the request parameters.Parameter project_id is not supported.Table 2 describes the re", + "doc_type":"api", + "kw":"Creating an IKE Policy,IKE Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating an IKE Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1043.html", + "node_id":"en-us_topic_0000001807530384.xml", + "product_code":"vpn", + "code":"101", + "des":"This API is used to query details about an IKE policy.GET /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneTable 2 describes the response parameters.Example requestGET /v2.0/vpn/i", + "doc_type":"api", + "kw":"Querying Details About an IKE Policy,IKE Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Details About an IKE Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1044.html", + "node_id":"en-us_topic_0000001807370556.xml", + "product_code":"vpn", + "code":"102", + "des":"This API is used to query IKE policies.GET /v2.0/vpn/ikepoliciesTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes the respon", + "doc_type":"api", + "kw":"Querying IKE Policies,IKE Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying IKE Policies", + "githuburl":"" + }, + { + "uri":"vpn_api_1045.html", + "node_id":"en-us_topic_0000001854169229.xml", + "product_code":"vpn", + "code":"103", + "des":"This API is used to update an IKE policy.If the IKE policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}Table 2 d", + "doc_type":"api", + "kw":"Updating an IKE Policy,IKE Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating an IKE Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1046.html", + "node_id":"en-us_topic_0000001854089277.xml", + "product_code":"vpn", + "code":"104", + "des":"This interface is used to delete an IKE policy.DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneNoneExample RequestDELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}Example Respon", + "doc_type":"api", + "kw":"Deleting an IKE Policy,IKE Policy Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting an IKE Policy", + "githuburl":"" + }, + { + "uri":"vpn_api_1047.html", + "node_id":"en-us_topic_0000001807530388.xml", + "product_code":"vpn", + "code":"105", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"VPN Endpoint Group Management", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"VPN Endpoint Group Management", + "githuburl":"" + }, + { + "uri":"vpn_api_1048.html", + "node_id":"en-us_topic_0000001807370560.xml", + "product_code":"vpn", + "code":"106", + "des":"This API is used to create a VPN endpoint group.POST /v2.0/vpn/endpoint-groupsTable 1 describes the request parameters.Parameter project_id is not supported.Table 2 descr", + "doc_type":"api", + "kw":"Creating a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Creating a VPN Endpoint Group", + "githuburl":"" + }, + { + "uri":"vpn_api_1049.html", + "node_id":"en-us_topic_0000001854169233.xml", + "product_code":"vpn", + "code":"107", + "des":"This API is used to query details about a VPN endpoint group.GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneTable 2 describes the response parameters.Example reques", + "doc_type":"api", + "kw":"Querying Details About a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying Details About a VPN Endpoint Group", + "githuburl":"" + }, + { + "uri":"vpn_api_1050.html", + "node_id":"en-us_topic_0000001854089285.xml", + "product_code":"vpn", + "code":"108", + "des":"This API is used to query VPN endpoint groups.GET /v2.0/vpn/endpoint-groupsTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes", + "doc_type":"api", + "kw":"Querying VPN Endpoint Groups,VPN Endpoint Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Querying VPN Endpoint Groups", + "githuburl":"" + }, + { + "uri":"vpn_api_1051.html", + "node_id":"en-us_topic_0000001807530392.xml", + "product_code":"vpn", + "code":"109", + "des":"This API is used to update a VPN endpoint group.PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}Table 2 describes the request parameters.Parameter project_id is not supp", + "doc_type":"api", + "kw":"Updating a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Updating a VPN Endpoint Group", + "githuburl":"" + }, + { + "uri":"vpn_api_1052.html", + "node_id":"en-us_topic_0000001807370564.xml", + "product_code":"vpn", + "code":"110", + "des":"This interface is used to delete a VPN endpoint group.DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneNoneExample RequestExample ResponseNoneNoneFor details, see ", + "doc_type":"api", + "kw":"Deleting a VPN Endpoint Group,VPN Endpoint Group Management,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Deleting a VPN Endpoint Group", + "githuburl":"" + }, + { + "uri":"vpn_api_1053.html", + "node_id":"en-us_topic_0000001854169241.xml", + "product_code":"vpn", + "code":"111", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Common Parameters", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Common Parameters", + "githuburl":"" + }, + { + "uri":"vpn_api_1054.html", + "node_id":"en-us_topic_0000001854089293.xml", + "product_code":"vpn", + "code":"112", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Common Returned Values,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Common Returned Values", + "githuburl":"" + }, + { + "uri":"vpn_api_1055.html", + "node_id":"en-us_topic_0000001807530396.xml", + "product_code":"vpn", + "code":"113", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Error Codes,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"vpn_api_1056.html", + "node_id":"en-us_topic_0000001807370572.xml", + "product_code":"vpn", + "code":"114", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Status Codes,Common Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"classic_vpn_0055.html", + "node_id":"en-us_topic_0000001988911265.xml", + "product_code":"vpn", + "code":"115", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Permissions and Supported Actions", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Permissions and Supported Actions", + "githuburl":"" + }, + { + "uri":"classic_vpn_0056.html", + "node_id":"en-us_topic_0000001954032050.xml", + "product_code":"vpn", + "code":"116", + "des":"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 ca", + "doc_type":"api", + "kw":"Introduction,Permissions and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"vpn_api_1057.html", + "node_id":"en-us_topic_0000001877209645.xml", + "product_code":"vpn", + "code":"117", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "operation_id":"CreateVgw;ShowVgw;ListVgws;UpdateVgw;DeleteVgw;ListAvailabilityZones;CreateVgwCertificate;ShowVpnGatewayCertificate;UpdateVgwCertificate;CreateCgw;ShowCgw;ListCgws;DeleteCgw;CreateVpnConnection;ShowVpnConnection;ListVpnConnections;UpdateVpnConnection;DeleteVpnConnection;CreateConnectionMonitor;ShowConnectionMonitor;ListConnectionMonitors;DeleteConnectionMonitor;ShowQuotasInfo", + "prodname":"vpn", + "documenttype":"api" + } + ], + "title":"Change History", "githuburl":"" } ] \ No newline at end of file diff --git a/docs/vpn/api-ref/CLASS.TXT.json b/docs/vpn/api-ref/CLASS.TXT.json index 72280672..688e137d 100644 --- a/docs/vpn/api-ref/CLASS.TXT.json +++ b/docs/vpn/api-ref/CLASS.TXT.json @@ -1,234 +1,234 @@ [ { - "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"API Usage Guidelines", - "uri":"en_topic_0093011471.html", + "title":"API Reference - Enterprise Edition VPN", + "uri":"vpn_api_1001.html", "doc_type":"api", "p_code":"", "code":"1" }, { - "desc":"VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.A combination of these two types of APIs allows you to use all functions provided by the ", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"API Overview", - "uri":"en_topic_0093011472.html", + "title":"Before You Start", + "uri":"vpn_api_0001.html", "doc_type":"api", - "p_code":"", + "p_code":"1", "code":"2" }, { - "desc":"The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the s", + "desc":"A Virtual Private Network (VPN) establishes an encrypted, Internet-based communication tunnel between your network and a Virtual Private Cloud (VPC). By default, Elastic ", "product_code":"vpn", - "title":"VPN API Usage Instructions", - "uri":"en_topic_0093011479.html", + "title":"Overview", + "uri":"vpn_api_0002.html", "doc_type":"api", - "p_code":"", + "p_code":"2", "code":"3" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"VPN supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see Calling APIs.", "product_code":"vpn", - "title":"API", - "uri":"en_topic_0093011480.html", + "title":"API Calling", + "uri":"vpn_api_0003.html", "doc_type":"api", - "p_code":"", + "p_code":"2", "code":"4" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"An endpoint is the request address for calling an API. Endpoints vary according to services and regions.", "product_code":"vpn", - "title":"API Version Information", - "uri":"en_topic_0093011481.html", + "title":"Endpoints", + "uri":"vpn_api_0004.html", "doc_type":"api", - "p_code":"4", + "p_code":"2", "code":"5" }, { - "desc":"This API is used to query all available versions of a native OpenStack API.GETRequest parameterNoneExample requestResponse parameterExample responseSee Status Codes.See E", + "desc":"The number of VPN resources that you can create is determined by your quota. You can view or increase the quota.For more constraints, see description of each API.", "product_code":"vpn", - "title":"Querying API Versions", - "uri":"en_topic_0093011482.html", + "title":"Constraints", + "uri":"vpn_api_0005.html", "doc_type":"api", - "p_code":"5", + "p_code":"2", "code":"6" }, + { + "desc":"AccountAn 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 use", + "product_code":"vpn", + "title":"Basic Concepts", + "uri":"vpn_api_0006.html", + "doc_type":"api", + "p_code":"2", + "code":"7" + }, + { + "desc":"Table 1 lists the APIs provided by the VPN service. For details about API permissions, see Permission Policies and Supported Actions.", + "product_code":"vpn", + "title":"API Overview", + "uri":"vpn_api_0007.html", + "doc_type":"api", + "p_code":"1", + "code":"8" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"Tag Management", - "uri":"en_topic_0093011483.html", + "title":"Calling APIs", + "uri":"vpn_api_0008.html", "doc_type":"api", - "p_code":"4", - "code":"7" - }, - { - "desc":"This interface is used to query VPN resource instances by tag.Tag Management Service (TMS) uses this API to filter out service resources and display them in a list. These", - "product_code":"vpn", - "title":"Querying VPN Resource Instances by Tag", - "uri":"en_topic_0093011484.html", - "doc_type":"api", - "p_code":"7", - "code":"8" - }, - { - "desc":"This interface is used to add multiple tags to or delete multiple tags from a VPN resource instance at a time.This API is idempotent.If there are duplicate keys in the re", - "product_code":"vpn", - "title":"Batch Creating or Deleting VPN Resource Tags", - "uri":"en_topic_0093011485.html", - "doc_type":"api", - "p_code":"7", + "p_code":"1", "code":"9" }, { - "desc":"This interface is used to create a tag for a VPN resource.POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_idindicates the project ID,", + "desc":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ", "product_code":"vpn", - "title":"Creating a Tag for a VPN Resource", - "uri":"en_topic_0093011486.html", + "title":"Request", + "uri":"vpn_api_0009.html", "doc_type":"api", - "p_code":"7", + "p_code":"9", "code":"10" }, { - "desc":"This interface is used to query tags of a specified VPN resource.GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_idindicates the proje", + "desc":"Requests for calling an API can be authenticated using either of the following methods:Token authentication: Requests are authenticated using tokens.AK/SK authentication:", "product_code":"vpn", - "title":"Querying VPN Resource Tags", - "uri":"en_topic_0093011487.html", + "title":"Authentication", + "uri":"vpn_api_0010.html", "doc_type":"api", - "p_code":"7", + "p_code":"9", "code":"11" }, { - "desc":"This interface is used to delete a VPN resource tag.DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}In the URI, project_idindicates the project I", + "desc":"Status CodeAfter sending a request, you can receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging fr", "product_code":"vpn", - "title":"Deleting a VPN Resource Tag", - "uri":"en_topic_0093011488.html", + "title":"Response", + "uri":"vpn_api_0011.html", "doc_type":"api", - "p_code":"7", + "p_code":"9", "code":"12" }, { - "desc":"This interface is used to query all tags of a VPN in a specified region.GET /v2.0/{project_id}/ipsec-site-connections/tagsIn the URI, project_idindicates the project ID.N", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"Querying VPN Tags in a Specified Project", - "uri":"en_topic_0093011489.html", + "title":"APIs of Enterprise Edition VPN", + "uri":"vpn_api_0012.html", "doc_type":"api", - "p_code":"7", + "p_code":"1", "code":"13" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"Native OpenStack APIs", - "uri":"en_topic_0093011490.html", + "title":"VPN Gateway", + "uri":"vpn_api_0013.html", "doc_type":"api", - "p_code":"", + "p_code":"13", "code":"14" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"This API is used to create a VPN gateway.For details, see Calling APIs.POST /v5/{project_id}/vpn-gatewaysParameter descriptionParameterTypeMandatoryDescriptionproject_idS", "product_code":"vpn", - "title":"IPsec Connection Management", - "uri":"en_topic_0093011491.html", + "title":"Creating a VPN Gateway", + "uri":"vpn_api_0014.html", "doc_type":"api", "p_code":"14", "code":"15" }, { - "desc":"This interface is used to create an IPsec VPN connection.POST /v2.0/vpn/ipsec-site-connectionsTable 1 lists the request parameters for creating an IPsec site connection.T", + "desc":"This API is used to query a VPN gateway with a specified gateway ID.For details, see Calling APIs.GET /v5/{project_id}/vpn-gateways/{vgw_id}Request parametersNoneNoneExam", "product_code":"vpn", - "title":"Creating an IPsec VPN Connection", - "uri":"en_topic_0093011492.html", + "title":"Querying a Specified VPN Gateway", + "uri":"vpn_api_0015.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "code":"16" }, { - "desc":"This interface is used to query details about an IPsec VPN connection.GET /v2.0/vpn/ipsec-site-connections/{connection_id}NoneTable 2 describes the response parameters.Ex", + "desc":"This API is used to query the VPN gateway list.For details, see Calling APIs.GET /v5/{project_id}/vpn-gatewaysRequest parametersNoneNoneExample requestsQuery all VPN gate", "product_code":"vpn", - "title":"Querying Details About an IPsec VPN Connection", - "uri":"en_topic_0093011493.html", + "title":"Querying the VPN Gateway List", + "uri":"vpn_api_0016.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "code":"17" }, { - "desc":"This interface is used to query IPsec VPN connections.GET /v2.0/vpn/ipsec-site-connectionsTable 1 describes the request parameters.The project_id, peer_id, dpd, and local", + "desc":"This API is used to update a VPN gateway with a specified gateway ID.For details, see Calling APIs.PUT /v5/{project_id}/vpn-gateways/{vgw_id}Request parametersRequest par", "product_code":"vpn", - "title":"Querying IPsec VPN Connections", - "uri":"en_topic_0093011494.html", + "title":"Updating a VPN Gateway", + "uri":"vpn_api_0017.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "code":"18" }, { - "desc":"This interface is used to update an IPsec VPN connection.PUT /v2.0/vpn/ipsec-site-connections/{connection_id}Table 2 describes the request parameters.The project_id, peer", + "desc":"This API is used to delete a VPN gateway with a specified gateway ID.For details, see Calling APIs.DELETE /v5/{project_id}/vpn-gateways/{vgw_id}Request parametersNoneNone", "product_code":"vpn", - "title":"Updating an IPsec VPN Connection", - "uri":"en_topic_0093011495.html", + "title":"Deleting a VPN Gateway", + "uri":"vpn_api_0018.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "code":"19" }, { - "desc":"This interface is used to delete an IPsec VPN connection.DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}NoneNoneExample RequestDELETE /v2.0/vpn/ipsec-site-connect", + "desc":"This API is used to query the AZs of VPN gateways.For details, see Calling APIs.GET /v5/{project_id}/vpn-gateways/availability-zonesRequest parametersNoneNoneExample requ", "product_code":"vpn", - "title":"Deleting an IPsec VPN Connection", - "uri":"en_topic_0093011496.html", + "title":"Querying the AZs of VPN Gateways", + "uri":"vpn_api_0019.html", "doc_type":"api", - "p_code":"15", + "p_code":"14", "code":"20" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"VPN Service Management", - "uri":"en_topic_0093011497.html", + "title":"Customer Gateway", + "uri":"vpn_api_0020.html", "doc_type":"api", - "p_code":"14", + "p_code":"13", "code":"21" }, { - "desc":"This interface is used to create a VPN service.Only one VPN service can be created for each VPC.POST /v2.0/vpn/vpnservicesTable 1 describes the request parameters.The pro", + "desc":"This API is used to create a customer gateway to which a VPN gateway connects.For details, see Calling APIs.POST /v5/{project_id}/customer-gatewaysRequest parametersReque", "product_code":"vpn", - "title":"Creating a VPN Service", - "uri":"en_topic_0093011498.html", + "title":"Creating a Customer Gateway", + "uri":"vpn_api_0021.html", "doc_type":"api", "p_code":"21", "code":"22" }, { - "desc":"This interface is used to query details about a VPN service.GET /v2.0/vpn/vpnservices/{service_id}NoneTable 2 describes the response parameters.Example RequestGET /v2.0/v", + "desc":"This API is used to query a customer gateway with a specified gateway ID.For details, see Calling APIs.GET /v5/{project_id}/customer-gateways/{customer_gateway_id}Request", "product_code":"vpn", - "title":"Querying Details About a VPN Service", - "uri":"en_topic_0093011499.html", + "title":"Querying a Specified Customer Gateway", + "uri":"vpn_api_0022.html", "doc_type":"api", "p_code":"21", "code":"23" }, { - "desc":"This interface is used to query VPN services.GET /v2.0/vpn/vpnservicesTable 1 describes the request parameters.The project_idparameter is not supported.Table 2 describes ", + "desc":"This API is used to query the customer gateway list.For details, see Calling APIs.GET /v5/{project_id}/customer-gatewaysRequest parametersNoneNoneExample requestGET https", "product_code":"vpn", - "title":"Querying VPN Services", - "uri":"en_topic_0093011500.html", + "title":"Querying the Customer Gateway List", + "uri":"vpn_api_0023.html", "doc_type":"api", "p_code":"21", "code":"24" }, { - "desc":"This interface is used to update a VPN service.PUT /v2.0/vpn/vpnservices/{service_id}Table 2 describes the request parameters.The project_idparameter is not supported.The", + "desc":"This API is used to update a customer gateway with a specified gateway ID. Only the gateway name and certificate can be updated. To modify other parameters, you need to c", "product_code":"vpn", - "title":"Updating a VPN Service", - "uri":"en_topic_0093011501.html", + "title":"Updating a Customer Gateway", + "uri":"vpn_api_0024.html", "doc_type":"api", "p_code":"21", "code":"25" }, { - "desc":"This interface is used to delete a VPN service.This interface cannot be used to delete a VPN service in the active-active VPN scenarios.DELETE /v2.0/vpn/vpnservices/{serv", + "desc":"This API is used to delete a customer gateway with a specified gateway ID.For details, see Calling APIs.DELETE /v5/{project_id}/customer-gateways/{customer_gateway_id}Req", "product_code":"vpn", - "title":"Deleting a VPN Service", - "uri":"en_topic_0093011502.html", + "title":"Deleting a Customer Gateway", + "uri":"vpn_api_0025.html", "doc_type":"api", "p_code":"21", "code":"26" @@ -236,53 +236,53 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"IPsec Policy Management", - "uri":"en_topic_0093011503.html", + "title":"VPN Connection", + "uri":"vpn_api_0026.html", "doc_type":"api", - "p_code":"14", + "p_code":"13", "code":"27" }, { - "desc":"This interface is used to create an IPsec policy.POST /v2.0/vpn/ipsecpoliciesThe project_idparameter is not supported.The value of tenant_idcan contain a maximum of 255 c", + "desc":"This API is used to create a VPN connection that connects a VPN gateway to a customer gateway.For details, see Calling APIs.POST /v5/{project_id}/vpn-connectionRequest pa", "product_code":"vpn", - "title":"Creating an IPsec Policy", - "uri":"en_topic_0093011504.html", + "title":"Creating a VPN Connection", + "uri":"vpn_api_0027.html", "doc_type":"api", "p_code":"27", "code":"28" }, { - "desc":"This interface is used to query details about an IPsec policy.GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}The project_idparameter is not supported.The ipsecpolicy_idparam", + "desc":"This API is used to query a VPN connection with a specified connection ID.For details, see Calling APIs.GET /v5/{project_id}/vpn-connection/{vpn_connection_id}Request par", "product_code":"vpn", - "title":"Querying Details About an IPsec Policy", - "uri":"en_topic_0093011505.html", + "title":"Querying a Specified VPN Connection", + "uri":"vpn_api_0028.html", "doc_type":"api", "p_code":"27", "code":"29" }, { - "desc":"This interface is used to query IPsec policies.GET /v2.0/vpn/ipsecpoliciesTable 1 describes the request parameters.The project_idparameter is not supported.Table 2 descri", + "desc":"This API is used to query the VPN connection list.For details, see Calling APIs.GET /v5/{project_id}/vpn-connectionRequest parametersNoneNoneExample requestsQuery all VPN", "product_code":"vpn", - "title":"Querying IPsec Policies", - "uri":"en_topic_0093011506.html", + "title":"Querying the VPN Connection List", + "uri":"vpn_api_0029.html", "doc_type":"api", "p_code":"27", "code":"30" }, { - "desc":"This interface is used to update an IPsec policy.If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ipsecpolicies/{ipsecpolic", + "desc":"This API is used to update a VPN connection with a specified connection ID.For details, see Calling APIs.PUT /v5/{project_id}/vpn-connection/{vpn_connection_id}Request pa", "product_code":"vpn", - "title":"Updating an IPsec Policy", - "uri":"en_topic_0093011507.html", + "title":"Updating a VPN Connection", + "uri":"vpn_api_0030.html", "doc_type":"api", "p_code":"27", "code":"31" }, { - "desc":"This interface is used to delete an IPsec policy.DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}NoneNoneExample RequestDELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}Exam", + "desc":"This API is used to delete a VPN connection with a specified connection ID.For details, see Calling APIs.DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id}Request", "product_code":"vpn", - "title":"Deleting an IPsec Policy", - "uri":"en_topic_0093011508.html", + "title":"Deleting a VPN Connection", + "uri":"vpn_api_0031.html", "doc_type":"api", "p_code":"27", "code":"32" @@ -290,154 +290,766 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"IKE Policy Management", - "uri":"en_topic_0093011509.html", + "title":"VPN Connection Monitoring", + "uri":"vpn_api_0032.html", "doc_type":"api", - "p_code":"14", + "p_code":"13", "code":"33" }, { - "desc":"This interface is used to create an IKE policy.POST /v2.0/vpn/ikepoliciesTable 1 describes the request parameters.The project_idparameter is not supported.The value of te", + "desc":"This API is used to create a VPN connection monitor to perform health check between gateways. After a VPN connection monitor is created, the VPN gateway sends probe packe", "product_code":"vpn", - "title":"Creating an IKE Policy", - "uri":"en_topic_0093011510.html", + "title":"Creating a VPN Connection Monitor", + "uri":"vpn_api_0033.html", "doc_type":"api", "p_code":"33", "code":"34" }, { - "desc":"This interface is used to query details about an IKE policy.GET /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneTable 2 describes the response parameters.Example RequestGET /v2.0", + "desc":"This API is used to query a VPN connection monitor with a specified ID.For details, see Calling APIs.GET /v5/{project_id}/connection-monitors/{connection_monitor_id}Reque", "product_code":"vpn", - "title":"Querying Details About an IKE Policy", - "uri":"en_topic_0093011511.html", + "title":"Querying a VPN Connection Monitor", + "uri":"vpn_api_0034.html", "doc_type":"api", "p_code":"33", "code":"35" }, { - "desc":"This interface is used to query IKE policies.GET /v2.0/vpn/ikepoliciesTable 1 describes the request parameters.The project_idparameter is not supported.Table 2 describes ", + "desc":"This API is used to query the list of VPN connection monitors.For details, see Calling APIs.GET /v5/{project_id}/connection-monitorsRequest parametersNoneNoneExample requ", "product_code":"vpn", - "title":"Querying IKE Policies", - "uri":"en_topic_0093011512.html", + "title":"Querying the List of VPN Connection Monitors", + "uri":"vpn_api_0035.html", "doc_type":"api", "p_code":"33", "code":"36" }, { - "desc":"This interface is used to update an IKE policy.If the IKE policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}Tab", + "desc":"This API is used to delete a VPN connection monitor with a specified ID.For details, see Calling APIs.DELETE /v5/{project_id}/connection-monitors/{connection_monitor_id}R", "product_code":"vpn", - "title":"Updating an IKE Policy", - "uri":"en_topic_0093011513.html", + "title":"Deleting a VPN Connection Monitor", + "uri":"vpn_api_0036.html", "doc_type":"api", "p_code":"33", "code":"37" }, { - "desc":"This interface is used to delete an IKE policy.DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneNoneExample RequestDELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}Example Respon", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"Deleting an IKE Policy", - "uri":"en_topic_0093011514.html", + "title":"Quota", + "uri":"vpn_api_0037.html", "doc_type":"api", - "p_code":"33", + "p_code":"13", "code":"38" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"This API is used to query VPN resource quotas of a tenant, including VPN gateways, customer gateways, and VPN connections.For details, see Calling APIs.GET /v5/{project_i", "product_code":"vpn", - "title":"VPN Endpoint Group Management", - "uri":"en_topic_0093011515.html", + "title":"Querying Quotas", + "uri":"vpn_api_0038.html", "doc_type":"api", - "p_code":"14", + "p_code":"38", "code":"39" }, { - "desc":"This interface is used to create a VPN endpoint group.POST /v2.0/vpn/endpoint-groupsTable 1 describes the request parameters.The project_idparameter is not supported.The ", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"Creating a VPN Endpoint Group", - "uri":"en_topic_0093011516.html", + "title":"Tags", + "uri":"vpn_api_0060.html", "doc_type":"api", - "p_code":"39", + "p_code":"13", "code":"40" }, { - "desc":"This interface is used to query details about a VPN endpoint group.GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneTable 2 describes the response parameters.Example ", + "desc":"This API is used to query resource instances based on tags.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/resource-instances/filterRequest parameters", "product_code":"vpn", - "title":"Querying Details About a VPN Endpoint Group", - "uri":"en_topic_0093011517.html", + "title":"Querying the Resource Instance List", + "uri":"vpn_api_0061.html", "doc_type":"api", - "p_code":"39", + "p_code":"40", "code":"41" }, { - "desc":"This interface is used to query VPN endpoint groups.GET /v2.0/vpn/endpoint-groupsTable 1 describes the request parameters.The project_idparameter is not supported.Table 2", + "desc":"This API is used to query the number of resource instances based on tags.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/resource-instances/countReque", "product_code":"vpn", - "title":"Querying VPN Endpoint Groups", - "uri":"en_topic_0093011518.html", + "title":"Querying the Number of Resource Instances", + "uri":"vpn_api_0062.html", "doc_type":"api", - "p_code":"39", + "p_code":"40", "code":"42" }, { - "desc":"This interface is used to update a VPN endpoint group.PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}Table 2 describes the request parameters.The endpoint_group_idparam", + "desc":"This API is used to add tags to a specified instance in batches.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/{resource_id}/tags/createRequest param", "product_code":"vpn", - "title":"Updating a VPN Endpoint Group", - "uri":"en_topic_0093011519.html", + "title":"Adding Resource Tags in Batches", + "uri":"vpn_api_0063.html", "doc_type":"api", - "p_code":"39", + "p_code":"40", "code":"43" }, { - "desc":"This interface is used to delete a VPN endpoint group.DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneNoneExample RequestDELETE /v2.0/vpn/endpoint-groups/{endpoin", + "desc":"This API is used to delete tags from a specified instance in batches.For details, see Calling APIs.POST /v5/{project_id}/{resource_type}/{resource_id}/tags/deleteRequest ", "product_code":"vpn", - "title":"Deleting a VPN Endpoint Group", - "uri":"en_topic_0093011520.html", + "title":"Deleting Resource Tags in Batches", + "uri":"vpn_api_0064.html", "doc_type":"api", - "p_code":"39", + "p_code":"40", "code":"44" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"This API is used to query tags of a specified instance.For details, see Calling APIs.GET /v5/{project_id}/{resource_type}/{resource_id}/tagsRequest parametersNoneNoneExam", "product_code":"vpn", - "title":"Common Parameters", - "uri":"en_topic_0093011521.html", + "title":"Querying Resource Tags", + "uri":"vpn_api_0065.html", "doc_type":"api", - "p_code":"", + "p_code":"40", "code":"45" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"This API is used to query all tags of a specified resource type in a specified project of a tenant.For details, see Calling APIs.GET /v5/{project_id}/{resource_type}/tags", "product_code":"vpn", - "title":"Common Returned Values", - "uri":"en_topic_0093011522.html", + "title":"Querying Project Tags", + "uri":"vpn_api_0066.html", "doc_type":"api", - "p_code":"45", + "p_code":"40", "code":"46" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"Error Codes", - "uri":"en_topic_0093011523.html", + "title":"Application Examples", + "uri":"vpn_api_0039.html", "doc_type":"api", - "p_code":"45", + "p_code":"1", "code":"47" }, + { + "desc":"This section describes how to create a VPN gateway by calling APIs.You have determined the region where the VPN gateway is to be deployed and obtained the endpoint for ca", + "product_code":"vpn", + "title":"Example 1: Creating a VPN Gateway", + "uri":"vpn_api_0040.html", + "doc_type":"api", + "p_code":"47", + "code":"48" + }, + { + "desc":"This section describes how to create a customer gateway by calling APIs.You have obtained a user token if you need to use token authentication. In addition, you need to a", + "product_code":"vpn", + "title":"Example 2: Creating a Customer Gateway", + "uri":"vpn_api_0041.html", + "doc_type":"api", + "p_code":"47", + "code":"49" + }, + { + "desc":"This section describes how to create a VPN connection by calling APIs.You have created a VPN gateway. For details, see Creating a VPN Gateway.You have created a customer ", + "product_code":"vpn", + "title":"Example 3: Creating a VPN Connection", + "uri":"vpn_api_0042.html", + "doc_type":"api", + "p_code":"47", + "code":"50" + }, + { + "desc":"This section describes how to create a VPN connection monitor by calling APIs.You have created a VPN connection. For details, see Creating a VPN Connection.You have obtai", + "product_code":"vpn", + "title":"Example 4: Creating a VPN Connection Monitor", + "uri":"vpn_api_0043.html", + "doc_type":"api", + "p_code":"47", + "code":"51" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Permissions and Supported Actions", + "uri":"vpn_api_0044.html", + "doc_type":"api", + "p_code":"1", + "code":"52" + }, + { + "desc":"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 ca", + "product_code":"vpn", + "title":"Introduction", + "uri":"vpn_api_0045.html", + "doc_type":"api", + "p_code":"52", + "code":"53" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Actions Supported by Enterprise Edition VPN", + "uri":"vpn_api_0114.html", + "doc_type":"api", + "p_code":"52", + "code":"54" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Gateway", + "uri":"vpn_api_0115.html", + "doc_type":"api", + "p_code":"54", + "code":"55" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Customer Gateway", + "uri":"vpn_api_0116.html", + "doc_type":"api", + "p_code":"54", + "code":"56" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Connection", + "uri":"vpn_api_0117.html", + "doc_type":"api", + "p_code":"54", + "code":"57" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Connection Monitor", + "uri":"vpn_api_0118.html", + "doc_type":"api", + "p_code":"54", + "code":"58" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Actions Supported by Public Service APIs", + "uri":"vpn_api_0124.html", + "doc_type":"api", + "p_code":"52", + "code":"59" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Quota", + "uri":"vpn_api_0125.html", + "doc_type":"api", + "p_code":"59", + "code":"60" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Tag", + "uri":"vpn_api_0126.html", + "doc_type":"api", + "p_code":"59", + "code":"61" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Appendixes", + "uri":"vpn_api_0050.html", + "doc_type":"api", + "p_code":"1", + "code":"62" + }, + { + "desc":"A project ID is required by some URLs used for calling APIs. You can obtain the project ID using either of the following methods:Obtaining the project ID by calling an AP", + "product_code":"vpn", + "title":"Obtaining the Project ID", + "uri":"vpn_api_0051.html", + "doc_type":"api", + "p_code":"62", + "code":"63" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", "title":"Status Codes", - "uri":"en_topic_0093011524.html", + "uri":"vpn_api_0052.html", "doc_type":"api", - "p_code":"45", - "code":"48" + "p_code":"62", + "code":"64" + }, + { + "desc":"If an error occurs when an API is called, error information is returned. This section describes the error information for VPN APIs (excluding native OpenStack APIs).", + "product_code":"vpn", + "title":"Error Codes", + "uri":"vpn_api_0067.html", + "doc_type":"api", + "p_code":"62", + "code":"65" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"vpn", - "title":"A Change History", - "uri":"en_topic_0093011528.html", + "title":"API Reference - Classic VPN", + "uri":"vpn_api_1002.html", "doc_type":"api", "p_code":"", - "code":"49" + "code":"66" + }, + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"vpn", + "title":"API Usage Guidelines", + "uri":"vpn_api_1003.html", + "doc_type":"api", + "p_code":"66", + "code":"67" + }, + { + "desc":"VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.A combination of these two types of APIs allows you to use all functions provided by the ", + "product_code":"vpn", + "title":"API Overview", + "uri":"vpn_api_1004.html", + "doc_type":"api", + "p_code":"66", + "code":"68" + }, + { + "desc":"The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the s", + "product_code":"vpn", + "title":"VPN API Usage Instructions", + "uri":"vpn_api_1011.html", + "doc_type":"api", + "p_code":"66", + "code":"69" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"API", + "uri":"vpn_api_1012.html", + "doc_type":"api", + "p_code":"66", + "code":"70" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"API Version Information", + "uri":"vpn_api_1013.html", + "doc_type":"api", + "p_code":"70", + "code":"71" + }, + { + "desc":"This API is used to query all available versions of a native OpenStack API.GETRequest parameterNoneExample requestResponse parameterExample responseSee Status Codes.See E", + "product_code":"vpn", + "title":"Querying API Versions", + "uri":"vpn_api_1014.html", + "doc_type":"api", + "p_code":"71", + "code":"72" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Tag Management", + "uri":"vpn_api_1015.html", + "doc_type":"api", + "p_code":"70", + "code":"73" + }, + { + "desc":"This API is used to query VPNs by tag.Tag Management Service (TMS) filters service resource instances by tag and displays them in a list.POST /v2.0/{project_id}/ipsec-sit", + "product_code":"vpn", + "title":"Querying VPNs by Tag", + "uri":"vpn_api_1016.html", + "doc_type":"api", + "p_code":"73", + "code":"74" + }, + { + "desc":"This API is used to batch create or delete VPN tags.This API is idempotent.If there are duplicate keys in the request body when you add tags, an error is reported.During ", + "product_code":"vpn", + "title":"Batch Creating or Deleting VPN Tags", + "uri":"vpn_api_1017.html", + "doc_type":"api", + "p_code":"73", + "code":"75" + }, + { + "desc":"This API is used to create tags for a VPN.POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_id indicates the project ID, and resource_i", + "product_code":"vpn", + "title":"Creating Tags for a VPN", + "uri":"vpn_api_1018.html", + "doc_type":"api", + "p_code":"73", + "code":"76" + }, + { + "desc":"This API is used to query tags of a specified VPN.GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tagsIn the URI, project_id indicates the project ID, and res", + "product_code":"vpn", + "title":"Querying VPN Tags", + "uri":"vpn_api_1019.html", + "doc_type":"api", + "p_code":"73", + "code":"77" + }, + { + "desc":"This API is used to delete VPN tags.DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}In the URI, project_id indicates the project ID, resource_id ", + "product_code":"vpn", + "title":"Deleting VPN Tags", + "uri":"vpn_api_1020.html", + "doc_type":"api", + "p_code":"73", + "code":"78" + }, + { + "desc":"This API is used to query all tags of a VPN in a specified project.GET /v2.0/{project_id}/ipsec-site-connections/tagsIn the URI, project_id indicates the project ID.NoneT", + "product_code":"vpn", + "title":"Querying VPN Tags in a Specified Project", + "uri":"vpn_api_1021.html", + "doc_type":"api", + "p_code":"73", + "code":"79" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Native OpenStack APIs", + "uri":"vpn_api_1022.html", + "doc_type":"api", + "p_code":"66", + "code":"80" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"IPsec Connection Management", + "uri":"vpn_api_1023.html", + "doc_type":"api", + "p_code":"80", + "code":"81" + }, + { + "desc":"This API is used to create an IPsec VPN connection.POST /v2.0/vpn/ipsec-site-connectionsTable 1 lists the request parameters for creating an IPsec site connection.route_m", + "product_code":"vpn", + "title":"Creating an IPsec VPN Connection", + "uri":"vpn_api_1024.html", + "doc_type":"api", + "p_code":"81", + "code":"82" + }, + { + "desc":"This API is used to query details about an IPsec VPN connection.GET /v2.0/vpn/ipsec-site-connections/{connection_id}NoneTable 2 describes the response parameters.Example ", + "product_code":"vpn", + "title":"Querying Details About an IPsec VPN Connection", + "uri":"vpn_api_1025.html", + "doc_type":"api", + "p_code":"81", + "code":"83" + }, + { + "desc":"This API is used to query IPsec VPN connections.GET /v2.0/vpn/ipsec-site-connectionsTable 1 describes the request parameter.Table 2 describes the response parameters.For ", + "product_code":"vpn", + "title":"Querying IPsec VPN Connections", + "uri":"vpn_api_1026.html", + "doc_type":"api", + "p_code":"81", + "code":"84" + }, + { + "desc":"This API is used to update an IPsec VPN connection.PUT /v2.0/vpn/ipsec-site-connections/{connection_id}Table 2 describes the request parameters.Table 4 describes the resp", + "product_code":"vpn", + "title":"Updating an IPsec VPN Connection", + "uri":"vpn_api_1027.html", + "doc_type":"api", + "p_code":"81", + "code":"85" + }, + { + "desc":"This interface is used to delete an IPsec VPN connection.DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}NoneNoneExample RequestDELETE /v2.0/vpn/ipsec-site-connect", + "product_code":"vpn", + "title":"Deleting an IPsec VPN Connection", + "uri":"vpn_api_1028.html", + "doc_type":"api", + "p_code":"81", + "code":"86" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Service Management", + "uri":"vpn_api_1029.html", + "doc_type":"api", + "p_code":"80", + "code":"87" + }, + { + "desc":"This API is used to create a VPN service.Only one VPN service can be created for each VPC.POST /v2.0/vpn/vpnservicesTable 1 describes the request parameters.Parameter pro", + "product_code":"vpn", + "title":"Creating a VPN Service", + "uri":"vpn_api_1030.html", + "doc_type":"api", + "p_code":"87", + "code":"88" + }, + { + "desc":"This API is used to query details about a VPN service.GET /v2.0/vpn/vpnservices/{service_id}NoneTable 2 describes the response parameters.Example requestGET /v2.0/vpn/vpn", + "product_code":"vpn", + "title":"Querying Details About a VPN Service", + "uri":"vpn_api_1031.html", + "doc_type":"api", + "p_code":"87", + "code":"89" + }, + { + "desc":"This API is used to query VPN services.GET /v2.0/vpn/vpnservicesTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes the respon", + "product_code":"vpn", + "title":"Querying VPN Services", + "uri":"vpn_api_1032.html", + "doc_type":"api", + "p_code":"87", + "code":"90" + }, + { + "desc":"This API is used to update a VPN service.PUT /v2.0/vpn/vpnservices/{service_id}Table 2 describes the request parameters.Parameter project_id is not supported.Table 3 desc", + "product_code":"vpn", + "title":"Updating a VPN Service", + "uri":"vpn_api_1033.html", + "doc_type":"api", + "p_code":"87", + "code":"91" + }, + { + "desc":"This interface is used to delete a VPN service.This interface cannot be used to delete a VPN service in the active-active VPN scenarios.DELETE /v2.0/vpn/vpnservices/{serv", + "product_code":"vpn", + "title":"Deleting a VPN Service", + "uri":"vpn_api_1034.html", + "doc_type":"api", + "p_code":"87", + "code":"92" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"IPsec Policy Management", + "uri":"vpn_api_1035.html", + "doc_type":"api", + "p_code":"80", + "code":"93" + }, + { + "desc":"This API is used to create an IPsec policy.POST /v2.0/vpn/ipsecpoliciesParameter project_id is not supported.Table 2 describes the response parameters.Example requestPOST", + "product_code":"vpn", + "title":"Creating an IPsec Policy", + "uri":"vpn_api_1036.html", + "doc_type":"api", + "p_code":"93", + "code":"94" + }, + { + "desc":"This API is used to query details about an IPsec policy.GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}Parameter project_id is not supported.NoneTable 2 describes the respon", + "product_code":"vpn", + "title":"Querying Details About an IPsec Policy", + "uri":"vpn_api_1037.html", + "doc_type":"api", + "p_code":"93", + "code":"95" + }, + { + "desc":"This API is used to query IPsec policies.GET /v2.0/vpn/ipsecpoliciesTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes the re", + "product_code":"vpn", + "title":"Querying IPsec Policies", + "uri":"vpn_api_1038.html", + "doc_type":"api", + "p_code":"93", + "code":"96" + }, + { + "desc":"This API is used to update an IPsec policy.If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}T", + "product_code":"vpn", + "title":"Updating an IPsec Policy", + "uri":"vpn_api_1039.html", + "doc_type":"api", + "p_code":"93", + "code":"97" + }, + { + "desc":"This interface is used to delete an IPsec policy.DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}NoneNoneExample RequestExample ResponseNoneNoneFor details, see section Co", + "product_code":"vpn", + "title":"Deleting an IPsec Policy", + "uri":"vpn_api_1040.html", + "doc_type":"api", + "p_code":"93", + "code":"98" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"IKE Policy Management", + "uri":"vpn_api_1041.html", + "doc_type":"api", + "p_code":"80", + "code":"99" + }, + { + "desc":"This API is used to create an IKE policy.POST /v2.0/vpn/ikepoliciesTable 1 describes the request parameters.Parameter project_id is not supported.Table 2 describes the re", + "product_code":"vpn", + "title":"Creating an IKE Policy", + "uri":"vpn_api_1042.html", + "doc_type":"api", + "p_code":"99", + "code":"100" + }, + { + "desc":"This API is used to query details about an IKE policy.GET /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneTable 2 describes the response parameters.Example requestGET /v2.0/vpn/i", + "product_code":"vpn", + "title":"Querying Details About an IKE Policy", + "uri":"vpn_api_1043.html", + "doc_type":"api", + "p_code":"99", + "code":"101" + }, + { + "desc":"This API is used to query IKE policies.GET /v2.0/vpn/ikepoliciesTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes the respon", + "product_code":"vpn", + "title":"Querying IKE Policies", + "uri":"vpn_api_1044.html", + "doc_type":"api", + "p_code":"99", + "code":"102" + }, + { + "desc":"This API is used to update an IKE policy.If the IKE policy is updated, the IPsec VPN connection also needs to be updated.PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}Table 2 d", + "product_code":"vpn", + "title":"Updating an IKE Policy", + "uri":"vpn_api_1045.html", + "doc_type":"api", + "p_code":"99", + "code":"103" + }, + { + "desc":"This interface is used to delete an IKE policy.DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}NoneNoneExample RequestDELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}Example Respon", + "product_code":"vpn", + "title":"Deleting an IKE Policy", + "uri":"vpn_api_1046.html", + "doc_type":"api", + "p_code":"99", + "code":"104" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"VPN Endpoint Group Management", + "uri":"vpn_api_1047.html", + "doc_type":"api", + "p_code":"80", + "code":"105" + }, + { + "desc":"This API is used to create a VPN endpoint group.POST /v2.0/vpn/endpoint-groupsTable 1 describes the request parameters.Parameter project_id is not supported.Table 2 descr", + "product_code":"vpn", + "title":"Creating a VPN Endpoint Group", + "uri":"vpn_api_1048.html", + "doc_type":"api", + "p_code":"105", + "code":"106" + }, + { + "desc":"This API is used to query details about a VPN endpoint group.GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneTable 2 describes the response parameters.Example reques", + "product_code":"vpn", + "title":"Querying Details About a VPN Endpoint Group", + "uri":"vpn_api_1049.html", + "doc_type":"api", + "p_code":"105", + "code":"107" + }, + { + "desc":"This API is used to query VPN endpoint groups.GET /v2.0/vpn/endpoint-groupsTable 1 describes the request parameter.Parameter project_id is not supported.Table 2 describes", + "product_code":"vpn", + "title":"Querying VPN Endpoint Groups", + "uri":"vpn_api_1050.html", + "doc_type":"api", + "p_code":"105", + "code":"108" + }, + { + "desc":"This API is used to update a VPN endpoint group.PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}Table 2 describes the request parameters.Parameter project_id is not supp", + "product_code":"vpn", + "title":"Updating a VPN Endpoint Group", + "uri":"vpn_api_1051.html", + "doc_type":"api", + "p_code":"105", + "code":"109" + }, + { + "desc":"This interface is used to delete a VPN endpoint group.DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}NoneNoneExample RequestExample ResponseNoneNoneFor details, see ", + "product_code":"vpn", + "title":"Deleting a VPN Endpoint Group", + "uri":"vpn_api_1052.html", + "doc_type":"api", + "p_code":"105", + "code":"110" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Common Parameters", + "uri":"vpn_api_1053.html", + "doc_type":"api", + "p_code":"66", + "code":"111" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Common Returned Values", + "uri":"vpn_api_1054.html", + "doc_type":"api", + "p_code":"111", + "code":"112" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Error Codes", + "uri":"vpn_api_1055.html", + "doc_type":"api", + "p_code":"111", + "code":"113" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Status Codes", + "uri":"vpn_api_1056.html", + "doc_type":"api", + "p_code":"111", + "code":"114" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Permissions and Supported Actions", + "uri":"classic_vpn_0055.html", + "doc_type":"api", + "p_code":"66", + "code":"115" + }, + { + "desc":"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 ca", + "product_code":"vpn", + "title":"Introduction", + "uri":"classic_vpn_0056.html", + "doc_type":"api", + "p_code":"115", + "code":"116" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"vpn", + "title":"Change History", + "uri":"vpn_api_1057.html", + "doc_type":"api", + "p_code":"", + "code":"117" } ] \ No newline at end of file diff --git a/docs/vpn/api-ref/classic_vpn_0055.html b/docs/vpn/api-ref/classic_vpn_0055.html new file mode 100644 index 00000000..4a86fd88 --- /dev/null +++ b/docs/vpn/api-ref/classic_vpn_0055.html @@ -0,0 +1,15 @@ + + +
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.
+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.
+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.
+Policy-based authorization is useful if you want to allow or deny the access to an API.
+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 vpn:vpnGateways:list action.
+Supported Actions
+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:
+VPN supports the following actions that can be defined in custom policies:
+[Example] VPN gateway, including actions supported by VPN gateway APIs, such as the APIs for creating, querying, updating, and deleting VPN gateways.
+Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
-Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
-For details about how to use APIs, see API Usage Guidelines.
-VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.
-A combination of these two types of APIs allows you to use all functions provided by the VPN service.
- -Category - |
-Sub-Category - |
-Description - |
-
---|---|---|
Native OpenStack API - |
-IPsec connection management - |
-APIs for creating, querying, modifying, and deleting IPsec connections - |
-
VPN service management - |
-APIs for creating, querying, modifying, and deleting VPN services - |
-|
IPsec policy management - |
-APIs for creating, querying, modifying, and deleting IPsec policies - |
-|
IKE policy management - |
-APIs for creating, querying, modifying, and deleting IKE policies - |
-|
VPN endpoint group management - |
-APIs for creating, querying, modifying, and deleting VPN endpoint groups - |
-|
VPN API - |
-Tag management - |
-APIs for creating, querying, and deleting tags, and querying VPN resources by tags - |
-
The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the VPN service APIs.
-This API is used to query all available versions of a native OpenStack API.
-GET
-Request parameter
-None
-Example request
-GET https://{Endpoint}/-
Response parameter
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
versions - |
-Array of version objects - |
-Specifies the API version list. For details, see Table 2. - |
-
Parameter - |
-Type - |
-Description - |
-
---|---|---|
status - |
-String - |
-Specifies the API version status. Possible values are as follows: -
|
-
id - |
-String - |
-Specifies the API version. - |
-
links - |
-Array of link objects - |
-Specifies the link list. For details, see Table 3. - |
-
Parameter - |
-Type - |
-Description - |
-
---|---|---|
href - |
-String - |
-Specifies the API link. - |
-
rel - |
-String - |
-Specifies the relationship between the API link and the API version. - |
-
Example response
-{ - "versions": [ - { - "status": "CURRENT", - "id": "v2.0", - "links": [ - { - "href": "https://None/v2.0", - "rel": "self" - } - ] - } - ] -}-
See Status Codes.
-See Error Codes.
-This interface is used to query VPN resource instances by tag.
-Tag Management Service (TMS) uses this API to filter out service resources and display them in a list. These services must have the query capabilities.
-POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
tags - |
-List<tag> - |
-No - |
-Specifies the included tags. Each tag contains a maximum of 10 keys, and each key contains a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique. - |
-
limit - |
-Integer - |
-No - |
-Sets the page size. This parameter is not available when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number. - |
-
offset - |
-Integer - |
-No - |
-Specifies the index position. The query starts from the next piece of data indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number. - |
-
action - |
-String - |
-Yes - |
-Specifies the operation to perform. The value can only be filter (filtering) or count (querying the total number). -The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned. - |
-
matches - |
-List<match> - |
-No - |
-Specifies the search criteria. The tag key is the field to match. Currently, only resource_name is supported. The tag value indicates the value to be matched. The key field is a fixed dictionary value. - |
-
Name - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
key - |
-String - |
-Yes - |
-Specifies the tag key. It contains a maximum of 127 Unicode characters. It cannot be left blank. (This parameter is not verified in the search process.) - |
-
values - |
-List<String> - |
-Yes - |
-Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The resources containing one or more values listed in values will be found and displayed. - |
-
Name - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
key - |
-String - |
-Yes - |
-Specifies the tag key. Currently, the tag key can only be the resource name. - |
-
value - |
-String - |
-Yes - |
-Specifies the tag value. Each value can contain a maximum of 255 Unicode characters. - |
-
Name - |
-Type - |
-Description - |
-
---|---|---|
resources - |
-List<resource> - |
-N/A - |
-
total_count - |
-int - |
-Specifies the total number of records. - |
-
Name - |
-Type - |
-Description - |
-
---|---|---|
resource_id - |
-String - |
-Specifies the resource ID. - |
-
resouce_detail - |
-Object - |
-Specifies the resource details. The value is a resource object, used for extension. This parameter is left blank by default. - |
-
tags - |
-List<resource_tag> - |
-Specifies the tag list. This parameter is an empty array by default if there is no tag. - |
-
resource_name - |
-String - |
-Specifies the resource name. This parameter is an empty string by default if there is no resource name. - |
-
POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action-
{ - "offset": "0", - "limit": "100", - "action": "filter", - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ], - "tags": [ - { - "key": "key1", - "values": [ - "*value1", - "value2" - ] - } - ] -}-
{ - "action": "count", - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ], - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ] -}-
{ - "resources": [ - { - "resource_detail": null, - "resource_id": "cdfs_cefs_wesas_12_dsad", - "resource_name": "resouece1", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value1" - } - ] - } - ], - "total_count": 1000 -} --
{ - "total_count": 1000 -}-
This interface is used to add multiple tags to or delete multiple tags from a VPN resource instance at a time.
-This API is idempotent.
-If there are duplicate keys in the request body when you add tags, an error is reported.
-During tag creation, duplicate keys are not allowed. If a key exists in the database, its value will be overwritten.
-During tag deletion, if some tags do not exist, the operation is considered to be successful by default. The character set of the tags will not be checked. When you delete tags, the tag structure cannot be missing, and the key cannot be left blank or be an empty string.
-POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/action
-In the URI, project_id indicates the project ID, and resource_id indicates the target resource ID.
-Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
tags - |
-List<resource_tag> - |
-Yes - |
-Specifies the tag list. A tag list can contain a maximum of 10 keys. - |
-
action - |
-String - |
-Yes - |
-Specifies the operation to perform. The value can be create or delete. - |
-
Description of field resource_tag
- -Name - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
key - |
-String - |
-Yes - |
-Specifies the tag key. -The parameter constraints are as follows: -
|
-
value - |
-String - - |
-(This parameter is mandatory when action is set to create and optional when action is set to delete.) - |
-Specifies the tag value list. -The parameter constraints are as follows: -
|
-
None
-POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/action-
{ - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key", - "value": "value3" - } - ] -}-
Or
-{ - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] -}-
For details, see section Common Returned Values.
-This interface is used to create a tag for a VPN resource.
-POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
-In the URI, project_id indicates the project ID, and resource_id indicates the target resource ID.
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
tag - |
-List<resource_tag> - |
-Yes - |
-Specifies the tag. - |
-
Description of field resource_tag
- -Name - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
key - |
-String - |
-Yes - |
-Specifies the tag key. -The parameter constraints are as follows: -
|
-
value - |
-String - |
-Yes - |
-Specifies the tag value. -The parameter constraints are as follows: -
|
-
None
-POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags -{ - "tag": { - "key": "key1", - "value": "value1" - } -}- -
For details, see section Common Returned Values.
-This interface is used to query tags of a specified VPN resource.
-GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
-In the URI, project_id indicates the project ID, and resource_id indicates the target resource ID.
-None
-Table 1 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
tags - |
-List<resource_tag> - |
-Specifies the tag list. - |
-
Description of field resource_tag
- -Name - |
-Type - |
-Description - |
-
---|---|---|
key - |
-String - |
-Specifies the tag key. -The parameter constraints are as follows: -
|
-
value - |
-String - |
-Specifies the tag value. -The parameter constraints are as follows: -
|
-
GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags-
{ - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] -}-
For details, see section Common Returned Values.
-This interface is used to delete a VPN resource tag.
-DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}
-In the URI, project_id indicates the project ID, resource_id indicates the target resource ID, and key indicates the tag key to be deleted.
-None
-None
-DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}-
For details, see section Common Returned Values.
-This interface is used to query all tags of a VPN in a specified region.
-GET /v2.0/{project_id}/ipsec-site-connections/tags
-In the URI, project_id indicates the project ID.
-None
-Table 1 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
tags - |
-List<tag> - |
-Specifies the tag list. - |
-
Name - |
-Type - |
-Description - |
-
---|---|---|
key - |
-String - |
-Specifies the tag key. -The parameter constraints are as follows: -
|
-
values - |
-List<String> - |
-Specifies the tag value list. -The parameter constraints are as follows: -
|
-
GET /v2.0/{project_id}/ipsec-site-connections/tags-
{ - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ] -}-
For details, see section Common Returned Values.
-This interface is used to create an IPsec VPN connection.
-POST /v2.0/vpn/ipsec-site-connections
-Table 1 lists the request parameters for creating an IPsec site connection.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
dpd - |
-Object - |
-No - |
-Specifies the DPD protocol control. - |
-
local_id - |
-String - |
-No - |
-Specifies the ID of the external gateway address of a virtual router. - |
-
psk - |
-String - |
-Yes - |
-Specifies the pre-shared key. - |
-
initiator - |
-String - |
-No - |
-Specifies whether this VPN can only respond to connections or both respond to and initiate connections. - |
-
ipsecpolicy_id - |
-String - |
-Yes - |
-Specifies the IPsec policy ID. - |
-
admin_state_up - |
-Boolean - |
-No - |
-Specifies the administrative status. The value can be true or false. - |
-
mtu - |
-Integer - |
-No - |
-Specifies the maximum transmission unit to address fragmentation. - |
-
peer_ep_group_id - |
-String - |
-Yes - |
-Specifies the endpoint group ID (tenant CIDR blocks). - |
-
ikepolicy_id - |
-String - |
-Yes - |
-Specifies the IKE policy ID. - |
-
vpnservice_id - |
-String - |
-Yes - |
-Specifies the VPN service ID. - |
-
local_ep_group_id - |
-String - |
-Yes - |
-Specifies the endpoint group ID (VPC subnets). - |
-
peer_address - |
-String - |
-Yes - |
-Specifies the remote gateway address. - |
-
peer_id - |
-String - |
-Yes - |
-Specifies the remote gateway ID. - |
-
name - |
-String - |
-No - |
-Specifies the IPsec VPN connection name. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the IPsec VPN connection. - |
-
auth_mode - |
-String - |
-No - |
-Specifies the authentication mode. The default value is psk. - |
-
peer_cidrs - |
-List<String> - |
-No - |
-(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >. - |
-
tenant_id - |
-String - |
-No - |
-Specifies the project ID. - |
-
Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
interval - |
-Integer - |
-Specifies the DPD interval in seconds. The default value is 30. - |
-
dpd - |
-Object - |
-Specifies the DPD protocol control. - |
-
psk - |
-String - |
-Specifies the pre-shared key. - |
-
initiator - |
-String - |
-Specifies whether this VPN can only respond to connections or both respond to and initiate connections. - |
-
ipsecpolicy_id - |
-String - |
-Specifies the IPsec policy ID. - |
-
admin_state_up - |
-Boolean - |
-Specifies the administrative status. The value can be true or false. - |
-
mtu - |
-Integer - |
-Specifies the maximum transmission unit to address fragmentation. - |
-
peer_ep_group_id - |
-String - |
-Specifies the endpoint group ID (tenant CIDR blocks). - |
-
ikepolicy_id - |
-String - |
-Specifies the IKE policy ID. - |
-
vpnservice_id - |
-String - |
-Specifies the VPN service ID. - |
-
local_ep_group_id - |
-String - |
-Specifies the endpoint group ID (VPC subnets). - |
-
peer_address - |
-String - |
-Specifies the remote gateway address. - |
-
peer_id - |
-String - |
-Specifies the remote gateway ID. - |
-
name - |
-String - |
-Specifies the IPsec VPN connection name. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec VPN connection. - |
-
auth_mode - |
-String - |
-Specifies the authentication mode. The default value is psk. - |
-
id - |
-String - |
-Specifies the IPsec VPN connection ID. - |
-
route_mode - |
-String - |
-Specifies the route advertising mode. The default value is static. - |
-
status - |
-String - |
-Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
peer_cidrs - |
-List - |
-(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
timeout - |
-Integer - |
-Specifies the DPD timeout. The default value is 120 seconds. - |
-
action - |
-String - |
-Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold. - |
-
created_at - |
-String - |
-Specifies the time when the IPsec connection was created. - |
-
POST /v2.0/vpn/ipsec-site-connections -{ - "ipsec_site_connection" : { - "psk" : "secret", - "initiator" : "bi-directional", - "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", - "admin_state_up" : true, - "mtu" : 1500, - "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", - "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", - "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", - "peer_address" : "172.24.4.233", - "peer_id" : "172.24.4.233", - "name" : "vpnconnection1" - } -}-
{ - "ipsec_site_connection" : { - "status" : "PENDING_CREATE", - "psk" : "secret", - "initiator" : "bi-directional", - "name" : "vpnconnection1", - "admin_state_up" : true, - "tenant_id" : "10039663455a446d8ba2cbb058b0f578", - "auth_mode" : "psk", - "peer_cidrs" : [ ], - "mtu" : 1500, - "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", - "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", - "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "dpd" : { - "action" : "hold", - "interval" : 30, - "timeout" : 120 - }, - "route_mode" : "static", - "vpnservice_id": "4754261f-f8c5-4799-a365-78b2e682e38a", - "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", - "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", - "peer_address" : "172.24.4.233", - "created_at": "2018-11-03 14:24:33.749714", - "peer_id" : "172.24.4.233", - "id" : "851f280f-5639-4ea3-81aa-e298525ab74b", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query details about an IPsec VPN connection.
-GET /v2.0/vpn/ipsec-site-connections/{connection_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
connection_id - |
-String - |
-Yes - |
-Specifies the IPsec VPN connection ID. - |
-
None
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
local_ep_group_id - |
-String - |
-Specifies the endpoint group ID (VPC subnets). - |
-
status - |
-String - |
-Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
psk - |
-String - |
-Specifies the pre-shared key. - |
-
initiator - |
-String - |
-Specifies whether this VPN can only respond to connections or both respond to and initiate connections. - |
-
name - |
-String - |
-Specifies the IPsec VPN connection name. - |
-
admin_state_up - |
-Boo - |
-Specifies the administrative status. The value can be true or false. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
ipsecpolicy_id - |
-String - |
-Specifies the IPsec policy ID. - |
-
auth_mode - |
-String - |
-Specifies the authentication mode. The default value is psk. - |
-
peer_cidrs - |
-List<String> - |
-(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >. - |
-
mtu - |
-Integer - |
-Specifies the maximum transmission unit to address fragmentation. - |
-
ikepolicy_id - |
-String - |
-Specifies the IKE policy ID. - |
-
peer_address - |
-String - |
-Specifies the remote gateway address. - |
-
id - |
-String - |
-Specifies the IPsec VPN connection ID. - |
-
ipsec_site_connection - |
-Object - |
-Specifies the IPsec VPN connection object. - |
-
route_mode - |
-String - |
-Specifies the route advertising mode. The default value is static. - |
-
peer_id - |
-String - |
-Specifies the remote gateway ID. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec VPN connection. - |
-
interval - |
-Integer - |
-Specifies the DPD interval in seconds. The default value is 30. - |
-
peer_ep_group_id - |
-String - |
-Specifies the endpoint group ID (tenant CIDR blocks). - |
-
dpd - |
-Object - |
-Specifies the DPD protocol control. - |
-
timeout - |
-Integer - |
-Specifies the DPD timeout. The default value is 120 seconds. - |
-
action - |
-String - |
-Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold. - |
-
vpnservice_id - |
-String - |
-Specifies the VPN service ID. - |
-
GET /v2.0/vpn/ipsec-site-connections/{connection_id}-
{ - "ipsec_site_connection" : { - "status" : "DOWN", - "psk" : "secret", - "initiator" : "bi-directional", - "name" : "vpnconnection1", - "admin_state_up" : true, - "project_id" : "10039663455a446d8ba2cbb058b0f578", - "tenant_id" : "10039663455a446d8ba2cbb058b0f578", - "auth_mode" : "psk", - "peer_cidrs" : [ ], - "mtu" : 1500, - "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", - "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", - "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "dpd" : { - "action" : "hold", - "interval" : 30, - "timeout" : 120 - }, - "route_mode" : "static", - "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", - "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", - "peer_address" : "172.24.4.226", - "peer_id" : "172.24.4.226", - "id" : "851f280f-5639-4ea3-81aa-e298525ab74b", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query IPsec VPN connections.
-GET /v2.0/vpn/ipsec-site-connections
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
fields - |
-String - |
-No - |
-Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. - |
-
The project_id, peer_id, dpd, and local_id parameters are not supported.
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
peer_cidrs - |
-List<String> - |
-(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >. - |
-
mtu - |
-Integer - |
-Specifies the maximum transmission unit to address fragmentation. - |
-
peer_ep_group_id - |
-String - |
-Specifies the endpoint group ID (tenant CIDR blocks). - |
-
ikepolicy_id - |
-String - |
-Specifies the IKE policy ID. - |
-
dpd - |
-Object - |
-Specifies the DPD protocol control. - |
-
route_mode - |
-String - |
-Specifies the route advertising mode. The default value is static. - |
-
peer_address - |
-String - |
-Specifies the remote gateway address. - |
-
peer_id - |
-String - |
-Specifies the remote gateway ID. - |
-
id - |
-String - |
-Specifies the IPsec VPN connection ID. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec VPN connection. - |
-
project_id - |
-String - |
-Specifies the project ID. - |
-
interval - |
-Integer - |
-Specifies the DPD interval in seconds. The default value is 30. - |
-
timeout - |
-Integer - |
-Specifies the DPD timeout. The default value is 120 seconds. - |
-
action - |
-String - |
-Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold. - |
-
vpnservice_id - |
-String - |
-Specifies the VPN service ID. - |
-
local_ep_group_id - |
-String - |
-Specifies the endpoint group ID (VPC subnets). - |
-
status - |
-String - |
-Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
psk - |
-String - |
-Specifies the pre-shared key. - |
-
initiator - |
-String - |
-Specifies whether this VPN can only respond to connections or both respond to and initiate connections. - |
-
name - |
-String - |
-Specifies the IPsec VPN connection name. - |
-
admin_state_up - |
-Boolean - |
-Specifies the administrative status. The value can be true or false. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
ipsecpolicy_id - |
-String - |
-Specifies the IPsec policy ID. - |
-
auth_mode - |
-String - |
-Specifies the authentication mode. The default value is psk. - |
-
GET /v2.0/vpn/ipsec-site-connections-
{ - "ipsec_site_connections" : [ { - "status" : "PENDING CREATE", - "psk" : "secret", - "initiator" : "bi-directional", - "name" : "vpnconnection1", - "admin_state_up" : true, - "project_id" : "10039663455a446d8ba2cbb058b0f578", - "tenant_id" : "10039663455a446d8ba2cbb058b0f578", - "auth_mode" : "psk", - "peer_cidrs" : [ ], - "mtu" : 1500, - "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", - "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", - "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "dpd" : { - "action" : "hold", - "interval" : 30, - "timeout" : 120 - }, - "route_mode" : "static", - "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", - "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", - "peer_address" : "172.24.4.226", - "peer_id" : "172.24.4.226", - "id" : "851f280f-5639-4ea3-81aa-e298525ab74b", - "description" : "" - } ] -}-
For details, see section Common Returned Values.
-This interface is used to update an IPsec VPN connection.
-PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
connection_id - |
-String - |
-Yes - |
-Specifies the IPsec VPN connection ID. - |
-
Table 2 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ipsec_site_connection - |
-Object - |
-Yes - |
-Specifies the IPsec VPN connection object. - |
-
psk - |
-String - |
-No - |
-Specifies the pre-shared key. - |
-
initiator - |
-String - |
-No - |
-Specifies whether this VPN can only respond to connections or both respond to and initiate connections. - |
-
description - |
-String - |
-No - |
-Specifies the IPsec policy ID. - |
-
admin_state_up - |
-Boolean - |
-No - |
-Specifies the administrative status. The value can be true or false. - |
-
interval - |
-Integer - |
-No - |
-Specifies the DPD interval in seconds. The default value is 30. - |
-
peer_cidrs - |
-List<String> - |
-No - |
-(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >. - |
-
mtu - |
-Integer - |
-No - |
-Specifies the maximum transmission unit to address fragmentation. - |
-
peer_ep_group_id - |
-String - |
-No - |
-Specifies the endpoint group ID (tenant CIDR blocks). - |
-
local_ep_group_id - |
-String - |
-No - |
-Specifies the endpoint group ID (VPC subnets). - |
-
dpd - |
-Object - |
-No - |
-Specifies the DPD protocol control. - |
-
timeout - |
-Integer - |
-No - |
-Specifies the DPD timeout. The default value is 120 seconds. - |
-
action - |
-String - |
-No - |
-Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold. - |
-
peer_address - |
-String - |
-Yes - |
-Specifies the remote gateway address. - |
-
peer_id - |
-String - |
-Yes - |
-Specifies the remote gateway ID. - |
-
name - |
-String - |
-No - |
-Specifies the IPsec VPN connection name. - |
-
Table 3 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
status - |
-String - |
-Specifies the IPsec VPN connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
psk - |
-String - |
-Specifies the pre-shared key. - |
-
initiator - |
-String - |
-Specifies whether this VPN can only respond to connections or both respond to and initiate connections. - |
-
name - |
-String - |
-Specifies the IPsec VPN connection name. - |
-
admin_state_up - |
-Boolean - |
-Specifies the administrative status. The value can be true or false. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
ipsecpolicy_id - |
-String - |
-Specifies the IPsec policy ID. - |
-
auth_mode - |
-String - |
-Specifies the authentication mode. The default value is psk. - |
-
peer_cidrs - |
-String - |
-(Deprecated) Specifies the tenant's CIDR blocks. The value is in the form of <net_address > / < prefix >. - |
-
mtu - |
-Integer - |
-Specifies the maximum transmission unit to address fragmentation. - |
-
peer_ep_group_id - |
-String - |
-Specifies the endpoint group ID (tenant CIDR blocks). - |
-
ikepolicy_id - |
-String - |
-Specifies the IKE policy ID. - |
-
dpd - |
-Object - |
-Specifies the DPD protocol control. - |
-
route_mode - |
-String - |
-Specifies the route advertising mode. The default value is static. - |
-
vpnservice_id - |
-String - |
-Specifies the VPN service ID. - |
-
local_ep_group_id - |
-String - |
-Specifies the endpoint group ID (VPC subnets). - |
-
peer_address - |
-String - |
-Specifies the remote gateway address. - |
-
peer_id - |
-String - |
-Specifies the remote gateway ID. - |
-
id - |
-String - |
-Specifies the IPsec VPN connection ID. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec VPN connection. - |
-
ipsec_site_connection - |
-Object - |
-Specifies the IPsec VPN connection object. - |
-
project_id - |
-String - |
-Specifies the project ID. - |
-
interval - |
-Integer - |
-Specifies the DPD interval in seconds. The default value is 30. - |
-
timeout - |
-Integer - |
-Specifies the DPD timeout. The default value is 120 seconds. - |
-
action - |
-String - |
-Specifies the DPD action. The value can be clear, hold, restart, disabled, or restart-by-peer. The default value is hold. - |
-
PUT /v2.0/vpn/ipsec-site-connections/{connection_id} -{ - "ipsec_site_connection" : { - "mtu" : 1200, - } -}-
{ - "ipsec_site_connection": { - "status": "DOWN", - "psk": "secret", - "initiator": "bi-directional", - "name": "vpnconnection1", - "admin_state_up": true, - "project_id": "10039663455a446d8ba2cbb058b0f578", - "tenant_id": "10039663455a446d8ba2cbb058b0f578", - "auth_mode": "psk", - "peer_cidrs": [], - "mtu": 1200, - "peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", - "ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", - "vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "dpd": { - "action": "hold", - "interval": 30, - "timeout": 120 - }, - "route_mode": "static", - "ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", - "local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68", - "peer_address": "172.24.4.233", - "peer_id": "172.24.4.233", - "id": "851f280f-5639-4ea3-81aa-e298525ab74b", - "description": "New description" - } -}-
For details, see section Common Returned Values.
-This interface is used to delete an IPsec VPN connection.
-DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
connection_id - |
-String - |
-Yes - |
-Specifies the IPsec VPN connection ID. - |
-
None
-None
-DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}-
For details, see section Common Returned Values.
-This interface is used to create a VPN service.
-Only one VPN service can be created for each VPC.
-POST /v2.0/vpn/vpnservices
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
subnet_id - |
-String - |
-No - |
-Specifies the subnet ID. - |
-
router_id - |
-String - |
-Yes - |
-Specifies the router ID. - |
-
name - |
-String - |
-No - |
-Specifies the VPN service name. - |
-
admin_state_up - |
-Boolean - |
-No - |
-Specifies the administrative status. The value can be true or false. - |
-
tenant_id - |
-String - |
-No - |
-Specifies the project ID. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the VPN service. - |
-
vpnservice - |
-Object - |
-Yes - |
-Specifies the VPN service object. - |
-
Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
router_id - |
-String - |
-Specifies the router ID. - |
-
status - |
-String - |
-Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
name - |
-String - |
-Specifies the VPN service name. - |
-
external_v6_ip - |
-String - |
-Specifies the IPv6 address of the VPN service external gateway. - |
-
admin_state_up - |
-Boolean - |
-Specifies the administrative status. The value can be true or false. - |
-
subnet_id - |
-String - |
-Specifies the subnet ID. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
external_v4_ip - |
-String - |
-Specifies the IPv4 address of the VPN service external gateway. - |
-
id - |
-String - |
-Specifies the VPN service ID. - |
-
description - |
-String - |
-Provides supplementary information about the VPN service. - |
-
vpnservice - |
-Object - |
-Specifies the VPN service object. - |
-
POST /v2.0/vpn/vpnservices -{ - "vpnservice": { - "subnet_id": null, - "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", - "name": "myservice", - "admin_state_up": true - } -}-
{ - "vpnservice" : { - "router_id" : "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", - "status" : "PENDING_CREATE", - "name" : "myservice", - "external_v6_ip" : "2001:db8::1", - "admin_state_up" : true, - "subnet_id" : null, - "project_id" : "10039663455a446d8ba2cbb058b0f578", - "tenant_id" : "10039663455a446d8ba2cbb058b0f578", - "external_v4_ip" : "172.32.1.11", - "id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query details about a VPN service.
-GET /v2.0/vpn/vpnservices/{service_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
service_id - |
-String - |
-Yes - |
-Specifies the VPN service ID. - |
-
None
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
status - |
-String - |
-Yes - |
-Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
router_id - |
-String - |
-Yes - |
-Specifies the router ID. - |
-
name - |
-String - |
-No - |
-Specifies the VPN service name. - |
-
external_v6_ip - |
-String - |
-Yes - |
-Specifies the IPv6 address of the VPN service external gateway. - |
-
admin_state_up - |
-Boolean - |
-No - |
-Specifies the administrative status. The value can be true or false. - |
-
subnet_id - |
-String - |
-No - |
-Specifies the subnet ID. - |
-
tenant_id - |
-String - |
-No - |
-Specifies the project ID. - |
-
external_v4_ip - |
-String - |
-Yes - |
-Specifies the IPv4 address of the VPN service external gateway. - |
-
id - |
-String - |
-Yes - |
-Specifies the VPN service ID. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the VPN service. - |
-
vpnservice - |
-Object - |
-Yes - |
-Specifies the VPN service object. - |
-
GET /v2.0/vpn/vpnservices/{service_id}-
{ - "vpnservice": { - "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", - "status": "PENDING_CREATE", - "name": "myservice", - "external_v6_ip": "2001:db8::1", - "admin_state_up": true, - "subnet_id": null, - "project_id": "10039663455a446d8ba2cbb058b0f578", - "tenant_id": "10039663455a446d8ba2cbb058b0f578", - "external_v4_ip": "172.32.1.11", - "id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "description": "", - } -}-
For details, see section Common Returned Values.
-This interface is used to query VPN services.
-GET /v2.0/vpn/vpnservices
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
fields - |
-String - |
-No - |
-Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. - |
-
The project_id parameter is not supported.
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
vpnservices - |
-List<Object> - |
-Yes - |
-Specifies the VPN service object. - |
-
status - |
-String - |
-Yes - |
-Specifies whether the VPN service is currently operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. - |
-
router_id - |
-String - |
-Yes - |
-Specifies the router ID. - |
-
name - |
-String - |
-Yes - |
-Specifies the VPN service name. - |
-
external_v6_ip - |
-String - |
-Yes - |
-Specifies the IPv6 address of the VPN service external gateway. - |
-
admin_state_up - |
-Boolean - |
-Yes - |
-Specifies the administrative status. The value can be true or false. - |
-
subnet_id - |
-String - |
-No - |
-Specifies the subnet ID. - |
-
tenant_id - |
-String - |
-Yes - |
-Specifies the project ID. - |
-
external_v4_ip - |
-String - |
-Yes - |
-Specifies the IPv4 address of the VPN service external gateway. - |
-
id - |
-String - |
-No - |
-Specifies the VPN service ID. - |
-
description - |
-String - |
-Yes - |
-Provides supplementary information about the VPN service. - |
-
GET /v2.0/vpn/vpnservices-
{ - "vpnservices": [ - { - "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", - "status": "PENDING_CREATE", - "name": "myservice", - "external_v6_ip": "2001:db8::1", - "admin_state_up": true, - "subnet_id": null, - "project_id": "10039663455a446d8ba2cbb058b0f578", - "tenant_id": "10039663455a446d8ba2cbb058b0f578", - "external_v4_ip": "172.32.1.11", - "id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828", - "description": "", - } - ] -}-
For details, see section Common Returned Values.
-This interface is used to update a VPN service.
-PUT /v2.0/vpn/vpnservices/{service_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
service_id - |
-String - |
-Yes - |
-Specifies the VPN service ID. - |
-
Table 2 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
description - |
-String - |
-No - |
-Provides supplementary information about the VPN service. - |
-
name - |
-String - |
-No - |
-Specifies the VPN service name. - |
-
admin_state_up - |
-Boolean - |
-No - |
-Specifies the administrative status. The value can be true or false. - |
-
vpnservice - |
-Object - |
-Yes - |
-Specifies the VPN service object. - |
-
Table 3 describes the response parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
id - |
-String - |
-Yes - |
-Specifies the VPN service ID. - |
-
router_id - |
-String - |
-Yes - |
-Specifies the router ID. - |
-
status - |
-String - |
-Yes - |
-Specifies the VPN service status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_UPDATE, or PENDING_DELETE. - |
-
name - |
-String - |
-Yes - |
-Specifies the VPN service name. - |
-
external_v6_ip - |
-String - |
-Yes - |
-Specifies the IPv6 address of the VPN service external gateway. - |
-
admin_state_up - |
-Boolean - |
-Yes - |
-Specifies the administrative status. The value can be true or false. - |
-
subnet_id - |
-String - |
-No - |
-Specifies the subnet ID. - |
-
tenant_id - |
-String - |
-Yes - |
-Specifies the project ID. - |
-
external_v4_ip - |
-String - |
-Yes - |
-Specifies the IPv4 address of the VPN service external gateway. - |
-
description - |
-String - |
-Yes - |
-Provides supplementary information about the VPN service. - |
-
vpnservice - |
-Object - |
-Yes - |
-Specifies the VPN service object. - |
-
PUT /v2.0/vpn/vpnservices/{service_id} -{ - "vpnservice" : { - "description" : "Updated description" - } -}-
{ - "vpnservice": { - "router_id": "881b7b30-4efb-407e-a162-5630a7af3595", - "status": "ACTIVE", - "name": "myvpn", - "admin_state_up": true, - "subnet_id": null, - "project_id": "26de9cd6cae94c8cb9f79d660d628e1f", - "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f", - "id": "41bfef97-af4e-4f6b-a5d3-4678859d2485", - "description": "Updated description", - } -}-
For details, see section Common Returned Values.
-This interface is used to delete a VPN service.
-This interface cannot be used to delete a VPN service in the active-active VPN scenarios.
-DELETE /v2.0/vpn/vpnservices/{service_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
service_id - |
-String - |
-Yes - |
-Specifies the VPN service ID. - |
-
None
-None
-DELETE v2.0/vpn/vpnservices/{service_id}-
For details, see section Common Returned Values.
-This interface is used to create an IPsec policy.
-POST /v2.0/vpn/ipsecpolicies
-Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
name - |
-String - |
-No - |
-Specifies the IPsec policy name. - |
-
pfs - |
-String - |
-No - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. -The value disable indicates that the PFS function is disabled. - |
-
auth_algorithm - |
-String - |
-No - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the IPsec policy. - |
-
encapsulation_mode - |
-String - |
-No - |
-Specifies the encapsulation mode. The default value is tunnel. - |
-
encryption_algorithm - |
-String - |
-No - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
ipsecpolicy - |
-Object - |
-Yes - |
-Specifies the IPsec policy object. - |
-
lifetime - |
-Object - |
-No - |
-Specifies the lifetime object of SA. - |
-
tenant_id - |
-String - |
-No - |
-Specifies the project ID. - |
-
transform_protocol - |
-String - |
-No - |
-Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp. - |
-
value - |
-Integer - |
-No - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-No - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec policy. - |
-
encapsulation_mode - |
-String - |
-Specifies the encapsulation mode. The default value is tunnel. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
id - |
-String - |
-Specifies the IPsec policy ID. - |
-
ipsecpolicy - |
-Object - |
-Specifies the IPsec policy object. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-Specifies the IPsec policy name. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. -The value disable indicates that the PFS function is disabled. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
transform_protocol - |
-String - |
-Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
POST /v2.0/vpn/ipsecpolicies -{ - "ipsecpolicy" : { - "name" : "ipsecpolicy1", - "transform_protocol" : "esp", - "auth_algorithm" : "sha1", - "encapsulation_mode" : "tunnel", - "encryption_algorithm" : "aes-128", - "pfs" : "group5", - "lifetime" : { - "units" : "seconds", - "value" : 7200 - } - } -}-
{ - "ipsecpolicy" : { - "name" : "ipsecpolicy1", - "transform_protocol" : "esp", - "auth_algorithm" : "sha1", - "encapsulation_mode" : "tunnel", - "encryption_algorithm" : "aes-128", - "pfs" : "group5", - "project_id" : "ccb81365fe36411a9011e90491fe1330", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "lifetime" : { - "units" : "seconds", - "value" : 7200 - }, - "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query details about an IPsec policy.
-GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ipsecpolicy_id - |
-String - |
-Yes - |
-Specifies the IPsec policy ID. - |
-
None
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
name - |
-String - |
-Specifies the IPsec policy name. - |
-
encapsulation_mode - |
-String - |
-Specifies the encapsulation mode. The default value is tunnel. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. -The value disable indicates that the PFS function is disabled. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
transform_protocol - |
-String - |
-Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
id - |
-String - |
-Specifies the IPsec policy ID. - |
-
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec policy. - |
-
ipsecpolicy - |
-Object - |
-Specifies the IPsec policy object. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}-
{ - "ipsecpolicy" : { - "name" : "ipsecpolicy1", - "transform_protocol" : "esp", - "auth_algorithm" : "sha1", - "encapsulation_mode" : "tunnel", - "encryption_algorithm" : "aes-128", - "pfs" : "group14", - "project_id" : "ccb81365fe36411a9011e90491fe1330", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "lifetime" : { - "units" : "seconds", - "value" : 3600 - }, - "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query IPsec policies.
-GET /v2.0/vpn/ipsecpolicies
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
fields - |
-String - |
-No - |
-Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. - |
-
The project_id parameter is not supported.
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
transform_protocol - |
-String - |
-Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
id - |
-String - |
-Specifies the IPsec policy ID. - |
-
encapsulation_mode - |
-String - |
-Specifies the encapsulation mode. The default value is tunnel. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. -The value disable indicates that the PFS function is disabled. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-Specifies the IPsec policy name. - |
-
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec policy. - |
-
ipsecpolicies - |
-List<Object> - |
-Specifies the IPsec policy list. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
GET /v2.0/vpn/ipsecpolicies-
{ - "ipsecpolicies" : [ { - "name" : "ipsecpolicy1", - "transform_protocol" : "esp", - "auth_algorithm" : "sha1", - "encapsulation_mode" : "tunnel", - "encryption_algorithm" : "aes-128", - "pfs" : "group14", - "project_id" : "ccb81365fe36411a9011e90491fe1330", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "lifetime" : { - "units" : "seconds", - "value" : 3600 - }, - "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c", - "description" : "" - } ] -}-
For details, see section Common Returned Values.
-This interface is used to update an IPsec policy.
-If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.
-PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ipsecpolicy_id - |
-String - |
-Yes - |
-Specifies the IPsec policy ID. - |
-
Table 2 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ipsecpolicy - |
-Object - |
-Yes - |
-Specifies the IPsec policy object. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the IPsec policy. - |
-
transform_protocol - |
-String - |
-No - |
-Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp. - |
-
auth_algorithm - |
-String - |
-No - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
encapsulation_mode - |
-String - |
-No - |
-Specifies the encapsulation mode. The default value is tunnel. - |
-
encryption_algorithm - |
-String - |
-No - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
pfs - |
-String - |
-No - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. -The value disable indicates that the PFS function is disabled. - |
-
value - |
-Integer - |
-No - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-No - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
lifetime - |
-Object - |
-No - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-No - |
-Specifies the IPsec policy name. - |
-
Table 3 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. -The value disable indicates that the PFS function is disabled. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-Specifies the IPsec policy name. - |
-
transform_protocol - |
-String - |
-Specifies the transform protocol used. The value can be esp, ah, or ah-esp. The default value is esp. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
id - |
-String - |
-Specifies the IPsec policy ID. - |
-
encapsulation_mode - |
-String - |
-Specifies the encapsulation mode. The default value is tunnel. - |
-
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-Provides supplementary information about the IPsec policy. - |
-
ipsecpolicy - |
-Object - |
-Specifies the IPsec policy object. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id} -{ - "ipsecpolicy" : { - "pfs" : "group14" - } -}-
{ - "ipsecpolicy": { - "name": "ipsecpolicy1", - "transform_protocol": "esp", - "auth_algorithm": "sha1", - "encapsulation_mode": "tunnel", - "encryption_algorithm": "aes-128", - "pfs": "group14", - "project_id": "ccb81365fe36411a9011e90491fe1330", - "tenant_id": "ccb81365fe36411a9011e90491fe1330", - "lifetime": { - "units": "seconds", - "value": 3600 - }, - "id": "5291b189-fd84-46e5-84bd-78f40c05d69c", - "description": "" - } -}-
For details, see section Common Returned Values.
-This interface is used to delete an IPsec policy.
-DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ipsecpolicy_id - |
-String - |
-Yes - |
-Specifies the IPsec policy ID. - |
-
None
-None
-DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}-
For details, see section Common Returned Values.
-This interface is used to create an IKE policy.
-POST /v2.0/vpn/ikepolicies
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
name - |
-String - |
-No - |
-Specifies the IKE policy name. - |
-
auth_algorithm - |
-String - |
-No - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the IKE policy. - |
-
encryption_algorithm - |
-String - |
-No - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
ike_version - |
-String - |
-No - |
-Specifies the IKE version. The value can be v1 or v2. The default value is v1. - |
-
lifetime - |
-Object - |
-No - |
-Specifies the lifetime object of SA. - |
-
pfs - |
-String - |
-No - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. - |
-
phase1_negotiation_mode - |
-String - |
-No - |
-Specifies the IKE mode The default value is main. - |
-
tenant_id - |
-String - |
-No - |
-Specifies the project ID. - |
-
value - |
-String - |
-No - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-No - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
ikepolicy - |
-Object - |
-Yes - |
-Specifies the IKE policy object. - |
-
Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-Provides supplementary information about the IKE policy. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-Specifies the IKE policy name. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. - |
-
phase1_negotiation_mode - |
-String - |
-Specifies the IKE mode The default value is main. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
ikepolicy - |
-Object - |
-Specifies the IKE policy object. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
id - |
-String - |
-Specifies the IKE policy ID. - |
-
ike_version - |
-String - |
-Specifies the IKE version. The value can be v1 or v2. The default value is v1. - |
-
POST /v2.0/vpn/ikepolicies -{ - "ikepolicy" : { - "phase1_negotiation_mode" : "main", - "auth_algorithm" : "sha1", - "encryption_algorithm" : "aes-128", - "pfs" : "group5", - "lifetime" : { - "units" : "seconds", - "value" : 7200 - }, - "ike_version" : "v1", - "name" : "ikepolicy1" - } -}-
{ - "ikepolicy" : { - "name" : "ikepolicy1", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "auth_algorithm" : "sha1", - "encryption_algorithm" : "aes-128", - "pfs" : "group5", - "phase1_negotiation_mode" : "main", - "lifetime" : { - "units" : "seconds", - "value" : 7200 - }, - "ike_version" : "v1", - "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query details about an IKE policy.
-GET /v2.0/vpn/ikepolicies/{ikepolicy_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ikepolicy_id - |
-String - |
-Yes - |
-Specifies the IKE policy ID. - |
-
None
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
ikepolicy - |
-Object - |
-Specifies the IKE policy object. - |
-
description - |
-String - |
-Provides supplementary information about the IKE policy. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
name - |
-String - |
-Specifies the IKE policy name. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
phase1_negotiation_mode - |
-String - |
-Specifies the IKE mode The default value is main. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
id - |
-String - |
-Specifies the IKE policy ID. - |
-
ike_version - |
-String - |
-Specifies the IKE version number. The value can be v1 or v2. The default value is v1. - |
-
GET /v2.0/vpn/ikepolicies/{ikepolicy_id}-
{ - "ikepolicy" : { - "name" : "ikepolicy1", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "auth_algorithm" : "sha1", - "encryption_algorithm" : "aes-256", - "pfs" : "group5", - "phase1_negotiation_mode" : "main", - "lifetime" : { - "units" : "seconds", - "value" : 3600 - }, - "ike_version" : "v1", - "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to query IKE policies.
-GET /v2.0/vpn/ikepolicies
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
fields - |
-String - |
-No - |
-Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. - |
-
The project_id parameter is not supported.
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
ikepolicies - |
-List<Object> - |
-Specifies the IKE policy list. - |
-
description - |
-String - |
-Provides supplementary information about the IKE policy. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
name - |
-String - |
-Specifies the IKE policy name. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
phase1_negotiation_mode - |
-String - |
-Specifies the IKE mode The default value is main. - |
-
units - |
-String - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
id - |
-String - |
-Specifies the IKE policy ID. - |
-
ike_version - |
-String - |
-Specifies the IKE version. The value can be v1 or v2. The default value is v1. - |
-
GET /v2.0/vpn/ikepolicies-
{ - "ikepolicies" : [ { - "name" : "ikepolicy1", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "auth_algorithm" : "sha1", - "encryption_algorithm" : "aes-256", - "pfs" : "group5", - "phase1_negotiation_mode" : "main", - "lifetime" : { - "units" : "seconds", - "value" : 3600 - }, - "ike_version" : "v1", - "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", - "description" : "" - } ] -}-
For details, see section Common Returned Values.
-This interface is used to update an IKE policy.
-If the IKE policy is updated, the IPsec VPN connection also needs to be updated.
-PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ikepolicy_id - |
-String - |
-Yes - |
-Specifies the IKE policy ID. - |
-
Table 2 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
auth_algorithm - |
-String - |
-No - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the IKE policy. - |
-
encryption_algorithm - |
-String - |
-No - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
ike_version - |
-String - |
-No - |
-Specifies the IKE version. The value can be v1 or v2. The default value is v1. - |
-
ikepolicy - |
-Object - |
-Yes - |
-Specifies the IKE policy object. - |
-
lifetime - |
-Object - |
-No - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-No - |
-Specifies the IKE policy name. - |
-
pfs - |
-String - |
-No - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. - |
-
phase1_negotiation_mode - |
-String - |
-No - |
-Specifies the IKE mode The default value is main. - |
-
value - |
-Integer - |
-No - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-No - |
-Specifies the lifecycle unit. The default value is seconds. - |
-
Table 3 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
auth_algorithm - |
-String - |
-Specifies the authentication hash algorithm. The value can be md5, sha1, sha2-256, sha2-384, or sha2-512. - |
-
description - |
-String - |
-Provides supplementary information about the IKE policy. - |
-
encryption_algorithm - |
-String - |
-Specifies the encryption algorithm. The value can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. - |
-
id - |
-String - |
-Specifies the IKE policy ID. - |
-
ike_version - |
-String - |
-Specifies the IKE version. The value can be v1 or v2. The default value is v1. - |
-
lifetime - |
-Object - |
-Specifies the lifetime object of SA. - |
-
name - |
-String - |
-Specifies the IKE policy name. - |
-
pfs - |
-String - |
-Specifies the PFS. The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. -The default value is group5. - |
-
phase1_negotiation_mode - |
-String - |
-Specifies the IKE mode The default value is main. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
ikepolicy - |
-Object - |
-Specifies the IKE policy object. - |
-
value - |
-Integer - |
-Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. - |
-
units - |
-String - |
-Specifies the lifetime unit of the SA. The default unit is seconds. The default value is 3600. - |
-
{ - "ikepolicy" : { - "encryption_algorithm" : "aes-256" - } -}-
{ - "ikepolicy" : { - "name" : "ikepolicy1", - "tenant_id" : "ccb81365fe36411a9011e90491fe1330", - "auth_algorithm" : "sha1", - "encryption_algorithm" : "aes-256", - "pfs" : "group5", - "phase1_negotiation_mode" : "main", - "lifetime" : { - "units" : "seconds", - "value" : 3600 - }, - "ike_version" : "v1", - "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", - "description" : "" - } -}-
For details, see section Common Returned Values.
-This interface is used to delete an IKE policy.
-DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
ikepolicy_id - |
-String - |
-Yes - |
-Specifies the IKE policy ID. - |
-
None
-None
-DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}-
For details, see section Common Returned Values.
-This interface is used to create a VPN endpoint group.
-POST /v2.0/vpn/endpoint-groups
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
endpoints - |
-List<String> - |
-Yes - |
-Specifies the endpoint list. The endpoints in a list must be of the same type. - |
-
type - |
-String - |
-Yes - |
-Specifies the endpoint type. The value can be subnet or cidr. - |
-
name - |
-String - |
-No - |
-Specifies the VPN endpoint group name. - |
-
tenant_id - |
-String - |
-No - |
-Specifies the project ID. - |
-
description - |
-String - |
-No - |
-Provides supplementary information about the VPN endpoint group. - |
-
Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
description - |
-String - |
-No - |
-Provides supplementary information about the VPN endpoint group. - |
-
tenant_id - |
-String - |
-Yes - |
-Specifies the project ID. - |
-
endpoints - |
-List<String> - |
-Yes - |
-Specifies the endpoint list. The endpoints in a list must be of the same type. - |
-
type - |
-String - |
-Yes - |
-Specifies the endpoint type. The value can be subnet or cidr. - |
-
id - |
-String - |
-Yes - |
-Specifies the VPN endpoint group ID. - |
-
name - |
-String - |
-No - |
-Specifies the VPN endpoint group name. - |
-
POST /v2.0/vpn/endpoint-groups -{ - "endpoint_group" : { - "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], - "type" : "cidr", - "name" : "peers" - } -}-
{ - "endpoint_group" : { - "description" : "", - "tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d", - "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], - "type" : "cidr", - "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", - "name" : "peers" - } -}-
For details, see section Common Returned Values.
-This interface is used to query details about a VPN endpoint group.
-GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
endpoint_group_id - |
-String - |
-No - |
-Specifies the VPN endpoint group ID. - |
-
None
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
description - |
-Object - |
-Provides supplementary information about the VPN endpoint group. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
endpoints - |
-List - |
-Specifies the endpoint list. The endpoints in a list must be of the same type. - |
-
type - |
-String - |
-Specifies the endpoint type. The value can be subnet or cidr. - |
-
id - |
-String - |
-Specifies the VPN endpoint group ID. - |
-
name - |
-String - |
-Specifies the VPN endpoint group name. - |
-
GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}-
{ - "endpoint_group": { - "description": "", - "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d", - "endpoints": [ - "10.2.0.0/24", - "10.3.0.0/24" - ], - "type": "cidr", - "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", - "name": "peers" - } -}-
For details, see section Common Returned Values.
-This interface is used to query VPN endpoint groups.
-GET /v2.0/vpn/endpoint-groups
-Table 1 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
fields - |
-String - |
-No - |
-Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. - |
-
The project_id parameter is not supported.
-Table 2 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
description - |
-String - |
-Provides supplementary information about the VPN endpoint group. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
endpoints - |
-List - |
-Specifies the endpoint list. The endpoints in a list must be of the same type. - |
-
type - |
-String - |
-Specifies the endpoint type. The value can be subnet or cidr. - |
-
id - |
-String - |
-Specifies the VPN endpoint group ID. - |
-
name - |
-String - |
-Specifies the VPN endpoint group name. - |
-
GET /v2.0/vpn/endpoint-groups-
{ - "endpoint_groups": [ - { - "description": "", - "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d", - "endpoints": [ - "a3da778c-adfb-46db-88b3-d2ce53290a89" - ], - "type": "subnet", - "id": "6bf34c7c-864c-4948-a6d4-db791669f9d4", - "name": "locals" - }, - { - "description": "", - "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d", - "endpoints": [ - "10.2.0.0/24", - "10.3.0.0/24" - ], - "type": "cidr", - "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", - "name": "peers" - } - ] -}-
For details, see section Common Returned Values.
-This interface is used to update a VPN endpoint group.
-PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
endpoint_group_id - |
-String - |
-No - |
-Specifies the VPN endpoint group ID. - |
-
Table 2 describes the request parameters.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
description - |
-String - |
-No - |
-Provides supplementary information about the VPN endpoint group. - |
-
name - |
-String - |
-No - |
-Specifies the VPN endpoint group name. - |
-
Table 3 describes the response parameters.
- -Parameter - |
-Type - |
-Description - |
-
---|---|---|
description - |
-Yes - |
-Provides supplementary information about the VPN endpoint group. - |
-
tenant_id - |
-Yes - |
-Specifies the project ID. - |
-
endpoints - |
-Yes - |
-Specifies the endpoint list. The endpoints in a list must be of the same type. - |
-
type - |
-Yes - |
-Specifies the endpoint type. The value can be subnet or cidr. - |
-
id - |
-Yes - |
-Specifies the VPN endpoint group ID. - |
-
name - |
-Yes - |
-Provides supplementary information about the VPN endpoint group. - |
-
PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id} -{ - "endpoint_group" : { - "description" : "New description" - } -}-
{ - "endpoint_group" : { - "description" : "New description", - "tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d", - "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], - "type" : "cidr", - "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", - "name" : "peers" - } -}-
For details, see section Common Returned Values.
-This interface is used to delete a VPN endpoint group.
-DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
---|---|---|---|
endpoint_group_id - |
-String - |
-Yes - |
-Specifies the VPN endpoint group ID. - |
-
None
-None
-DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}-
For details, see section Common Returned Values.
-Normal Response Code - |
-Type - |
-Description - |
-
---|---|---|
200 - |
-OK - |
-Specifies the normal response code for the GET and PUT operations. - |
-
201 - |
-Created - |
-Specifies the normal response code for the POST operation. - |
-
204 - |
-No Content - |
-Specifies the normal response code for the DELETE operation. - |
-
Returned Value - |
-Description - |
-
---|---|
400 Bad Request - |
-The server failed to process the request. - |
-
401 Unauthorized - |
-You must enter a username and password to access the requested page. - |
-
403 Forbidden - |
-You are forbidden to access the requested page. - |
-
404 Not Found - |
-The server could not find the requested page. - |
-
405 Method Not Allowed - |
-You are not allowed to use the method specified in the request. - |
-
406 Not Acceptable - |
-The response generated by the server could not be accepted by the client. - |
-
407 Proxy Authentication Required - |
-You must use the proxy server for authentication so that the request can be processed. - |
-
408 Request Timeout - |
-The request timed out. - |
-
409 Conflict - |
-The request could not be processed due to a conflict. - |
-
500 Internal Server Error - |
-Failed to complete the request because of an internal service error. - |
-
501 Not Implemented - |
-Failed to complete the request because the server does not support the requested function. - |
-
502 Bad Gateway - |
-Failed to complete the request because the request is invalid. - |
-
503 Service Unavailable - |
-Failed to complete the request because the service is unavailable. - |
-
504 Gateway Timeout - |
-A gateway timeout error occurred. - |
-
Service - |
-Error Code - |
-HTTP Status Code - |
-Description - |
-Handling Measure - |
-
VPN - |
-VPC.1001 - |
-400 - |
-Invalid VPN parameters. - |
-Correct the parameter settings and send the request again. - |
-
VPC.1002 - |
-500 - |
-Internal server error. - |
-System exception. Try again later. - |
-|
VPC.1003 - |
-400 - |
-The quota limit has been reached. - |
-Increase the VPN connection quota. - |
-|
VPC.1004 - |
-400 - |
-The remote gateway is being used by another VPN connection. - |
-Change the IP address and then create the connection. - |
-|
VPC.1016 - |
-400 - |
-The VPN remote subnet is the same as the local subnet. - |
-Change the subnet to ensure that the local and remote subnets are different. - |
-|
VPC.1017 - |
-400 - |
-You do not have permission to perform this operation. - |
-Perform another operation, or obtain the required permission and try again. - |
-|
VPC.1018 - |
-400 - |
-Both the local and remote subnets are being used by other VPNs. - |
-Change the subnets or delete existing VPN subnets. - |
-|
VPC.1019 - |
-400 - |
-The local gateway IP address you specified is in use. - |
-Specify another local gateway IP address. - |
-|
VPC.1020 - |
-400 - |
-Failed to create the VPN connection. - |
-System error. Contact technical support. - |
-|
VPC.1021 - |
-400 - |
-The remote subnet of the VPN is in use. - |
-Select another remote subnet for the VPN. - |
-|
VPC.1023 - |
-400 - |
-Failed to query the VPN gateway. - |
-System error. Contact technical support. - |
-|
VPC.1024 - |
-400 - |
-Failed to create the VPN gateway. - |
-System error. Contact technical support. - |
-|
VPC.1025 - |
-400 - |
-Failed to update the VPN gateway. - |
-System error. Contact technical support. - |
-|
VPC.1026 - |
-400 - |
-The VPN gateway already exists. - |
-System error. Contact technical support. - |
-|
VPC.1027 - |
-400 - |
-Failed to create the VPN gateway. - |
-System error. Contact technical support. - |
-|
VPC.1028 - |
-400 - |
-Failed to create the VPN gateway. - |
-System error. Contact technical support. - |
-|
VPC.1029 - |
-400 - |
-Failed to allocate bandwidth to the VPN gateway. - |
-System error. Contact technical support. - |
-|
VPC.1030 - |
-400 - |
-Failed to allocate bandwidth to the VPN gateway. - |
-System error. Contact technical support. - |
-
Normal Response Code - |
-Type - |
-Description - |
-
---|---|---|
200 - |
-OK - |
-Specifies the normal response code for the GET, PUT, and POST operations. - |
-
201 - |
-Created - |
-Specifies the normal response code for the POST operation of the OpenStack Neutron API. - |
-
204 - |
-No Content - |
-Specifies the normal response code for the DELETE operation. - |
-
Returned Value - |
-Description - |
-
---|---|
400 Bad Request - |
-The server failed to process the request. - |
-
401 Unauthorized - |
-You must enter a username and password to access the requested page. - |
-
403 Forbidden - |
-You are forbidden to access the requested page. - |
-
404 Not Found - |
-The server could not find the requested page. - |
-
405 Method Not Allowed - |
-You are not allowed to use the method specified in the request. - |
-
406 Not Acceptable - |
-The response generated by the server could not be accepted by the client. - |
-
407 Proxy Authentication Required - |
-You must use the proxy server for authentication so that the request can be processed. - |
-
408 Request Timeout - |
-The request timed out. - |
-
409 Conflict - |
-The request could not be processed due to a conflict. - |
-
500 Internal Server Error - |
-Failed to complete the request because of an internal service error. - |
-
501 Not Implemented - |
-Failed to complete the request because the server does not support the requested function. - |
-
502 Bad Gateway - |
-Failed to complete the request because the server has received an invalid response. - |
-
503 Service Unavailable - |
-Failed to complete the request because the service is unavailable. - |
-
504 Gateway Timeout - |
-A gateway timeout error occurred. - |
-
Released On - |
-What's New - |
-
---|---|
2019-04-26 - |
-This release incorporates the following changes: -
|
-
2019-01-28 - |
-Accepted in OTC-4.0/Agile. - |
-
2019-01-03 - |
-This release incorporates the following changes: -Updated the PFS values in sections IPsec Policy Management and IKE Policy Management. - |
-
2018-11-12 - |
-This issue is the first official release. - |
-
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.
+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 API Overview.
+If you plan to use APIs of the VPN service, ensure that you are familiar with concepts of VPN.
+VPN supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details, see Calling APIs.
+An endpoint is the request address for calling an API. Endpoints vary according to services and regions.
+The number of VPN resources that you can create is determined by your quota. You can view or increase the quota.
+For more constraints, see description of each API.
+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.
+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).
+To view your account ID and IAM user ID, log in to the console, click your account in the upper right corner, and choose My Credentials. The account name, username, and password will be required for API authentication.
+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.
+Regions are classified into universal regions and dedicated regions.
+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.
+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.
+To view a project ID, log in to the console, click your account in the upper right corner, and choose My Credentials.
+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.
+Table 1 lists the APIs provided by the VPN service. For details about API permissions, see Permission Policies and Supported Actions.
+ +API Type + |
+Description + |
+
---|---|
+ | +APIs for creating, querying, updating, and deleting VPN gateways, and querying AZs of VPN gateways. + |
+
+ | +APIs for creating, querying, updating, and deleting customer gateways. + |
+
+ | +APIs for creating, querying, updating, and deleting VPN connections. + |
+
+ | +APIs for creating, querying, and deleting VPN connection health checks. + |
+
+ | +API for querying quotas. + |
+
+ | +APIs for querying tag information. + |
+
This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
+Request URI
+A request URI is in the following format:
+{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
+Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be separately transmitted.
+ +Parameter + |
+Description + |
+
---|---|
URI-scheme + |
+Protocol used to transmit requests. All APIs use HTTPS. + |
+
Endpoint + |
+Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. + |
+
resource-path + |
+Resource path of an API. Obtain the path from the URI of an API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens. + |
+
query-string + |
+(Optional) Query parameter. Ensure that a question mark (?) is included in front of each query parameter, which is in the format of Parameter name=Parameter value. For example, ?limit=10 indicates that a maximum of 10 data records can be queried. + |
+
To simplify the URI display, this document provides only the resource-path and request method in the URI of each API. The URI-scheme of all APIs is https, and the endpoints in a region are the same.
+Request Methods
+The HTTP protocol defines the following request methods for sending requests to a server.
+ +Method + |
+Description + |
+
---|---|
GET + |
+Requests a server to return specified resources. + |
+
PUT + |
+Requests a server to update specified resources. + |
+
POST + |
+Requests a server to add resources or perform special operations. + |
+
DELETE + |
+Requests a server to delete a specified resource (for example, an object). + |
+
HEAD + |
+Requests resource headers from a server. + |
+
PATCH + |
+Requests a server to update part of specified resources. +If the requested resource does not exist, the server may create a resource using the PATCH method. + |
+
POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens+
Request Header
+You can add additional fields, such as the fields required by a specified URI or HTTP method, to a request header. For example, to request authentication information, you can add Content-Type to specify the type of the request body.
+For details about common request headers, see Table 3.
+ +Parameter + |
+Description + |
+Mandatory + |
+Example + |
+
---|---|---|---|
Host + |
+Specifies the server to which a request is sent, which can be obtained from the URL of the service API. The value is in the format of Host name:Port number. If the port number is not specified, the default port is used. The default port number for https is 443. + |
+No +This field is mandatory for access key (AK)/secret access key (SK) authentication. + |
+code.test.com +or +code.test.com:443 + |
+
Content-Type + |
+Specifies the type (or format) of a message body. The default value application/json is recommended. Other values will be described in the specific APIs. + |
+Yes + |
+application/json + |
+
Content-Length + |
+Specifies the length of a request body, in bytes. + |
+No + |
+3495 + |
+
X-Project-Id + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+No +This field is mandatory for requests that use AK/SK authentication in the Dedicated Cloud (DeC) scenario or multi-project scenario. + |
+e9993fc7************baa340f9c0f4 + |
+
X-Auth-Token + |
+Specifies a user token. +A user token is carried in a response to the API for obtaining a user token. This API is the only one that does not require authentication. +The value of X-Subject-Token in the response header is the token. + |
+No +This field is mandatory for token authentication. + |
+The following is part of an example token: +MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ + |
+
APIs also support AK/SK authentication, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added to the request.
+For details about AK/SK authentication, see Authentication.
+POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokensContent-Type:application/json+
Request Body
+This part is optional. A request body is generally sent in a structured format (for example, JSON or XML), which is specified by Content-Type in the request header. It is used to transfer content other than the request header. If the request body contains full-width characters, these characters must be coded in UTF-8.
+Request bodies vary according to APIs. Some APIs do not require a request body, such as the APIs called using the GET and DELETE methods.
+For the API used to obtain a user token, you can obtain the request parameters and parameter description from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name, for example, eu-de-01) with the actual values.
+The scope field specifies where a token takes effect. In the following example, the token takes effect only for the resources in a specified project.
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 | POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokensContent-Type:application/json +{ + "auth":{ + "identity":{ + "methods":[ + "password" + ], + "password":{ + "user":{ + "name":"username", + "password":"********", + "domain":{ + "name":"domainname" + } + } + } + }, + "scope":{ + "project":{ + "name":"xxxxxxxxxxxxxxxxxx" + } + } + } +} + |
If all data required by an API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API for obtaining a user token, x-subject-token carries a user token. You can use this token to authenticate the calling of other APIs.
+Token Authentication
+A token is valid for 24 hours. When using a token for authentication, cache it to avoid frequent calling.
+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.
+A cloud service can be deployed as either a project-level service or global service.
+A project-level token is required for calling APIs of the VPN service. As such, set auth.scope in the request body to project when you call the API for obtaining a user token.
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 | { + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxx" + } + } + } +} + |
After obtaining a token, add the X-Auth-Token field specifying the token to the request header when calling other APIs. For example, when the token is ABCDEFJ..., add X-Auth-Token: ABCDEFJ... to the request header as follows:
+1 +2 +3 | POST https://iam.eu-de.otc.t-systems.com/v3/auth/tokens +Content-Type: application/json +X-Auth-Token: ABCDEFJ.... + |
AK/SK Authentication
+AK/SK authentication supports API requests with a body size not larger than 12 MB. For API requests with larger sizes, use token authentication.
+In AK/SK-based authentication, AK/SK is used to sign requests, and the signature is then added to the request header for authentication.
+In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK.
+Different from the SDKs provided by services, the signing SDK is used only for signing.
+Status Code
+After sending a request, you can receive a response, including a status code, response header, and response body.
+A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.
+For example, if status code 201 is returned after you call the API for obtaining a user token, the request is successful.
+Response Header
+Like a request, a response also has a header, for example, Content-Type.
+Figure 1 shows the response header for the API used to obtain a user token. The x-subject-token field carries a user token. You can use this token to authenticate the calling of other APIs.
+ +Response Body
+This part is optional. A response body is generally returned in a structured format (for example, JSON or XML), which is specified by Content-Type in the response header. It is used to transfer content other than the response header.
+The following is part of a response body for the API used to obtain a user token.
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 | { + "token": { + "expires_at": "2022-09-10T06:52:13.855000Z", + "methods": [ + "password" + ], + "catalog": [ + { + "endpoints": [ + { +...... + |
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.
+1 +2 +3 +4 | { + "error_msg": "The format of message is error", + "error_code": "AS.0001" +} + |
error_code specifies an error code, and error_msg describes the error.
+This API is used to create a VPN gateway.
+For details, see Calling APIs.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vpn_gateway + |
+CreateVgwRequestBodyContent object + |
+Yes + |
+Specifies the VPN gateway object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+
|
+
network_type + |
+String + |
+No + |
+
|
+
attachment_type + |
+String + |
+No + |
+
|
+
er_id + |
+String + |
+No + |
++ | +
vpc_id + |
+String + |
+No + |
+
You can obtain the VPC ID by querying VPCs. + |
+
local_subnets + |
+Array of String + |
+No + |
+
|
+
connect_subnet + |
+String + |
+No + |
+
|
+
bgp_asn + |
+Long + |
+No + |
+
|
+
flavor + |
+String + |
+No + |
+
NOTE:
+
|
+
availability_zone_ids + |
+Array of String + |
+No + |
+
|
+
enterprise_project_id + |
+String + |
+No + |
+
|
+
eip1 + |
+CreateRequestEip object + |
+No + |
+
|
+
eip2 + |
+CreateRequestEip object + |
+No + |
+
|
+
access_vpc_id + |
+String + |
+No + |
+
|
+
access_subnet_id + |
+String + |
+No + |
+
|
+
ha_mode + |
+String + |
+No + |
+
|
+
access_private_ip_1 + |
+String + |
+No + |
+
|
+
access_private_ip_2 + |
+String + |
+No + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+No + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
value + |
+String + |
+Yes + |
+
|
+
POST https://{Endpoint}/v5/{project_id}/vpn-gateways + +{ + "vpn_gateway": { + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": [ + "192.168.0.0/24", "192.168.1.0/24" + ], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "eip1": { + "id": "cff40e5e-demo-a8df-va86-7366077bf097" + }, + "eip2": { + "id": "d290f1ee-demo-a8df-va86-d701748f0851" + } + } +}+
POST https://{Endpoint}/v5/{project_id}/vpn-gateways + +{ + "vpn_gateway": { + "name": "vpngw-1234", + "attachment_type": "er", + "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "vpc_id": "584a238f-demo-a8df-va86-edca746f6277", + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 65533, + "flavor": "Professional2", + "availability_zone_ids": [ + "eu-de-01" + "eu-de-02" + ], + "eip1": { + "type": "5_bgp", + + "charge_mode": "traffic", + "bandwidth_size": 1000, + "bandwidth_name": "vpngw-bandwidth-1391" + }, + "eip2": { + "type": "5_bgp", + "charge_mode": "traffic", + "bandwidth_size": 1000, + "bandwidth_name": "vpngw-bandwidth-1392" + } + } +}+
POST https://{Endpoint}/v5/{project_id}/vpn-gateways + +{ + "vpn_gateway": { + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": [ + "192.168.0.0/24", "192.168.1.0/24" + ], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "network_type": "private" + } +}+
Returned status code 201: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_gateway + |
+ResponseVpnGateway object + |
+Specifies the VPN gateway object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
network_type + |
+String + |
+
|
+
attachment_type + |
+String + |
+
|
+
er_id + |
+String + |
+Specifies the ID of the enterprise router instance to which the VPN gateway connects. This parameter is available only when attachment_type is set to er. + |
+
vpc_id + |
+String + |
+When attachment_type is set to vpc, vpc_id specifies the ID of the service VPC associated with the VPN gateway. +This parameter is not returned when attachment_type is set to er. To view the ID of the access VPC used by the VPN gateway, check the access_vpc_id field. + |
+
local_subnets + |
+Array of String + |
+Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN. For example, a local subnet can be 192.168.52.0/24. This parameter is available only when attachment_type is set to vpc. + |
+
connect_subnet + |
+String + |
+Specifies the ID of the VPC subnet used by the VPN gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the VPN gateway. + |
+
flavor + |
+String + |
+
|
+
connection_number + |
+Integer + |
+Specifies the maximum number of VPN connections supported for the VPN gateway. + |
+
used_connection_number + |
+Integer + |
+Specifies the number of VPN connections that have been used by the VPN gateway. + |
+
used_connection_group + |
+Integer + |
+Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway. + |
+
enterprise_project_id + |
+String + |
+
|
+
access_vpc_id + |
+String + |
+
|
+
access_subnet_id + |
+String + |
+
|
+
ha_mode + |
+String + |
+
|
+
policy_template + |
+PolicyTemplate object + |
+Specifies a policy template. This parameter is returned only for a VPN gateway that supports access via non-fixed IP addresses. + |
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_policy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsec_policy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_algorithm + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
{ + "vpn_gateway": { + "id": "134f9fb1-demo-a8df-va86-2040a5c13325", + "name": "vpngw-9f24", + "network_type": "public", + "attachment_type": "vpc", + "vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "local_subnets": ["192.168.0.0/24"], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 64512, + "flavor": "Professional1", + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, + "request_id": "7b37532a-d6e4-46b9-98dc-9169ec2ca58f" +}+
{ + "vpn_gateway": { + "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", + "name": "vpngw-1234", + "network_type": "public", + "attachment_type": "er", + "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "bgp_asn": 65533, + "flavor": "Professional2", + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, + "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311" +}+
{ + "vpn_gateway": { + "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", + "name": "vpngw-1234", + "network_type": "private", + "attachment_type": "vpc", + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": ["192.168.0.0/24", "192.168.1.0/24"], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 65533, + "flavor": "Professional2", + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, + "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311" +}+
For details, see Status Codes.
+This API is used to query a VPN gateway with a specified gateway ID.
+For details, see Calling APIs.
+GET /v5/{project_id}/vpn-gateways/{vgw_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
vgw_id + |
+String + |
+Yes + |
+Specifies a VPN gateway ID. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_gateway + |
+ResponseVpnGateway object + |
+Specifies the VPN gateway object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
network_type + |
+String + |
+
|
+
status + |
+String + |
++ | +
attachment_type + |
+String + |
+
|
+
certificate_id + |
+String + |
+
|
+
er_id + |
+String + |
+Specifies the ID of the enterprise router instance to which the VPN gateway connects. This parameter is available only when attachment_type is set to er. + |
+
vpc_id + |
+String + |
+Specifies the ID of the service VPC associated with the VPN gateway. This parameter is available only when attachment_type is set to vpc. + |
+
local_subnets + |
+Array of String + |
+Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN. For example, a local subnet can be 192.168.52.0/24. This parameter is available only when attachment_type is set to vpc. + |
+
connect_subnet + |
+String + |
+Specifies the ID of the VPC subnet used by the VPN gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the VPN gateway. + |
+
flavor + |
+String + |
+
|
+
availability_zone_ids + |
+Array of String + |
+Specifies the AZ where the VPN gateway is deployed. This parameter is available when an AZ is specified. If no AZ is specified, this parameter is available only when the VPN gateway is in ACTIVE state. + |
+
connection_number + |
+Integer + |
+Specifies the maximum number of VPN connections supported for the VPN gateway. + |
+
used_connection_number + |
+Integer + |
+Specifies the number of VPN connections that have been used by the VPN gateway. + |
+
used_connection_group + |
+Integer + |
+Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway. + |
+
enterprise_project_id + |
+String + |
++ | +
eip1 + |
+ResponseEip object + |
+Specifies the first EIP of the VPN gateway using the active-active mode or the active EIP of the VPN gateway using the active-standby mode. This parameter is available when the VPN gateway is in ACTIVE state. + |
+
eip2 + |
+ResponseEip object + |
+Specifies the second EIP of the VPN gateway using the active-active mode or the standby EIP of the VPN gateway using the active-standby mode. This parameter is available when the VPN gateway is in ACTIVE state. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
lock_status + |
+Integer + |
+Specifies whether a frozen VPN gateway can be deleted. +The value 1 indicates that a frozen gateway can be deleted. +The value 2 indicates that a frozen gateway cannot be deleted. + |
+
master_eip + |
+master_eip + |
+Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
slave_eip + |
+slave_eip + |
+Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
high_availability + |
+Boolean + |
+Specifies the high availability (HA) attribute of the VPN gateway. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
access_vpc_id + |
+String + |
+
|
+
access_subnet_id + |
+String + |
+
|
+
access_private_ip_1 + |
+String + |
+Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the first private IP address of the VPN gateway in active-active mode or the active private IP address of the VPN gateway in the active-standby mode. +An example is 192.168.52.9. This parameter is available only when network_type is set to private. + |
+
access_private_ip_2 + |
+String + |
+Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the second private IP address of the VPN gateway in active-active mode or the standby private IP address of the VPN gateway in the active-standby mode. +An example is 192.168.52.9. This parameter is available only when network_type is set to private. + |
+
ha_mode + |
+String + |
+
|
+
policy_template + |
+PolicyTemplate object + |
+Indicates a policy template. This parameter is returned only for a VPN gateway that supports access via non-fixed IP addresses. + |
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
ip_version + |
+Integer + |
+
|
+
type + |
+String + |
+
|
+
ip_address + |
+String + |
+
|
+
charge_mode + |
+String + |
++ | +
bandwidth_id + |
+String + |
+
|
+
bandwidth_size + |
+Integer + |
+
|
+
bandwidth_name + |
+String + |
+
|
+
share_type + |
+String + |
++ | +
network_type + |
+String + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_policy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsec_policy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_algorithm + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "vpn_gateway": { + "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", + "name": "vpngw-5bd6", + "network_type": "public", + "status": "ACTIVE", + "attachment_type": "er", + "er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": ["eu-de-01", "eu-de-02"], + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "eip1": { + "id": "0f6d1415-demo-a8df-va86-edb2ee97c9cc", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.251", + "charge_mode": "traffic", + "bandwidth_id": "e93767cc-demo-a8df-va86-bac2987f90a4", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-10c3" + }, + "eip2": { + "id": "7b46b62f-demo-a8df-va86-6b8e44312416", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.102", + "charge_mode": "traffic", + "bandwidth_id": "bde3557e-demo-a8df-va86-629a3754ae07", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-18bd" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, + "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799" +}+
{
+ "vpn_gateway": {
+ "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5",
+ "name": "vpngw-5bd6",
+ "network_type": "private",
+ "status": "ACTIVE",
+ "attachment_type": "vpc",
+ "vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c",
+ "local_subnets": ["192.168.0.0/24"],
+ "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114",
+ "bgp_asn": 64512,
+ "flavor": "Professional1",
+ "availability_zone_ids": ["eu-de-01", "eu-de-02"],
+ "connection_number": 200,
+ "used_connection_number": 0,
+ "used_connection_group": 0,
+ "enterprise_project_id": "0",
+ "created_at": "2024-06-28T09:41:11.445Z",
+ "updated_at": "2024-06-28T09:41:11.445Z",
+ "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa",
+ "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114",
+ "access_private_ip_1": "192.168.146.45",
+ "access_private_ip_2": "192.168.146.77",
+ "ha_mode": "active-active"
+ },
+ "request_id": "28b795f8-d431-4f1e-93ab-1c401a82b799"
+}
+For details, see Status Codes.
+This API is used to query the VPN gateway list.
+For details, see Calling APIs.
+GET /v5/{project_id}/vpn-gateways
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
enterprise_project_id + |
+Array + |
+No + |
+Specifies an enterprise project ID. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_gateways + |
+Array of ResponseVpnGateway objects + |
+Specifies gateway Information. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
network_type + |
+String + |
+
|
+
status + |
+String + |
++ | +
attachment_type + |
+String + |
+
|
+
er_id + |
+String + |
+Specifies the ID of the enterprise router instance to which the VPN gateway connects. This parameter is available only when attachment_type is set to er. + |
+
vpc_id + |
+String + |
+Specifies the ID of the service VPC associated with the VPN gateway. This parameter is returned only when attachment_type is set to vpc. + |
+
local_subnets + |
+Array of String + |
+Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN. For example, a local subnet can be 192.168.52.0/24. This parameter is available only when attachment_type is set to vpc. + |
+
connect_subnet + |
+String + |
+Specifies the ID of the VPC subnet used by the VPN gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the VPN gateway. + |
+
flavor + |
+String + |
+
|
+
availability_zone_ids + |
+Array of String + |
+Specifies the AZ where the VPN gateway is deployed. This parameter is available when an AZ is specified. If no AZ is specified, this parameter is available only when the VPN gateway is in ACTIVE state. + |
+
connection_number + |
+Integer + |
+Specifies the maximum number of VPN connections supported for the VPN gateway. + |
+
used_connection_number + |
+Integer + |
+Specifies the number of VPN connections that have been used by the VPN gateway. + |
+
used_connection_group + |
+Integer + |
+Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway. + |
+
enterprise_project_id + |
+String + |
++ | +
eip1 + |
+ResponseEip object + |
+Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. + |
+
eip2 + |
+ResponseEip object + |
+Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
lock_status + |
+Integer + |
+Specifies whether a frozen VPN gateway can be deleted. +The value 1 indicates that a frozen gateway can be deleted. +The value 2 indicates that a frozen gateway cannot be deleted. + |
+
master_eip + |
+master_eip + |
+Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
slave_eip + |
+slave_eip + |
+Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
high_availability + |
+Boolean + |
+Specifies the high availability (HA) attribute of the VPN gateway. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
access_vpc_id + |
+String + |
+
|
+
access_subnet_id + |
+String + |
+
|
+
access_private_ip_1 + |
+String + |
+Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the first private IP address of the VPN gateway in active-active mode or the active private IP address of the VPN gateway in the active-standby mode. +An example is 192.168.52.9. This parameter is available only when network_type is set to private. + |
+
access_private_ip_2 + |
+String + |
+Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the second private IP address of the VPN gateway in active-active mode or the standby private IP address of the VPN gateway in the active-standby mode. +An example is 192.168.52.9. This parameter is available only when network_type is set to private. + |
+
ha_mode + |
+String + |
+
|
+
policy_template + |
+PolicyTemplate object + |
+Indicates a policy template. This parameter is returned only for a VPN gateway that supports access via non-fixed IP addresses. + |
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
ip_version + |
+Integer + |
+
|
+
type + |
+String + |
+
|
+
ip_address + |
+String + |
+
|
+
charge_mode + |
+String + |
++ | +
bandwidth_id + |
+String + |
+
|
+
bandwidth_size + |
+Integer + |
+
|
+
bandwidth_name + |
+String + |
+
|
+
share_type + |
+String + |
++ | +
network_type + |
+String + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_policy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsec_policy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_algorithm + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "vpn_gateways": [{ + "id": "8e1d0686-demo-a8df-va86-91f32fa1dfc8", + "name": "vpngw-1af3", + "network_type": "public", + "status": "ACTIVE", + "attachment_type": "vpc", + "vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c", + "local_subnets": ["192.168.15.0/24"], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": ["eu-de-01", "eu-de-02"], + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "eip1": { + "id": "8ff5d6b5-demo-a8df-va86-b9d598033153", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.111", + "charge_mode": "traffic", + "bandwidth_id": "aa62f8f2-demo-a8df-va86-b05b2b999715", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-13a3" + }, + "eip2": { + "id": "08e7e927-demo-a8df-va86-26a6394021eb", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.199", + "charge_mode": "traffic", + "bandwidth_id": "887d61f7-demo-a8df-va86-38ee8232e27c", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-1afb" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "access_vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, { + "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", + "name": "vpngw-2be4", + "network_type": "public", + "status": "ACTIVE", + "attachment_type": "er", + "er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": ["eu-de-01", "eu-de-02"], + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "eip1": { + "id": "0f6d1415-demo-a8df-va86-edb2ee97c9cc", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.251", + "charge_mode": "traffic", + "bandwidth_id": "e93767cc-demo-a8df-va86-bac2987f90a4", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-10c3" + }, + "eip2": { + "id": "7b46b62f-demo-a8df-va86-6b8e44312416", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.102", + "charge_mode": "traffic", + "bandwidth_id": "bde3557e-demo-a8df-va86-629a3754ae07", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-18bd", + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + },{ + "id":"66ddeacb-demo-a8df-va86-9a414b5bd7d5", + "name":"vpngw-5bd6", + "network_type":"public", + "status":"ACTIVE", + "attachment_type":"vpc", + "vpc_id":"c62fad0d-demo-a8df-va86-e06c4c351b9f", + "local_subnets":[ + "192.168.0.0/24" + ], + "connect_subnet":"fd75bf7b--demo-a8df-va86-db13f03e299a", + "bgp_asn":64512, + "flavor":"Professional1-NonFixedIP", + "availability_zone_ids":[ + "eu-de-01" + ], + "connection_number":200, + "used_connection_number":0, + "used_connection_group":0, + "enterprise_project_id":"0", + "ha_mode":"active-standby", + "eip1":{ + "id":"0f6d1415-demo-a8df-va86-edb2ee97c9cc", + "ip_version":4, + "type":"5_bgp", + "ip_address":"88.***.***.251", + "charge_mode": "traffic", + "bandwidth_id":"e93767cc-demo-a8df-va86-bac2987f90a4", + "bandwidth_size":300, + "bandwidth_name":"vpngw-bandwidth-10c3" + }, + "eip2":{ + "id":"7b46b62f-demo-a8df-va86-6b8e44312416", + "ip_version":4, + "type":"5_bgp", + "ip_address":"88.***.***.102", + "charge_mode": "traffic", + "bandwidth_id":"bde3557e-demo-a8df-va86-629a3754ae07", + "bandwidth_size":300, + "bandwidth_name":"vpngw-bandwidth-18bd" + }, + "policy_template":{ + "ike_policy":{ + "encryption_algorithm":"aes-128", + "dh_group":"group20", + "authentication_algorithm":"sha2-256", + "lifetime_seconds":86400 + }, + "ipsec_policy":{ + "authentication_algorithm":"sha2-256", + "encryption_algorithm":"aes-128", + "pfs":"group20", + "lifetime_seconds":3600 + } + }, + "created_at":"2024-06-28T09:41:11.445Z", + "updated_at":"2024-06-28T09:41:11.445Z", + "access_vpc_id":"4d03fe2d--demo-a8df-va86-6def96440f2b", + "access_subnet_id":"fd75bf7b--demo-a8df-va86-e-db13f03e299a" + }], + "request_id": "de1b6caf-d024-4dac-850e-645af40c84f3" +}+
{ + "vpn_gateways": [{ + "id": "8e1d0686-demo-a8df-va86-91f32fa1dfc8", + "name": "vpngw-1af3", + "network_type": "public", + "status": "ACTIVE", + "attachment_type": "vpc", + "vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c", + "local_subnets": ["192.168.15.0/24"], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": ["eu-de-01", "eu-de-02"], + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "7354dda9-demo-a8df-va86-a6b08fb92043", + "eip1": { + "id": "8ff5d6b5-demo-a8df-va86-b9d598033153", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.111", + "charge_mode": "traffic", + "bandwidth_id": "aa62f8f2-demo-a8df-va86-b05b2b999715", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-13a3" + }, + "eip2": { + "id": "08e7e927-demo-a8df-va86-26a6394021eb", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.199", + "charge_mode": "traffic", + "bandwidth_id": "887d61f7-demo-a8df-va86-38ee8232e27c", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-1afb" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "access_vpc_id": "91a74241-demo-a8df-va86-9b5f98c66c8c", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, { + "id": "66ddeacb-demo-a8df-va86-9a414b5bd7d5", + "name": "vpngw-2be4", + "network_type": "private", + "status": "ACTIVE", + "attachment_type": "er", + "er_id": "c62fad0d-demo-a8df-va86-e06c4c351b9f", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": ["eu-de-01", "eu-de-02"], + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "7354dda9-demo-a8df-va86-a6b08fb92043", + "access_private_ip_1": "192.168.4.7", + "access_private_ip_2": "192.168.4.99", + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + } + ], + "request_id": "bfa819a1-e824-4799-8e72-21a35dad97c9" +}+
For details, see Status Codes.
+This API is used to update a VPN gateway with a specified gateway ID.
+For details, see Calling APIs.
+PUT /v5/{project_id}/vpn-gateways/{vgw_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
vgw_id + |
+String + |
+Yes + |
+Specifies the ID of a VPN gateway instance. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vpn_gateway + |
+UpdateVgwRequestBodyContent object + |
+Yes + |
+Specifies the VPN gateway object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+
|
+
local_subnets + |
+Array of String + |
+No + |
+
|
+
eip_id_1 + |
+String + |
+No + |
+
|
+
eip_id_2 + |
+String + |
+No + |
+
|
+
policy_template + |
+PolicyTemplate object + |
+No + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_policy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsec_policy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_algorithm + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
PUT https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id} + +{ + "vpn_gateway": { + "name": "vpngw-4321", + "local_subnets": [ + "192.168.0.0/24" + ], + "eip_id_1": "f1469b4a-demo-a8df-va86-bb7de91cf493", + "eip_id_2": "6ad8e297-demo-a8df-va86-da0f885ccb98" + } +}+
PUT https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id} +{ + "vpn_gateway":{ + "policy_template":{ + "ike_policy":{ + "authentication_algorithm":"sha2-256", + "encryption_algorithm":"aes-128-gcm-16", + "dh_group":"group21", + "lifetime_seconds":86400 + }, + "ipsec_policy":{ + "authentication_algorithm":"sha2-256", + "encryption_algorithm":"aes-128-gcm-16", + "pfs":"disable", + "lifetime_seconds":3600 + } + } + } +}+
Returned status code 200: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_gateway + |
+ResponseVpnGateway object + |
+Specifies the VPN gateway object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
network_type + |
+String + |
+
|
+
attachment_type + |
+String + |
+
|
+
er_id + |
+String + |
+Specifies the ID of the enterprise router instance to which the VPN gateway connects. This parameter is available only when attachment_type is set to er. + |
+
vpc_id + |
+String + |
+When attachment_type is set to vpc, vpc_id specifies the ID of the service VPC associated with the VPN gateway. +This parameter is not returned when attachment_type is set to er. To view the ID of the access VPC used by the VPN gateway, check the access_vpc_id field. + |
+
local_subnets + |
+Array of String + |
+Specifies a local subnet. This subnet is a cloud-side subnet that needs to communicate with an on-premises network through a VPN. For example, a local subnet can be 192.168.52.0/24. This parameter is available only when attachment_type is set to vpc. + |
+
connect_subnet + |
+String + |
+Specifies the ID of the VPC subnet used by the VPN gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the VPN gateway. + |
+
flavor + |
+String + |
+
|
+
availability_zone_ids + |
+Array of String + |
+Specifies the AZ where the VPN gateway is deployed. This parameter is available when an AZ is specified. If no AZ is specified, this parameter is available only when the VPN gateway is in ACTIVE state. + |
+
connection_number + |
+Integer + |
+Specifies the maximum number of VPN connections supported for the VPN gateway. + |
+
used_connection_number + |
+Integer + |
+Specifies the number of VPN connections that have been used by the VPN gateway. + |
+
used_connection_group + |
+Integer + |
+Specifies the number of VPN connection groups that have been used by the VPN gateway. A connection group consists of two connections between a customer gateway and a VPN gateway. By default, 10 VPN connection groups are included free of charge with the purchase of a VPN gateway. + |
+
enterprise_project_id + |
+String + |
++ | +
eip1 + |
+ResponseEip object + |
+Specifies the first EIP of the VPN gateway in the active-active mode or the active EIP of the VPN gateway in the active-standby mode. This parameter is available when the VPN gateway is in ACTIVE state. + |
+
eip2 + |
+ResponseEip object + |
+Specifies the second EIP of the VPN gateway in the active-active mode or the standby EIP of the VPN gateway in the active-standby mode. This parameter is available when the VPN gateway is in ACTIVE state. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
master_eip + |
+master_eip + |
+Specifies the first EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
slave_eip + |
+slave_eip + |
+Specifies the second EIP used by the VPN gateway. This parameter is available when the VPN gateway is in ACTIVE state. +This parameter has been deprecated, but is retained for compatibility purposes. Using this parameter is not recommended. + |
+
access_vpc_id + |
+String + |
+
|
+
access_subnet_id + |
+String + |
+
|
+
access_private_ip_1 + |
+String + |
+Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the first private IP address of the VPN gateway in active-active mode or the active private IP address of the VPN gateway in the active-standby mode. +An example is 192.168.52.9. This parameter is available only when network_type is set to private. + |
+
access_private_ip_2 + |
+String + |
+Specifies a private IP address used by the VPN gateway to connect to a customer gateway when the network type is private network. This address is the second private IP address of the VPN gateway in active-active mode or the standby private IP address of the VPN gateway in the active-standby mode. +An example is 192.168.52.9. This parameter is available only when network_type is set to private. + |
+
ha_mode + |
+String + |
+
|
+
policy_template + |
+PolicyTemplate object + |
+Indicates a policy template. This parameter is returned only for a VPN gateway that supports access via non-fixed IP addresses. + |
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
ip_version + |
+Integer + |
+
|
+
type + |
+String + |
+
|
+
ip_address + |
+String + |
+
|
+
charge_mode + |
+String + |
++ | +
bandwidth_id + |
+String + |
+
|
+
bandwidth_size + |
+Integer + |
+
|
+
bandwidth_name + |
+String + |
+
|
+
share_type + |
+String + |
++ | +
network_type + |
+String + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_policy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsec_policy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_algorithm + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
lifetime_seconds + |
+Integer + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "vpn_gateway": { + "id": "620d99b8-demo-a8df-va86-200b868f2d7d", + "name": "vpngw-4321", + "attachment_type": "vpc", + "network_type": "public", + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": [ + "192.168.0.0/24" + ], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": ["eu-de-01", "eu-de-02"], + "connection_number": 200, + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "eip1": { + "id": "f1469b4a-demo-a8df-va86-bb7de91cf493", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.102", + "charge_mode": "traffic", + "bandwidth_id": "cff40e5e-demo-a8df-va86-7366077bf097", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-1391" + }, + "eip2": { + "id": "6ad8e297-demo-a8df-va86-da0f885ccb98", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.188", + "charge_mode": "traffic", + "bandwidth_id": "d290f1ee-demo-a8df-va86-d701748f0851", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-1392" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T11:13:13.677Z", + "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "ha_mode": "active-active" + }, + "request_id": "33a2b77a-65f9-4fa0-90bd-4bd42038eb41" +}+
{ + "error_code":"VPN.0003", + "error_msg":"resource (type=GATEWAY, ID=ff9bdca6-demo-a8df-va86-e4bcc1ea52bc) is not ready, currently CREATING", + "request_id": "abafe41c-7744-41af-bf3d-4452872af799" +}+
For details, see Status Codes.
+This API is used to delete a VPN gateway with a specified gateway ID.
+For details, see Calling APIs.
+DELETE /v5/{project_id}/vpn-gateways/{vgw_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
vgw_id + |
+String + |
+Yes + |
+Specifies the ID of a VPN gateway instance. + |
+
Response returned when a VPN gateway being created fails to be deleted
+{ + "error_code":"VPN.0003", + "error_msg":"resource (type=GATEWAY, ID=ff9bdca6-demo-a8df-va86-e4bcc1ea52bc) is not ready, currently CREATING", + "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac" +}+
For details, see Status Codes.
+This API is used to query the AZs of VPN gateways.
+For details, see Calling APIs.
+GET /v5/{project_id}/vpn-gateways/availability-zones
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Returned status code 200: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
availability_zones + |
+AvailabilityZones object + |
+Specifies the list of AZs. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
basic + |
+VpnGatewayAvailabilityZones object + |
+Indicates that the specification of VPN gateways is Basic. + |
+
professional1 + |
+VpnGatewayAvailabilityZones object + |
+Indicates that the specification of VPN gateways is Professional1. + |
+
Professional1-NonFixedIP + |
+VpnGatewayAvailabilityZones object + |
+Indicates that the specification of VPN gateways is Professional1-NonFixedIP. + |
+
professional2 + |
+VpnGatewayAvailabilityZones object + |
+Indicates that the specification of VPN gateways is Professional2. + |
+
Professional2-NonFixedIP + |
+VpnGatewayAvailabilityZones object + |
+Indicates that the specification of VPN gateways is Professional2-NonFixedIP. + |
+
The supported specification options are subject to the value range of the Specification parameter on the page for creating a VPN gateway on the VPN console.
+ + +{ + "availability_zones": { + "basic": { + "vpc": ["eu-de-01", "eu-de-02"], + "er": [] + }, + "professional1": { +, + "vpc": ["eu-de-01", "eu-de-02"], + "er": ["eu-de-01", "eu-de-02"] + }, + "professional2": { + "vpc": ["eu-de-01", "eu-de-02"], + "er": ["eu-de-01", "eu-de-02"] + }, + "Professional1-NonFixedIP": { + "vpc": [], + "er": [] + }, + "Professional2-NonFixedIP": { + "vpc": [], + "er": [] + }, + "gm": { + "vpc": [], + "er": [] + } + }, + "request_id": "b60309ab-812c-4269-9de4-fb9a65e6db16" +}+
For details, see Status Codes.
+This API is used to create a customer gateway to which a VPN gateway connects.
+For details, see Calling APIs.
+POST /v5/{project_id}/customer-gateways
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
customer_gateway + |
+CreateCgwRequestBodyContent object + |
+Yes + |
+Specifies the customer gateway object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+
|
+
id_type + |
+String + |
+No + |
+
|
+
id_value + |
+String + |
+Yes + |
+
|
+
bgp_asn + |
+Long + |
+No + |
+
|
+
tags + |
+Array of VpnResourceTag object + |
+No + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
value + |
+String + |
+Yes + |
+
|
+
POST https://{Endpoint}/v5/{project_id}/vpn/customer-gateways + +{ + "customer_gateway": { + "name": "cgw-2abf", + "id_type": "ip", + "id_value": "10.***.***.21", + "bgp_asn": 65000, + } +}+
Returned status code 201: successful creation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
customer_gateway + |
+ResponseCustomerGateway object + |
+Specifies the customer gateway object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
id_type + |
+String + |
+
|
+
id_value + |
+String + |
+Specifies the identifier of a customer gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the customer gateway. This parameter is available only when id_type is set to ip. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "customer_gateway": { + "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", + "name": "cgw-2abf", + "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" + }, + "request_id": "7e0383bf-a7fb-461b-a926-baa8a795bf1a" +}+
For details, see Status Codes.
+This API is used to query a customer gateway with a specified gateway ID.
+For details, see Calling APIs.
+GET /v5/{project_id}/customer-gateways/{customer_gateway_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
customer_gateway_id + |
+String + |
+Yes + |
+Specifies a customer gateway ID. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
customer_gateway + |
+ResponseCustomerGateway object + |
+Specifies the customer gateway object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
id_type + |
+String + |
+
|
+
id_value + |
+String + |
+Specifies the identifier of a customer gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the customer gateway. This parameter is available only when id_type is set to ip. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
route_mode + |
+String + |
++ | +
ip + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "customer_gateway": { + "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", + "name": "cgw-ba08", + "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" + }, + "request_id": "8111d315-5024-45c9-8ee3-5ef676edb0d1" +}+
For details, see Status Codes.
+This API is used to query the customer gateway list.
+For details, see Calling APIs.
+GET /v5/{project_id}/customer-gateways
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
limit + |
+Integer + |
+No + |
+
|
+
marker + |
+String + |
+No + |
+
|
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
customer_gateways + |
+Array of +ResponseCustomerGateway objects + |
+Specifies the customer gateway object. + |
+
total_count + |
+Long + |
+Specifies the total number of a tenant's customer gateways. + |
+
page_info + |
+PageInfo object + |
+Specifies pagination information. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
id_type + |
+String + |
+
|
+
id_value + |
+String + |
+Specifies the identifier of a customer gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the customer gateway. This parameter is available only when id_type is set to ip. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
route_mode + |
+String + |
++ | +
ip + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
next_marker + |
+String + |
+Specifies the marker of the next page. The value is the time when the last resource in the last query response was created. + |
+
current_count + |
+Integer + |
+Specifies the number of resources in the list. If the value of current_count is less than the value of limit in the query request, the current page is the last page. + |
+
{ + "customer_gateways": [{ + "id": "e67d6e27-demo-a8df-va86-be9a0f0168e9", + "name": "cgw-a45b", + "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" + }, { + "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" + }], + "total_count": 2, + "page_info": { + "next_marker": "2022-11-28T06:25:01.937Z", + "current_count": 2 + }, + "request_id": "82a108d9-0929-42e9-adb7-e146c04c587c" +}+
For details, see Status Codes.
+This API is used to update a customer gateway with a specified gateway ID. Only the gateway name and certificate can be updated. To modify other parameters, you need to create another customer gateway.
+For details, see Calling APIs.
+PUT /v5/{project_id}/customer-gateways/{customer_gateway_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
customer_gateway_id + |
+String + |
+Yes + |
+Specifies a customer gateway ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
customer_gateway + |
+UpdateCgwRequestBodyContent object + |
+Yes + |
+Specifies the customer gateway object. + |
+
PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} + +{ + "customer_gateway": { + "name": "cgw-f846", + } +}+
Returned status code 200: successful update
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
customer_gateway + |
+ResponseCustomerGateway object + |
+Specifies the customer gateway object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
id_type + |
+String + |
+
|
+
id_value + |
+String + |
+Specifies the identifier of a customer gateway. + |
+
bgp_asn + |
+Long + |
+Specifies the BGP AS number of the customer gateway. This parameter is available only when id_type is set to ip. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "customer_gateway": { + "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", + "name": "cgw-f846", + "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" + }, + "request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90" +}+
For details, see Status Codes.
+This API is used to delete a customer gateway with a specified gateway ID.
+For details, see Calling APIs.
+DELETE /v5/{project_id}/customer-gateways/{customer_gateway_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
customer_gateway_id + |
+String + |
+Yes + |
+Specifies a customer gateway ID. + |
+
DELETE https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} +{ + "error_code": "VPN.0001", + "error_msg": "invalid request: customer gateway 575c1722-demo-a8df-va86-dd7f41876332 has connection", + "request_id": "c923ac44-1890-48d5-a004-5be6432cf361" +}+
For details, see Status Codes.
+This API is used to create a VPN connection that connects a VPN gateway to a customer gateway.
+For details, see Calling APIs.
+POST /v5/{project_id}/vpn-connection
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vpn_connection + |
++ | +Yes + |
+Specifies the VPN connection object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+
|
+
vgw_id + |
+String + |
+Yes + |
+
You can obtain the VPN gateway ID by querying the VPN gateway list. + |
+
vgw_ip + |
+String + |
+Yes + |
+
You can obtain the EIP IDs or private IP addresses of the VPN gateway by querying information about the VPN gateway. + |
+
style + |
+String + |
+No + |
++ | +
cgw_id + |
+String + |
+Yes + |
+
|
+
peer_subnets + |
+Array of String + |
+No + |
+
|
+
tunnel_local_address + |
+String + |
+No + |
+
|
+
tunnel_peer_address + |
+String + |
+No + |
+
|
+
enable_nqa + |
+Boolean + |
+No + |
+
|
+
psk + |
+String + |
+No + |
+
|
+
policy_rules + |
+Array of PolicyRule objects + |
+No + |
+
|
+
ikepolicy + |
+IkePolicy object + |
+No + |
+Specifies the Internet Key Exchange (IKE) policy object. + |
+
ipsecpolicy + |
+IpsecPolicy object + |
+No + |
+Specifies the Internet Protocol Security (IPsec) policy object. + |
+
ha_role + |
+String + |
+No + |
+
|
+
tags + |
+Array of VpnResourceTag object + |
+No + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
rule_index + |
+Integer + |
+No + |
+
|
+
source + |
+String + |
+No + |
+
|
+
destination + |
+Array of String + |
+No + |
++ | +
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ike_version + |
+String + |
+No + |
++ | +
phase1_negotiation_mode + |
+String + |
+No + |
++ | +
authentication_algorithm + |
+String + |
+No + |
++ | +
encryption_algorithm + |
+String + |
+No + |
++ | +
dh_group + |
+String + |
+No + |
+
|
+
authentication_method + |
+String + |
+No + |
++ | +
lifetime_seconds + |
+Integer + |
+No + |
+
|
+
local_id_type + |
+String + |
+No + |
+
|
+
local_id + |
+String + |
+No + |
+
|
+
peer_id_type + |
+String + |
+No + |
+
|
+
peer_id + |
+String + |
+No + |
+
|
+
dpd + |
+Dpd object + |
+No + |
+Specifies the dead peer detection (DPD) object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
timeout + |
+Integer + |
+No + |
+
|
+
interval + |
+Integer + |
+No + |
+
|
+
msg + |
+String + |
+No + |
++ | +
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
authentication_algorithm + |
+String + |
+No + |
++ | +
encryption_algorithm + |
+String + |
+No + |
++ | +
pfs + |
+String + |
+No + |
+
|
+
transform_protocol + |
+String + |
+No + |
++ | +
lifetime_seconds + |
+Integer + |
+No + |
+
|
+
encapsulation_mode + |
+String + |
+No + |
++ | +
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
value + |
+String + |
+Yes + |
+
|
+
POST https://{Endpoint}/v5/{project_id}/vpn-connection + +{ + "vpn_connection": { + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": [ + "192.168.44.0/24" + ], + "psk": "abcd****" + } +}+
POST https://{Endpoint}/v5/{project_id}/vpn-connection + +{ + "vpn_connection": { + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "policy", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": [ + "192.168.44.0/24" + ], + "psk": "abcd****", + "policy_rules": [{ + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.0.0/24" + ] + }] + } +}+
POST https://{Endpoint}/v5/{project_id}/vpn-connection + +{ + "vpn_connection": { + "name": "vpn-1655", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "bgp", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": [ + "192.168.44.0/24" + ], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "psk": "abcd****", + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-512", + "encryption_algorithm": "aes-256", + "dh_group": "group16", + "lifetime_seconds": 172800, + "local_id": "123***", + "peer_id": "456***", + "dpd": { + "timeout": 30, + "interval": 60, + "msg": "seq-notify-hash" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-512", + "encryption_algorithm": "aes-256", + "pfs": "group16", + "transform_protocol": "esp", + "lifetime_seconds": 7200, + "encapsulation_mode": "tunnel" + } + } +}+
Returned status code 201: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_connection + |
+ResponseVpnConnection object + |
+Specifies the VPN connection object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
vgw_id + |
+String + |
+
|
+
vgw_ip + |
+String + |
+
|
+
style + |
+String + |
++ | +
cgw_id + |
+String + |
+
|
+
peer_subnets + |
+Array of String + |
+Specifies a customer subnet. This parameter is not returned when the association mode of the VPN gateway is ER and style is BGP or POLICY. + |
+
tunnel_local_address + |
+String + |
+Specifies the tunnel interface address configured on the VPN gateway in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
tunnel_peer_address + |
+String + |
+Specifies the tunnel interface address configured on the customer gateway device in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
enable_nqa + |
+Boolean + |
+
|
+
policy_rules + |
+Array of PolicyRule objects + |
+Specifies policy rules, which are returned only when style is set to POLICY. + |
+
ikepolicy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsecpolicy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
enterprise_project_id + |
+String + |
+
|
+
ha_role + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
eip_id + |
+String + |
+
|
+
type + |
+String + |
++ | +
route_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
rule_index + |
+Integer + |
+
|
+
source + |
+String + |
+Specifies a source CIDR block. + |
+
destination + |
+Array of String + |
+Specifies a destination CIDR block. For example, a destination CIDR block can be 192.168.52.0/24. A maximum of 50 destination CIDR blocks can be returned for each policy rule. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_version + |
+String + |
+
|
+
phase1_negotiation_mode + |
+String + |
++ | +
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_method + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
local_id_type + |
+String + |
+
|
+
local_id + |
+String + |
+Specifies the local ID. When local_id_type is set to ip, the VPN gateway IP address corresponding to the VPN connection is returned. When local_id_type is set to fqdn, the local ID specified during VPN connection creation or update is returned. + |
+
peer_id_type + |
+String + |
+
|
+
peer_id + |
+String + |
+Specifies the peer ID. When peer_id_type is set to ip, the IP address of the customer gateway is returned. When peer_id_type is set to fqdn, the peer ID specified during VPN connection creation or update is returned. + |
+
dpd + |
+Dpd object + |
+Specifies the DPD object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
timeout + |
+Integer + |
+
|
+
interval + |
+Integer + |
+
|
+
msg + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
transform_protocol + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
encapsulation_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "vpn_connection": { + "id": "98c5af8a-6ee2-4482-99a2-ae2280a6f4c3", + "name": "vpn-b2cb", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "STATIC", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.44.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "enable_nqa": false, + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.***.***.134", + "peer_id_type": "ip", + "peer_id": "88.***.***.164", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "enterprise_project_id": "0", + "ha_role":"master" + }, + "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" +}+
{ + "vpn_connection": { + "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", + "name": "vpn-799d", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "POLICY", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.44.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "policy_rules": [{ + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.44.0/24" + ] + }], + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.***.***.134", + "peer_id_type": "ip", + "peer_id": "88.***.***.164", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "enterprise_project_id": "0", + "ha_role":"master" + }, + "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" +}+
{ + "vpn_connection": { + "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", + "name": "vpn-1655", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "BGP", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.44.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-512", + "encryption_algorithm": "aes-256", + "dh_group": "group16", + "authentication_method": "pre-share", + "lifetime_seconds": 172800, + "local_id": "123***", + "peer_id": "456***", + "dpd": { + "timeout": 30, + "interval": 60, + "msg": "seq-notify-hash" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-512", + "encryption_algorithm": "aes-256", + "pfs": "group16", + "transform_protocol": "esp", + "lifetime_seconds": 7200, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "enterprise_project_id": "0", + "ha_role":"master" + }, + "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" +}+
For details, see Status Codes.
+This API is used to query a VPN connection with a specified connection ID.
+For details, see Calling APIs.
+GET /v5/{project_id}/vpn-connection/{vpn_connection_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
vpn_connection_id + |
+String + |
+Yes + |
+Specifies a VPN connection ID. + |
+
Returned status code 200: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_connection + |
+ResponseVpnConnection object + |
+Specifies the VPN connection object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
status + |
+String + |
++ | +
vgw_id + |
+String + |
+
|
+
vgw_ip + |
+String + |
+
|
+
style + |
+String + |
++ | +
cgw_id + |
+String + |
+
|
+
peer_subnets + |
+Array of String + |
+Specifies a customer subnet. This parameter is not returned when the association mode of the VPN gateway is ER and style is BGP or POLICY. + |
+
tunnel_local_address + |
+String + |
+Specifies the tunnel interface address configured on the VPN gateway in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
tunnel_peer_address + |
+String + |
+Specifies the tunnel interface address configured on the customer gateway device in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
enable_nqa + |
+Boolean + |
+
|
+
policy_rules + |
+Array of PolicyRule objects + |
+Specifies policy rules, which are returned only when style is set to POLICY. + |
+
ikepolicy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsecpolicy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
enterprise_project_id + |
+String + |
+
|
+
connection_monitor_id + |
+String + |
+
|
+
ha_role + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
eip_id + |
+String + |
+
|
+
type + |
+String + |
++ | +
route_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
rule_index + |
+Integer + |
+
|
+
source + |
+String + |
+Specifies a source CIDR block. + |
+
destination + |
+Array of String + |
+Specifies a destination CIDR block. For example, a destination CIDR block can be 192.168.52.0/24. A maximum of 50 destination CIDR blocks can be returned for each policy rule. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_version + |
+String + |
+
|
+
phase1_negotiation_mode + |
+String + |
++ | +
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_method + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
local_id_type + |
+String + |
+
|
+
local_id + |
+String + |
+Specifies the local ID. When local_id_type is set to ip, the VPN gateway IP address corresponding to the VPN connection is returned. When local_id_type is set to fqdn, the local ID specified during VPN connection creation or update is returned. + |
+
peer_id_type + |
+String + |
+
|
+
peer_id + |
+String + |
+Specifies the peer ID. When peer_id_type is set to ip, the IP address of the customer gateway is returned. When peer_id_type is set to fqdn, the peer ID specified during VPN connection creation or update is returned. + |
+
dpd + |
+Dpd object + |
+Specifies the DPD object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
timeout + |
+Integer + |
+
|
+
interval + |
+Integer + |
+
|
+
msg + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
transform_protocol + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
encapsulation_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "vpn_connection": { + "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", + "name": "vpn-1655", + "status": "DOWN", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "POLICY", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.0.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "policy_rules": [{ + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.0.0/24" + ] + }], + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.***.***.134", + "peer_id_type": "ip", + "peer_id": "88.***.***.164", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "enterprise_project_id": "0", + "ha_role":"master" + }, + "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" +}+
For details, see Status Codes.
+This API is used to query the VPN connection list.
+For details, see Calling APIs.
+GET /v5/{project_id}/vpn-connection
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vgw_ip + |
+String + |
+No + |
+Specifies an EIP ID or private IP address of a VPN gateway. + |
+
vgw_id + |
+String + |
+No + |
+Specifies a VPN gateway ID. + |
+
enterprise_project_id + |
+Array + |
+No + |
+Specifies an enterprise project ID. + |
+
limit + |
+Integer + |
+No + |
+
|
+
marker + |
+String + |
+No + |
+
|
+
GET https://{Endpoint}/v5/{project_id}/vpn-connection+
GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_ip={vgw_ip}&limit={limit}&marker={marker}+
GET https://{Endpoint}/v5/{project_id}/vpn-connection?vgw_id={vgw_id}&limit={limit}&marker={marker}+
Returned status code 200: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_connections + |
+Array of +ResponseVpnConnection objects + |
+Specifies the VPN connection object. + |
+
page_info + |
+PageInfo object + |
+Specifies pagination information. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
total_count + |
+Long + |
+Specifies the total number of a tenant's connections. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
status + |
+String + |
++ | +
vgw_id + |
+String + |
+
|
+
vgw_ip + |
+String + |
+
|
+
style + |
+String + |
++ | +
cgw_id + |
+String + |
+
|
+
peer_subnets + |
+Array of String + |
+Specifies a customer subnet. This parameter is not returned when the association mode of the VPN gateway is ER and style is BGP or POLICY. + |
+
tunnel_local_address + |
+String + |
+Specifies the tunnel interface address configured on the VPN gateway in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
tunnel_peer_address + |
+String + |
+Specifies the tunnel interface address configured on the customer gateway device in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
enable_nqa + |
+Boolean + |
+
|
+
policy_rules + |
+Array of PolicyRule objects + |
+Specifies policy rules, which are returned only when style is set to POLICY. + |
+
ikepolicy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsecpolicy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
enterprise_project_id + |
+String + |
+
|
+
connection_monitor_id + |
+String + |
+
|
+
ha_role + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
eip_id + |
+String + |
+
|
+
type + |
+String + |
++ | +
route_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
rule_index + |
+Integer + |
+
|
+
source + |
+String + |
+Specifies a source CIDR block. + |
+
destination + |
+Array of String + |
+Specifies a destination CIDR block. For example, a destination CIDR block can be 192.168.52.0/24. A maximum of 50 destination CIDR blocks can be returned for each policy rule. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_version + |
+String + |
+
|
+
phase1_negotiation_mode + |
+String + |
+
|
+
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_method + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
local_id_type + |
+String + |
+
|
+
local_id + |
+String + |
+Specifies the local ID. When local_id_type is set to ip, the VPN gateway IP address corresponding to the VPN connection is returned. When local_id_type is set to fqdn, the local ID specified during VPN connection creation or update is returned. + |
+
peer_id_type + |
+String + |
+
|
+
peer_id + |
+String + |
+Specifies the peer ID. When peer_id_type is set to ip, the IP address of the customer gateway is returned. When peer_id_type is set to fqdn, the peer ID specified during VPN connection creation or update is returned. + |
+
dpd + |
+Dpd object + |
+Specifies the DPD object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
timeout + |
+Integer + |
+
|
+
interval + |
+Integer + |
+
|
+
msg + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+
|
+
transform_protocol + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
encapsulation_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
next_marker + |
+String + |
+Specifies the marker of the next page. The value is the time when the last resource in the last query response was created. + |
+
current_count + |
+Integer + |
+Specifies the number of resources in the list. If the value of current_count is less than the value of limit in the query request, the current page is the last page. + |
+
{ + "vpn_connections": [{ + "id": "228a68f0-demo-a8df-va86-a9919a3ea3de", + "name": "vpn-56ea", + "status": "DOWN", + "vgw_id": "ba90819b-demo-a8df-va86-3a01622856a5", + "vgw_ip": "3ea3b006-demo-a8df-va86-ae180ae07885", + "style": "STATIC", + "cgw_id": "537d9c26-demo-a8df-va86-99364a410f00", + "peer_subnets": [ + "192.168.1.0/24" + ], + "tunnel_local_address": "169.254.149.2/30", + "tunnel_peer_address": "169.254.149.1/30", + "enable_nqa": true, + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.1.1.216", + "peer_id_type": "ip", + "peer_id": "10.0.1.67", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T09:41:11.445Z", + "updated_at": "2024-06-28T09:41:11.445Z", + "enterprise_project_id": "0" + }, + { + "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", + "name": "vpn-15ea", + "status": "DOWN", + "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", + "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", + "style": "POLICY", + "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", + "tunnel_local_address": "169.254.77.169/30", + "tunnel_peer_address": "169.254.77.170/30", + "policy_rules": [{ + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.44.0/24" + ] + }], + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 3600, + "local_id_type": "ip", + "local_id": "88.88.201.167", + "peer_id_type": "ip", + "peer_id": "10.111.222.21", + "dpd": { + "interval": 30, + "timeout": 15, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T07:24:27.674Z", + "updated_at": "2024-06-28T07:24:27.674Z", + "enterprise_project_id": "0", + "ha_role":"master" + } + ], + "page_info": { + "next_marker": "2024-06-28T07:24:27.674Z", + "current_count": 2 + }, + "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", + "total_count": 2 +}+
{ + "vpn_connections": [ + { + "id": "8fa335dd-demo-a8df-va86-78bb55a8bb04", + "name": "vpn-2acd", + "status": "DOWN", + "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", + "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", + "style": "STATIC", + "cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0", + "peer_subnets": [ + "192.168.44.0/24" + ], + "tunnel_local_address": "169.254.58.225/30", + "tunnel_peer_address": "169.254.58.226/30", + "enable_nqa": false, + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 3600, + "local_id_type": "ip", + "local_id": "88.***.***.167", + "peer_id_type": "ip", + "peer_id": "10.***.***.9", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T14:24:25.115Z", + "updated_at": "2024-06-28T14:24:25.115Z", + "enterprise_project_id": "0" + }, + { + "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", + "name": "vpn-15ea", + "status": "DOWN", + "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", + "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", + "style": "POLICY", + "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", + "tunnel_local_address": "169.254.77.169/30", + "tunnel_peer_address": "169.254.77.170/30", + "policy_rules": [ + { + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.44.0/24" + ] + } + ], + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 3600, + "local_id_type": "ip", + "local_id": "88.88.201.167", + "peer_id_type": "ip", + "peer_id": "10.111.222.21", + "dpd": { + "interval": 30, + "timeout": 15, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T13:59:59.633Z", + "updated_at": "2024-06-28T13:59:59.633Z", + "enterprise_project_id": "0", + "ha_role":"master" + } + ], + "page_info": { + "next_marker": "2024-06-28T13:59:59.633Z", + "current_count": 2 + }, + "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", + "total_count": 12 +}+
{ + "vpn_connections": [ + { + "id": "8fa335dd-demo-a8df-va86-78bb55a8bb04", + "name": "vpn-2acd", + "status": "DOWN", + "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", + "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", + "style": "STATIC", + "cgw_id": "eba04567-demo-a8df-va86-5b0352f89af0", + "peer_subnets": [ + "192.168.44.0/24" + ], + "tunnel_local_address": "169.254.58.225/30", + "tunnel_peer_address": "169.254.58.226/30", + "enable_nqa": false, + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 3600, + "local_id_type": "ip", + "local_id": "88.***.***.167", + "peer_id_type": "ip", + "peer_id": "10.***.***.9", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T14:24:25.115Z", + "updated_at": "2024-06-28T14:24:25.115Z", + "enterprise_project_id": "0", + "ha_role":"master" + }, + { + "id": "a4df33ca-demo-a8df-va86-410a7dd6973f", + "name": "vpn-15ea", + "status": "DOWN", + "vgw_id": "02217fb1-demo-a8df-va86-806ea291a8f2", + "vgw_ip": "f5acac2c-demo-a8df-va86-72b819a5f525", + "style": "POLICY", + "cgw_id": "10a4496f-demo-a8df-va86-7510f4b2af33", + "tunnel_local_address": "169.254.77.169/30", + "tunnel_peer_address": "169.254.77.170/30", + "policy_rules": [ + { + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.44.0/24" + ] + } + ], + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 3600, + "local_id_type": "ip", + "local_id": "88.88.201.167", + "peer_id_type": "ip", + "peer_id": "10.111.222.21", + "dpd": { + "interval": 30, + "timeout": 15, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T13:59:59.633Z", + "updated_at": "2024-06-28T13:59:59.633Z", + "enterprise_project_id": "0", + "ha_role":"master" + } + ], + "page_info": { + "next_marker": "2024-06-28T13:59:59.633Z", + "current_count": 2 + }, + "request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac", + "total_count": 12 +}+
For details, see Status Codes.
+This API is used to update a VPN connection with a specified connection ID.
+For details, see Calling APIs.
+PUT /v5/{project_id}/vpn-connection/{vpn_connection_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
vpn_connection_id + |
+String + |
+Yes + |
+Specifies a VPN connection ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vpn_connection + |
++ | +Yes + |
+Specifies the VPN connection object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+
|
+
cgw_id + |
+String + |
+No + |
+
|
+
peer_subnets + |
+Array of String + |
+No + |
+
|
+
tunnel_local_address + |
+String + |
+No + |
+
|
+
tunnel_peer_address + |
+String + |
+No + |
+
|
+
psk + |
+String + |
+No + |
+
|
+
policy_rules + |
+Array of PolicyRule objects + |
+No + |
+
You can obtain the style value of a VPN connection by querying the VPN connection. + |
+
ikepolicy + |
+UpdateIkePolicy object + |
+No + |
+Specifies the IKE policy object. + |
+
ipsecpolicy + |
+UpdateIpsecPolicy object + |
+No + |
+Specifies the IPsec policy object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
rule_index + |
+Integer + |
+No + |
+
|
+
source + |
+String + |
+No + |
+
|
+
destination + |
+Array of String + |
+No + |
++ | +
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ike_version + |
+String + |
+No + |
+
|
+
phase1_negotiation_mode + |
+String + |
+No + |
++ | +
authentication_algorithm + |
+String + |
+No + |
+
|
+
encryption_algorithm + |
+String + |
+No + |
++ | +
dh_group + |
+String + |
+No + |
+
|
+
lifetime_seconds + |
+Integer + |
+No + |
+
|
+
local_id_type + |
+String + |
+No + |
+
|
+
local_id + |
+String + |
+No + |
+
|
+
peer_id_type + |
+String + |
+No + |
+
|
+
peer_id + |
+String + |
+No + |
+
|
+
dpd + |
+UpdateDpd object + |
+No + |
+Specifies the DPD object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
timeout + |
+Integer + |
+No + |
+
|
+
interval + |
+Integer + |
+No + |
+
|
+
msg + |
+String + |
+No + |
++ | +
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
authentication_algorithm + |
+String + |
+No + |
++ | +
encryption_algorithm + |
+String + |
+No + |
++ | +
pfs + |
+String + |
+No + |
+
|
+
transform_protocol + |
+String + |
+No + |
++ | +
lifetime_seconds + |
+Integer + |
+No + |
+
|
+
encapsulation_mode + |
+String + |
+No + |
++ | +
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} + +{ + "vpn_connection": { + "peer_subnets": [ + "192.168.1.0/24" + ] + } +}+
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} + +{ + "vpn_connection": { + "policy_rules": [{ + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.1.0/24" + ] + }] + } +}+
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} + +{ + "vpn_connection": { + "ikepolicy": { + "lifetime_seconds": 3600 + }, + "ipsecpolicy": { + "lifetime_seconds": 3600 + } + } +}+
PUT https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} + +{ + "vpn_connection": { + "name": "vpn_connection_name" + } +}+
Returned status code 200: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpn_connection + |
+ResponseVpnConnection object + |
+Specifies the VPN connection object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
name + |
+String + |
+
|
+
vgw_id + |
+String + |
+
|
+
vgw_ip + |
+String + |
+
|
+
style + |
+String + |
++ | +
cgw_id + |
+String + |
+
|
+
peer_subnets + |
+Array of String + |
+Specifies a customer subnet. This parameter is not returned when the association mode of the VPN gateway is ER and style is BGP or POLICY. + |
+
tunnel_local_address + |
+String + |
+Specifies the tunnel interface address configured on the VPN gateway in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
tunnel_peer_address + |
+String + |
+Specifies the tunnel interface address configured on the customer gateway device in route-based mode. This parameter is valid only when style is STATIC or BGP. + |
+
enable_nqa + |
+Boolean + |
+
|
+
policy_rules + |
+Array of PolicyRule objects + |
+Specifies policy rules, which are returned only when style is set to POLICY. + |
+
ikepolicy + |
+IkePolicy object + |
+Specifies the IKE policy object. + |
+
ipsecpolicy + |
+IpsecPolicy object + |
+Specifies the IPsec policy object. + |
+
created_at + |
+String + |
+
|
+
updated_at + |
+String + |
+
|
+
enterprise_project_id + |
+String + |
+
|
+
connection_monitor_id + |
+String + |
+
|
+
ha_role + |
+String + |
+
|
+
tags + |
+Array of VpnResourceTag objects + |
+Specifies a tag list. + |
+
eip_id + |
+String + |
+
|
+
type + |
+String + |
++ | +
route_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
rule_index + |
+Integer + |
+
|
+
source + |
+String + |
+Specifies a source CIDR block. + |
+
destination + |
+Array of String + |
+Specifies a destination CIDR block. For example, a destination CIDR block can be 192.168.52.0/24. A maximum of 50 destination CIDR blocks can be returned for each policy rule. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
ike_version + |
+String + |
+
|
+
phase1_negotiation_mode + |
+String + |
++ | +
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
dh_group + |
+String + |
+
|
+
authentication_method + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
local_id_type + |
+String + |
+
|
+
local_id + |
+String + |
+Specifies the local ID. When local_id_type is set to ip, the VPN gateway IP address corresponding to the VPN connection is returned. + |
+
peer_id_type + |
+String + |
+
|
+
peer_id + |
+String + |
+Specifies the peer ID. When peer_id_type is set to ip, the IP address of the customer gateway is returned. + |
+
dpd + |
+Dpd object + |
+Specifies the DPD object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
timeout + |
+Integer + |
+
|
+
interval + |
+Integer + |
+
|
+
msg + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
authentication_algorithm + |
+String + |
+
|
+
encryption_algorithm + |
+String + |
+
|
+
pfs + |
+String + |
+Specifies the DH key group used by PFS. +
|
+
transform_protocol + |
+String + |
++ | +
lifetime_seconds + |
+Integer + |
+
|
+
encapsulation_mode + |
+String + |
++ | +
Parameter + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+
|
+
value + |
+String + |
+
|
+
{ + "vpn_connection": { + "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", + "name": "vpn-1655", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "POLICY", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.1.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "policy_rules": [{ + "rule_index": 1, + "source": "10.0.0.0/24", + "destination": [ + "192.168.1.0/24" + ] + }], + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.***.***.134", + "peer_id_type": "ip", + "peer_id": "88.***.***.164", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2024-06-28T13:41:34.626Z", + "updated_at": "2024-06-28T13:41:34.626Z", + "enterprise_project_id": "0", + "ha_role": "master" + }, + "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" +}+
{ + "error_code": "VPN.0001", + "error_msg": "invalid request: ILLEGAL not allowed update vpnConnection", + "request_id": "8c833634-4560-7897-7740-a7462f5bcbd4" +}+
For details, see Status Codes.
+This API is used to delete a VPN connection with a specified connection ID.
+For details, see Calling APIs.
+DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
vpn_connection_id + |
+String + |
+Yes + |
+Specifies a VPN connection ID. + |
+
DELETE https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id} + +{ + "error_code":"VPN.0001", + "error_msg":"invalid request: ILLEGAL not allowed delete vpnConnection", + "request_id":"76b771cb-3b2a-151a-5bed-fdf5df12ff82" +}+
For details, see Status Codes.
+This API is used to create a VPN connection monitor to perform health check between gateways. After a VPN connection monitor is created, the VPN gateway sends probe packets to the customer gateway to collect statistics about the round-trip delay and packet loss rate, thereby monitoring quality of VPN connections between the gateways.
+For details, see Calling APIs.
+POST /v5/{project_id}/connection-monitors
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
connection_monitor + |
++ | +Yes + |
+Specifies the connection_monitor object. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vpn_connection_id + |
+String + |
+Yes + |
+Specifies the ID of the VPN connection to be monitored. +You can obtain VPN connection IDs by querying the VPN connection list. + |
+
POST https://{Endpoint}/v5/{project_id}/connection-monitors + +{ + "connection_monitor": { + "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220" + } +}+
Returned status code 201: successful operation
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
connection_monitor + |
+ConnectionMonitorInfo object + |
+Specifies the connection_monitor object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
vpn_connection_id + |
+String + |
+
|
+
type + |
+String + |
+
|
+
source_ip + |
+String + |
+Specifies the source address to be monitored. + |
+
destination_ip + |
+String + |
+Specifies the destination address to be monitored. + |
+
proto_type + |
+String + |
+
|
+
{ + "connection_monitor":{ + "id":"76f64229-demo-a8df-va86-3907e2815b6d", + "vpn_connection_id":"cae286f2-demo-a8df-va86-e22416ca1220", + "type":"gateway", + "source_ip":"88.***.***.60", + "destination_ip":"88.***.***.32", + "proto_type":"icmp" + }, + "request_id": "bd37d16d-387c-41ab-a180-01b649f73590" +}+
For details, see Status Codes.
+This API is used to query a VPN connection monitor with a specified ID.
+For details, see Calling APIs.
+GET /v5/{project_id}/connection-monitors/{connection_monitor_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
connection_monitor_id + |
+String + |
+Yes + |
+Specifies the ID of a VPN connection monitor. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
connection_monitor + |
+ConnectionMonitorInfo object + |
+Specifies the connection_monitor object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
status + |
+String + |
++ | +
vpn_connection_id + |
+String + |
+
|
+
type + |
+String + |
+
|
+
source_ip + |
+String + |
+Specifies the source address to be monitored. + |
+
destination_ip + |
+String + |
+Specifies the destination address to be monitored. + |
+
proto_type + |
+String + |
+
|
+
{ + "connection_monitor": { + "id": "76f64229-demo-a8df-va86-3907e2815b6d", + "status": "ACTIVE", + "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220", + "type": "gateway", + "source_ip": "88.***.***.60", + "destination_ip": "88.***.***.32", + "proto_type": "icmp" + }, + "request_id": "6d212bc0-ecb1-457b-977b-5e815fce658d" +}+
For details, see Status Codes.
+This API is used to query the list of VPN connection monitors.
+For details, see Calling APIs.
+GET /v5/{project_id}/connection-monitors
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
vpn_connection_id + |
+String + |
+No + |
+Specifies a VPN connection ID. + |
+
enterprise_project_id + |
+Array + |
+No + |
+Specifies an enterprise project ID. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
connection_monitors + |
+Array of ConnectionMonitorInfo objects + |
+Specifies the connection_monitor object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+
|
+
status + |
+String + |
++ | +
vpn_connection_id + |
+String + |
+
|
+
type + |
+String + |
+
|
+
source_ip + |
+String + |
+Specifies the source address to be monitored. + |
+
destination_ip + |
+String + |
+Specifies the destination address to be monitored. + |
+
proto_type + |
+String + |
+
|
+
{ + "connection_monitors":[ + { + "id":"76f64229-demo-a8df-va86-3907e2815b6d", + "status":"ACTIVE", + "vpn_connection_id":"2342adf2-demo-a8df-va86-12aq511s0917", + "type":"gateway", + "source_ip":"88.***.***.60", + "destination_ip":"88.***.***.32", + "proto_type":"icmp" + }, + { + "id":"85t53318-demo-a8df-va86-zq9312525f6t", + "status":"ACTIVE", + "vpn_connection_id":"cae286f2-demo-a8df-va86-e22416ca1220", + "type":"gateway", + "source_ip":"89.***.***.21", + "destination_ip":"88.***.***.12", + "proto_type":"icmp" + } + ], + "request_id": "531f8b2c-ec55-45d8-90a3-ede922f7d63c" +}+
{ + "connection_monitors":[ + { + "id":"76f64229-demo-a8df-va86-3907e2815b6d", + "status":"ACTIVE", + "vpn_connection_id":"2342adf2-demo-a8df-va86-12aq511s0917", + "type":"gateway", + "source_ip":"88.***.***.60", + "destination_ip":"88.***.***.32", + "proto_type":"icmp" + } + ], + "request_id": "05ab9b58-9b4c-4cee-8113-4b0f325f1dfc" +}+
For details, see Status Codes.
+This API is used to delete a VPN connection monitor with a specified ID.
+For details, see Calling APIs.
+DELETE /v5/{project_id}/connection-monitors/{connection_monitor_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
connection_monitor_id + |
+String + |
+Yes + |
+Specifies the ID of a VPN connection monitor. + |
+
For details, see Status Codes.
+This API is used to query VPN resource quotas of a tenant, including VPN gateways, customer gateways, and VPN connections.
+For details, see Calling APIs.
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
quotas + |
+Quotas object + |
+Specifies the quotas object. + |
+
request_id + |
+String + |
+Specifies a request ID. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
resources + |
+Array of QuotaInfo objects + |
+Specifies the resources object. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
type + |
+String + |
+
|
+
quota + |
+Integer + |
+Specifies the quota upper limit. + |
+
used + |
+Integer + |
+Specifies the number of resources in use. + |
+
{ + "quotas": { + "resources": [ + { + "type": "customer_gateway", + "quota": 100, + "used": 13 + }, + { + "type": "vpn_connection", + "quota": 5000, + "used": 306 + }, + { + "type": "vpn_gateway", + "quota": 50, + "used": 23 + } + ] + }, + "request_id": "9aeb7f73-e1b6-42eb-96ad-b68aef8186e3" +}+
For details, see Status Codes.
+ +This section describes how to create a VPN gateway by calling APIs.
+You have determined the region where the VPN gateway is to be deployed and obtained the endpoint for calling APIs based on the region.
+You have obtained a user token if you need to use token authentication. In addition, you need to add X-Auth-Token to the request header when calling an API. For details about token authentication, see "Authentication" in the Virtual Private Cloud API Reference.
+Parameter + |
+Description + |
+Example Value + |
+
---|---|---|
vpc_id + |
+Specifies the ID of the VPC to which the VPN gateway connects. + |
+cb4a631d-demo-a8df-va86-ca3fa348c36c + |
+
local_subnets + |
+Specifies a local subnet. + |
+192.168.0.0/24,192.168.1.0/24 + |
+
connect_subnet + |
+Specifies the ID of the VPC subnet used by the VPN gateway. + |
+f5741286-demo-a8df-va86-2c82bd9ee114 + |
+
eip1.id + |
+Specifies the ID of the active EIP used by the VPN gateway. + |
+cff40e5e-demo-a8df-va86-7366077bf097 + |
+
eip2.id + |
+Specifies the ID of the standby EIP used by the VPN gateway. + |
+d290f1ee-demo-a8df-va86-d701748f0851 + |
+
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 | { + "vpn_gateway": { + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": [ + "192.168.0.0/24", "192.168.1.0/24" + ], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "eip1": { + "id": "cff40e5e-demo-a8df-va86-7366077bf097" + }, + "eip2": { + "id": "d290f1ee-demo-a8df-va86-d701748f0851" + } + } +} + |
{ + "vpn_gateway": { + "id": "620d99b8-demo-a8df-va86-200b868f2d7d", + "name": "vpngw-3caf", + "network_type": "public", + "attachment_type": "vpc", + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": ["192.168.0.0/24", "192.168.1.0/24"], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 64512, + "access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "flavor": "Professional1", + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0" + }, + "request_id": "4a739f5c-edb7-4122-b31f-b77fb1b94857" +}+
{ + "vpn_gateway": { + "id": "620d99b8-demo-a8df-va86-200b868f2d7d", + "name": "vpngw-3caf", + "network_type": "public", + "status": "ACTIVE", + "attachment_type": "vpc", + "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "local_subnets": [ + "192.168.0.0/24", "192.168.1.0/24" + ], + "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", + "access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", + "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", + "bgp_asn": 64512, + "flavor": "Professional1", + "availability_zone_ids": [ + "eu-de-01", "eu-de-02" + ], + "used_connection_number": 0, + "used_connection_group": 0, + "enterprise_project_id": "0", + "eip1": { + "id": "cff40e5e-demo-a8df-va86-7366077bf097", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.8", + "charge_mode": "traffic", + "bandwidth_id": "593a1a79-demo-a8df-va86-64ec45fb23f6", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-1391" + }, + "eip2": { + "id": "d290f1ee-demo-a8df-va86-d701748f0851", + "ip_version": 4, + "type": "5_bgp", + "ip_address": "88.***.***.6", + "charge_mode": "traffic", + "bandwidth_id": "0abb9d55-demo-a8df-va86-b7500ac2a338", + "bandwidth_size": 300, + "bandwidth_name": "vpngw-bandwidth-1392" + }, + "created_at": "2022-09-15T08:56:09.386Z", + "updated_at": "2022-09-15T11:13:13.677Z" + }, + "request_id": "d099a7dc-ea71-45a6-a75b-dccbfe17d438" +}+
This section describes how to create a customer gateway by calling APIs.
+You have obtained a user token if you need to use token authentication. In addition, you need to add X-Auth-Token to the request header when calling an API. For details about token authentication, see "Authentication" in the Virtual Private Cloud API Reference.
+Parameter + |
+Description + |
+Example Value + |
+
---|---|---|
name + |
+Specifies a customer gateway name. + |
+stub-customer-gateway-id-1 + |
+
route_mode + |
+Specifies the gateway routing mode. + |
+static + |
+
ip + |
+Specifies the IP address of the customer gateway. + |
+10.12.13.21 + |
+
{ + "customer_gateway": { + "name": "cgw-3ebf", + "id_type": "ip", + "id_value": "10.***.***.21" + } +}+
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 | { + "customer_gateway": { + "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", + "name": "cgw-3ebf", + "id_type": "ip", + "id_value": "10.***.***.21", + "created_at": "2024-06-25T13:19:37.335+02:00", + "updated_at": "2024-06-25T13:19:37.335+02:00" + }, + "request_id": "e55783ba-5cc8-40c1-ad81-12cce6f773d2" +} + |
1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 | { + "customer_gateway": { + "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", + "name": "cgw-3ebf", + "id_type": "ip", + "id_value": "10.***.***.21", + "created_at": "2024-06-25T13:19:37.335Z", + "updated_at": "2024-06-25T13:19:37.335Z" + }, + "request_id": "8cf476c4-c3d4-4516-bfbc-01e2473e549b" +} + |
This section describes how to create a VPN connection by calling APIs.
+Parameter + |
+Description + |
+Example Value + |
+
---|---|---|
vgw_id + |
+Specifies a VPN gateway ID. + |
+b32d91a4-demo-a8df-va86-e907174eb11d + |
+
vgw_ip + |
+Specifies an EIP ID of the VPN gateway. + |
+0c464dad-demo-a8df-va86-c22bb0eb0bde + |
+
cgw_id + |
+Specifies a customer gateway ID. + |
+5247ae10-demo-a8df-va86-dd36659a7f5d + |
+
peer_subnets + |
+Specifies a customer subnet. + |
+192.168.44.0/24 + |
+
psk + |
+Specifies a pre-shared key. + |
+abcd**** + |
+
{ + "vpn_connection": { + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": [ + "192.168.44.0/24" + ], + "psk": "abcd****" + } +}+
{ + "vpn_connection": { + "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", + "name": "vpn-1655", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "STATIC", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.44.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "enable_nqa": false, + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.***.***.134", + "peer_id_type": "ip", + "peer_id": "88.***.***.164", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2022-11-26T13:41:34.626Z", + "updated_at": "2022-11-26T13:41:34.626Z", + "enterprise_project_id": "0", + }, + "request_id": "f74da97d-aa27-4f62-a87c-a33b5706964b" +}+
{ + "vpn_connection": { + "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", + "name": "vpn-1655", + "status": "DOWN", + "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", + "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", + "style": "STATIC", + "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", + "peer_subnets": ["192.168.44.0/24"], + "tunnel_local_address": "169.254.56.225/30", + "tunnel_peer_address": "169.254.56.226/30", + "enable_nqa": false, + "ikepolicy": { + "ike_version": "v2", + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "dh_group": "group15", + "authentication_method": "pre-share", + "lifetime_seconds": 86400, + "local_id_type": "ip", + "local_id": "10.***.***.134", + "peer_id_type": "ip", + "peer_id": "88.***.***.164", + "dpd": { + "timeout": 15, + "interval": 30, + "msg": "seq-hash-notify" + } + }, + "ipsecpolicy": { + "authentication_algorithm": "sha2-256", + "encryption_algorithm": "aes-128", + "pfs": "group15", + "transform_protocol": "esp", + "lifetime_seconds": 3600, + "encapsulation_mode": "tunnel" + }, + "created_at": "2022-11-26T13:41:34.626Z", + "updated_at": "2022-11-26T13:41:34.626Z", + "enterprise_project_id": "0", + }, + "request_id": "104c5608-b68b-462c-af17-ead2fb5ccee4" +}+
This section describes how to create a VPN connection monitor by calling APIs.
+Parameter + |
+Description + |
+Example Value + |
+
---|---|---|
vpn_connection_id + |
+Specifies the ID of the VPN connection to be monitored. + |
+cae286f2-demo-a8df-va86-e22416ca1220 + |
+
{ + "connection_monitor": { + "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220" + } +}+
{ + "connection_monitor": { + "id": "76f64229-demo-a8df-va86-3907e2815b6d", + "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220", + "type": "gateway", + "source_ip": "88.***.***.60", + "destination_ip": "192.***.***.0", + "proto_type": "icmp" + }, + "request_id": "54af23d8-989e-445d-bb48-0a9da33d7f0f" +}+
{ + "connection_monitor": { + "id": "76f64229-demo-a8df-va86-3907e2815b6d", + "status": "ACTIVE", + "vpn_connection_id": "cae286f2-demo-a8df-va86-e22416ca1220", + "type": "gateway", + "source_ip": "88.***.***.60", + "destination_ip": "192.***.***.0", + "proto_type": "icmp" + }, + "request_id": "72d05395-0637-4f93-9844-b4979e9d7bdc" +}+
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.
+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.
+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.
+Policy-based authorization is useful if you want to allow or deny the access to an API.
+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 vpn:vpnGateways:list action.
+Supported Actions
+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:
+VPN supports the following actions that can be defined in custom policies:
+[Example] VPN gateway, including actions supported by VPN gateway APIs, such as the APIs for creating, querying, updating, and deleting VPN gateways.
+A project ID is required by some URLs used for calling APIs. You can obtain the project ID using either of the following methods:
+You can obtain the project ID by calling the API used to query project information.
+The API for obtaining the project ID is GET https://{IAM endpoint}/v3/projects. For details about API authentication, see "Authentication" in the Virtual Private Cloud API Reference.
+The following is an example response. The value of id is the project ID.
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 | { + "projects": [ + { + "domain_id": "65382450e8f64ac0870cd180d14e684b", + "is_domain": false, + "parent_id": "65382450e8f64ac0870cd180d14e684b", + "name": "project_name", + "description": "", + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" + }, + "id": "a4a5d4098fb4474fa22cd05f897d6b99", + "enabled": true + } + ], + "links": { + "next": null, + "previous": null, + "self": "https://www.example.com/v3/projects" + } +} + |
Perform the following operations:
+On the API Credentials page, view the project ID in the project list.
+Status Code + |
+Type + |
+Description + |
+
---|---|---|
200 + |
+OK + |
+Successful GET or PUT operations + |
+
201 + |
+Created + |
+Successful POST operations + |
+
204 + |
+No Content + |
+Successful DELETE operations + |
+
Status Code + |
+Type + |
+Description + |
+
---|---|---|
400 + |
+Bad Request + |
+The server fails to process the request. + |
+
401 + |
+Unauthorized + |
+A username and password are required for access to the requested page. + |
+
403 + |
+Forbidden + |
+Access to the requested page is forbidden. + |
+
404 + |
+Not Found + |
+The requested page is not found. + |
+
405 + |
+Method Not Allowed + |
+The method specified in the request is not allowed. + |
+
406 + |
+Not Acceptable + |
+The response generated by the server could not be accepted by the client. + |
+
407 + |
+Proxy Authentication Required + |
+Processing the request requires authentication by a proxy server. + |
+
408 + |
+Request Timeout + |
+The request times out. + |
+
409 + |
+Conflict + |
+The request cannot be processed due to a conflict. + |
+
500 + |
+Internal Server Error + |
+The request is not completed due to a service exception. + |
+
501 + |
+Not Implemented + |
+The request is not completed because the server does not support the requested function. + |
+
502 + |
+Bad Gateway + |
+The request is not completed because the server receives an invalid response from the upstream server. + |
+
503 + |
+Service Unavailable + |
+The request is not completed because the service is unavailable. + |
+
504 + |
+Gateway Timeout + |
+A gateway timeout error occurs. + |
+
This API is used to query resource instances based on tags.
+For details, see Calling APIs.
+POST /v5/{project_id}/{resource_type}/resource-instances/filter
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
resource_type + |
+String + |
+Yes + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
limit + |
+Integer + |
+No + |
+
|
+
offset + |
+Integer + |
+No + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
without_any_tag + |
+Boolean + |
+No + |
+
|
+
tags + |
+Array of Tag objects + |
+No + |
+
|
+
matches + |
+Array of Match objects + |
+No + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
values + |
+Array of String + |
+Yes + |
+
|
+
POST https://{Endpoint}/v5/{project_id}/{resource_type}/resource-instances/filter +{ + "tags": [{ + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [{ + "key": "resource_name", + "value": "resource1" + }], + "without_any_tag": "false" +}+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
resources + |
+Array of Resource objects + |
+Indicates the resource object list. + |
+
total_count + |
+Integer + |
+Indicates the total number of records. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
resource_id + |
+String + |
+Indicates a resource ID. + |
+
resource_detail + |
+object + |
+Specifies resource details. This parameter is reserved for extension and is left empty by default. + |
+
tags + |
+Array of ResourceTag objects + |
+Specifies a tag list. + |
+
resource_name + |
+String + |
+Indicates a resource name. + |
+
{ + "resources": [{ + "resource_id": "134f9fb1-demo-a8df-va86-2040a5c13325", + "resource_name": "resouece1", + "tags": [{ + "key": "key1", + "value": "value1" + }] + }], + "total_count": 1000 +}+
For details, see Status Codes.
+This API is used to query the number of resource instances based on tags.
+For details, see Calling APIs.
+POST /v5/{project_id}/{resource_type}/resource-instances/count
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
resource_type + |
+String + |
+Yes + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
without_any_tag + |
+Boolean + |
+No + |
+
|
+
tags + |
+Array of Tag objects + |
+No + |
+
|
+
matches + |
+Array of Match objects + |
+No + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
values + |
+Array of String + |
+Yes + |
+
|
+
POST https://{Endpoint}/v5/{project_id}/{resource_type}/resource-instances/count +{ + "tags": [{ + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [{ + "key": "resource_name", + "value": "resource1" + }], + "without_any_tag": "false" +}+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
total_count + |
+Integer + |
+Indicates the total number of records. + |
+
{ + "total_count": 1000 +}+
For details, see Status Codes.
+This API is used to add tags to a specified instance in batches.
+For details, see Calling APIs.
+POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
resource_type + |
+String + |
+Yes + |
+
|
+
resource_id + |
+String + |
+Yes + |
+Indicates a resource ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
tags + |
+Array of ResourceTag objects + |
+Yes + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
value + |
+String + |
+No + |
+
|
+
POST https://{Endpoint}/v5/{project_id}/{resource_type}/{resource_id}/tags/create +{ + "tags": [{ + "key": "key1", + "value": "value1" + }] +}+
For details, see Status Codes.
+This API is used to delete tags from a specified instance in batches.
+For details, see Calling APIs.
+POST /v5/{project_id}/{resource_type}/{resource_id}/tags/delete
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
resource_type + |
+String + |
+Yes + |
+
|
+
resource_id + |
+String + |
+Yes + |
+Indicates a resource ID. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
tags + |
+Array of ResourceTag objects + |
+Yes + |
+
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+
|
+
value + |
+String + |
+No + |
+
|
+
DELETE https://{Endpoint}/v5/{project_id}/{resource_type}/{resource_id}/tags/delete +{ + "tags": [{ + "key": "key1", + "value": "value1" + }] +}+
For details, see Status Codes.
+This API is used to query tags of a specified instance.
+For details, see Calling APIs.
+GET /v5/{project_id}/{resource_type}/{resource_id}/tags
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
resource_type + |
+String + |
+Yes + |
+
|
+
resource_id + |
+String + |
+Yes + |
+Indicates a resource ID. + |
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
tags + |
+Array of ResourceTag objects + |
+Specifies the list of resource tags. + |
+
{ + "tags":[ + { + "key":"key1", + "value":"value1" + } + ] +}+
For details, see Status Codes.
+This API is used to query all tags of a specified resource type in a specified project of a tenant.
+For details, see Calling APIs.
+GET /v5/{project_id}/{resource_type}/tags
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID. + |
+
resource_type + |
+String + |
+Yes + |
+
|
+
Returned status code 200: successful query
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
tags + |
+Array of ResourceTag objects + |
+Specifies the list of resource tags. + |
+
{ + "tags":[ + { + "key":"key1", + "values":["value1"] + } + ] +}+
For details, see Status Codes.
+If an error occurs when an API is called, error information is returned. This section describes the error information for VPN APIs (excluding native OpenStack APIs).
+{ + "code": "VPN.0001", + "message": "invalid request:xxx" +}+
Module + |
+Status Code + |
+Error Code + |
+Error Information + |
+Description + |
+Handling Measure + |
+
---|---|---|---|---|---|
Common + |
+400 + |
+VPN.0001 + |
+invalid request:xxx + |
+The input parameter is invalid. + |
+Contact technical support. + |
+
500 + |
+VPN.0002 + |
+server error: xxx + |
+Internal server error. + |
+Contact technical support. + |
+|
403 + |
+VPN.0003 + |
+Authentication failed: xxx + |
+Access denied. + |
+Obtain the required permissions. + |
+|
404 + |
+VPN.0004 + |
+resource not found + |
+Failed to find the resource. + |
+Check whether the resource ID is correct or whether the resource exists under the tenant. + |
+
Permission + |
+API + |
+Action + |
+Dependencies + |
+IAM Project + |
+Enterprise Project + |
+
---|---|---|---|---|---|
Creating a VPN gateway + |
+POST /v5/{project_id}/vpn-gateways + |
+vpn:vpnGateways:create + |
+
|
+√ + |
+√ + |
+
Querying a VPN gateway + |
+GET /v5/{project_id}/vpn-gateways/{vgw_id} + |
+vpn:vpnGateways:get + |
+
|
+√ + |
+√ + |
+
Querying the VPN gateway list + |
+GET /v5/{project_id}/vpn-gateways + |
+vpn:vpnGateways:list + |
+
|
+√ + |
+× + |
+
Updating a VPN gateway + |
+PUT /v5/{project_id}/vpn-gateways/{vgw_id} + |
+vpn:vpnGateways:update + |
+
|
+√ + |
+√ + |
+
Deleting a VPN gateway + |
+DELETE /v5/{project_id}/vpn-gateways/{vgw_id} + |
+vpn:vpnGateways:delete + |
+
|
+√ + |
+√ + |
+
Querying the AZs of VPN gateways + |
+GET /v5/{project_id}/vpn-gateways/availability-zones + |
+vpn:vpnGatewayAvailabilityZone + |
+- + |
+√ + |
+√ + |
+
Permission + |
+API + |
+Action + |
+Dependencies + |
+IAM Project + |
+Enterprise Project + |
+
---|---|---|---|---|---|
Creating a customer gateway + |
+POST /v5/{project_id}/customer-gateways + |
+vpn:customerGateways:create + |
+- + |
+√ + |
+x + |
+
Querying details about a customer gateway + |
+GET /v5/{project_id}/customer-gateways/{customer_gateway_id} + |
+vpn:customerGateways:get + |
+- + |
+√ + |
+x + |
+
Querying the customer gateway list + |
+GET /v5/{project_id}/customer-gateways + |
+vpn:customerGateways:list + |
+- + |
+√ + |
+x + |
+
Updating a customer gateway + |
+PUT /v5/{project_id}/customer-gateways/{customer_gateway_id} + |
+vpn:customerGateways:update + |
+- + |
+√ + |
+x + |
+
Deleting a customer gateway + |
+DELETE /v5/{project_id}/customer-gateways/{customer_gateway_id} + |
+vpn:customerGateways:delete + |
+- + |
+√ + |
+x + |
+
Permission + |
+API + |
+Action + |
+Dependencies + |
+IAM Project + |
+Enterprise Project + |
+
---|---|---|---|---|---|
Creating a VPN connection + |
+POST /v5/{project_id}/vpn-connection + |
+vpn:vpnConnections:create + |
+ces:metricData:list +ces:currentRegionSupportedMetrics:list +vpc:vpcs:list +vpc:vpcs:get +vpc:subnets:get +vpc:subnets:list +vpc:subNetworkInterfaces:update +vpc:publicIps:get +vpc:publicIps:list +vpc:bandwidths:list +vpc:ports:get +vpc:routeTables:update +vpc:routeTables:get + |
+√ + |
+√ + |
+
Querying the VPN connection list + |
+GET /v5/{project_id}/vpn-connection + |
+vpn:vpnConnections:list + |
+vpc:publicIps:get +vpc:publicIps:list +vpc:bandwidths:list +er:instances:list +er:instances:get +vpc:vpcs:list +vpc:vpcs:get +vpc:subnets:get +vpc:subnets:list + |
+√ + |
+× + |
+
Querying details about a VPN connection + |
+GET /v5/{project_id}/vpn-connection/{vpn_connection_id} + |
+vpn:vpnConnections:get + |
+vpc:publicIps:get +vpc:publicIps:list +vpc:bandwidths:list +er:instances:list +er:instances:get +vpc:vpcs:list +vpc:vpcs:get +vpc:subnets:get +vpc:subnets:list + |
+√ + |
+√ + |
+
Updating a VPN connection + |
+PUT /v5/{project_id}/vpn-connection/{vpn_connection_id} + |
+vpn:vpnConnections:update + |
+vpc:vpcs:list +vpc:vpcs:get +vpc:subnets:get +vpc:subnets:list +vpc:subNetworkInterfaces:update +vpc:publicIps:get +vpc:publicIps:list +vpc:bandwidths:list +vpc:ports:get +vpc:routeTables:update +vpc:routeTables:get + |
+√ + |
+√ + |
+
Deleting a VPN connection + |
+DELETE /v5/{project_id}/vpn-connection/{vpn_connection_id} + |
+vpn:vpnConnections:delete + |
+ces:metricData:list +ces:currentRegionSupportedMetrics:list +vpc:vpcs:list +vpc:vpcs:get +vpc:subnets:get +vpc:subNetworkInterfaces:update +vpc:publicIps:get +vpc:publicIps:list +vpc:bandwidths:list +vpc:ports:get +vpc:routeTables:update +vpc:routeTables:get + |
+√ + |
+√ + |
+
Permission + |
+API + |
+Action + |
+Dependencies + |
+IAM Project + |
+Enterprise Project + |
+
---|---|---|---|---|---|
Creating a VPN connection monitor + |
+POST /v5/{project_id}/connection-monitors + |
+vpn:connectionMonitors:create + |
+- + |
+√ + |
+x + |
+
Querying the VPN connection monitor list + |
+GET /v5/{project_id}/connection-monitors + |
+vpn:connectionMonitors:list + |
+- + |
+√ + |
+x + |
+
Deleting a VPN connection monitor + |
+DELETE /v5/{project_id}/connection-monitors/{connection_monitor_id} + |
+vpn:connectionMonitors:delete + |
+- + |
+√ + |
+x + |
+
Querying a VPN connection monitor + |
+GET /v5/{project_id}/connection-monitors/{connection_monitor_id} + |
+vpn:connectionMonitors:get + |
+- + |
+√ + |
+x + |
+
Permission + |
+API + |
+Action + |
+Dependencies + |
+IAM Project + |
+Enterprise Project + |
+
---|---|---|---|---|---|
Querying VPN quotas + |
+GET /v5/{project_id}/vpn/quotas + |
+vpn:quota:list + |
+- + |
+√ + |
+× + |
+
Permission + |
+API + |
+Action + |
+Dependencies + |
+IAM Project + |
+Enterprise Project + |
+
---|---|---|---|---|---|
Creating a resource tag + |
+POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create + |
+vpn:resourceInstanceTags:create + |
+- + |
+√ + |
+x + |
+
Deleting tags of a resource + |
+POST /v5/{project_id}/{resource_type}/{resource_id}/tags/delete + |
+vpn:resourceInstanceTags:delete + |
+- + |
+√ + |
+x + |
+
Querying the list of tags for a specific type of resources + |
+GET /v5/{project_id}/{resource_type}/tags + |
+vpn:resourceTypeTags:list + |
+- + |
+√ + |
+x + |
+
Querying the resource instance list + |
+POST /v5/{project_id}/{resource_type}/resource-instances/filter + |
+vpn:resourceInstances:list + |
+- + |
+√ + |
+x + |
+
Querying the resource tag list + |
+GET /v5/{project_id}/{resource_type}/{resource_id}/tags + |
+vpn:resourceInstanceTags:list + |
+- + |
+√ + |
+x + |
+
Querying the number of resource instances + |
+POST /v5/{project_id}/{resource_type}/resource-instances/count + |
+vpn:resourceInstances:count + |
+- + |
+√ + |
+x + |
+
Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+VPN APIs include both APIs provided by the VPN service and native OpenStack APIs.
+A combination of these two types of APIs allows you to use all functions provided by the VPN service.
+ +Category + |
+Sub-Category + |
+Description + |
+
---|---|---|
Native OpenStack API + |
+IPsec connection management + |
+APIs for creating, querying, modifying, and deleting IPsec connections + |
+
VPN service management + |
+APIs for creating, querying, modifying, and deleting VPN services + |
+|
IPsec policy management + |
+APIs for creating, querying, modifying, and deleting IPsec policies + |
+|
IKE policy management + |
+APIs for creating, querying, modifying, and deleting IKE policies + |
+|
VPN endpoint group management + |
+APIs for creating, querying, modifying, and deleting VPN endpoint groups + |
+|
VPN API + |
+Tag management + |
+APIs for creating, querying, and deleting tags, and querying VPN resources by tags + |
+
The VPN service does not have independent endpoints. When API calls are made to the VPN service, the VPC APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the VPN APIs.
+This API is used to query all available versions of a native OpenStack API.
+GET
+Request parameter
+None
+Example request
+GET https://{Endpoint}/+
Response parameter
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
versions + |
+Array of version objects + |
+Specifies the API version list. For details, see Table 2. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
status + |
+String + |
+Specifies the API version status. Possible values are as follows: +
|
+
id + |
+String + |
+Specifies the API version. + |
+
links + |
+Array of link objects + |
+Specifies the link list. For details, see Table 3. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
href + |
+String + |
+Specifies the API link. + |
+
rel + |
+String + |
+Specifies the relationship between the API link and the API version. + |
+
Example response
+{ + "versions": [ + { + "status": "CURRENT", + "id": "v2.0", + "links": [ + { + "href": "https://None/v2.0", + "rel": "self" + } + ] + } + ] +}+
See Status Codes.
+See Error Codes.
+This API is used to query VPNs by tag.
+Tag Management Service (TMS) filters service resource instances by tag and displays them in a list.
+POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action
+Table 1 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
tags + |
+List<tag> + |
+No + |
+Specifies the list of tags. +
|
+
limit + |
+Integer + |
+No + |
+Specifies the maximum number of resources to be queried. +
|
+
offset + |
+Integer + |
+No + |
+Specifies the index position. The query starts from the next data record indexed by this parameter. +
|
+
action + |
+String + |
+Yes + |
+Specifies the operation identifier. +The identifier can be filter or count. +
|
+
matches + |
+List<match> + |
+No + |
+Specifies the search criteria. The tag key is the field to match. Currently, only resource_name is supported. The tag value indicates the value to be matched. The key field is a fixed dictionary value. + |
+
Name + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +
|
+
values + |
+List<String> + |
+Yes + |
+Specifies the list of tag values. + + |
+
Name + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +The tag key can only be the resource name. + |
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +Each value can contain a maximum of 255 Unicode characters. + |
+
Table 4 describes the response parameters.
+ +Name + |
+Type + |
+Description + |
+
---|---|---|
resources + |
+List<resource> + |
+N/A + |
+
total_count + |
+int + |
+Specifies the total number of records. + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
resource_id + |
+String + |
+Specifies the resource ID. + |
+
resource_detail + |
+Object + |
+Specifies the resource details. +The details are left blank by default. + |
+
tags + |
+List<resource_tag> + |
+Specifies the list of tags. +If there is no tag in the list, tags is taken as an empty array. + |
+
resource_name + |
+String + |
+Specifies the resource name. +If there is no resource name, the parameter is an empty string by default. + |
+
POST /v2.0/{project_id}/ipsec-site-connections/resource_instances/action+
{ + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ] +}+
{ + "action": "count", + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ] +}+
{ + "resources": [ + { + "resource_detail": null, + "resource_id": "cdfs_cefs_wesas_12_dsad", + "resource_name": "resource1", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value1" + } + ] + } + ], + "total_count": 1000 +} ++
{ + "total_count": 1000 +}+
This API is used to batch create or delete VPN tags.
+This API is idempotent.
+POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/action
+In the URI, project_id indicates the project ID, and resource_id indicates the ID of the target resource.
+Table 1 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
tags + |
+List<resource_tag> + |
+Yes + |
+Specifies the list of tags. +Up to 10 keys are supported. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation identifier. +The identifier can be create or delete. + |
+
Name + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +The key +
|
+
value + |
+String + + |
+
|
+Specifies the list of tag values. +The value +
|
+
None
+POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/action+
{ + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key", + "value": "value3" + } + ] +}+
Or
+{ + "action": "delete", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] +}+
For details, see Common Returned Values.
+This API is used to create tags for a VPN.
+POST /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
+In the URI, project_id indicates the project ID, and resource_id indicates the ID of the target resource.
+Table 1 describes the request parameter.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
tag + |
+List<resource_tag> + |
+Yes + |
+Specifies the tag. + |
+
Name + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +The key +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +The value +
|
+
None
+For details, see Common Returned Values.
+This API is used to query tags of a specified VPN.
+GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags
+In the URI, project_id indicates the project ID, and resource_id indicates the ID of the target resource.
+None
+Table 1 describes the response parameter.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
tags + |
+List<resource_tag> + |
+Specifies the list of tags. + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+Specifies the tag key. +The key +
|
+
value + |
+String + |
+Specifies the tag value. +The value +
|
+
GET /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags+
{ + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] +}+
For details, see Common Returned Values.
+This API is used to delete VPN tags.
+DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}
+In the URI, project_id indicates the project ID, resource_id indicates the ID of the target resource, and key indicates the tag key to be deleted.
+None
+None
+DELETE /v2.0/{project_id}/ipsec-site-connections/{resource_id}/tags/{key}+
For details, see Common Returned Values.
+This API is used to query all tags of a VPN in a specified project.
+GET /v2.0/{project_id}/ipsec-site-connections/tags
+In the URI, project_id indicates the project ID.
+None
+Table 1 describes the response parameter.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
tags + |
+List<tag> + |
+Specifies the list of tags. + |
+
Name + |
+Type + |
+Description + |
+
---|---|---|
key + |
+String + |
+Specifies the tag key. +The key +
|
+
values + |
+List<String> + |
+Specifies the list of tag values. +The value +
|
+
GET /v2.0/{project_id}/ipsec-site-connections/tags+
{ + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ] +}+
For details, see Common Returned Values.
+This API is used to create an IPsec VPN connection.
+POST /v2.0/vpn/ipsec-site-connections
+Table 1 lists the request parameters for creating an IPsec site connection.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
psk + |
+String + |
+Yes + |
+Specifies the pre-shared key. +The key +
|
+
initiator + |
+String + |
+No + |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections. +The value can be bi-directional or response-only. + |
+
ipsecpolicy_id + |
+String + |
+Yes + |
+Specifies the IPsec policy ID. + |
+
admin_state_up + |
+Boolean + |
+No + |
+Specifies the administrative status, which can be true or false. +Currently, admin_state_up can only be true. + |
+
mtu + |
+Integer + |
+No + |
+Specifies the maximum transmission unit to address fragmentation. +mtu can only be 1500. + |
+
peer_ep_group_id + |
+String + |
+Yes + |
+Specifies the endpoint group ID (tenant CIDR blocks). + |
+
ikepolicy_id + |
+String + |
+Yes + |
+Specifies the IKE policy ID. + |
+
vpnservice_id + |
+String + |
+Yes + |
+Specifies the VPN service ID. + |
+
local_ep_group_id + |
+String + |
+Yes + |
+Specifies the endpoint group ID (VPC subnets). + |
+
peer_address + |
+String + |
+Yes + |
+Specifies the remote gateway address. +The address can contain up to 250 characters. + |
+
peer_id + |
+String + |
+Yes + |
+Specifies the remote gateway ID. +The ID can contain up to 250 characters. + |
+
name + |
+String + |
+No + |
+Specifies the name of the IPsec VPN connection. +The name can contain 1 to 64 characters. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the IPsec VPN connection. +description can contain a maximum of 255 characters. This parameter has been used by internal components, and you are not allowed to configure the parameter. + |
+
peer_cidrs + |
+List<String> + |
+No + |
+Deprecated parameter +Specifies valid CIDR blocks of a tenant. +The format is <net_address > / < prefix >. + |
+
tenant_id + |
+String + |
+No + |
+Specifies the project ID. +The ID can contain up to 255 characters. + |
+
order_id + |
+String + |
+No + |
+Specifies the ID of a yearly/monthly order. +This parameter is applicable only to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+No + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
dpd + |
+Object + |
+No + |
+Dead Peer Detection (DPD) is used to detect whether the peer is alive. +For details, see Table 2. + |
+
ipsec_site_connection + |
+Object + |
+Yes + |
+Specifies the object of the IPsec VPN connection. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
action + |
+String + |
+Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. + |
+
interval + |
+Integer + |
+Specifies the DPD interval in seconds. The default interval is 30 seconds. + |
+
timeout + |
+Integer + |
+Specifies the DPD timeout. The default timeout is 120 seconds. + |
+
Table 3 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
dpd + |
+Object + |
+DPD is used to detect whether the peer is alive. +For details, see Table 4. + |
+
psk + |
+String + |
+Specifies the pre-shared key. +The key +
|
+
initiator + |
+String + |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections. +The value can be bi-directional or response-only. + |
+
ipsecpolicy_id + |
+String + |
+Specifies the IPsec policy ID. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
mtu + |
+Integer + |
+Specifies the maximum transmission unit to address fragmentation. + |
+
peer_ep_group_id + |
+String + |
+Specifies the endpoint group ID (tenant CIDR blocks). + |
+
ikepolicy_id + |
+String + |
+Specifies the IKE policy ID. + |
+
vpnservice_id + |
+String + |
+Specifies the VPN service ID. + |
+
local_ep_group_id + |
+String + |
+Specifies the endpoint group ID (VPC subnets). + |
+
peer_address + |
+String + |
+Specifies the remote gateway address. + |
+
peer_id + |
+String + |
+Specifies the remote gateway ID. + |
+
name + |
+String + |
+Specifies the name of the IPsec VPN connection. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec VPN connection. + |
+
auth_mode + |
+String + |
+Specifies the authentication mode. The default mode is psk. + |
+
id + |
+String + |
+Specifies the ID of the IPsec VPN connection. + |
+
route_mode + |
+String + |
+Specifies the route advertising mode. The default mode is static. + |
+
status + |
+String + |
+Specifies the status of the IPsec VPN connection, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
peer_cidrs + |
+List + |
+Deprecated parameter +Specifies valid CIDR blocks of a tenant. +The format is <net_address > / < prefix >. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
created_at + |
+String + |
+Specifies the time when the IPsec connection was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. +This parameter is applicable only to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is applicable only to yearly/monthly VPNs. + |
+
ipsec_site_connection + |
+Object + |
+Specifies the object of the IPsec VPN connection. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
action + |
+String + |
+Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. + |
+
interval + |
+Integer + |
+Specifies the DPD interval in seconds. The default interval is 30 seconds. + |
+
timeout + |
+Integer + |
+Specifies the DPD timeout. The default timeout is 120 seconds. + |
+
POST /v2.0/vpn/ipsec-site-connections +{ + "ipsec_site_connection" : { + "psk" : "secret", + "initiator" : "bi-directional", + "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", + "admin_state_up" : true, + "mtu" : 1500, + "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", + "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", + "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", + "peer_address" : "172.24.4.233", + "peer_id" : "172.24.4.233", + "name" : "vpnconnection1" + } +}+
{ + "ipsec_site_connection" : { + "status" : "PENDING_CREATE", + "psk" : "secret", + "initiator" : "bi-directional", + "name" : "vpnconnection1", + "admin_state_up" : true, + "tenant_id" : "10039663455a446d8ba2cbb058b0f578", + "auth_mode" : "psk", + "peer_cidrs" : [ ], + "mtu" : 1500, + "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", + "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", + "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "dpd" : { + "action" : "hold", + "interval" : 30, + "timeout" : 120 + }, + "route_mode" : "static", + "vpnservice_id": "4754261f-f8c5-4799-a365-78b2e682e38a", + "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", + "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", + "peer_address" : "172.24.4.233", + "peer_id" : "172.24.4.233", + "id" : "851f280f-5639-4ea3-81aa-e298525ab74b", + "description" : "", + "order_id": "", + "product_id": "", + "created_at": "2020-08-05 12:39:35.921257" + } +}+
For details, see Common Returned Values.
+This API is used to query details about an IPsec VPN connection.
+GET /v2.0/vpn/ipsec-site-connections/{connection_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
connection_id + |
+String + |
+Yes + |
+Specifies the ID of the IPsec VPN connection. + |
+
None
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
local_ep_group_id + |
+String + |
+Specifies the endpoint group ID (VPC subnets). + |
+
status + |
+String + |
+Specifies the status of the IPsec VPN connection, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
psk + |
+String + |
+Specifies the pre-shared key. +The key +
|
+
initiator + |
+String + |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections. +The value can be bi-directional or response-only. + |
+
name + |
+String + |
+Specifies the name of the IPsec VPN connection. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
ipsecpolicy_id + |
+String + |
+Specifies the IPsec policy ID. + |
+
auth_mode + |
+String + |
+Specifies the authentication mode. The default mode is psk. + |
+
peer_cidrs + |
+List<String> + |
+Deprecated parameter +Specifies valid CIDR blocks of a tenant. +The format is <net_address > / < prefix >. + |
+
mtu + |
+Integer + |
+Specifies the maximum transmission unit to address fragmentation. + |
+
ikepolicy_id + |
+String + |
+Specifies the IKE policy ID. + |
+
peer_address + |
+String + |
+Specifies the remote gateway address. + |
+
id + |
+String + |
+Specifies the ID of the IPsec VPN connection. + |
+
ipsec_site_connection + |
+Object + |
+Specifies the object of the IPsec VPN connection. + |
+
route_mode + |
+String + |
+Specifies the route advertising mode. The default mode is static. + |
+
peer_id + |
+String + |
+Specifies the remote gateway ID. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec VPN connection. + |
+
peer_ep_group_id + |
+String + |
+Specifies the endpoint group ID (tenant CIDR blocks). + |
+
dpd + |
+Object + |
+DPD is used to detect whether the peer is alive. +For details, see Table 3. + |
+
vpnservice_id + |
+String + |
+Specifies the VPN service ID. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
created_at + |
+String + |
+Specifies the time when the IPsec connection was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
tags + |
+List<Object> + |
+Specifies the tags. +
|
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
action + |
+String + |
+Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. + |
+
interval + |
+Integer + |
+Specifies the DPD interval in seconds. The default interval is 30 seconds. + |
+
timeout + |
+Integer + |
+Specifies the DPD timeout. The default timeout is 120 seconds. + |
+
GET /v2.0/vpn/ipsec-site-connections/{connection_id}+
{ + "ipsec_site_connection" : { + "status" : "DOWN", + "psk" : "secret", + "initiator" : "bi-directional", + "name" : "vpnconnection1", + "admin_state_up" : true, + "tenant_id" : "10039663455a446d8ba2cbb058b0f578", + "auth_mode" : "psk", + "peer_cidrs" : [ ], + "mtu" : 1500, + "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", + "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", + "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "dpd" : { + "action" : "hold", + "interval" : 30, + "timeout" : 120 + }, + "route_mode" : "static", + "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", + "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", + "peer_address" : "172.24.4.226", + "peer_id" : "172.24.4.226", + "id" : "851f280f-5639-4ea3-81aa-e298525ab74b", + "description" : "", + "order_id": "", + "product_id": "", + "created_at": "2020-08-05 12:39:35.921257", + "tags": [] + } +}+
For details, see Common Returned Values.
+This API is used to query IPsec VPN connections.
+GET /v2.0/vpn/ipsec-site-connections
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
peer_cidrs + |
+List<String> + |
+Deprecated parameter +Specifies valid CIDR blocks of a tenant. +The format is <net_address > / < prefix >. + |
+
mtu + |
+Integer + |
+Specifies the maximum transmission unit to address fragmentation. + |
+
peer_ep_group_id + |
+String + |
+Specifies the endpoint group ID (tenant CIDR blocks). + |
+
ikepolicy_id + |
+String + |
+Specifies the IKE policy ID. + |
+
dpd + |
+Object + |
+DPD is used to detect whether the peer is alive. +For details, see Table 3. + |
+
route_mode + |
+String + |
+Specifies the route advertising mode. The default mode is static. + |
+
peer_address + |
+String + |
+Specifies the remote gateway address. + |
+
peer_id + |
+String + |
+Specifies the remote gateway ID. + |
+
id + |
+String + |
+Specifies the ID of the IPsec VPN connection. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec VPN connection. + |
+
vpnservice_id + |
+String + |
+Specifies the VPN service ID. + |
+
local_ep_group_id + |
+String + |
+Specifies the endpoint group ID (VPC subnets). + |
+
status + |
+String + |
+Specifies the status of the IPsec VPN connection, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
psk + |
+String + |
+Specifies the pre-shared key. +The key +
|
+
initiator + |
+String + |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections. +The value can be bi-directional or response-only. + |
+
name + |
+String + |
+Specifies the name of the IPsec VPN connection. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
ipsecpolicy_id + |
+String + |
+Specifies the IPsec policy ID. + |
+
auth_mode + |
+String + |
+Specifies the authentication mode. The default mode is psk. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
created_at + |
+String + |
+Specifies the time when the IPsec connection was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
tags + |
+List<Object> + |
+Specifies the tags. +
|
+
ipsec_site_connections + |
+List<Object> + |
+Specifies the VPN connection list. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
action + |
+String + |
+Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. + |
+
interval + |
+Integer + |
+Specifies the DPD interval in seconds. The default interval is 30 seconds. + |
+
timeout + |
+Integer + |
+Specifies the DPD timeout. The default timeout is 120 seconds. + |
+
GET /v2.0/vpn/ipsec-site-connections+
{ + "ipsec_site_connections" : [ { + "status" : "PENDING CREATE", + "psk" : "secret", + "initiator" : "bi-directional", + "name" : "vpnconnection1", + "admin_state_up" : true, + "tenant_id" : "10039663455a446d8ba2cbb058b0f578", + "auth_mode" : "psk", + "peer_cidrs" : [ ], + "mtu" : 1500, + "peer_ep_group_id" : "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", + "ikepolicy_id" : "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", + "vpnservice_id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "dpd" : { + "action" : "hold", + "interval" : 30, + "timeout" : 120 + }, + "route_mode" : "static", + "ipsecpolicy_id" : "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", + "local_ep_group_id" : "3e1815dd-e212-43d0-8f13-b494fa553e68", + "peer_address" : "172.24.4.226", + "peer_id" : "172.24.4.226", + "id" : "851f280f-5639-4ea3-81aa-e298525ab74b", + "description" : "", + "order_id": "", + "product_id": "", + "created_at": "2020-08-05 12:39:35.921257", + "tags": [] + } ] +}+
For details, see Common Returned Values.
+This API is used to update an IPsec VPN connection.
+PUT /v2.0/vpn/ipsec-site-connections/{connection_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
connection_id + |
+String + |
+Yes + |
+Specifies the ID of the IPsec VPN connection. + |
+
Table 2 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ipsec_site_connection + |
+Object + |
+Yes + |
+Specifies the object of the IPsec VPN connection. + |
+
psk + |
+String + |
+No + |
+Specifies the pre-shared key. +The key +
|
+
initiator + |
+String + |
+No + |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections. +The value can be bi-directional or response-only. + |
+
description + |
+String + |
+No + |
+Specifies the IPsec policy ID. +description can contain a maximum of 255 characters. This parameter has been used by internal components, and you are not allowed to configure the parameter. + |
+
admin_state_up + |
+Boolean + |
+No + |
+Specifies the administrative status, which can be true or false. +Currently, admin_state_up can only be true. + |
+
peer_cidrs + |
+List<String> + |
+No + |
+Deprecated parameter +Specifies valid CIDR blocks of a tenant. +The format is <net_address > / < prefix >. + |
+
mtu + |
+Integer + |
+No + |
+Specifies the maximum transmission unit to address fragmentation. +mtu can only be 1500. + |
+
peer_ep_group_id + |
+String + |
+No + |
+Specifies the endpoint group ID (tenant CIDR blocks). + |
+
local_ep_group_id + |
+String + |
+No + |
+Specifies the endpoint group ID (VPC subnets). + |
+
peer_address + |
+String + |
+No + |
+Specifies the remote gateway address. +The address can contain up to 250 characters. + |
+
peer_id + |
+String + |
+No + |
+Specifies the remote gateway ID. +The ID can contain up to 250 characters. + |
+
name + |
+String + |
+No + |
+Specifies the name of the IPsec VPN connection. +The name can contain 1 to 64 characters. + |
+
dpd + |
+Object + |
+No + |
+DPD is used to detect whether the peer is alive. +For details, see Table 3. + |
+
order_id + |
+String + |
+No + |
+Specifies the ID of a yearly/monthly order. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+No + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
action + |
+String + |
+Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. + |
+
interval + |
+Integer + |
+Specifies the DPD interval in seconds. The default interval is 30 seconds. + |
+
timeout + |
+Integer + |
+Specifies the DPD timeout. The default timeout is 120 seconds. + |
+
Table 4 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
status + |
+String + |
+Specifies the status of the IPsec VPN connection, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
psk + |
+String + |
+Specifies the pre-shared key. +The key +
|
+
initiator + |
+String + |
+Specifies whether this VPN can only respond to connections or both respond to and initiate connections. + |
+
name + |
+String + |
+Specifies the name of the IPsec VPN connection. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
ipsecpolicy_id + |
+String + |
+Specifies the IPsec policy ID. + |
+
auth_mode + |
+String + |
+Specifies the authentication mode. The default mode is psk. + |
+
peer_cidrs + |
+String + |
+Deprecated parameter +Specifies valid CIDR blocks of a tenant. +The format is <net_address > / < prefix >. + |
+
mtu + |
+Integer + |
+Specifies the maximum transmission unit to address fragmentation. + |
+
peer_ep_group_id + |
+String + |
+Specifies the endpoint group ID (tenant CIDR blocks). + |
+
ikepolicy_id + |
+String + |
+Specifies the IKE policy ID. + |
+
dpd + |
+Object + |
+DPD is used to detect whether the peer is alive. +For details, see Table 5. + |
+
route_mode + |
+String + |
+Specifies the route advertising mode. The default mode is static. + |
+
vpnservice_id + |
+String + |
+Specifies the VPN service ID. + |
+
local_ep_group_id + |
+String + |
+Specifies the endpoint group ID (VPC subnets). + |
+
peer_address + |
+String + |
+Specifies the remote gateway address. + |
+
peer_id + |
+String + |
+Specifies the remote gateway ID. + |
+
id + |
+String + |
+Specifies the ID of the IPsec VPN connection. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec VPN connection. + |
+
ipsec_site_connection + |
+Object + |
+Specifies the object of the IPsec VPN connection. + |
+
project_id + |
+String + |
+Specifies the project ID. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
created_at + |
+String + |
+Specifies the time when the IPsec connection was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
Parameter + |
+Type + |
+Description + |
+
---|---|---|
action + |
+String + |
+Specifies the DPD action, which can be clear, hold, restart, disabled, or restart-by-peer. The default action is hold. + |
+
interval + |
+Integer + |
+Specifies the DPD interval in seconds. The default interval is 30 seconds. + |
+
timeout + |
+Integer + |
+Specifies the DPD timeout. The default timeout is 120 seconds. + |
+
PUT /v2.0/vpn/ipsec-site-connections/{connection_id} +{ + "ipsec_site_connection" : { + "mtu" : 1200, + } +}+
{ + "ipsec_site_connection": { + "status": "DOWN", + "psk": "secret", + "initiator": "bi-directional", + "name": "vpnconnection1", + "admin_state_up": true, + "tenant_id": "10039663455a446d8ba2cbb058b0f578", + "auth_mode": "psk", + "peer_cidrs": [], + "mtu": 1200, + "peer_ep_group_id": "9ad5a7e0-6dac-41b4-b20d-a7b8645fddf1", + "ikepolicy_id": "9b00d6b0-6c93-4ca5-9747-b8ade7bb514f", + "vpnservice_id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "dpd": { + "action": "hold", + "interval": 30, + "timeout": 120 + }, + "route_mode": "static", + "ipsecpolicy_id": "e6e23d0c-9519-4d52-8ea4-5b1f96d857b1", + "local_ep_group_id": "3e1815dd-e212-43d0-8f13-b494fa553e68", + "peer_address": "172.24.4.233", + "peer_id": "172.24.4.233", + "id": "851f280f-5639-4ea3-81aa-e298525ab74b", + "description": "New description", + "order_id": "", + "product_id": "", + "created_at": "2020-08-05 12:39:35.921257" + } +}+
For details, see Common Returned Values.
+This interface is used to delete an IPsec VPN connection.
+DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
connection_id + |
+String + |
+Yes + |
+Specifies the IPsec VPN connection ID. + |
+
None
+None
+DELETE /v2.0/vpn/ipsec-site-connections/{connection_id}+
For details, see section Common Returned Values.
+This API is used to create a VPN service.
+Only one VPN service can be created for each VPC.
+POST /v2.0/vpn/vpnservices
+Table 1 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
subnet_id + |
+String + |
+No + |
+Specifies the subnet ID. +The subnet here is the VPC subnet. Query the subnet and enter the correct ID. + |
+
router_id + |
+String + |
+Yes + |
+Specifies the router ID. +The value of router_id must be the VPC router ID. + |
+
name + |
+String + |
+No + |
+Specifies the VPN service name. +The name can contain 1 to 64 characters. + |
+
admin_state_up + |
+Boolean + |
+No + |
+Specifies the administrative status, which can be true or false. +Currently, admin_state_up can only be true. + |
+
tenant_id + |
+String + |
+No + |
+Specifies the project ID. +The ID can contain up to 255 characters. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the VPN service. +The description can contain up to 255 characters. + |
+
order_id + |
+String + |
+No + |
+Specifies the ID of a yearly/monthly order. +The ID can contain up to 255 characters. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+No + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +The ID can contain up to 255 characters. +This parameter is only available to yearly/monthly VPNs. + |
+
prepay_connection_num + |
+Integer + |
+No + |
+Specifies the number of connections of the yearly/monthly VPN service. +This parameter is only available to yearly/monthly VPNs. + |
+
resource_speccode + |
+String + |
+No + |
+Specifies the specifications of the product that is billed on a yearly/monthly basis. +The specifications can contain up to 255 characters. +This parameter is only available to yearly/monthly VPNs. + |
+
external_v4_ip + |
+String + |
+No + |
+Specifies the IPv4 address of the VPN service external gateway. +The address can contain up to 255 characters. + NOTE:
+When you configure this parameter, ensure that the tenant meets one of the following conditions: +
|
+
vpnservice + |
+Object + |
+Yes + |
+Specifies the VPN service object. + |
+
Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
router_id + |
+String + |
+Specifies the router ID. + |
+
status + |
+String + |
+Specifies whether the VPN service is operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
name + |
+String + |
+Specifies the VPN service name. + |
+
external_v6_ip + |
+String + |
+Specifies the IPv6 address of the VPN service external gateway. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
subnet_id + |
+String + |
+Specifies the subnet ID. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
external_v4_ip + |
+String + |
+Specifies the IPv4 address of the VPN service external gateway. + |
+
id + |
+String + |
+Specifies the VPN service ID. + |
+
description + |
+String + |
+Provides supplementary information about the VPN service. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. + |
+
prepay_connection_num + |
+Integer + |
+Specifies the number of connections of the yearly/monthly VPN service. + |
+
resource_speccode + |
+String + |
+Specifies the specifications of the product that is billed on a yearly/monthly basis. + |
+
created_at + |
+String + |
+Specifies the time when the VPN service was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
vpnservice + |
+Object + |
+Specifies the VPN service object. + |
+
POST /v2.0/vpn/vpnservices +{ + "vpnservice": { + "subnet_id": null, + "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", + "name": "myservice", + "admin_state_up": true + } +}+
{ + "vpnservice" : { + "router_id" : "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", + "status" : "PENDING_CREATE", + "name" : "myservice", + "external_v6_ip" : "2001:db8::1", + "admin_state_up" : true, + "subnet_id" : null, + "tenant_id" : "10039663455a446d8ba2cbb058b0f578", + "external_v4_ip" : "172.32.1.11", + "id" : "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "description" : "", + "prepay_connection_num": 0, + "resource_speccode": "", + "order_id": "", + "product_id": "", + "created_at": "2020-08-05 12:36:35.921257" + } +}+
For details, see Common Returned Values.
+This API is used to query details about a VPN service.
+GET /v2.0/vpn/vpnservices/{service_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
service_id + |
+String + |
+Yes + |
+Specifies the VPN service ID. + |
+
None
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
status + |
+String + |
+Specifies whether the VPN service is operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
router_id + |
+String + |
+Specifies the router ID. + |
+
name + |
+String + |
+Specifies the VPN service name. + |
+
external_v6_ip + |
+String + |
+Specifies the IPv6 address of the VPN service external gateway. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
subnet_id + |
+String + |
+Specifies the subnet ID. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
external_v4_ip + |
+String + |
+Specifies the IPv4 address of the VPN service external gateway. + |
+
id + |
+String + |
+Specifies the VPN service ID. + |
+
description + |
+String + |
+Provides supplementary information about the VPN service. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
prepay_connection_num + |
+Integer + |
+Specifies the number of connections of the yearly/monthly VPN service. +This parameter is only available to yearly/monthly VPNs. + |
+
resource_speccode + |
+String + |
+Specifies the specifications of the product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
created_at + |
+String + |
+Specifies the time when the VPN service was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
tags + |
+List<Object> + |
+Specifies the tags. + |
+
vpnservice + |
+Object + |
+Specifies the VPN service object. + |
+
GET /v2.0/vpn/vpnservices/{service_id}+
{ + "vpnservice": { + "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", + "status": "PENDING_CREATE", + "name": "myservice", + "external_v6_ip": "2001:db8::1", + "admin_state_up": true, + "subnet_id": null, + "tenant_id": "10039663455a446d8ba2cbb058b0f578", + "external_v4_ip": "172.32.1.11", + "id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "description": "", + "product_id": "", + "order_id": "", + "created_at": "2020-08-05 12:36:35.921257", + "prepay_connection_num": 0, + "tags": [], + "resource_speccode": "" + } +}+
For details, see Common Returned Values.
+This API is used to query VPN services.
+GET /v2.0/vpn/vpnservices
+Table 1 describes the request parameter.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
fields + |
+String + |
+No + |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
vpnservices + |
+List<Object> + |
+Specifies the VPN service list. + |
+
status + |
+String + |
+Specifies whether the VPN service is operational. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. + |
+
router_id + |
+String + |
+Specifies the router ID. + |
+
name + |
+String + |
+Specifies the VPN service name. + |
+
external_v6_ip + |
+String + |
+Specifies the IPv6 address of the VPN service external gateway. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
subnet_id + |
+String + |
+Specifies the subnet ID. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
external_v4_ip + |
+String + |
+Specifies the IPv4 address of the VPN service external gateway. + |
+
id + |
+String + |
+Specifies the VPN service ID. + |
+
description + |
+String + |
+Provides supplementary information about the VPN service. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
prepay_connection_num + |
+Integer + |
+Specifies the number of connections of the yearly/monthly VPN service. +This parameter is only available to yearly/monthly VPNs. + |
+
resource_speccode + |
+String + |
+Specifies the specifications of the product that is billed on a yearly/monthly basis. +This parameter is only available to yearly/monthly VPNs. + |
+
created_at + |
+String + |
+Specifies the time when the VPN service was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
tags + |
+List<Object> + |
+Specifies the tags. + |
+
GET /v2.0/vpn/vpnservices+
{ + "vpnservices": [ + { + "router_id": "66e3b16c-8ce5-40fb-bb49-ab6d8dc3f2aa", + "status": "PENDING_CREATE", + "name": "myservice", + "external_v6_ip": "2001:db8::1", + "admin_state_up": true, + "subnet_id": null, + "tenant_id": "10039663455a446d8ba2cbb058b0f578", + "external_v4_ip": "172.32.1.11", + "id": "5c561d9d-eaea-45f6-ae3e-08d1a7080828", + "description": "", + "product_id": "", + "order_id": "", + "created_at": "2020-08-05 12:36:35.921257", + "prepay_connection_num": 0, + "tags": [], + "resource_speccode": "" + } + ] +}+
For details, see Common Returned Values.
+This API is used to update a VPN service.
+PUT /v2.0/vpn/vpnservices/{service_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
service_id + |
+String + |
+Yes + |
+Specifies the VPN service ID. + |
+
Table 2 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
description + |
+String + |
+No + |
+Provides supplementary information about the VPN service. +The description can contain up to 255 characters. + |
+
name + |
+String + |
+No + |
+Specifies the VPN service name. +The name can contain 1 to 64 characters. + |
+
admin_state_up + |
+Boolean + |
+No + |
+Specifies the administrative status, which can be true or false. +Currently, admin_state_up can only be true. + |
+
order_id + |
+String + |
+No + |
+Specifies the ID of a yearly/monthly order. +The ID can contain up to 255 characters. +This parameter is only available to yearly/monthly VPNs. + |
+
product_id + |
+String + |
+No + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. +The ID can contain up to 255 characters. +This parameter is only available to yearly/monthly VPNs. + |
+
prepay_connection_num + |
+Integer + |
+No + |
+Specifies the number of connections of the yearly/monthly VPN service. +This parameter is only available to yearly/monthly VPNs. + |
+
resource_speccode + |
+String + |
+No + |
+Specifies the specifications of the product that is billed on a yearly/monthly basis. +The specifications can contain up to 255 characters. +This parameter is only available to yearly/monthly VPNs. + |
+
vpnservice + |
+Object + |
+Yes + |
+Specifies the VPN service object. + |
+
Parameter project_id is not supported.
+Table 3 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
id + |
+String + |
+Specifies the VPN service ID. + |
+
router_id + |
+String + |
+Specifies the router ID. + |
+
status + |
+String + |
+Specifies the VPN service status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_UPDATE, or PENDING_DELETE. + |
+
name + |
+String + |
+Specifies the VPN service name. + |
+
external_v6_ip + |
+String + |
+Specifies the IPv6 address of the VPN service external gateway. + |
+
admin_state_up + |
+Boolean + |
+Specifies the administrative status, which can be true or false. + |
+
subnet_id + |
+String + |
+Specifies the subnet ID. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
external_v4_ip + |
+String + |
+Specifies the IPv4 address of the VPN service external gateway. + |
+
description + |
+String + |
+Provides supplementary information about the VPN service. + |
+
order_id + |
+String + |
+Specifies the ID of a yearly/monthly order. + |
+
product_id + |
+String + |
+Specifies the ID of a product that is billed on a yearly/monthly basis. + |
+
prepay_connection_num + |
+Integer + |
+Specifies the number of connections of the yearly/monthly VPN service. + |
+
resource_speccode + |
+String + |
+Specifies the specifications of the product that is billed on a yearly/monthly basis. + |
+
created_at + |
+String + |
+Specifies the time when the VPN service was created. +The time is in YYYY-mm-dd HH:MM:SS.ffffff format. + |
+
vpnservice + |
+Object + |
+Specifies the VPN service object. + |
+
PUT /v2.0/vpn/vpnservices/{service_id} +{ + "vpnservice" : { + "description" : "Updated description" + } +}+
{ + "vpnservice": { + "router_id": "881b7b30-4efb-407e-a162-5630a7af3595", + "status": "ACTIVE", + "name": "myvpn", + "admin_state_up": true, + "subnet_id": null, + "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f", + "id": "41bfef97-af4e-4f6b-a5d3-4678859d2485", + "description": "Updated description", + "order_id": "", + "product_id": "", + "prepay_connection_num": 0, + "resource_speccode": "", + "created_at": "2020-08-05 12:36:35.921257" + } +}+
For details, see Common Returned Values.
+This interface is used to delete a VPN service.
+This interface cannot be used to delete a VPN service in the active-active VPN scenarios.
+DELETE /v2.0/vpn/vpnservices/{service_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
service_id + |
+String + |
+Yes + |
+Specifies the VPN service ID. + |
+
None
+None
+DELETE v2.0/vpn/vpnservices/{service_id}+
For details, see section Common Returned Values.
+This API is used to create an IPsec policy.
+POST /v2.0/vpn/ipsecpolicies
+Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+Specifies the IPsec policy name. +The name can contain 1 to 64 characters. + |
+
pfs + |
+String + |
+No + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. +disable indicates that PFS is disabled. + |
+
auth_algorithm + |
+String + |
+No + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the IPsec policy. +The description can contain up to 255 characters. + |
+
encapsulation_mode + |
+String + |
+No + |
+Specifies the encapsulation mode, which is tunnel by default. + |
+
encryption_algorithm + |
+String + |
+No + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
ipsecpolicy + |
+Object + |
+Yes + |
+Specifies the IPsec policy object. + |
+
lifetime + |
+Object + |
+No + |
+Specifies the lifetime object of SA. + |
+
tenant_id + |
+String + |
+No + |
+Specifies the project ID. +The ID can contain up to 255 characters. + |
+
transform_protocol + |
+String + |
+No + |
+Specifies the transform protocol used, which can be esp, ah, or ah-esp. The default protocol is esp. + |
+
value + |
+Integer + |
+No + |
+Specifies the lifetime value of the SA. The default unit is seconds. The default value is 3600. +Supported range: 60 to 604800 + |
+
units + |
+String + |
+No + |
+Specifies the lifecycle unit. The default unit is seconds. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec policy. + |
+
encapsulation_mode + |
+String + |
+Specifies the encapsulation mode. The default mode is tunnel. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
id + |
+String + |
+Specifies the IPsec policy ID. + |
+
ipsecpolicy + |
+Object + |
+Specifies the IPsec policy object. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+Specifies the IPsec policy name. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. +disable indicates that PFS is disabled. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
transform_protocol + |
+String + |
+Specifies the transform protocol used, which can be esp, ah, or ah-esp. The default protocol is esp. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
POST /v2.0/vpn/ipsecpolicies +{ + "ipsecpolicy" : { + "name" : "ipsecpolicy1", + "transform_protocol" : "esp", + "auth_algorithm" : "sha1", + "encapsulation_mode" : "tunnel", + "encryption_algorithm" : "aes-128", + "pfs" : "group5", + "lifetime" : { + "units" : "seconds", + "value" : 7200 + } + } +}+
{ + "ipsecpolicy" : { + "name" : "ipsecpolicy1", + "transform_protocol" : "esp", + "auth_algorithm" : "sha1", + "encapsulation_mode" : "tunnel", + "encryption_algorithm" : "aes-128", + "pfs" : "group5", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "lifetime" : { + "units" : "seconds", + "value" : 7200 + }, + "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c", + "description" : "" + } +}+
For details, see Common Returned Values.
+This API is used to query details about an IPsec policy.
+GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ipsecpolicy_id + |
+String + |
+Yes + |
+Specifies the IPsec policy ID. + |
+
Parameter project_id is not supported.
+None
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
name + |
+String + |
+Specifies the IPsec policy name. + |
+
encapsulation_mode + |
+String + |
+Specifies the encapsulation mode. The default mode is tunnel. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. +disable indicates that PFS is disabled. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
transform_protocol + |
+String + |
+Specifies the transform protocol used, which can be esp, ah, or ah-esp. The default protocol is esp. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
id + |
+String + |
+Specifies the IPsec policy ID. + |
+
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec policy. + |
+
ipsecpolicy + |
+Object + |
+Specifies the IPsec policy object. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
GET /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}+
{ + "ipsecpolicy" : { + "name" : "ipsecpolicy1", + "transform_protocol" : "esp", + "auth_algorithm" : "sha1", + "encapsulation_mode" : "tunnel", + "encryption_algorithm" : "aes-128", + "pfs" : "group14", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "lifetime" : { + "units" : "seconds", + "value" : 3600 + }, + "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c", + "description" : "" + } +}+
For details, see Common Returned Values.
+This API is used to query IPsec policies.
+GET /v2.0/vpn/ipsecpolicies
+Table 1 describes the request parameter.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
fields + |
+String + |
+No + |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
transform_protocol + |
+String + |
+Specifies the transform protocol used, which can be esp, ah, or ah-esp. The default protocol is esp. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
id + |
+String + |
+Specifies the IPsec policy ID. + |
+
encapsulation_mode + |
+String + |
+Specifies the encapsulation mode. The default mode is tunnel. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. +disable indicates that PFS is disabled. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+Specifies the IPsec policy name. + |
+
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec policy. + |
+
ipsecpolicies + |
+List<Object> + |
+Specifies the IPsec policy list. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
GET /v2.0/vpn/ipsecpolicies+
{ + "ipsecpolicies" : [ { + "name" : "ipsecpolicy1", + "transform_protocol" : "esp", + "auth_algorithm" : "sha1", + "encapsulation_mode" : "tunnel", + "encryption_algorithm" : "aes-128", + "pfs" : "group14", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "lifetime" : { + "units" : "seconds", + "value" : 3600 + }, + "id" : "5291b189-fd84-46e5-84bd-78f40c05d69c", + "description" : "" + } ] +}+
For details, see Common Returned Values.
+This API is used to update an IPsec policy.
+If the IPsec policy is updated, the IPsec VPN connection also needs to be updated.
+PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ipsecpolicy_id + |
+String + |
+Yes + |
+Specifies the IPsec policy ID. + |
+
Table 2 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ipsecpolicy + |
+Object + |
+Yes + |
+Specifies the IPsec policy object. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the IPsec policy. +The description can contain a maximum of 255 characters. + |
+
transform_protocol + |
+String + |
+No + |
+Specifies the transform protocol used, which can be esp, ah, or ah-esp. The default protocol is esp. + |
+
auth_algorithm + |
+String + |
+No + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
encapsulation_mode + |
+String + |
+No + |
+Specifies the encapsulation mode. The default mode is tunnel. + |
+
encryption_algorithm + |
+String + |
+No + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
pfs + |
+String + |
+No + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. +disable indicates that PFS is disabled. + |
+
value + |
+Integer + |
+No + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. +Supported range: 60 to 604800 + |
+
units + |
+String + |
+No + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
lifetime + |
+Object + |
+No + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+No + |
+Specifies the IPsec policy name. +The name can contain 1 to 64 characters. + |
+
Parameter project_id is not supported.
+Table 3 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. +disable indicates that PFS is disabled. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+Specifies the IPsec policy name. + |
+
transform_protocol + |
+String + |
+Specifies the transform protocol used, which can be esp, ah, or ah-esp. The default protocol is esp. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
id + |
+String + |
+Specifies the IPsec policy ID. + |
+
encapsulation_mode + |
+String + |
+Specifies the encapsulation mode. The default mode is tunnel. + |
+
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+Provides supplementary information about the IPsec policy. + |
+
ipsecpolicy + |
+Object + |
+Specifies the IPsec policy object. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
PUT /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id} +{ + "ipsecpolicy" : { + "pfs" : "group14" + } +}+
{ + "ipsecpolicy": { + "name": "ipsecpolicy1", + "transform_protocol": "esp", + "auth_algorithm": "sha1", + "encapsulation_mode": "tunnel", + "encryption_algorithm": "aes-128", + "pfs": "group14", + "tenant_id": "ccb81365fe36411a9011e90491fe1330", + "lifetime": { + "units": "seconds", + "value": 3600 + }, + "id": "5291b189-fd84-46e5-84bd-78f40c05d69c", + "description": "" + } +}+
For details, see Common Returned Values.
+This interface is used to delete an IPsec policy.
+DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ipsecpolicy_id + |
+String + |
+Yes + |
+Specifies the IPsec policy ID. + |
+
None
+None
+DELETE /v2.0/vpn/ipsecpolicies/{ipsecpolicy_id}+
For details, see section Common Returned Values.
+This API is used to create an IKE policy.
+POST /v2.0/vpn/ikepolicies
+Table 1 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
name + |
+String + |
+No + |
+Specifies the IKE policy name. +The name can contain 1 to 64 characters. + |
+
auth_algorithm + |
+String + |
+No + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the IKE policy. +The description can contain up to 255 characters. + |
+
encryption_algorithm + |
+String + |
+No + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default value is aes-128. + |
+
ike_version + |
+String + |
+No + |
+Specifies the IKE version, which can be v1 or v2. The default version is v1. + |
+
lifetime + |
+Object + |
+No + |
+Specifies the lifetime object of SA. + |
+
pfs + |
+String + |
+No + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. + |
+
phase1_negotiation_mode + |
+String + |
+No + |
+Specifies the IKE mode, which is main by default. + |
+
tenant_id + |
+String + |
+No + |
+Specifies the project ID. +The ID can contain up to 255 characters. + |
+
value + |
+String + |
+No + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. +Supported range: 60 to 604800 + |
+
units + |
+String + |
+No + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
ikepolicy + |
+Object + |
+Yes + |
+Specifies the IKE policy object. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+Provides supplementary information about the IKE policy. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+Specifies the IKE policy name. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. + |
+
phase1_negotiation_mode + |
+String + |
+Specifies the IKE mode, which is main by default. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
ikepolicy + |
+Object + |
+Specifies the IKE policy object. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
id + |
+String + |
+Specifies the IKE policy ID. + |
+
ike_version + |
+String + |
+Specifies the IKE version, which can be v1 or v2. The default version is v1. + |
+
POST /v2.0/vpn/ikepolicies +{ + "ikepolicy" : { + "phase1_negotiation_mode" : "main", + "auth_algorithm" : "sha1", + "encryption_algorithm" : "aes-128", + "pfs" : "group5", + "lifetime" : { + "units" : "seconds", + "value" : 7200 + }, + "ike_version" : "v1", + "name" : "ikepolicy1" + } +}+
{ + "ikepolicy" : { + "name" : "ikepolicy1", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "auth_algorithm" : "sha1", + "encryption_algorithm" : "aes-128", + "pfs" : "group5", + "phase1_negotiation_mode" : "main", + "lifetime" : { + "units" : "seconds", + "value" : 7200 + }, + "ike_version" : "v1", + "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", + "description" : "" + } +}+
For details, see Common Returned Values.
+This API is used to query details about an IKE policy.
+GET /v2.0/vpn/ikepolicies/{ikepolicy_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ikepolicy_id + |
+String + |
+Yes + |
+Specifies the IKE policy ID. + |
+
None
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
ikepolicy + |
+Object + |
+Specifies the IKE policy object. + |
+
description + |
+String + |
+Provides supplementary information about the IKE policy. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
name + |
+String + |
+Specifies the IKE policy name. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
phase1_negotiation_mode + |
+String + |
+Specifies the IKE mode, which is main by default. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
id + |
+String + |
+Specifies the IKE policy ID. + |
+
ike_version + |
+String + |
+Specifies the IKE version, which can be v1 or v2. The default value is v1. + |
+
GET /v2.0/vpn/ikepolicies/{ikepolicy_id}+
{ + "ikepolicy" : { + "name" : "ikepolicy1", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "auth_algorithm" : "sha1", + "encryption_algorithm" : "aes-256", + "pfs" : "group5", + "phase1_negotiation_mode" : "main", + "lifetime" : { + "units" : "seconds", + "value" : 3600 + }, + "ike_version" : "v1", + "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", + "description" : "" + } +}+
For details, see Common Returned Values.
+This API is used to query IKE policies.
+GET /v2.0/vpn/ikepolicies
+Table 1 describes the request parameter.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
fields + |
+String + |
+No + |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
ikepolicies + |
+List<Object> + |
+Specifies the IKE policy list. + |
+
description + |
+String + |
+Provides supplementary information about the IKE policy. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
name + |
+String + |
+Specifies the IKE policy name. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
phase1_negotiation_mode + |
+String + |
+Specifies the IKE mode, which is main by default. + |
+
units + |
+String + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
id + |
+String + |
+Specifies the IKE policy ID. + |
+
ike_version + |
+String + |
+Specifies the IKE version, which can be v1 or v2. The default value is v1. + |
+
GET /v2.0/vpn/ikepolicies+
{ + "ikepolicies" : [ { + "name" : "ikepolicy1", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "auth_algorithm" : "sha1", + "encryption_algorithm" : "aes-256", + "pfs" : "group5", + "phase1_negotiation_mode" : "main", + "lifetime" : { + "units" : "seconds", + "value" : 3600 + }, + "ike_version" : "v1", + "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", + "description" : "" + } ] +}+
For details, see Common Returned Values.
+This API is used to update an IKE policy.
+If the IKE policy is updated, the IPsec VPN connection also needs to be updated.
+PUT /v2.0/vpn/ikepolicies/{ikepolicy_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ikepolicy_id + |
+String + |
+Yes + |
+Specifies the IKE policy ID. + |
+
Table 2 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
auth_algorithm + |
+String + |
+No + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the IKE policy. +The description can contain up to 255 characters. + |
+
encryption_algorithm + |
+String + |
+No + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
ike_version + |
+String + |
+No + |
+Specifies the IKE version, which can be v1 or v2. The default version is v1. + |
+
ikepolicy + |
+Object + |
+Yes + |
+Specifies the IKE policy object. + |
+
lifetime + |
+Object + |
+No + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+No + |
+Specifies the IKE policy name. +The name can contain 1 to 64 characters. + |
+
pfs + |
+String + |
+No + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. + |
+
phase1_negotiation_mode + |
+String + |
+No + |
+Specifies the IKE mode, which is main by default. + |
+
value + |
+Integer + |
+No + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. +Supported range: 60 to 604800 + |
+
units + |
+String + |
+No + |
+Specifies the lifecycle unit, which is seconds by default. + |
+
Table 3 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
auth_algorithm + |
+String + |
+Specifies the authentication hash algorithm, which can be md5, sha1, sha2-256, sha2-384, or sha2-512. + |
+
description + |
+String + |
+Provides supplementary information about the IKE policy. + |
+
encryption_algorithm + |
+String + |
+Specifies the encryption algorithm, which can be 3des, aes-128, aes-192, or aes-256. The default algorithm is aes-128. + |
+
id + |
+String + |
+Specifies the IKE policy ID. + |
+
ike_version + |
+String + |
+Specifies the IKE version, which can be v1 or v2. The default version is v1. + |
+
lifetime + |
+Object + |
+Specifies the lifetime object of SA. + |
+
name + |
+String + |
+Specifies the IKE policy name. + |
+
pfs + |
+String + |
+Specifies the PFS, which can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. +The default PFS is group5. + |
+
phase1_negotiation_mode + |
+String + |
+Specifies the IKE mode, which is main by default. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
ikepolicy + |
+Object + |
+Specifies the IKE policy object. + |
+
value + |
+Integer + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
units + |
+String + |
+Specifies the lifetime value of the SA, which is 3600 by default. The default unit is seconds. + |
+
{ + "ikepolicy" : { + "encryption_algorithm" : "aes-256" + } +}+
{ + "ikepolicy" : { + "name" : "ikepolicy1", + "tenant_id" : "ccb81365fe36411a9011e90491fe1330", + "auth_algorithm" : "sha1", + "encryption_algorithm" : "aes-256", + "pfs" : "group5", + "phase1_negotiation_mode" : "main", + "lifetime" : { + "units" : "seconds", + "value" : 3600 + }, + "ike_version" : "v1", + "id" : "5522aff7-1b3c-48dd-9c3c-b50f016b73db", + "description" : "" + } +}+
For details, see Common Returned Values.
+This interface is used to delete an IKE policy.
+DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
ikepolicy_id + |
+String + |
+Yes + |
+Specifies the IKE policy ID. + |
+
None
+None
+DELETE /v2.0/vpn/ikepolicies/{ikepolicy_id}+
For details, see section Common Returned Values.
+This API is used to create a VPN endpoint group.
+POST /v2.0/vpn/endpoint-groups
+Table 1 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
endpoints + |
+List<String> + |
+Yes + |
+Specifies the endpoint list. The endpoints in a list must be of the same type. + |
+
type + |
+String + |
+Yes + |
+Specifies the endpoint type, which can be subnet or cidr. + |
+
name + |
+String + |
+No + |
+Specifies the name of the VPN endpoint group. +The name can contain 1 to 64 characters. + |
+
tenant_id + |
+String + |
+No + |
+Specifies the project ID. +The ID can contain up to 255 characters. + |
+
description + |
+String + |
+No + |
+Provides supplementary information about the VPN endpoint group. +The description can contain up to 255 characters. + |
+
endpoint_group + |
+Object + |
+Yes + |
+Specifies the endpoint group. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
description + |
+String + |
+Provides supplementary information about the VPN endpoint group. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
endpoints + |
+List<String> + |
+Specifies the endpoint list. The endpoints in a list must be of the same type. + |
+
type + |
+String + |
+Specifies the endpoint type, which can be subnet or cidr. + |
+
id + |
+String + |
+Specifies the ID of the VPN endpoint group. + |
+
name + |
+String + |
+Specifies the name of the VPN endpoint group. + |
+
endpoint_group + |
+Object + |
+Specifies the object of the VPN endpoint group. + |
+
POST /v2.0/vpn/endpoint-groups +{ + "endpoint_group" : { + "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], + "type" : "cidr", + "name" : "peers" + } +}+
{ + "endpoint_group" : { + "description" : "", + "tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d", + "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], + "type" : "cidr", + "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", + "name" : "peers" + } +}+
For details, see Common Returned Values.
+This API is used to query details about a VPN endpoint group.
+GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
endpoint_group_id + |
+String + |
+Yes + |
+Specifies the ID of the VPN endpoint group. + |
+
None
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
description + |
+Object + |
+Provides supplementary information about the VPN endpoint group. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
endpoints + |
+List + |
+Specifies the endpoint list. The endpoints in a list must be of the same type. + |
+
type + |
+String + |
+Specifies the endpoint type, which can be subnet or cidr. + |
+
id + |
+String + |
+Specifies the ID of the VPN endpoint group. + |
+
name + |
+String + |
+Specifies the name of the VPN endpoint group. + |
+
endpoint_group + |
+Object + |
+Specifies the object of the VPN endpoint group. + |
+
GET /v2.0/vpn/endpoint-groups/{endpoint_group_id}+
{ + "endpoint_group": { + "description": "", + "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d", + "endpoints": [ + "10.2.0.0/24", + "10.3.0.0/24" + ], + "type": "cidr", + "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", + "name": "peers" + } +}+
For details, see Common Returned Values.
+This API is used to query VPN endpoint groups.
+GET /v2.0/vpn/endpoint-groups
+Table 1 describes the request parameter.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
fields + |
+String + |
+No + |
+Controls which parameters are returned. If this parameter is not specified, all parameters will be returned. + |
+
Parameter project_id is not supported.
+Table 2 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
description + |
+String + |
+Provides supplementary information about the VPN endpoint group. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
endpoints + |
+List + |
+Specifies the endpoint list. The endpoints in a list must be of the same type. + |
+
type + |
+String + |
+Specifies the endpoint type, which can be subnet or cidr. + |
+
id + |
+String + |
+Specifies the ID of the VPN endpoint group. + |
+
name + |
+String + |
+Specifies the name of the VPN endpoint group. + |
+
endpoint_groups + |
+List<Object> + |
+Specifies the object of the VPN endpoint groups. + |
+
GET /v2.0/vpn/endpoint-groups+
{ + "endpoint_groups": [ + { + "description": "", + "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d", + "endpoints": [ + "a3da778c-adfb-46db-88b3-d2ce53290a89" + ], + "type": "subnet", + "id": "6bf34c7c-864c-4948-a6d4-db791669f9d4", + "name": "locals" + }, + { + "description": "", + "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d", + "endpoints": [ + "10.2.0.0/24", + "10.3.0.0/24" + ], + "type": "cidr", + "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", + "name": "peers" + } + ] +}+
For details, see Common Returned Values.
+This API is used to update a VPN endpoint group.
+PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
endpoint_group_id + |
+String + |
+Yes + |
+Specifies the ID of the VPN endpoint group. + |
+
Table 2 describes the request parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
description + |
+String + |
+No + |
+Provides supplementary information about the VPN endpoint group. +The description can contain up to 255 characters. + |
+
name + |
+String + |
+No + |
+Specifies the name of the VPN endpoint group. +The name can contain 1 to 64 characters. + |
+
endpoint_group + |
+Object + |
+Yes + |
+Specifies the endpoint group. + |
+
Parameter project_id is not supported.
+Table 3 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
---|---|---|
description + |
+String + |
+Provides supplementary information about the VPN endpoint group. + |
+
tenant_id + |
+String + |
+Specifies the project ID. + |
+
endpoints + |
+List + |
+Specifies the endpoint list. The endpoints in a list must be of the same type. + |
+
type + |
+String + |
+Specifies the endpoint type, which can be subnet or cidr. + |
+
id + |
+String + |
+Specifies the ID of the VPN endpoint group. + |
+
name + |
+String + |
+Provides supplementary information about the VPN endpoint group. + |
+
endpoint_group + |
+Object + |
+Specifies the object of the VPN endpoint group. + |
+
PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id} +{ + "endpoint_group" : { + "description" : "New description" + } +}+
{ + "endpoint_group" : { + "description" : "New description", + "tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d", + "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], + "type" : "cidr", + "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", + "name" : "peers" + } +}+
For details, see Common Returned Values.
+This interface is used to delete a VPN endpoint group.
+DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
---|---|---|---|
endpoint_group_id + |
+String + |
+Yes + |
+Specifies the VPN endpoint group ID. + |
+
None
+None
+DELETE /v2.0/vpn/endpoint-groups/{endpoint_group_id}+
For details, see section Common Returned Values.
+Normal Response Code + |
+Type + |
+Description + |
+
---|---|---|
200 + |
+OK + |
+Specifies the normal response code for the GET and PUT operations. + |
+
201 + |
+Created + |
+Specifies the normal response code for the POST operation. + |
+
204 + |
+No Content + |
+Specifies the normal response code for the DELETE operation. + |
+
Returned Value + |
+Description + |
+
---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter a username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The server could not find the requested page. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server could not be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication so that the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request could not be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the request is invalid. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurred. + |
+
Service + |
+Error Code + |
+HTTP Status Code + |
+Description + |
+Handling Measure + |
+
---|---|---|---|---|
VPN + |
+VPC.1001 + |
+400 + |
+Invalid VPN parameters. + |
+Correct the parameter settings and send the request again. + |
+
VPC.1002 + |
+500 + |
+Internal server error. + |
+System exception. Try again later. + |
+|
VPC.1003 + |
+400 + |
+The quota limit has been reached. + |
+Increase the VPN connection quota. + |
+|
VPC.1004 + |
+400 + |
+The remote gateway is being used by another VPN connection. + |
+Change the IP address and then create the connection. + |
+|
VPC.1016 + |
+400 + |
+The VPN remote subnet is the same as the local subnet. + |
+Change the subnet to ensure that the local and remote subnets are different. + |
+|
VPC.1017 + |
+400 + |
+You do not have permission to perform this operation. + |
+Perform another operation, or obtain the required permission and try again. + |
+|
VPC.1018 + |
+400 + |
+Both the local and remote subnets are being used by other VPNs. + |
+Change the subnets or delete existing VPN subnets. + |
+|
VPC.1019 + |
+400 + |
+The local gateway IP address you specified is in use. + |
+Specify another local gateway IP address. + |
+|
VPC.1020 + |
+400 + |
+Failed to create the VPN connection. + |
+System error. Contact technical support. + |
+|
VPC.1021 + |
+400 + |
+The remote subnet of the VPN is in use. + |
+Select another remote subnet for the VPN. + |
+|
VPC.1023 + |
+400 + |
+Failed to query the VPN gateway. + |
+System error. Contact technical support. + |
+|
VPC.1024 + |
+400 + |
+Failed to create the VPN gateway. + |
+System error. Contact technical support. + |
+|
VPC.1025 + |
+400 + |
+Failed to update the VPN gateway. + |
+System error. Contact technical support. + |
+|
VPC.1026 + |
+400 + |
+The VPN gateway already exists. + |
+System error. Contact technical support. + |
+|
VPC.1027 + |
+400 + |
+Failed to create the VPN gateway. + |
+System error. Contact technical support. + |
+|
VPC.1028 + |
+400 + |
+Failed to create the VPN gateway. + |
+System error. Contact technical support. + |
+|
VPC.1029 + |
+400 + |
+Failed to allocate bandwidth to the VPN gateway. + |
+System error. Contact technical support. + |
+|
VPC.1030 + |
+400 + |
+Failed to allocate bandwidth to the VPN gateway. + |
+System error. Contact technical support. + |
+
Normal Response Code + |
+Type + |
+Description + |
+
---|---|---|
200 + |
+OK + |
+Specifies the normal response code for the GET, PUT, and POST operations. + |
+
201 + |
+Created + |
+Specifies the normal response code for the POST operation of the OpenStack Neutron API. + |
+
204 + |
+No Content + |
+Specifies the normal response code for the DELETE operation. + |
+
Returned Value + |
+Description + |
+
---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter a username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The server could not find the requested page. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server could not be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication so that the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request could not be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurred. + |
+
Released On + |
+What's New + |
+
---|---|
2024-08-09 + |
+This release incorporates the following change: +Added APIs of Enterprise Edition VPN. For details, see API Reference - Enterprise Edition VPN. + |
+
2021-10-27 + |
+This release incorporates the following change: +Optimized the description of the parameter dpd and added the dpd parameters table in Creating an IPsec VPN Connection, Querying Details About an IPsec VPN Connection, Querying IPsec VPN Connections, and Updating an IPsec VPN Connection. + |
+
2021-02-04 + |
+This release incorporates the following change: +
|
+
2019-04-26 + |
+This release incorporates the following change: +
|
+
2019-01-28 + |
+Accepted in OTC-4.0/Agile. + |
+
2019-01-03 + |
+This release incorporates the following change: +Updated the PFS values in IPsec Policy Management and IKE Policy Management. + |
+
2018-11-12 + |
+This release is the first official release. + |
+
To improve ECS access security, you can create a security group, define security group rules, and add ECSs in the VPC to the security group. We recommend that you allocate ECSs that have different Internet access policies to different security groups.
+To improve ECS access security, you can create a security group, define security group rules, and add ECSs in the VPC to the security group. We recommend that you allocate ECSs that have different Internet access policies to different security groups.
Parameter +
diff --git a/docs/vpn/umn/en-us_topic_0030969470.html b/docs/vpn/umn/en-us_topic_0030969470.html
index e70c97b9..693f1487 100644
--- a/docs/vpn/umn/en-us_topic_0030969470.html
+++ b/docs/vpn/umn/en-us_topic_0030969470.html
@@ -1,98 +1,96 @@
Adding a Security Group Rule-ScenariosAfter a security group is created, you can add rules to the security group. A rule applies either to inbound traffic (ingress) or outbound traffic (egress). After ECSs are added to the security group, they are protected by the rules of that group. -
ScenariosAfter a security group is created, you can add rules to the security group. A rule applies either to inbound traffic (ingress) or outbound traffic (egress). After ECSs are added to the security group, they are protected by the rules of that group. +
Procedure
|
---|