doc-exports/docs/vpcep/api-ref/ALL_META.TXT.json
Qin Ying, Fan 8aa98e3fe1 vpcep_api
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
2022-10-18 12:00:20 +00:00

342 lines
14 KiB
JSON

[
{
"uri":"vpcep_05_0000.html",
"product_code":"vpcep",
"code":"1",
"des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ",
"doc_type":"api",
"kw":"API Usage Guidelines,API Reference",
"title":"API Usage Guidelines",
"githuburl":""
},
{
"uri":"vpcep_06_0000.html",
"product_code":"vpcep",
"code":"2",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"APIs",
"title":"APIs",
"githuburl":""
},
{
"uri":"vpcep_06_0100.html",
"product_code":"vpcep",
"code":"3",
"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":"Version Management",
"title":"Version Management",
"githuburl":""
},
{
"uri":"vpcep_06_0101.html",
"product_code":"vpcep",
"code":"4",
"des":"This API is used to query versions of VPCEP APIs.GET /Example requestGET https://{endpoint}/GET https://{endpoint}/ParametersResponse parametersParameterTypeDescriptionve",
"doc_type":"api",
"kw":"Querying Versions of VPCEP APIs,Version Management,API Reference",
"title":"Querying Versions of VPCEP APIs",
"githuburl":""
},
{
"uri":"vpcep_06_0102.html",
"product_code":"vpcep",
"code":"5",
"des":"This API is used to query the version of a specified VPCEP API.GET /{version}ParametersRequest parametersParameterMandatoryTypeDescriptionversionNoStringSpecifies the ver",
"doc_type":"api",
"kw":"Querying the Version of a Specified VPCEP API,Version Management,API Reference",
"title":"Querying the Version of a Specified VPCEP API",
"githuburl":""
},
{
"uri":"vpcep_06_0200.html",
"product_code":"vpcep",
"code":"6",
"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":"APIs for Managing VPC Endpoint Services",
"title":"APIs for Managing VPC Endpoint Services",
"githuburl":""
},
{
"uri":"vpcep_06_0201.html",
"product_code":"vpcep",
"code":"7",
"des":"This API is used to create a VPC endpoint service. Other users can create a VPC endpoint to connect to the endpoint service.This API is an asynchronous interface. If it i",
"doc_type":"api",
"kw":"Creating a VPC Endpoint Service,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Creating a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0202.html",
"product_code":"vpcep",
"code":"8",
"des":"This API is used to query details of a VPC endpoint service.GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}Table 1 describes the required parameters.",
"doc_type":"api",
"kw":"Querying Details of a VPC Endpoint Service,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Querying Details of a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0203.html",
"product_code":"vpcep",
"code":"9",
"des":"This API is used to modify a VPC endpoint service.PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}Table 1 describes the required parameters.Parameter ",
"doc_type":"api",
"kw":"Modifying a VPC Endpoint Service,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Modifying a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0204.html",
"product_code":"vpcep",
"code":"10",
"des":"This API is used to delete a VPC endpoint service.DELETE /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}Table 1 describes the required parameters.Paramet",
"doc_type":"api",
"kw":"Deleting a VPC Endpoint Service,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Deleting a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0205.html",
"product_code":"vpcep",
"code":"11",
"des":"This API is used to query VPC endpoint services.GET /v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&id={id}&sort_key={sort_key}&sort_",
"doc_type":"api",
"kw":"Querying VPC Endpoint Services,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Querying VPC Endpoint Services",
"githuburl":""
},
{
"uri":"vpcep_06_0206.html",
"product_code":"vpcep",
"code":"12",
"des":"This API is used to query connections of a VPC endpoint service. The marker ID is the unique ID of each connection.GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoin",
"doc_type":"api",
"kw":"Querying Connections of a VPC Endpoint Service,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Querying Connections of a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0207.html",
"product_code":"vpcep",
"code":"13",
"des":"This API is used to accept or reject a VPC endpoint for a VPC endpoint service.POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/actionTab",
"doc_type":"api",
"kw":"Accepting or Rejecting a VPC Endpoint,APIs for Managing VPC Endpoint Services,API Reference",
"title":"Accepting or Rejecting a VPC Endpoint",
"githuburl":""
},
{
"uri":"vpcep_06_0208.html",
"product_code":"vpcep",
"code":"14",
"des":"This API is used to query the whitelist records of a VPC endpoint service.Your domain ID is in the whitelist of your own VPC endpoint service by default.GET /v1/{project_",
"doc_type":"api",
"kw":"Querying the Whitelist Records of a VPC Endpoint Service,APIs for Managing VPC Endpoint Services,API",
"title":"Querying the Whitelist Records of a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0209.html",
"product_code":"vpcep",
"code":"15",
"des":"This API is used to batch add to or delete whitelist records from a VPC endpoint service.Your domain ID is in the whitelist of your own VPC endpoint service by default.PO",
"doc_type":"api",
"kw":"Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service,APIs for Managing VPC Endpoint ",
"title":"Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0300.html",
"product_code":"vpcep",
"code":"16",
"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":"APIs for Managing VPC Endpoints",
"title":"APIs for Managing VPC Endpoints",
"githuburl":""
},
{
"uri":"vpcep_06_0301.html",
"product_code":"vpcep",
"code":"17",
"des":"This API is used to query public VPC endpoint services. These services are created by operations people and can be visible to and assessed by all users.GET /v1/{project_i",
"doc_type":"api",
"kw":"Querying Public VPC Endpoint Services,APIs for Managing VPC Endpoints,API Reference",
"title":"Querying Public VPC Endpoint Services",
"githuburl":""
},
{
"uri":"vpcep_06_0302.html",
"product_code":"vpcep",
"code":"18",
"des":"This API is used to query basic information of a target VPC endpoint service. You can use this API to query the target VPC endpoint service to be accessed. This API can a",
"doc_type":"api",
"kw":"Querying Basic Information of a VPC Endpoint Service,APIs for Managing VPC Endpoints,API Reference",
"title":"Querying Basic Information of a VPC Endpoint Service",
"githuburl":""
},
{
"uri":"vpcep_06_0303.html",
"product_code":"vpcep",
"code":"19",
"des":"This API is used to create a VPC endpoint for accessing a VPC endpoint service.POST /v1/{project_id}/vpc-endpointsTable 1 describes the required parameters.Parameter desc",
"doc_type":"api",
"kw":"Creating a VPC Endpoint,APIs for Managing VPC Endpoints,API Reference",
"title":"Creating a VPC Endpoint",
"githuburl":""
},
{
"uri":"vpcep_06_0304.html",
"product_code":"vpcep",
"code":"20",
"des":"This API is used to query details of a VPC endpoint.GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}Table 1 describes the required parameters.Parameter descriptionPar",
"doc_type":"api",
"kw":"Querying Details of a VPC Endpoint,APIs for Managing VPC Endpoints,API Reference",
"title":"Querying Details of a VPC Endpoint",
"githuburl":""
},
{
"uri":"vpcep_06_0305.html",
"product_code":"vpcep",
"code":"21",
"des":"This API is used to delete a VPC endpoint.DELETE /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}For detailed about the parameters, see Table 1.ParametersParameterMandato",
"doc_type":"api",
"kw":"Deleting a VPC Endpoint,APIs for Managing VPC Endpoints,API Reference",
"title":"Deleting a VPC Endpoint",
"githuburl":""
},
{
"uri":"vpcep_06_0306.html",
"product_code":"vpcep",
"code":"22",
"des":"This API is used to query VPC endpoints.GET /v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id=",
"doc_type":"api",
"kw":"Querying VPC Endpoints,APIs for Managing VPC Endpoints,API Reference",
"title":"Querying VPC Endpoints",
"githuburl":""
},
{
"uri":"vpcep_06_0400.html",
"product_code":"vpcep",
"code":"23",
"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":"Resource Quota",
"title":"Resource Quota",
"githuburl":""
},
{
"uri":"vpcep_06_0401.html",
"product_code":"vpcep",
"code":"24",
"des":"This API is used to query the quota of your resources, including VPC endpoint services and VPC endpoints.GET /v1/{project_id}/quotas?type={resource_type}Table 1 describes",
"doc_type":"api",
"kw":"Querying the Quota,Resource Quota,API Reference",
"title":"Querying the Quota",
"githuburl":""
},
{
"uri":"vpcep_06_0500.html",
"product_code":"vpcep",
"code":"25",
"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 Function",
"title":"Tag Function",
"githuburl":""
},
{
"uri":"vpcep_06_0501.html",
"product_code":"vpcep",
"code":"26",
"des":"This API is used to query resources under the tenant using tags.POST /v1/{project_id}/{resource_type}/resource_instances/actionTable 1 describes the required parameters.",
"doc_type":"api",
"kw":"Querying Resources by Tag,Tag Function,API Reference",
"title":"Querying Resources by Tag",
"githuburl":""
},
{
"uri":"vpcep_06_0502.html",
"product_code":"vpcep",
"code":"27",
"des":"This API is used to batch add or delete tags for a specified VPC endpoint service or VPC endpoint.You can add a maximum of 20 tags to a resource.POST /v1/{project_id}/{r",
"doc_type":"api",
"kw":"Batch Adding or Deleting Tags of a Specified Resource,Tag Function,API Reference",
"title":"Batch Adding or Deleting Tags of a Specified Resource",
"githuburl":""
},
{
"uri":"vpcep_06_0503.html",
"product_code":"vpcep",
"code":"28",
"des":"This API is used to obtain tags of resources of a tenant based on the tenant ID and resource type.GET /v1/{project_id}/{resource_type}/tagsTable 1 describes the required",
"doc_type":"api",
"kw":"Querying Tags of a Tenant's Resource,Tag Function,API Reference",
"title":"Querying Tags of a Tenant's Resource",
"githuburl":""
},
{
"uri":"vpcep_06_0504.html",
"product_code":"vpcep",
"code":"29",
"des":"The key should be Unicode characters, including only digits, letters, hyphens (-), and underscores (_). It cannot be empty.The value should be Unicode characters, includi",
"doc_type":"api",
"kw":"Tag Character Set Specifications,Tag Function,API Reference",
"title":"Tag Character Set Specifications",
"githuburl":""
},
{
"uri":"vpcep_08_0000.html",
"product_code":"vpcep",
"code":"30",
"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":"Appendix",
"title":"Appendix",
"githuburl":""
},
{
"uri":"vpcep_08_0001.html",
"product_code":"vpcep",
"code":"31",
"des":"NormalReturn values for successful requestsStatus CodeReturned ValueDescription200OKThe results of POST, GET, and PUT operations are returned as expected.204No ContentThe",
"doc_type":"api",
"kw":"Status Code,Appendix,API Reference",
"title":"Status Code",
"githuburl":""
},
{
"uri":"vpcep_08_0002.html",
"product_code":"vpcep",
"code":"32",
"des":"If an error occurs during API calling, a customized error message will be returned. This section describes the meaning of each status code returned by VPCEP.An error code",
"doc_type":"api",
"kw":"Error Code,Appendix,API Reference",
"title":"Error Code",
"githuburl":""
},
{
"uri":"vpcep_08_0003_0.html",
"product_code":"vpcep",
"code":"33",
"des":"A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to ob",
"doc_type":"api",
"kw":"Obtaining a Project ID,Appendix,API Reference",
"title":"Obtaining a Project ID",
"githuburl":""
},
{
"uri":"vpcep_00_0004.html",
"product_code":"vpcep",
"code":"34",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Change History,API Reference",
"title":"Change History",
"githuburl":""
}
]