yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
d8e1c23e3b8fad5191d84bc016363fd4c3907107
doc-exports/docs/vpn/api-ref/CLASS.TXT.json
Hongwei, King Wang 708fdb2d21 vpn_api_20250707 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
2025-08-19 13:38:54 +00:00

1010 lines
39 KiB
JSON
Raw Blame History

[
{
"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 Reference - Enterprise Edition VPN",
"uri":"vpn_api_1001.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"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":"Before You Start",
"uri":"vpn_api_0006.html",
"doc_type":"api",
"p_code":"1",
"code":"2"
},
{
"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":"3"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"vpn",
"title":"Calling APIs",
"uri":"vpn_api_0008.html",
"doc_type":"api",
"p_code":"1",
"code":"4"
},
{
"desc":"This section describes the structure of a REST API request, and uses the IAM API for creating an IAM user as an administrator as an example to demonstrate how to call an ",
"product_code":"vpn",
"title":"Request",
"uri":"vpn_api_0009.html",
"doc_type":"api",
"p_code":"4",
"code":"5"
},
{
"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":"Authentication",
"uri":"vpn_api_0010.html",
"doc_type":"api",
"p_code":"4",
"code":"6"
},
{
"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":"Response",
"uri":"vpn_api_0011.html",
"doc_type":"api",
"p_code":"4",
"code":"7"
},
{
"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_0012.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":"S2C VPN Gateway",
"uri":"vpn_api_0013.html",
"doc_type":"api",
"p_code":"8",
"code":"9"
},
{
"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":"Creating a VPN Gateway",
"uri":"vpn_api_0014.html",
"doc_type":"api",
"p_code":"9",
"code":"10"
},
{
"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":"Querying a Specified VPN Gateway",
"uri":"vpn_api_0015.html",
"doc_type":"api",
"p_code":"9",
"code":"11"
},
{
"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 the VPN Gateway List",
"uri":"vpn_api_0016.html",
"doc_type":"api",
"p_code":"9",
"code":"12"
},
{
"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":"Updating a VPN Gateway",
"uri":"vpn_api_0017.html",
"doc_type":"api",
"p_code":"9",
"code":"13"
},
{
"desc":"This API is used to change the specification of a gateway. Currently, only pay-per-use gateways are supported.For details, see Calling APIs.POST /v5/{project_id}/vpn-gate",
"product_code":"vpn",
"title":"Changing the Specification of a Gateway",
"uri":"vpn_api_0069.html",
"doc_type":"api",
"p_code":"9",
"code":"14"
},
{
"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":"Deleting a VPN Gateway",
"uri":"vpn_api_0018.html",
"doc_type":"api",
"p_code":"9",
"code":"15"
},
{
"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":"Querying the AZs of VPN Gateways",
"uri":"vpn_api_0019.html",
"doc_type":"api",
"p_code":"9",
"code":"16"
},
{
"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_0020.html",
"doc_type":"api",
"p_code":"8",
"code":"17"
},
{
"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 Customer Gateway",
"uri":"vpn_api_0021.html",
"doc_type":"api",
"p_code":"17",
"code":"18"
},
{
"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 a Specified Customer Gateway",
"uri":"vpn_api_0022.html",
"doc_type":"api",
"p_code":"17",
"code":"19"
},
{
"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 the Customer Gateway List",
"uri":"vpn_api_0023.html",
"doc_type":"api",
"p_code":"17",
"code":"20"
},
{
"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 Customer Gateway",
"uri":"vpn_api_0024.html",
"doc_type":"api",
"p_code":"17",
"code":"21"
},
{
"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 Customer Gateway",
"uri":"vpn_api_0025.html",
"doc_type":"api",
"p_code":"17",
"code":"22"
},
{
"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_0026.html",
"doc_type":"api",
"p_code":"8",
"code":"23"
},
{
"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 a VPN Connection",
"uri":"vpn_api_0027.html",
"doc_type":"api",
"p_code":"23",
"code":"24"
},
{
"desc":"This API is used to create one or two VPN connections for a VPN gateway in batches.For details, see Calling APIs.POST /v5/{project_id}/vpn-connections/batch-createRequest",
"product_code":"vpn",
"title":"Creating VPN Connections in Batches",
"uri":"vpn_api_0150.html",
"doc_type":"api",
"p_code":"23",
"code":"25"
},
{
"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 a Specified VPN Connection",
"uri":"vpn_api_0028.html",
"doc_type":"api",
"p_code":"23",
"code":"26"
},
{
"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 the VPN Connection List",
"uri":"vpn_api_0029.html",
"doc_type":"api",
"p_code":"23",
"code":"27"
},
{
"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 a VPN Connection",
"uri":"vpn_api_0030.html",
"doc_type":"api",
"p_code":"23",
"code":"28"
},
{
"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 a VPN Connection",
"uri":"vpn_api_0031.html",
"doc_type":"api",
"p_code":"23",
"code":"29"
},
{
"desc":"This API is used to query logs of a VPN connection with a specified connection ID.For details, see Calling APIs.GET /v5/{project_id}/vpn-connection/{vpn_connection_id}/lo",
"product_code":"vpn",
"title":"Querying VPN Connection Logs",
"uri":"vpn_api_0145.html",
"doc_type":"api",
"p_code":"23",
"code":"30"
},
{
"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 Monitoring",
"uri":"vpn_api_0032.html",
"doc_type":"api",
"p_code":"8",
"code":"31"
},
{
"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 a VPN Connection Monitor",
"uri":"vpn_api_0033.html",
"doc_type":"api",
"p_code":"31",
"code":"32"
},
{
"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 a VPN Connection Monitor",
"uri":"vpn_api_0034.html",
"doc_type":"api",
"p_code":"31",
"code":"33"
},
{
"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 the List of VPN Connection Monitors",
"uri":"vpn_api_0035.html",
"doc_type":"api",
"p_code":"31",
"code":"34"
},
{
"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":"Deleting a VPN Connection Monitor",
"uri":"vpn_api_0036.html",
"doc_type":"api",
"p_code":"31",
"code":"35"
},
{
"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_0037.html",
"doc_type":"api",
"p_code":"8",
"code":"36"
},
{
"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":"Querying Quotas",
"uri":"vpn_api_0038.html",
"doc_type":"api",
"p_code":"36",
"code":"37"
},
{
"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_0060.html",
"doc_type":"api",
"p_code":"8",
"code":"38"
},
{
"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 the Resource Instance List",
"uri":"vpn_api_0061.html",
"doc_type":"api",
"p_code":"38",
"code":"39"
},
{
"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 the Number of Resource Instances",
"uri":"vpn_api_0062.html",
"doc_type":"api",
"p_code":"38",
"code":"40"
},
{
"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":"Adding Resource Tags in Batches",
"uri":"vpn_api_0063.html",
"doc_type":"api",
"p_code":"38",
"code":"41"
},
{
"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 Resource Tags in Batches",
"uri":"vpn_api_0064.html",
"doc_type":"api",
"p_code":"38",
"code":"42"
},
{
"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":"Querying Resource Tags",
"uri":"vpn_api_0065.html",
"doc_type":"api",
"p_code":"38",
"code":"43"
},
{
"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":"Querying Project Tags",
"uri":"vpn_api_0066.html",
"doc_type":"api",
"p_code":"38",
"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.",
"product_code":"vpn",
"title":"Application Examples",
"uri":"vpn_api_0039.html",
"doc_type":"api",
"p_code":"1",
"code":"45"
},
{
"desc":"This section describes how to create an S2C VPN gateway by calling an API.You have determined the region where the VPN gateway is to be deployed and obtained the endpoint",
"product_code":"vpn",
"title":"Example 1: Creating an S2C VPN Gateway",
"uri":"vpn_api_0040.html",
"doc_type":"api",
"p_code":"45",
"code":"46"
},
{
"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":"45",
"code":"47"
},
{
"desc":"This section describes how to create dual VPN connections by calling APIs.You have created a VPN gateway. For details, see Creating a VPN Gateway.You have created a custo",
"product_code":"vpn",
"title":"Example 3: Creating Dual VPN Connections",
"uri":"vpn_api_0042.html",
"doc_type":"api",
"p_code":"45",
"code":"48"
},
{
"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":"45",
"code":"49"
},
{
"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":"50"
},
{
"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 S2C VPN",
"uri":"vpn_api_0114.html",
"doc_type":"api",
"p_code":"50",
"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":"VPN Gateway",
"uri":"vpn_api_0115.html",
"doc_type":"api",
"p_code":"51",
"code":"52"
},
{
"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":"51",
"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":"VPN Connection",
"uri":"vpn_api_0117.html",
"doc_type":"api",
"p_code":"51",
"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 Connection Monitor",
"uri":"vpn_api_0118.html",
"doc_type":"api",
"p_code":"51",
"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":"Actions Supported by Public Service APIs",
"uri":"vpn_api_0124.html",
"doc_type":"api",
"p_code":"50",
"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 Quota",
"uri":"vpn_api_0125.html",
"doc_type":"api",
"p_code":"56",
"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 Tag",
"uri":"vpn_api_0126.html",
"doc_type":"api",
"p_code":"56",
"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":"Appendixes",
"uri":"vpn_api_0050.html",
"doc_type":"api",
"p_code":"1",
"code":"59"
},
{
"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":"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":"Status Codes",
"uri":"vpn_api_0052.html",
"doc_type":"api",
"p_code":"59",
"code":"61"
},
{
"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).If an",
"product_code":"vpn",
"title":"Error Codes",
"uri":"vpn_api_0067.html",
"doc_type":"api",
"p_code":"59",
"code":"62"
},
{
"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 Reference - Classic VPN",
"uri":"vpn_api_1002.html",
"doc_type":"api",
"p_code":"",
"code":"63"
},
{
"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":"63",
"code":"64"
},
{
"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":"63",
"code":"65"
},
{
"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":"63",
"code":"66"
},
{
"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":"63",
"code":"67"
},
{
"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":"67",
"code":"68"
},
{
"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":"68",
"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":"Tag Management",
"uri":"vpn_api_1015.html",
"doc_type":"api",
"p_code":"67",
"code":"70"
},
{
"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":"70",
"code":"71"
},
{
"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":"70",
"code":"72"
},
{
"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":"70",
"code":"73"
},
{
"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":"70",
"code":"74"
},
{
"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":"70",
"code":"75"
},
{
"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":"70",
"code":"76"
},
{
"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":"63",
"code":"77"
},
{
"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":"77",
"code":"78"
},
{
"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":"78",
"code":"79"
},
{
"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":"78",
"code":"80"
},
{
"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":"78",
"code":"81"
},
{
"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":"78",
"code":"82"
},
{
"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":"78",
"code":"83"
},
{
"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":"77",
"code":"84"
},
{
"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":"84",
"code":"85"
},
{
"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":"84",
"code":"86"
},
{
"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":"84",
"code":"87"
},
{
"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":"84",
"code":"88"
},
{
"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":"84",
"code":"89"
},
{
"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":"77",
"code":"90"
},
{
"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":"90",
"code":"91"
},
{
"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":"90",
"code":"92"
},
{
"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":"90",
"code":"93"
},
{
"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":"90",
"code":"94"
},
{
"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":"90",
"code":"95"
},
{
"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":"77",
"code":"96"
},
{
"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":"96",
"code":"97"
},
{
"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":"96",
"code":"98"
},
{
"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":"96",
"code":"99"
},
{
"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":"96",
"code":"100"
},
{
"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":"96",
"code":"101"
},
{
"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":"77",
"code":"102"
},
{
"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":"102",
"code":"103"
},
{
"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":"102",
"code":"104"
},
{
"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":"102",
"code":"105"
},
{
"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":"102",
"code":"106"
},
{
"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":"102",
"code":"107"
},
{
"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":"63",
"code":"108"
},
{
"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":"108",
"code":"109"
},
{
"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":"108",
"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":"Status Codes",
"uri":"vpn_api_1056.html",
"doc_type":"api",
"p_code":"108",
"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":"Change History",
"uri":"vpn_api_1057.html",
"doc_type":"api",
"p_code":"",
"code":"112"
}
]
View Git Blame Copy Permalink