diff --git a/docs/vpcep/api-ref/ALL_META.TXT.json b/docs/vpcep/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..b3861bc5c --- /dev/null +++ b/docs/vpcep/api-ref/ALL_META.TXT.json @@ -0,0 +1,342 @@ +[ + { + "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":"" + } +] \ No newline at end of file diff --git a/docs/vpcep/api-ref/CLASS.TXT.json b/docs/vpcep/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..036cd4ba1 --- /dev/null +++ b/docs/vpcep/api-ref/CLASS.TXT.json @@ -0,0 +1,308 @@ +[ + { + "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":"vpcep", + "title":"API Usage Guidelines", + "uri":"vpcep_05_0000.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "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":"vpcep", + "title":"APIs", + "uri":"vpcep_06_0000.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "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":"vpcep", + "title":"Version Management", + "uri":"vpcep_06_0100.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to query versions of VPCEP APIs.GET /Example requestGET https://{endpoint}/GET https://{endpoint}/ParametersResponse parametersParameterTypeDescriptionve", + "product_code":"vpcep", + "title":"Querying Versions of VPCEP APIs", + "uri":"vpcep_06_0101.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to query the version of a specified VPCEP API.GET /{version}ParametersRequest parametersParameterMandatoryTypeDescriptionversionNoStringSpecifies the ver", + "product_code":"vpcep", + "title":"Querying the Version of a Specified VPCEP API", + "uri":"vpcep_06_0102.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "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":"vpcep", + "title":"APIs for Managing VPC Endpoint Services", + "uri":"vpcep_06_0200.html", + "doc_type":"api", + "p_code":"2", + "code":"6" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Creating a VPC Endpoint Service", + "uri":"vpcep_06_0201.html", + "doc_type":"api", + "p_code":"6", + "code":"7" + }, + { + "desc":"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.", + "product_code":"vpcep", + "title":"Querying Details of a VPC Endpoint Service", + "uri":"vpcep_06_0202.html", + "doc_type":"api", + "p_code":"6", + "code":"8" + }, + { + "desc":"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 ", + "product_code":"vpcep", + "title":"Modifying a VPC Endpoint Service", + "uri":"vpcep_06_0203.html", + "doc_type":"api", + "p_code":"6", + "code":"9" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Deleting a VPC Endpoint Service", + "uri":"vpcep_06_0204.html", + "doc_type":"api", + "p_code":"6", + "code":"10" + }, + { + "desc":"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_", + "product_code":"vpcep", + "title":"Querying VPC Endpoint Services", + "uri":"vpcep_06_0205.html", + "doc_type":"api", + "p_code":"6", + "code":"11" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Querying Connections of a VPC Endpoint Service", + "uri":"vpcep_06_0206.html", + "doc_type":"api", + "p_code":"6", + "code":"12" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Accepting or Rejecting a VPC Endpoint", + "uri":"vpcep_06_0207.html", + "doc_type":"api", + "p_code":"6", + "code":"13" + }, + { + "desc":"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_", + "product_code":"vpcep", + "title":"Querying the Whitelist Records of a VPC Endpoint Service", + "uri":"vpcep_06_0208.html", + "doc_type":"api", + "p_code":"6", + "code":"14" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service", + "uri":"vpcep_06_0209.html", + "doc_type":"api", + "p_code":"6", + "code":"15" + }, + { + "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":"vpcep", + "title":"APIs for Managing VPC Endpoints", + "uri":"vpcep_06_0300.html", + "doc_type":"api", + "p_code":"2", + "code":"16" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Querying Public VPC Endpoint Services", + "uri":"vpcep_06_0301.html", + "doc_type":"api", + "p_code":"16", + "code":"17" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Querying Basic Information of a VPC Endpoint Service", + "uri":"vpcep_06_0302.html", + "doc_type":"api", + "p_code":"16", + "code":"18" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Creating a VPC Endpoint", + "uri":"vpcep_06_0303.html", + "doc_type":"api", + "p_code":"16", + "code":"19" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Querying Details of a VPC Endpoint", + "uri":"vpcep_06_0304.html", + "doc_type":"api", + "p_code":"16", + "code":"20" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Deleting a VPC Endpoint", + "uri":"vpcep_06_0305.html", + "doc_type":"api", + "p_code":"16", + "code":"21" + }, + { + "desc":"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=", + "product_code":"vpcep", + "title":"Querying VPC Endpoints", + "uri":"vpcep_06_0306.html", + "doc_type":"api", + "p_code":"16", + "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":"vpcep", + "title":"Resource Quota", + "uri":"vpcep_06_0400.html", + "doc_type":"api", + "p_code":"2", + "code":"23" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Querying the Quota", + "uri":"vpcep_06_0401.html", + "doc_type":"api", + "p_code":"23", + "code":"24" + }, + { + "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":"vpcep", + "title":"Tag Function", + "uri":"vpcep_06_0500.html", + "doc_type":"api", + "p_code":"2", + "code":"25" + }, + { + "desc":"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.", + "product_code":"vpcep", + "title":"Querying Resources by Tag", + "uri":"vpcep_06_0501.html", + "doc_type":"api", + "p_code":"25", + "code":"26" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Batch Adding or Deleting Tags of a Specified Resource", + "uri":"vpcep_06_0502.html", + "doc_type":"api", + "p_code":"25", + "code":"27" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Querying Tags of a Tenant's Resource", + "uri":"vpcep_06_0503.html", + "doc_type":"api", + "p_code":"25", + "code":"28" + }, + { + "desc":"The key should be Unicode characters, including only digits, letters, hyphens (-), and underscores (_). It cannot be empty.The value should be Unicode characters, includi", + "product_code":"vpcep", + "title":"Tag Character Set Specifications", + "uri":"vpcep_06_0504.html", + "doc_type":"api", + "p_code":"25", + "code":"29" + }, + { + "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":"vpcep", + "title":"Appendix", + "uri":"vpcep_08_0000.html", + "doc_type":"api", + "p_code":"", + "code":"30" + }, + { + "desc":"NormalReturn values for successful requestsStatus CodeReturned ValueDescription200OKThe results of POST, GET, and PUT operations are returned as expected.204No ContentThe", + "product_code":"vpcep", + "title":"Status Code", + "uri":"vpcep_08_0001.html", + "doc_type":"api", + "p_code":"30", + "code":"31" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Error Code", + "uri":"vpcep_08_0002.html", + "doc_type":"api", + "p_code":"30", + "code":"32" + }, + { + "desc":"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", + "product_code":"vpcep", + "title":"Obtaining a Project ID", + "uri":"vpcep_08_0003_0.html", + "doc_type":"api", + "p_code":"30", + "code":"33" + }, + { + "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":"vpcep", + "title":"Change History", + "uri":"vpcep_00_0004.html", + "doc_type":"api", + "p_code":"", + "code":"34" + } +] \ No newline at end of file diff --git a/docs/vpcep/api-ref/PARAMETERS.txt b/docs/vpcep/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/vpcep/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/vpcep/api-ref/en-us_image_0218975120.png b/docs/vpcep/api-ref/en-us_image_0218975120.png new file mode 100644 index 000000000..ec3abb85c Binary files /dev/null and b/docs/vpcep/api-ref/en-us_image_0218975120.png differ diff --git a/docs/vpcep/api-ref/public_sys-resources/ExpandCollapse.js b/docs/vpcep/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..3f1b7db00 --- /dev/null +++ b/docs/vpcep/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}}; \ No newline at end of file diff --git a/docs/vpcep/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/vpcep/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/vpcep/api-ref/public_sys-resources/commonltr.css b/docs/vpcep/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 000000000..c5480b0ab --- /dev/null +++ b/docs/vpcep/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/vpcep/api-ref/public_sys-resources/commonltr_print.css b/docs/vpcep/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/vpcep/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/vpcep/api-ref/public_sys-resources/commonrtl.css b/docs/vpcep/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..947a9a033 --- /dev/null +++ b/docs/vpcep/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/vpcep/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/vpcep/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/vpcep/api-ref/public_sys-resources/delta.gif b/docs/vpcep/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/deltaend.gif b/docs/vpcep/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/vpcep/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..84eec9be2 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/vpcep/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..39583d168 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-caution.gif b/docs/vpcep/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-danger.gif b/docs/vpcep/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-huawei.gif b/docs/vpcep/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-note.gif b/docs/vpcep/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-notice.gif b/docs/vpcep/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-tip.gif b/docs/vpcep/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/icon-warning.gif b/docs/vpcep/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/vpcep/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/vpcep/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/vpcep/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/vpcep/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/vpcep/api-ref/public_sys-resources/popup.js b/docs/vpcep/api-ref/public_sys-resources/popup.js new file mode 100644 index 000000000..5305962bc --- /dev/null +++ b/docs/vpcep/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!=null){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(tooltipTxt){if(document.body==null){return}if(i==0){return}clickFlag=true;var text=eval("jsonData."+tooltipTxt);var bodyWidth=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var st=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){st=0}var leftPos=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=text;dhtmlgoodies_tooltip.style.left=leftPos+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+st+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=leftPos+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+st+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var tooltipWidth=dhtmlgoodies_tooltip.offsetWidth;if(tooltipWidthbodyWidth){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if(dhtmlgoodies_tooltip!=null&&dhtmlgoodies_tooltip.style!=null){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/vpcep/api-ref/public_sys-resources/pygments.css b/docs/vpcep/api-ref/public_sys-resources/pygments.css new file mode 100644 index 000000000..49bada08a --- /dev/null +++ b/docs/vpcep/api-ref/public_sys-resources/pygments.css @@ -0,0 +1 @@ +.hll{background-color:#ffc}.c{color:#069;font-style:italic}.err{color:black}.k{color:#069;font-weight:bold}.ch{color:#069;font-style:italic}.cm{color:#008200}.cp{color:black}.cpf{color:#069;font-style:italic}.c1{color:#008200}.cs{color:#069;font-weight:bold}.gd{color:#000;background-color:#fdd}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:#aaa}.gt{color:#a00}.kc{color:#000080;font-weight:bold}.kd{color:#069;font-weight:bold}.kn{color:#000080;font-weight:bold}.kp{color:#069;font-weight:bold}.kr{color:#000080;font-weight:bold}.kt{color:#069;font-weight:bold}.m{color:blue}.s{color:blue}.na{color:gray}.nt{color:#069;font-weight:bold}.ow{font-weight:bold}.w{color:#bbb}.mb{color:blue}.mf{color:blue}.mh{color:blue}.mi{color:black}.mo{color:blue}.sa{color:blue}.sb{color:blue}.sc{color:#800080}.dl{color:blue}.sd{color:blue}.s2{color:blue}.se{color:blue}.sh{color:blue}.si{color:blue}.sx{color:blue}.sr{color:blue}.s1{color:blue}.ss{color:blue}.il{color:blue}.linenos{width:15px}.linenos{border-right:3px solid #6ce26c;color:#afafaf;text-align:right;padding:0 .5em 0 1em}.codecoloring{line-height:1.1em}.code .highlight pre{font-family:"Consolas","Bitstream Vera Sans Mono","Courier New",Courier,monospace}.code .highlight pre span{font-size:1em}.nb{color:#ff1493}.nv{color:#a70}.nx,.o,.n,.nf{color:black}.vc,.vi{color:#a70}.highlight pre{padding:0 1em}.highlighttable pre{box-sizing:border-box;margin:0} \ No newline at end of file diff --git a/docs/vpcep/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/vpcep/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/vpcep/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/vpcep/api-ref/vpcep_00_0004.html b/docs/vpcep/api-ref/vpcep_00_0004.html new file mode 100644 index 000000000..a4e7a743c --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_00_0004.html @@ -0,0 +1,38 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + +

Released On

+

Description

+

2021-02-05

+

This issue incorporates the following changes:

+

Supported a maximum of 20 tags for a resource.

+

2020-11-02

+

This issue incorporates the following changes:

+

Optimized request parameter permissions in Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service.

+

2020-07-31

+

This issue incorporates the following changes:

+

Changed parameter service_type from "Mandatory" to "Optional" in Creating a VPC Endpoint Service.

+

2020-07-15

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_05_0000.html b/docs/vpcep/api-ref/vpcep_05_0000.html new file mode 100644 index 000000000..15261a83f --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_05_0000.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.

+

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

+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0000.html b/docs/vpcep/api-ref/vpcep_06_0000.html new file mode 100644 index 000000000..9cad289fe --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0000.html @@ -0,0 +1,19 @@ + + +

APIs

+
+
+ +
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0100.html b/docs/vpcep/api-ref/vpcep_06_0100.html new file mode 100644 index 000000000..e3efd09e3 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0100.html @@ -0,0 +1,17 @@ + + +

Version Management

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0101.html b/docs/vpcep/api-ref/vpcep_06_0101.html new file mode 100644 index 000000000..35a278edd --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0101.html @@ -0,0 +1,148 @@ + + +

Querying Versions of VPCEP APIs

+

Function

This API is used to query versions of VPCEP APIs.

+
+

URI

GET /

+
+

Request

  • Example request

    GET https://{endpoint}/

    +
+
+

Response

  • Parameters +
    + + + + + + + + + +
    Table 1 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    versions

    +

    Array of objects

    +

    Lists the versions of VPCEP APIs. For details, see Table 2.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 VersionModel parameters

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the version status.

    +
    • CURRENT: indicates a major version.
    • SUPPORT: indicates an earlier version which is still supported.
    • DEPRECATED: indicates a deprecated version that may be deleted later.
    +

    id

    +

    String

    +

    Specifies the version ID.

    +

    updated

    +

    String

    +

    Specifies the time when the API version was released.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    version

    +

    String

    +

    Specifies the supported version.

    +

    min_version

    +

    String

    +

    Specifies the microversion number. If the APIs do not support microversions, the value is left blank.

    +

    links

    +

    Array of objects

    +

    Specifies the API URL. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 3 VersionLink parameters

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the reference address of the current API version.

    +

    type

    +

    String

    +

    Specifies the MIME type of the entity sending the request. The value is application/json.

    +

    rel

    +

    String

    +

    Specifies the relationship between the current API version and the referenced address.

    +
    +
    +
+
+
  • Example response
    {
+  "versions":[
+    {
+      "updated":"2018-09-30T00:00:00Z",
+      "version":"1",
+      "min_version":"",
+      "status":"CURRENT",
+      "id":"v1",
+      "links":[
+        {
+          "href":"https://{vpcep_uri}/v1",
+          "type":"application/json",
+          "rel":"self"
+        }
+      ]
+    }
+  ]
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: Version Management
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0102.html b/docs/vpcep/api-ref/vpcep_06_0102.html new file mode 100644 index 000000000..3997abd16 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0102.html @@ -0,0 +1,172 @@ + + +

Querying the Version of a Specified VPCEP API

+

Function

This API is used to query the version of a specified VPCEP API.

+
+

URI

GET /{version}

+
+

Request

  • Parameters +
    + + + + + + + + + + + +
    Table 1 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    version

    +

    No

    +

    String

    +

    Specifies the version to be queried. The value starts with v, for example, v1.

    +

    If this parameter is left blank, versions of all APIs are queried.

    +
    +
    +
  • Example request

    GET https://{endpoint}/v1

    +
+
+

Response

  • Parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    version

    +

    Object

    +

    Lists the versions of VPCEP APIs. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 VersionModel parameters

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the version status.

    +
    • CURRENT: indicates a major version.
    • SUPPORT: indicates an earlier version which is still supported.
    • DEPRECATED: indicates a deprecated version that may be deleted later.
    +

    id

    +

    String

    +

    Specifies the version ID.

    +

    updated

    +

    String

    +

    Specifies the time when the API version was released.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    version

    +

    String

    +

    Specifies the supported version.

    +

    min_version

    +

    String

    +

    Specifies the microversion number. If the APIs do not support microversions, the value is left blank.

    +

    links

    +

    Array of objects

    +

    Specifies the API URL. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 4 VersionLink parameters

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the reference address of the current API version.

    +

    type

    +

    String

    +

    Specifies the MIME type of the entity sending the request. The value is application/json.

    +

    rel

    +

    String

    +

    Specifies the relationship between the current API version and the referenced address.

    +
    +
    +
+
+
  • Example response
    {
+  "version":{
+    {
+      "updated":"2018-09-30T00:00:00Z",
+      "version":"1",
+      "min_version":"",
+      "status":"CURRENT",
+      "id":"v1",
+      "links":[
+        {
+          "href":"https://{vpcep_uri}/v1",
+          "type":"application/json",
+          "rel":"self"
+        }
+      ]
+    }
+  }
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: Version Management
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0200.html b/docs/vpcep/api-ref/vpcep_06_0200.html new file mode 100644 index 000000000..67ea22462 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0200.html @@ -0,0 +1,31 @@ + + +

APIs for Managing VPC Endpoint Services

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0201.html b/docs/vpcep/api-ref/vpcep_06_0201.html new file mode 100644 index 000000000..acbfb7510 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0201.html @@ -0,0 +1,513 @@ + + +

Creating a VPC Endpoint Service

+

Function

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 is successfully invoked, status code 200 is returned, indicating that the request has been successfully delivered. It takes 1 to 2 minutes to create a VPC endpoint service. You can view the creation result by performing operations in Querying Details of a VPC Endpoint Service.

+
+
+

URI

POST /v1/{project_id}/vpc-endpoint-services

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    port_id

    +

    Yes

    +

    String

    +

    Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID.

    +

    The values are as follows:

    +
    • If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field vip_port_id in Querying Details of a Load Balancer in the Elastic Load Balancing API Reference.
    • If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see Querying NICs of an ECS in the Elastic Load Balancing API Reference.
    • If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
    +
    NOTE:
    • To create a VPC endpoint service, the CIDR block of the VPC where the VPC endpoint service is deployed cannot overlap with 198.19.128.0/20.
    • The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/20.
    +
    +

    pool_id

    +

    No

    +

    String

    +

    Specifies the ID of the cluster associated with the target VPCEP resource.

    +

    vip_port_id

    +

    No

    +

    String

    +

    Specifies the ID of the virtual NIC to which the virtual IP address is bound.

    +

    service_name

    +

    No

    +

    String

    +

    Specifies the name of the VPC endpoint service. The name can contain a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).

    +
    • If you do not specify this parameter, the VPC endpoint service name is in the format: regionName.serviceId.
    • If you specify this parameter, the VPC endpoint service name is in the format: regionName.serviceName.serviceId.
    +

    vpc_id

    +

    Yes

    +

    String

    +

    Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.

    +

    For details, see response field id in Querying VPC Details in the Virtual Private Cloud API Reference.

    +

    approval_enabled

    +

    No

    +

    Boolean

    +

    Specifies whether connection approval is required.

    +
    • false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
    • true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
    +

    The default value is true.

    +

    service_type

    +

    No

    +

    String

    +

    Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.

    +
    There are two types of VPC endpoint services: interface and gateway.
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +
    +

    You can view those VPC endpoint services that are configured by operations people and are visible and accessible to all users. For detailed steps, see Querying Public VPC Endpoint Services. Perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoint services of the gateway type and interface type.

    +

    server_type

    +

    Yes

    +

    String

    +

    Specifies the resource type.

    +
    • VM: Select this value if the backend resource is an ECS. Backend resources of this type serve as servers.
    • VIP: Select this value if the backend resource is a virtual IP address that functions as a physical server hosting virtual resources.
    • LB: Select this value if the backend resource is an enhanced load balancer. Backend resources of this type suit services that receive high access traffic and demand high reliability and disaster recovery (DR) performance.
    +

    ports

    +

    Yes

    +

    Array of objects

    +

    Lists the port mappings opened to the VPC endpoint service. For details, see Table 3.

    +

    Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same. A maximum of 200 port mappings can be created at a time.

    +

    tcp_proxy

    +

    No

    +

    String

    +

    Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:

    +
    • TCP TOA: The client information is inserted into field tcp option and transmitted to the server.
      NOTE:

      TCP TOA is supported only when the backend resource is OBS.

      +
      +
    • Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
    +

    This parameter is available only when the server can parse fields tcp option and tcp payload.

    +

    The values are as follows:

    +
    • close: indicates that the TOA and Proxy Protocol methods are neither used.
    • toa_open: indicates that the TOA method is used.
    • proxy_open: indicates that the Proxy Protocol method is used.
    • open: indicates that the TOA and Proxy Protocol methods are both used.
    +

    The default value is close.

    +

    tags

    +

    No

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 4.

    +

    A maximum of 20 tags can be added to each VPC endpoint service.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Port mapping parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    client_port

    +

    No

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint.

    +

    This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535

    +

    server_port

    +

    No

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint service.

    +

    This port is provided by the backend service to provide services. Supported range: 1 to 65535

    +

    protocol

    +

    No

    +

    String

    +

    Specifies the protocol used in port mappings. The protocol can be TCP or UDP. The default protocol is TCP.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 ResourceTags parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    No

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).

    +

    value

    +

    No

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services
    +
    {
+   "port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
+   "vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
+   "approval_enabled":false,
+   "service_type":"interface",
+   "server_type":"VM",
+   "ports":
+  [
+    {
+      "client_port":8080,
+      "server_port":90,
+      "protocol":"TCP"
+    },
+    {
+      "client_port":8081,
+      "server_port":80,
+      "protocol":"TCP"
+    }
+  ]
+}
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +

    port_id

    +

    String

    +

    Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:

    +
    • If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
    • If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
    • If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
    +

    vip_port_id

    +

    String

    +

    Specifies the ID of the virtual NIC to which the virtual IP address is bound.

    +

    This parameter is returned only when port_id is set to VIP.

    +

    service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service.

    +
    There are two types of VPC endpoint services: interface and gateway.
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    server_type

    +

    String

    +

    Specifies the resource type.

    +
    • VM: indicates the ECS.
    • VIP: indicates the virtual IP address.
    • LB: indicates the enhanced load balancer.
    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.

    +

    pool_id

    +

    String

    +

    Specifies the ID of the cluster associated with the target VPCEP resource.

    +

    approval_enabled

    +

    Boolean

    +

    Specifies whether connection approval is required.

    +
    • false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
    • true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
    +

    status

    +

    String

    +

    Specifies the status of the VPC endpoint service.

    +
    • creating: indicates the VPC endpoint service is being created.
    • available: indicates the VPC endpoint service is connectable.
    • failed: indicates the creation of the VPC endpoint service failed.
    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    cidr_type

    +

    String

    +

    Specifies the network segment type. The type can be public or internal.

    +
    • public: indicates the public subnet CIDR block.
    • internal: indicates the private subnet CIDR block.
    +

    The default value is internal.

    +

    ports

    +

    Array of objects

    +

    Lists the port mappings opened to the VPC endpoint service. For details, see Table 6.

    +

    Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.

    +

    tcp_proxy

    +

    String

    +

    Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:

    +
    • TCP TOA: The client information is inserted into field tcp option and transmitted to the server.
      NOTE:

      TCP TOA is supported only when the backend resource is OBS.

      +
      +
    • Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
    +

    This parameter is available only when the server can parse fields tcp option and tcp payload.

    +

    The values are as follows:

    +
    • close: indicates that the TOA and Proxy Protocol methods are neither used.
    • toa_open: indicates that the TOA method is used.
    • proxy_open: indicates that the Proxy Protocol method is used.
    • open: indicates that the TOA and Proxy Protocol methods are both used.
    +

    The default value is close.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 7.

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Table 6 Port mapping parameters

    Parameter

    +

    Type

    +

    Description

    +

    client_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint.

    +

    This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535

    +

    server_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint service.

    +

    This port is provided by the backend service to provide services. Supported range: 1 to 65535

    +

    protocol

    +

    String

    +

    Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.

    +
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 7 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    +
+
+
  • Example response
    {
+    "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
+    "port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
+    "vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
+    "pool_id":"5289d3c2-8882-4871-a3c2-d380272eed80",
+    "status":"available",
+    "approval_enabled":false,
+    "service_name":"test123",
+    "service_type":"interface",
+    "server_type":"VM",
+    "project_id":"6e9dfd51d1124e8d8498dce894923a0d",
+    "created_at":"2018-01-30T07:42:01.174",
+    "ports":
+              [
+                {
+                    "client_port":8080,
+                    "server_port":90,
+                    "protocol":"TCP"
+                },
+                {
+                    "client_port":8081,
+                    "server_port":80,
+                    "protocol":"TCP"
+                }
+              ]
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0202.html b/docs/vpcep/api-ref/vpcep_06_0202.html new file mode 100644 index 000000000..dfce1c9f4 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0202.html @@ -0,0 +1,323 @@ + + +

Querying Details of a VPC Endpoint Service

+

Function

This API is used to query details of a VPC endpoint service.

+
+

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description

    None

    +
  • Example request
    This request is to query details of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +

    port_id

    +

    String

    +

    Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:

    +
    • If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
    • If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
    • If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
    +

    pool_id

    +

    String

    +

    Specifies the ID of the cluster associated with the target VPCEP resource.

    +

    vip_port_id

    +

    String

    +

    Specifies the ID of the virtual NIC to which the virtual IP address is bound.

    +

    This parameter is returned only when port_id is set to VIP.

    +

    service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    server_type

    +

    String

    +

    Specifies the resource type.

    +
    • VM: indicates the ECS.
    • VIP: indicates the virtual IP address.
    • LB: indicates the enhanced load balancer.
    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.

    +

    approval_enabled

    +

    Boolean

    +

    Specifies whether connection approval is required.

    +
    • false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
    • true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
    +

    status

    +

    String

    +

    Specifies the status of the VPC endpoint service.

    +
    • creating: indicates the VPC endpoint service is being created.
    • available: indicates the VPC endpoint service is connectable.
    • failed: indicates the creation of the VPC endpoint service failed.
    • deleting: indicates the VPC endpoint service is being deleted.
    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service.

    +
    There are two types of VPC endpoint services: interface and gateway.
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    cidr_type

    +

    String

    +

    Specifies the network segment type. The type can be public or internal.

    +
    • public: indicates the public subnet CIDR block.
    • internal: indicates the private subnet CIDR block.
    +

    The default value is internal.

    +

    ports

    +

    Array of objects

    +

    Lists the port mappings opened to the VPC endpoint service. For details, see Table 3.

    +

    Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.

    +

    tcp_proxy

    +

    String

    +

    Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:

    +
    • TCP TOA: The client information is inserted into field tcp option and transmitted to the server.
      NOTE:

      TCP TOA is supported only when the backend resource is OBS.

      +
      +
    • Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
    +

    This parameter is available only when the server can parse fields tcp option and tcp payload.

    +

    The values are as follows:

    +
    • close: indicates that the TOA and Proxy Protocol methods are neither used.
    • toa_open: indicates that the TOA method is used.
    • proxy_open: indicates that the Proxy Protocol method is used.
    • open: indicates that the TOA and Proxy Protocol methods are both used.
    +

    The default value is close.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 4.

    +

    error

    +

    Array of objects

    +

    Specifies the error message.

    +

    This field is returned when the status of the VPC endpoint service changes to failed. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 3 Port mapping parameters

    Parameter

    +

    Type

    +

    Description

    +

    client_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint.

    +

    This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535

    +

    server_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint service.

    +

    This port is provided by the backend service to provide services. Supported range: 1 to 65535

    +

    protocol

    +

    String

    +

    Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 5 Error parameters

    Parameter

    +

    Type

    +

    Description

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    error_message

    +

    String

    +

    Specifies the error message.

    +
    +
    +
+
+
  • Example response
    {
+    "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
+    "port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
+    "vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
+    "pool_id":"5289d3c2-8882-4871-a3c2-d380272eed80",
+    "status":"available",
+    "approval_enabled":false,
+    "service_name":"test123",
+    "service_type":"interface",
+    "server_type":"VM",
+    "project_id":"6e9dfd51d1124e8d8498dce894923a0d",
+    "created_at":"2018-01-30T07:42:01.174",
+    "ports":
+              [
+                {
+                    "client_port":8080,
+                    "server_port":90,
+                    "protocol":"TCP"
+                },
+                {
+                    "client_port":8081,
+                    "server_port":80,
+                    "protocol":"TCP"
+                }
+              ]
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0203.html b/docs/vpcep/api-ref/vpcep_06_0203.html new file mode 100644 index 000000000..a9076eae9 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0203.html @@ -0,0 +1,411 @@ + + +

Modifying a VPC Endpoint Service

+

Function

This API is used to modify a VPC endpoint service.

+
+

URI

PUT /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    approval_enabled

    +

    No

    +

    Boolean

    +

    Specifies whether connection approval is required.

    +
    • false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
    • true: indicates that connection approval is required. The created VPC endpoint is unavailable until the owner of the associated VPC endpoint service approves the connection.
    +

    The default value is true.

    +

    service_name

    +

    No

    +

    String

    +

    Specifies the name of the VPC endpoint service. The name can contain a maximum of 16 characters, including letters, digits, underscores (_), and hyphens (-).

    +

    ports

    +

    No

    +

    Array of objects

    +

    Lists the port mappings opened to the VPC endpoint service. For details, see Table 3.

    +

    Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same. A maximum of 200 port mappings can be created at a time.

    +

    port_id

    +

    No

    +

    String

    +

    Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:

    +
    • If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer. For details, see response field vip_port_id in Querying Details of a Load Balancer in the Elastic Load Balancing API Reference.
    • If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed. For details, see Querying NICs of an ECS in the Elastic Load Balancing API Reference.
    • If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
    +

    vip_port_id

    +

    No

    +

    String

    +

    Specifies the ID of the virtual NIC to which the virtual IP address is bound.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Port mapping parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    client_port

    +

    No

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint.

    +

    This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535

    +

    server_port

    +

    No

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint service.

    +

    This port is provided by the backend service to provide services. Supported range: 1 to 65535

    +

    protocol

    +

    No

    +

    String

    +

    Specifies the protocol used in port mappings. The protocol can be TCP or UDP. The default protocol is TCP.

    +
    +
    +
  • Example request
    This request is to modify the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
    PUT https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88
    +
    +
    {
+   "approval_enabled":true,
+   "service_name":"test",
+   "ports":[
+             {
+                "client_port":8081,
+                "server_port":22,
+                "protocol":"TCP"
+             },
+             {
+                "client_port":8082,
+                "server_port":23,
+                "protocol":"TCP"
+             }
+           ]
+}
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +

    port_id

    +

    String

    +

    Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:

    +
    • If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
    • If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
    • If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
    +

    pool_id

    +

    String

    +

    Specifies the ID of the cluster associated with the target VPCEP resource.

    +

    vip_port_id

    +

    String

    +

    Specifies the ID of the virtual NIC to which the virtual IP address is bound.

    +

    service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    server_type

    +

    String

    +

    Specifies the resource type.

    +
    • VM: indicates the ECS.
    • VIP: indicates the virtual IP address.
    • LB: indicates the enhanced load balancer.
    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.

    +

    approval_enabled

    +

    Boolean

    +

    Specifies whether connection approval is required.

    +
    • false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
    • true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
    +

    status

    +

    String

    +

    Specifies the status of the VPC endpoint service.

    +

    available: indicates the VPC endpoint service is connectable.

    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service.

    +
    There are two types of VPC endpoint services: interface and gateway.
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    cidr_type

    +

    String

    +

    Specifies the network segment type. The type can be public or internal.

    +
    • public: indicates the public subnet CIDR block.
    • internal: indicates the private subnet CIDR block.
    +

    The default value is internal.

    +

    ports

    +

    Array of objects

    +

    Lists the port mappings opened to the VPC endpoint service. For details, see Table 5.

    +

    Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.

    +

    tcp_proxy

    +

    String

    +

    Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:

    +
    • TCP TOA: The client information is inserted into field tcp option and transmitted to the server.
      NOTE:

      TCP TOA is supported only when the backend resource is OBS.

      +
      +
    • Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
    +

    This parameter is available only when the server can parse fields tcp option and tcp payload.

    +

    The values are as follows:

    +
    • close: indicates that the TOA and Proxy Protocol methods are neither used.
    • toa_open: indicates that the TOA method is used.
    • proxy_open: indicates that the Proxy Protocol method is used.
    • open: indicates that the TOA and Proxy Protocol methods are both used.
    +

    The default value is close.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 6.

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Table 5 Port mapping parameters

    Parameter

    +

    Type

    +

    Description

    +

    client_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint.

    +

    This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535

    +

    server_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint service.

    +

    This port is provided by the backend service to provide services. Supported range: 1 to 65535

    +

    protocol

    +

    String

    +

    Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.

    +
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 6 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    +
+
+
  • Example response
    {
+    "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
+    "port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
+    "vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
+    "pool_id":"5289d3c2-8882-4871-a3c2-d380272eed80",
+    "status":"available",
+    "approval_enabled":false,
+    "service_name":"test123",
+    "service_type":"interface",
+    "server_type":"VM",
+    "project_id":"6e9dfd51d1124e8d8498dce894923a0d",
+    "created_at":"2018-01-30T07:42:01.174",
+    "ports":
+              [
+                {
+                    "client_port":8080,
+                    "server_port":90,
+                    "protocol":"TCP"
+                },
+                {
+                    "client_port":8081,
+                    "server_port":80,
+                    "protocol":"TCP"
+                }
+              ]
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0204.html b/docs/vpcep/api-ref/vpcep_06_0204.html new file mode 100644 index 000000000..4cbe0bc8f --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0204.html @@ -0,0 +1,50 @@ + + +

Deleting a VPC Endpoint Service

+

Function

This API is used to delete a VPC endpoint service.

+
+

URI

DELETE /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description

    None

    +
  • Example request
    This request is to delete the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
    DELETE https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88
    +
    +
+
+

Response

None

+
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0205.html b/docs/vpcep/api-ref/vpcep_06_0205.html new file mode 100644 index 000000000..797c8fd90 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0205.html @@ -0,0 +1,418 @@ + + +

Querying VPC Endpoint Services

+

Function

This API is used to query VPC endpoint services.

+
+

URI

GET /v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}&status={status}

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    endpoint_service_name

    +

    No

    +

    String

    +

    Specifies the name of the VPC endpoint service. The name is not case-sensitive and supports fuzzy match.

    +

    id

    +

    No

    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +

    status

    +

    No

    +

    String

    +

    Specifies the status of the VPC endpoint service.

    +
    • creating: indicates the VPC endpoint service is being created.
    • available: indicates the VPC endpoint service is connectable.
    • failed: indicates the creation of the VPC endpoint service failed.
    • deleting: indicates the VPC endpoint service is being deleted.
    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the sorting field of the VPC endpoint service list. The field can be:

    +
    • create_at: indicates that VPC endpoint services are sorted by creation time.
    • update_at: indicates that VPC endpoint services are sorted by update time.
    +

    The default field is create_at.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting method of the VPC endpoint service list. The method can be:

    +
    • desc: indicates that VPC endpoint services are sorted in the descending order.
    • asc: indicates that VPC endpoint services are sorted in the ascending order.
    +

    The default method is desc.

    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the maximum number of VPC endpoint services displayed on each page.

    +

    The number ranges from 0 to 1000 and is generally 10, 20, or 50. The default number is 10.

    +

    offset

    +

    No

    +

    Integer

    +

    Specifies the offset.

    +

    All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +
    +
    +
  • Example request
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    endpoint_services

    +

    Array of objects

    +

    Lists the VPC endpoint services. For details, see Table 4.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of VPC endpoint services that meet the search criteria. The number is not affected by the limit or offset.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 endpoint_service parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +

    port_id

    +

    String

    +

    Specifies the ID for identifying the backend resource of the VPC endpoint service. The ID is in the form of the UUID. The values are as follows:

    +
    • If the backend resource is an enhanced load balancer, the value is the ID of the port bound to the private IP address of the load balancer.
    • If the backend resource is an ECS, the value is the NIC ID of the ECS where the VPC endpoint service is deployed.
    • If the backend resource is a virtual IP address, the value is the NIC ID of the physical server where virtual resources are created.
    +

    vip_port_id

    +

    String

    +

    Specifies the ID of the virtual NIC to which the virtual IP address is bound.

    +

    This parameter is returned only when port_id is set to VIP.

    +

    service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    server_type

    +

    String

    +

    Specifies the resource type.

    +
    • VM: indicates the ECS.
    • VIP: indicates the virtual IP address.
    • LB: indicates the enhanced load balancer.
    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC to which the backend resource of the VPC endpoint service belongs.

    +

    approval_enabled

    +

    Boolean

    +

    Specifies whether connection approval is required.

    +
    • false: indicates that connection approval is not required. The created VPC endpoint is in the Accepted state.
    • true: indicates that connection approval is required. The created VPC endpoint is in the Pending acceptance state until the owner of the associated VPC endpoint service approves the connection.
    +

    status

    +

    String

    +

    Specifies the status of the VPC endpoint service.

    +
    • creating: indicates the VPC endpoint service is being created.
    • available: indicates the VPC endpoint service is connectable.
    • failed: indicates the creation of the VPC endpoint service failed.
    • deleting: indicates the VPC endpoint service is being deleted.
    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service.

    +
    There are two types of VPC endpoint services: interface and gateway.
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    ports

    +

    Array of objects

    +

    Lists the port mappings opened to the VPC endpoint service. For details, see Table 5.

    +

    Duplicate port mappings are not allowed in the same VPC endpoint service. If multiple VPC endpoint services share the same port_id value, service ports and terminal ports of all these endpoint services cannot be duplicated when the protocol is the same.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 6.

    +

    connection_count

    +

    Integer

    +

    Specifies the number of Creating or Accepted VPC endpoints under the VPC endpoint service.

    +

    tcp_proxy

    +

    String

    +

    Specifies whether the client IP address and port number or marker_id information is transmitted to the server. The following methods are supported:

    +
    • TCP TOA: The client information is inserted into field tcp option and transmitted to the server.
      NOTE:

      TCP TOA is supported only when the backend resource is OBS.

      +
      +
    • Proxy Protocol: The client information is inserted into field tcp payload and transmitted to the server.
    +

    This parameter is available only when the server can parse fields tcp option and tcp payload.

    +

    The values are as follows:

    +
    • close: indicates that the TOA and Proxy Protocol methods are neither used.
    • toa_open: indicates that the TOA method is used.
    • proxy_open: indicates that the Proxy Protocol method is used.
    • open: indicates that the TOA and Proxy Protocol methods are both used.
    +

    The default value is close.

    +

    error

    +

    Array of objects

    +

    Specifies the error message.

    +

    This field is returned when the status of the VPC endpoint service changes to failed. For details, see Table 7.

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Table 5 Port mapping parameters

    Parameter

    +

    Type

    +

    Description

    +

    client_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint.

    +

    This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service. Supported range: 1 to 65535

    +

    server_port

    +

    Integer

    +

    Specifies the port for accessing the VPC endpoint service.

    +

    This port is provided by the backend service to provide services. Supported range: 1 to 65535

    +

    protocol

    +

    String

    +

    Specifies the protocol used in port mappings. The protocol can be TCPor UDP. The default protocol is TCP.

    +
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 6 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 7 Error parameters

    Parameter

    +

    Type

    +

    Description

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    error_message

    +

    String

    +

    Specifies the error message.

    +
    +
    +
+
+
  • Example response
    {
+   "endpoint_services":[
+         {
+           "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
+           "port_id":"4189d3c2-8882-4871-a3c2-d380272eed88",
+           "vpc_id":"4189d3c2-8882-4871-a3c2-d380272eed80",
+           "status":"available",
+           "approval_enabled":false,
+           "service_name":"test123",
+           "server_type":"VM",
+           "service_type":"interface",
+           "ports":[
+                {
+                  "client_port":8080,
+                  "server_port":90,
+                  "protocol":"TCP"
+                },
+                {
+                  "client_port":8081,
+                  "server_port":80,
+                  "protocol":"TCP"
+                }
+             ],
+           "project_id":"6e9dfd51d1124e8d8498dce894923a0d",
+           "created_at":"2018-01-30T07:42:01.174",
+           "update_at":"2018-01-30T07:42:01.174"
+         }
+     ],
+   "total_count":100
+}
    +
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0206.html b/docs/vpcep/api-ref/vpcep_06_0206.html new file mode 100644 index 000000000..edcf7adb9 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0206.html @@ -0,0 +1,239 @@ + + +

Querying Connections of a VPC Endpoint Service

+

Function

This API is used to query connections of a VPC endpoint service. The marker ID is the unique ID of each connection.

+
+

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections?id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    No

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    marker_id

    +

    No

    +

    String

    +

    Specifies the packet ID of the VPC endpoint.

    +

    status

    +

    No

    +

    String

    +

    Specifies the connection status of the VPC endpoint.

    +
    • pendingAcceptance: indicates that the VPC endpoint is pending acceptance.
    • accepted: indicates the VPC endpoint has been accepted.
    • rejected: indicates the VPC endpoint has been rejected.
    • failed: indicates the creation of the VPC endpoint failed.
    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the basis for sequencing VPC endpoint services. The value can be:

    +
    • create_at: indicates the creation time of the VPC endpoint.
    • update_at: indicates the update time of the VPC endpoint.
    +

    The default field is create_at.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting method of the VPC endpoint list. The value can be:

    +
    • desc: indicates that VPC endpoints are sorted in the descending order.
    • asc: indicates that VPC endpoints are sorted in the ascending order.
    +

    The default method is desc.

    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the maximum number of connections displayed on each page.

    +

    The value ranges from 0 to 1000 and is generally 10, 20, or 50. The default value is 10.

    +

    offset

    +

    No

    +

    Integer

    +

    Specifies the offset.

    +

    All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +
    +
    +
  • Example request
    This request is to query connections of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    connections

    +

    Array of objects

    +

    Lists the connections. For details, see Table 4.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of VPC endpoints that meet the search criteria. The number is not affected by the limit or offset.

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Connection parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    marker_id

    +

    Integer

    +

    Specifies the packet ID of the VPC endpoint.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    domain_id

    +

    String

    +

    Specifies the user's domain ID.

    +

    status

    +

    String

    +

    Specifies the connection status of the VPC endpoint.

    +
    • pendingAcceptance: indicates that the VPC endpoint is pending acceptance.
    • creating: indicates the VPC endpoint is being created.
    • accepted: indicates the VPC endpoint has been accepted.
    • rejected: indicates the VPC endpoint has been rejected.
    • failed: indicates the creation of the VPC endpoint failed.
    • deleting: indicates the VPC endpoint is being deleted.
    +
    +
    +
    +
+
+
  • Example response
    {
+  "connections": [
+    {
+      "id": "adb7b229-bb11-4072-bcc0-3327cd784263",
+      "status": "accepted",
+      "marker_id": 16777510,
+      "domain_id": "5fc973eea581490997e82ea11a1df31f",
+      "created_at": "2018-09-17T11:10:11Z",
+      "updated_at": "2018-09-17T11:10:12Z"
+    },
+    {
+      "id": "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea",
+      "status": "accepted",
+      "marker_id": 16777513,
+      "domain_id": "5fc973eea581490997e82ea11a1df31f",
+      "created_at": "2018-09-17T07:28:56Z",
+      "updated_at": "2018-09-17T07:28:58Z"
+    }
+  ],
+  "total_count":2
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0207.html b/docs/vpcep/api-ref/vpcep_06_0207.html new file mode 100644 index 000000000..3f78d3529 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0207.html @@ -0,0 +1,217 @@ + + +

Accepting or Rejecting a VPC Endpoint

+

Function

This API is used to accept or reject a VPC endpoint for a VPC endpoint service.

+
+

URI

POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections/action

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    action

    +

    Yes

    +

    String

    +

    Specifies whether to accept or reject a VPC endpoint for a VPC endpoint service.

    +
    • receive: means to accept the VPC endpoint.
    • reject: means to reject the VPC endpoint.
    +

    endpoints

    +

    Yes

    +

    Array of strings

    +

    Lists VPC endpoint IDs.

    +

    Each request accepts or rejects only one VPC endpoint.

    +
    +
    +
  • Example request
    This request is to accept VPC endpoint 705290f3-0d00-41f2-aedc-71f09844e879 to connect to VPC endpoint service 4189d3c2-8882-4871-a3c2-d380272eed88.
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections/action
    +
    +
    { 
+   "endpoints":["705290f3-0d00-41f2-aedc-71f09844e879"],
+   "action": "receive"
+}
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    connections

    +

    Array of objects

    +

    Lists the connections. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Connection parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    marker_id

    +

    Integer

    +

    Specifies the packet ID of the VPC endpoint.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    domain_id

    +

    String

    +

    Specifies the user's domain ID.

    +

    status

    +

    String

    +

    Specifies the connection status of the VPC endpoint.

    +
    • accepted: indicates the VPC endpoint has been accepted.
    • rejected: indicates the VPC endpoint has been rejected.
    +

    error

    +

    Array of objects

    +

    Specifies the error message.

    +

    This field is returned when the status of the VPC endpoint service changes to failed. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 5 Error parameters

    Parameter

    +

    Type

    +

    Description

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    error_message

    +

    String

    +

    Specifies the error message.

    +
    +
    +
+
+
  • Example response
    {
+  "connections":
+ [
+   {
+      "id":"4189d3c2-8882-4871-a3c2-d380272eed83",
+      "status":"accepted",
+      "marker_id":422321321312321321,
+      "domain_id":"6e9dfd51d1124e8d8498dce894923a0d",
+      "created_at":"2018-01-30T07:42:01.174",
+      "updated_at":"2018-01-30T07:42:01.174"
+       }
+   ]
+}
    +

    or

    +
    {
+  "error_code": "Endpoint.2013"
+  "error_msg": "The endpoint does not belong to the endpoint service."
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0208.html b/docs/vpcep/api-ref/vpcep_06_0208.html new file mode 100644 index 000000000..badb8f34f --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0208.html @@ -0,0 +1,189 @@ + + +

Querying the Whitelist Records of a VPC Endpoint Service

+

Function

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.

+
+
+

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions?permission={permission}&sort_dir={sort_dir}&limit={limit}&offset={offset}

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    permission

    +

    No

    +

    String

    +

    Specifies the authorized domain ID. The format is the iam:domain::domain_id.

    +

    domain_id indicates the domain ID, for example, iam:domain::6e9dfd51d1124e8d8498dce894923a0d

    +

    Fuzzy search is supported.

    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the maximum number of whitelist records displayed on each page.

    +

    The value ranges from 0 to 500 and is generally 10, 20, or 50. The default value is 10.

    +

    offset

    +

    No

    +

    Integer

    +

    Specifies the offset.

    +

    All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the basis for sequencing whitelist records. The value is create_at, indicating the time of adding each whitelist record.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting method of the whitelist record list. The value can be:

    +
    • desc: indicates that whitelist records are sorted in the descending order.
    • asc: indicates that whitelist records are sorted in the ascending order.
    +

    The default method is desc.

    +
    +
    +
  • Example request
    This request is to query whitelist records of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    permissions

    +

    Array of objects

    +

    Lists the whitelist records. For details, see Table 4.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of whitelist records that meet the search criteria. The number is not affected by the limit or offset.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 4 Whitelist record parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the permission.

    +

    permission

    +

    String

    +

    Lists the whitelist records.

    +

    The permission format is iam:domain:: 6e9dfd51d1124e8d8498dce894923a0d or *. * indicates all users can connect to the VPC endpoint service. 6e9dfd51d1124e8d8498dce894923a0d indicates the domain ID of the user.

    +

    created_at

    +

    String

    +

    create_at: indicates the time of adding the whitelist record.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +
    +
    +
+
+
  • Example response
    {
+  "permissions":
+   [
+          {
+                "id":"f2659906-c622-480a-83e9-ef42bdb67b90",
+                "permission":"*",
+                "created_at":"2018-10-18T13:26:40Z"
+            }
+    ],
+ "total_count":1
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0209.html b/docs/vpcep/api-ref/vpcep_06_0209.html new file mode 100644 index 000000000..5fd55e1f4 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0209.html @@ -0,0 +1,133 @@ + + +

Batch Adding or Deleting Whitelist Records of a VPC Endpoint Service

+

Function

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.

+
+
+

URI

POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/action

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_service_id

+

Yes

+

Specifies the ID of the VPC endpoint service.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    permissions

    +

    Yes

    +

    Array of strings

    +

    Lists the whitelist records.

    +

    The record is in the iam:domain::domain_id format.

    +

    Fields are described as follows:

    +
    • iam:domain:: is fixed.
    • domain_id indicates the domain ID of the target user.

      The value contains 1 to 64 characters, including letters, digits, and asterisks (*). If you enter an asterisk, this VPC endpoint service allows access from any VPC endpoints.

      +

      Example: iam:domain::6e9dfd51d1124e8d8498dce894923a0dd

      +
    +

    action

    +

    Yes

    +

    String

    +

    Specifies the operation to be performed.

    +

    The value is add or remove.

    +
    +
    +
  • Example request

    This request is to add a whitelist record to the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.

    +
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions/action
    +
    {
+    "permissions":
+      [
+        "iam:domain::fc973eea581490997e82ea11a1d0101"
+      ],
+    "action":"add"
+}
    +

    This request is to delete a whitelist record from the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88.

    +
    POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/iam:domain::5fc973eea581490997e82ea11a1d0101/action
    +
    {
+  "permissions":
+    [
+      "iam:domain::5fc973eea581490997e82ea11a1d0101"
+    ],
+   "action":"remove"
+}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    permissions

    +

    Array of strings

    +

    Lists the whitelist records.

    +

    The permission format is iam:domain:: 6e9dfd51d1124e8d8498dce894923a0d or *. * indicates all users can connect to the VPC endpoint service. 6e9dfd51d1124e8d8498dce894923a0d indicates the domain ID of the user.

    +
    +
    +
+
+
  • Example response
    {
+  "permissions":
+    [
+      "iam:domain::5fc973eea581490997e82ea11a1d0101",
+      "iam:domain::5fc973eea581490997e82ea11a1d0102"
+      ]
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoint Services
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0300.html b/docs/vpcep/api-ref/vpcep_06_0300.html new file mode 100644 index 000000000..5a129a611 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0300.html @@ -0,0 +1,25 @@ + + +

APIs for Managing VPC Endpoints

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0301.html b/docs/vpcep/api-ref/vpcep_06_0301.html new file mode 100644 index 000000000..8117cd117 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0301.html @@ -0,0 +1,222 @@ + + +

Querying Public VPC Endpoint Services

+

Function

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.

+
+

URI

GET /v1/{project_id}/vpc-endpoint-services/public?limit={limit}&offset={offset}&endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}&sort_key={sort_key}&sort_dir={sort_dir}

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the maximum number of public VPC endpoint services displayed on each page.

    +

    The value ranges from 0 to 1000 and is generally 10, 20, or 50. The default value is 10.

    +

    offset

    +

    No

    +

    Integer

    +

    Specifies the offset.

    +

    All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +

    endpoint_service_name

    +

    No

    +

    String

    +

    Specifies the name of the public VPC endpoint service. The value is not case-sensitive and supports fuzzy match.

    +

    id

    +

    No

    +

    String

    +

    Specifies the unique ID of the public VPC endpoint service.

    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the sorting field of the VPC endpoint service list. The field can be:

    +
    • create_at: indicates that VPC endpoint services are sorted by creation time.
    • update_at: indicates that VPC endpoint services are sorted by update time.
    +

    The default field is create_at.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting method of the VPC endpoint service list. The method can be:

    +
    • desc: indicates that VPC endpoint services are sorted in the descending order.
    • asc: indicates that VPC endpoint services are sorted in the ascending order.
    +

    The default method is desc.

    +
    +
    +
+
+
  • Example request
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/public
    +
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    endpoint_services

    +

    Array of objects

    +

    Lists the VPC endpoint services. For details, see Table 4.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of public VPC endpoint services that meet the search criteria. The number is not affected by the limit or offset.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 endpoint_service parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the public VPC endpoint service.

    +

    owner

    +

    String

    +

    Specifies the owner of the VPC endpoint service.

    +

    service_name

    +

    String

    +

    Specifies the name of the public VPC endpoint service.

    +

    service_type

    +

    String

    +
    Specifies the type of the VPC endpoint service. The value can be:
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    is_charge

    +

    Boolean

    +

    Specifies whether the associated VPC endpoint carries a charge.

    +
    • true: indicates that the associated VPC endpoint carries a charge.
    • false: indicates that the associated VPC endpoint does not a charge.
    +
    +
    +
+
+
  • Example response
    {
+  "endpoint_services": [
+    {
+      "id": "b0e22f6f-26f4-461c-b140-d873464d4fa0",
+      "owner": "example"
+      "service_name": "test123",
+      "service_type": "interface",
+      "created_at": "2018-09-10T13:13:23Z",
+      "is_charge": "true"
+    },
+	{
+      "id": "26391a76-546b-42a9-b2fc-496ec68c0e4d",
+      "owner": "example"
+      "service_name":  "OBS",
+      "service_type": "gateway",
+      "created_at": "2019-03-28T09:30:27Z",
+      "is_charge": "true"
+    }
+  ],
+  "total_count": 2
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoints
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0302.html b/docs/vpcep/api-ref/vpcep_06_0302.html new file mode 100644 index 000000000..3516b98d5 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0302.html @@ -0,0 +1,136 @@ + + +

Querying Basic Information of a VPC Endpoint Service

+

Function

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 also be used by other users to query basic information of your VPC endpoint service, without exposing your server information.

+
+

URI

GET /v1/{project_id}/vpc-endpoint-services/describe?endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    endpoint_service_name

    +

    No

    +
    NOTE:

    Either this parameter or the id parameter must be selected.

    +
    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    id

    +

    No

    +
    NOTE:

    Either this parameter or the endpoint_service_name parameter must be selected.

    +
    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +
    +
    +
  • Example request
    GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id={4189d3c2-8882-4871-a3c2-d380272eed83}
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint service.

    +

    service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.

    +
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint service.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    is_charge

    +

    Boolean

    +

    Specifies whether the associated VPC endpoint carries a charge.

    +
    • true: indicates that the associated VPC endpoint carries a charge.
    • false: indicates that the associated VPC endpoint does not a charge.
    +
    +
    +
+
+
  • Example response
    {
+  "id": "9d4c1028-1336-4556-9881-b5d807c1b8a8",
+  "service_name": "test123",
+  "service_type": "interface",
+  "created_at": "2018-09-17T07:28:31Z",
+  "is_charge": "true"
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoints
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0303.html b/docs/vpcep/api-ref/vpcep_06_0303.html new file mode 100644 index 000000000..4912a2e39 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0303.html @@ -0,0 +1,409 @@ + + +

Creating a VPC Endpoint

+

Function

This API is used to create a VPC endpoint for accessing a VPC endpoint service.

+
+

URI

POST /v1/{project_id}/vpc-endpoints

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    subnet_id

    +

    No

    +
    NOTE:

    This parameter is mandatory to create an interface VPC endpoint.

    +
    +

    String

    +

    The ID must be the ID of the subnet created in the VPC specified by vpc_id and in the format of the UUID.

    +

    For details, see response field id in Querying Subnet Details in the Virtual Private Cloud API Reference.

    +

    This parameter is mandatory only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +
    NOTE:
    • The CIDR block of the VPC subnet cannot overlap with 198.19.128.0/20.
    • The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/20.
    +
    +

    endpoint_service_id

    +

    Yes

    +

    String

    +

    Specifies the ID of the VPC endpoint service.

    +

    You can obtain the ID of the VPC endpoint service to be connected by performing operations in Querying Basic Information of a VPC Endpoint Service.

    +

    vpc_id

    +

    Yes

    +

    String

    +

    Specifies the ID of the VPC where the VPC endpoint is to be created.

    +

    For details, see response field id in Querying VPC Details in the Virtual Private Cloud API Reference.

    +

    enable_dns

    +

    No

    +

    Boolean

    +

    Specifies whether to create a private domain name.

    +
    • true: indicates that a private domain name is created.
    • false: indicates that a private domain name is not created.
    +

    The default value is false.

    +
    NOTE:

    When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter enable_dns is set to true or false.

    +
    +

    tags

    +

    No

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 3.

    +

    A maximum of 20 tags can be added to each VPC endpoint.

    +

    routetables

    +

    No

    +

    Array of objects

    +

    Lists the IDs of route tables.

    +

    For details, see response field id in Querying a VPC Route in the Virtual Private Cloud API Reference.

    +

    This parameter is mandatory only if you create a VPC endpoint for connecting to a gateway VPC endpoint service.

    +
    NOTE:

    If this parameter is not configured, use the default route table.

    +
    +

    port_ip

    +

    No

    +

    String

    +

    Specifies the IP address for accessing the associated VPC endpoint service.

    +

    You can specify IP addresses for accessing the associated VPC endpoint service when creating a VPC endpoint. Only IPv4 addresses are supported.

    +

    This parameter is mandatory only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    whitelist

    +

    No

    +

    Array of strings

    +

    Specifies the whitelist for controlling access to the VPC endpoint.

    +

    IPv4 addresses or CIDR blocks can be specified to control access when you create a VPC endpoint.

    +

    This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    enable_whitelist

    +

    No

    +

    Boolean

    +

    Specifies whether to enable access control.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 ResourceTags parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    No

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).

    +

    value

    +

    No

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).

    +
    +
    +
  • Example request
    POST https://{endpoint}/v1/{project_id}/vpc-endpoints
    +
    { 
+"subnet_id": "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
+"vpc_id": "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
+"tags":[
+            {
+                "key":"test1",
+                "value":"test1"
+            }
+       ],
+"endpoint_service_id":"e0c748b7-d982-47df-ba06-b9c8c7650c1a",
+"enable_dns":true
+}
    +
    +

    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.

    +
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +

    You can view those VPC endpoint services that are configured by operations people and are visible and accessible to all users. For detailed steps, see Querying Public VPC Endpoint Services. Perform the operations in Creating a VPC Endpoint Service to create an interface VPC endpoint service.

    +

    status

    +

    String

    +

    Specifies the connection status of the VPC endpoint.

    +
    • pendingAcceptance: indicates that the VPC endpoint is pending acceptance.
    • creating: indicates the VPC endpoint is being created.
    • accepted: indicates the VPC endpoint has been accepted.
    • failed: indicates the creation of the VPC endpoint failed.
    +

    active_status

    +

    String

    +

    Specifies the domain status.

    +
    • frozen: indicates that the domain is frozen.
    • active: indicates that the domain is normal.
    +

    endpoint_service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    marker_id

    +

    Integer

    +

    Specifies the packet ID of the VPC endpoint.

    +

    endpoint_service_id

    +

    String

    +

    Specifies the ID of the VPC endpoint service.

    +

    enable_dns

    +

    Boolean

    +

    Specifies whether to create a private domain name.

    +
    • true: indicates that a private domain name is created.
    • false: indicates that a private domain name is not created.
    +
    NOTE:

    When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter enable_dns is set to true or false.

    +
    +

    dns_names

    +

    Array of strings

    +

    Specifies the domain name for accessing the associated VPC endpoint service.

    +

    This parameter is only available when enable_dns is set to true.

    +

    subnet_id

    +

    String

    +

    Specifies the ID of the subnet in the VPC specified by vpc_id. The ID is in the UUID format.

    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC where the VPC endpoint is to be created.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 5.

    +

    whitelist

    +

    Array of strings

    +

    Specifies the whitelist for controlling access to the VPC endpoint.

    +

    If you do not specify this parameter, an empty whitelist is returned.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    enable_whitelist

    +

    Boolean

    +

    Specifies whether to enable access control.

    +
    • true: indicates that access control is enabled.
    • false: indicates that access control is disabled.
    +

    If you do not specify this parameter, the whitelist is not enabled.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    routetables

    +

    Array of strings

    +

    Lists the IDs of route tables.

    +

    If you do not specify this parameter, the route table ID of the VPC is returned.

    +

    This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 5 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    +
+
+
  • Example response
    {
+    "id": "4189d3c2-8882-4871-a3c2-d380272eed83",
+    "service_type": "interface",
+    "marker_id": 322312312312,
+    "status": "creating",
+    "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed83",
+    "enable_dns": false,
+    "endpoint_service_name": "test123",
+    "endpoint_service_id": "test123",
+    "project_id": "6e9dfd51d1124e8d8498dce894923a0d",
+    "whitelist": [
+        "127.0.0.1"
+    ],
+    "enable_whitelist": true,
+    "created_at": "2018-01-30T07:42:01.174",
+    "update_at": "2018-01-30T07:42:01.174",
+    "tags": [
+        {
+            "key": "test1",
+            "value": "test1"
+        }
+    ]
+}
    +

    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoints
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0304.html b/docs/vpcep/api-ref/vpcep_06_0304.html new file mode 100644 index 000000000..761e47c0f --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0304.html @@ -0,0 +1,299 @@ + + +

Querying Details of a VPC Endpoint

+

Function

This API is used to query details of a VPC endpoint.

+
+

URI

GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_id

+

Yes

+

Specifies the ID of the VPC endpoint.

+
+
+
+
+

Request

  • Parameter description

    None

    +
  • Example request
    This request is to query details of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed83.
    GET https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2-d380272eed83
    +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.

    +
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +

    status

    +

    String

    +

    Specifies the connection status of the VPC endpoint.

    +
    • pendingAcceptance: indicates that the VPC endpoint is pending acceptance.
    • creating: indicates the VPC endpoint is being created.
    • accepted: indicates the VPC endpoint has been accepted.
    • rejected: indicates the VPC endpoint has been rejected.
    • failed: indicates the creation of the VPC endpoint failed.
    • deleting: indicates the VPC endpoint is being deleted.
    +

    active_status

    +

    String

    +

    Specifies the domain status.

    +
    • frozen: indicates that the domain is frozen.
    • active: indicates that the domain is normal.
    +

    endpoint_service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    marker_id

    +

    Integer

    +

    Specifies the packet ID of the VPC endpoint.

    +

    endpoint_service_id

    +

    String

    +

    Specifies the ID of the VPC endpoint service.

    +

    enable_dns

    +

    Boolean

    +

    Specifies whether to create a private domain name.

    +
    • true: indicates that a private domain name is created.
    • false: indicates that a private domain name is not created.
    +
    NOTE:

    When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter enable_dns is set to true or false.

    +
    +

    dns_names

    +

    Array of strings

    +

    Specifies the domain name for accessing the associated VPC endpoint service.

    +

    This parameter is only available when enable_dns is set to true.

    +

    ip

    +

    String

    +

    Specifies the IP address for accessing the associated VPC endpoint service.

    +

    This parameter is returned only under the following conditions:

    +
    • You query a VPC endpoint for accessing an interface VPC endpoint service.
    • The connection approval function is enabled for the VPC endpoint service, and the connection has been approved.

      The status of the VPC endpoint can be Accepted or Rejected. The Rejected status only appears when the VPC endpoint is accepted and then rejected.

      +
    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC where the VPC endpoint is to be created.

    +

    subnet_id

    +

    String

    +

    Specifies the ID of the subnet in the VPC specified by vpc_id. The ID is in the UUID format.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 3.

    +

    error

    +

    Array of objects

    +

    Specifies the error message.

    +

    This field is returned when the status of the VPC endpoint changes to failed. For details, see Table 4.

    +

    whitelist

    +

    Array of strings

    +

    Specifies the whitelist for controlling access to the VPC endpoint.

    +

    If you do not specify this parameter, an empty whitelist is returned.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    enable_whitelist

    +

    Boolean

    +

    Specifies whether to enable access control.

    +
    • true: indicates that access control is enabled.
    • false: indicates that access control is disabled.
    +

    If you do not specify this parameter, the whitelist is not enabled.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    routetables

    +

    Array of strings

    +

    Lists the IDs of route tables.

    +

    If you do not specify this parameter, the route table ID of the VPC is returned.

    +

    This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 Error parameters

    Parameter

    +

    Type

    +

    Description

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    error_message

    +

    String

    +

    Specifies the error message.

    +
    +
    +
+
+
  • Example response
    {
+    "id": "4189d3c2-8882-4871-a3c2-d380272eed83",
+    "service_type": "interface",
+    "marker_id": 322312312312,
+    "status": "accepted",
+    "vpc_id": "4189d3c2-8882-4871-a3c2-d380272eed83",
+    "enable_dns": false,
+    "endpoint_service_name": "test123",
+    "endpoint_service_id": "test123",
+    "project_id": "6e9dfd51d1124e8d8498dce894923a0d",
+    "whitelist": [
+        "127.0.0.1"
+    ],
+    "enable_whitelist": true,
+    "created_at": "2018-01-30T07:42:01.174",
+    "update_at": "2018-01-30T07:42:01.174",
+    "tags": [
+        {
+            "key": "test1",
+            "value": "test1"
+        }
+    ]
+}
    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoints
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0305.html b/docs/vpcep/api-ref/vpcep_06_0305.html new file mode 100644 index 000000000..1a380b3e7 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0305.html @@ -0,0 +1,50 @@ + + +

Deleting a VPC Endpoint

+

Function

This API is used to delete a VPC endpoint.

+
+

URI

DELETE /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

+
For detailed about the parameters, see Table 1. +
+ + + + + + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+

vpc_endpoint_id

+

Yes

+

Specifies the ID of the VPC endpoint.

+
+
+
+
+

Request

  • Parameter description

    None

    +
  • Example request
    This request is to delete the VPC endpoint whose ID is 4189d3c2-8882-4871-a3c2-d380272eed83.
    DELETE https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2-d380272eed83
    +
    +
+
+

Response

None

+
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoints
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0306.html b/docs/vpcep/api-ref/vpcep_06_0306.html new file mode 100644 index 000000000..1e9ab3722 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0306.html @@ -0,0 +1,436 @@ + + +

Querying VPC Endpoints

+

Function

This API is used to query VPC endpoints.

+
+

URI

GET /v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    endpoint_service_name

    +

    No

    +

    String

    +

    Specifies the name of the VPC endpoint service. The name is not case-sensitive and supports fuzzy match.

    +

    vpc_id

    +

    No

    +

    String

    +

    Specifies the ID of the VPC where the VPC endpoint is to be created.

    +

    id

    +

    No

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    limit

    +

    No

    +

    Integer

    +

    Specifies the maximum number of VPC endpoints displayed on each page.

    +

    The number ranges from 0 to 1000 and is generally 10, 20, or 50. The default number is 10.

    +

    offset

    +

    No

    +

    Integer

    +

    Specifies the offset.

    +

    All VPC endpoint services after this offset will be queried. The offset must be an integer greater than 0 but less than the number of VPC endpoint services.

    +

    sort_key

    +

    No

    +

    String

    +

    Specifies the sorting field of the VPC endpoint list. The field can be:

    +
    • create_at: indicates that VPC endpoints are sorted by creation time.
    • update_at: indicates that VPC endpoints are sorted by update time.
    +

    The default field is create_at.

    +

    sort_dir

    +

    No

    +

    String

    +

    Specifies the sorting method of the VPC endpoint list. The method can be:

    +
    • desc: indicates that VPC endpoints are sorted in the descending order.
    • asc: indicates that VPC endpoints are sorted in the ascending order.
    +

    The default method is desc.

    +
    +
    +
  • Example request
    GET https://{endpoint}/v1/{project_id}/vpc-endpoints
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    endpoints

    +

    Array of objects

    +

    Lists the VPC endpoints. For details, see Table 4.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of VPC endpoints that meet the search criteria. The number is not affected by the limit or offset.

    +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 VPC endpoint parameters

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the unique ID of the VPC endpoint.

    +

    service_type

    +

    String

    +

    Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.

    +
    • Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.
    • Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.
    +

    You can perform the operations in Creating a VPC Endpoint to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.

    +

    status

    +

    String

    +

    Specifies the connection status of the VPC endpoint.

    +
    • pendingAcceptance: indicates that the VPC endpoint is pending acceptance.
    • creating: indicates the VPC endpoint is being created.
    • accepted: indicates the VPC endpoint has been accepted.
    • rejected: indicates the VPC endpoint has been rejected.
    • failed: indicates the creation of the VPC endpoint failed.
    • deleting: indicates the VPC endpoint is being deleted.
    +

    active_status

    +

    String

    +

    Specifies the domain status.

    +
    • frozen: indicates that the domain is frozen.
    • active: indicates that the domain is normal.
    +

    endpoint_service_name

    +

    String

    +

    Specifies the name of the VPC endpoint service.

    +

    marker_id

    +

    Integer

    +

    Specifies the packet ID of the VPC endpoint.

    +

    endpoint_service_id

    +

    String

    +

    Specifies the ID of the VPC endpoint service.

    +

    enable_dns

    +

    Boolean

    +

    Specifies whether to create a private domain name.

    +
    • true: indicates that a private domain name is created.
    • false: indicates that a private domain name is not created.
    +
    NOTE:

    When a VPC endpoint for connecting to a gateway VPC endpoint service is created, no private domain name is created no matter enable_dns is set to true or false.

    +
    +

    dns_names

    +

    Array of strings

    +

    Specifies the domain name for accessing the associated VPC endpoint service.

    +

    This parameter is only available when enable_dns is set to true.

    +

    ip

    +

    String

    +

    Specifies the IP address for accessing the associated VPC endpoint service.

    +

    This parameter is returned only under the following conditions:

    +
    • You query a VPC endpoint for accessing an interface VPC endpoint service.
    • The connection approval function is enabled for the VPC endpoint service, and the connection has been approved.

      The status of the VPC endpoint can be Accepted or Rejected. The Rejected status only appears when the VPC endpoint is accepted and then rejected.

      +
    +

    vpc_id

    +

    String

    +

    Specifies the ID of the VPC where the VPC endpoint is to be created.

    +

    subnet_id

    +

    String

    +

    Specifies the ID of the subnet in the VPC specified by vpc_id. The ID is in the UUID format.

    +

    created_at

    +

    String

    +

    Specifies the creation time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    updated_at

    +

    String

    +

    Specifies the update time of the VPC endpoint.

    +

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    +

    project_id

    +

    String

    +

    Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    tags

    +

    Array of objects

    +

    Lists the resource tags. For details, see Table 5.

    +

    error

    +

    Array of objects

    +

    Specifies the error message.

    +

    This field is returned when the status of the VPC endpoint changes to failed. For details, see Table 6.

    +

    whitelist

    +

    Array of strings

    +

    Specifies the whitelist for controlling access to the VPC endpoint.

    +

    If you do not specify this parameter, an empty whitelist is returned.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    enable_whitelist

    +

    Boolean

    +

    Specifies whether to enable access control.

    +
    • true: indicates that access control is enabled.
    • false: indicates that access control is disabled.
    +

    If you do not specify this parameter, the whitelist is not enabled.

    +

    This parameter is available only if you create a VPC endpoint for connecting to an interface VPC endpoint service.

    +

    routetables

    +

    Array of strings

    +

    Lists the IDs of route tables.

    +

    If you do not specify this parameter, the route table ID of the VPC is returned.

    +

    This parameter is available only when you create a VPC endpoint for connecting to a gateway VPC endpoint service.

    +
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 5 ResourceTags parameters

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. This parameter cannot be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +

    value

    +

    String

    +

    Specifies the tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), and underscores (_).

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 6 Error parameters

    Parameter

    +

    Type

    +

    Description

    +

    error_code

    +

    String

    +

    Specifies the error code.

    +

    error_message

    +

    String

    +

    Specifies the error message.

    +
    +
    +
+
+
  • Example response
    {  
+"endpoints":
+ [
+    {
+      "id":"03184a04-95d5-4555-86c4-e767a371ff99",
+      "status":"accepted",
+      "ip":"192.168.0.232",
+      "marker_id":16777337,
+      "active_status":"active",
+      "vpc_id":"84758cf5-9c62-43ae-a778-3dbd8370c0a4",
+      "service_type":"interface",
+      "project_id":"295dacf46a4842fcbf7844dc2dc2489d",
+      "subnet_id":"68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
+      "enable_dns":"true",
+      "dns_name":"test123",
+      "created_at":"2018-10-18T06:49:46Z",
+      "updated_at":"2018-10-18T06:49:50Z",
+      "endpoint_service_id":"5133655d-0e28-4090-b669-13f87b355c78",
+      "endpoint_service_name":"test123",
+      "whitelist":["127.0.0.1"],
+      "enable_whitelist":true,
+      "tags":
+        [
+          {
+            "key":"test1",
+            "value":"test1"
+          }
+        ]
+    },
+    {
+      "id":"43b0e3b0-eec9-49da-866b-6687b75f9fe5",
+      "status":"accepted",
+      "ip":"192.168.0.115",
+      "marker_id":16777322,
+      "active_status":"active",
+      "vpc_id":"e251b400-2963-4131-b38a-da81e32026ee",
+      "service_type":"interface",
+      "project_id":"295dacf46a4842fcbf7844dc2dc2489d",
+      "subnet_id":"65528a22-59a1-4972-ba64-88984b3207cd",
+      "enable_dns":"true",
+      "dns_name":"test123",
+      "created_at":"2018-10-18T06:36:20Z",
+      "updated_at":"2018-10-18T06:36:24Z",
+      "endpoint_service_id":"5133655d-0e28-4090-b669-13f87b355c78",
+      "endpoint_service_name":"test123",
+      "whitelist":["127.0.0.1"],
+      "enable_whitelist":true,
+      "tags":
+        [
+          {
+            "key":"test1",
+            "value":"test1"
+          }
+        ]
+    }
+ ],
+ "total_count":17
+}
    +

    +
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: APIs for Managing VPC Endpoints
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0400.html b/docs/vpcep/api-ref/vpcep_06_0400.html new file mode 100644 index 000000000..69c6d44da --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0400.html @@ -0,0 +1,15 @@ + + +

Resource Quota

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0401.html b/docs/vpcep/api-ref/vpcep_06_0401.html new file mode 100644 index 000000000..6c8c76742 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0401.html @@ -0,0 +1,156 @@ + + +

Querying the Quota

+

Function

This API is used to query the quota of your resources, including VPC endpoint services and VPC endpoints.

+
+

URI

GET /v1/{project_id}/quotas?type={resource_type}

+
Table 1 describes the required parameters. +
+ + + + + + + + + +
Table 1 Parameters

Parameter

+

Mandatory

+

Description

+

project_id

+

Yes

+

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    type

    +

    No

    +

    String

    +

    Specifies the resource type.

    +
    • endpoint_service: indicates the VPC endpoint service.
    • endpoint: indicates the VPC endpoint.
    +
    +
    +
  • Example request

    This request is to query the quota of VPC endpoint services.

    +
    GET https://{endpoint}/v1/{project_id}/quotas?type=endpoint_service
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + +
    Table 3 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    quotas

    +

    Object

    +

    Specifies quota details. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + +
    Table 4 Quotas description

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of objects

    +

    Lists the resources. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 5 Resource parameters

    Parameter

    +

    Type

    +

    Description

    +

    type

    +

    String

    +

    Specifies the resource type. You can query the quota of resources of a specified type by configuring this parameter.

    +
    • endpoint_service: indicates the VPC endpoint service.
    • endpoint: indicates the VPC endpoint.
    +

    used

    +

    Integer

    +

    Specifies the number of created resources.

    +

    The value ranges from 0 to the value of quota.

    +

    quota

    +

    Integer

    +

    Specifies the maximum quota of resources.

    +

    The value ranges from the default quota value to the maximum quota value.

    +
    +
    +
  • Example response
    {
+"quotas":{
+     "resources":[
+                 {
+                     "type":"endpoint",
+                     "used":4,
+                     "quota":150
+                },
+                 {
+                     "type":"endpoint_service",
+                     "used":10,
+                     "quota": 100
+                }
+              ]
+        }
+}
    +
+
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: Resource Quota
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0500.html b/docs/vpcep/api-ref/vpcep_06_0500.html new file mode 100644 index 000000000..bf26172a0 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0500.html @@ -0,0 +1,21 @@ + + +

Tag Function

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0501.html b/docs/vpcep/api-ref/vpcep_06_0501.html new file mode 100644 index 000000000..2a2a28c16 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0501.html @@ -0,0 +1,420 @@ + + +

Querying Resources by Tag

+

Function

This API is used to query resources under the tenant using tags.

+
+

URI

POST /v1/{project_id}/{resource_type}/resource_instances/action

+
Table 1 describes the required parameters. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. The type is endpoint_service or endpoint.

+
+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    No

    +

    List<tag>

    +

    Lists tags that are included. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing all tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.

    +

    tags_any

    +

    No

    +

    List<tag>

    +

    Lists any tags that are included. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship. If no tag filtering condition is specified, full data is returned.

    +

    not_tags

    +

    No

    +

    List<tag>

    +

    Lists tags that are not included. Each resource to be queried contains a maximum of 20 keys. Each tag key can have a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.

    +

    not_tags_any

    +

    No

    +

    List<tag>

    +

    Lists any tags that are not included. Each resource to be queried contains a maximum of 20 keys. Each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Each tag key and each value of the same tag key must be unique. The response returns resources containing no tags in this list. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering condition is specified, full data is returned.

    +

    limit

    +

    No

    +

    String

    +

    Sets the page size. This parameter is unavailable when action is set to count. The default size is 1000 when action is set to filter. The maximum value is 1000, and the minimum size is 1. The size cannot be a negative number.

    +

    offset

    +

    No

    +

    String

    +

    Specifies the index position. This parameter is unavailable when action is set to count. If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data. offset must be a positive number.

    +

    action

    +

    Yes

    +

    String

    +

    Specifies the operation to perform. The operation can only be filter (filtering) or count (querying the total number).

    +

    If action is set to filter, the query is performed based on the filter conditions. If action is set to count, only the total number of records is returned.

    +

    matches

    +

    No

    +

    List<match>

    +

    Specifies the search field. The tag key is the field to be matched, for example, resource_name. value indicates the matched value. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys.

    +

    Check whether fuzzy match is required based on the key value. For example, if key is set to resource_name, fuzzy search (case-insensitive) is performed by default. If value is empty, exact match is performed. Most services do not have resources without names. In this case, an empty list is returned. If key is resource_id, exact match is used. Currently, only resource_name for key is supported. Other key values will be available later.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Description of field tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. Each tag key contains a maximum of 127 unicode characters but cannot be left blank. The system does not verify the character set of key when searching for resources. key cannot be empty, an empty string, or spaces. Before using key, delete single-byte character (SBC) spaces before and after the value.

    +

    values

    +

    Yes

    +

    List<String>

    +

    Lists tag values. Each value contains a maximum of 255 Unicode characters. Before using values, delete SBC spaces before and after the value.

    +

    The value can be an empty array but cannot be left blank.

    +

    If the values are null, it indicates any_value (querying any value). The values are in the OR relationship.

    +

    The system does not verify the character set of values when searching for resources, but only verifies the length.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 Description of field match

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. Currently, only resource_name for key is supported. Other key values will be available later.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the tag value. Each value contains a maximum of 255 Unicode characters. The character set of value is not verified.

    +
    +
    +
+
  • Example request

    POST https://127.0.0.1:7443/v1/{project_id}/endpoint_service/resource_instances/action

    +

    or POST https://127.0.0.1:7443/v1/{project_id}/endpoint/resource_instances/action

    +

    or POST https://127.0.0.1:7443/v1/{project_id}/{resource_type}/resource_instances/action

    +
    • Request body when action is set to filter
      {
+    "offset": "100",
+    "limit": "100",
+    "action": "filter",
+    "matches": [
+        {
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ],
+    "not_tags": [
+        {
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags_any": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "not_tags_any": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ]
+}
      +
    • Request body when action is set to count
      {
+    "action": "count",
+    "not_tags": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "*value2"
+            ]
+        }
+    ],
+    "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        },
+        {
+            "key": "key2",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "tags_any": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "not_tags_any": [
+        {
+            "key": "key1",
+            "values": [
+                "value1",
+                "value2"
+            ]
+        }
+    ],
+    "matches": [
+        {
+            "key": "resource_name",
+            "value": "resource1"
+        }
+    ]
+}
      +
    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + + + +
    Table 5 Parameter description

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    List<resource>

    +

    N/A

    +

    total_count

    +

    Integer

    +

    Specifies the total number of records.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 6 Data structure of field resource

    Parameter

    +

    Type

    +

    Description

    +

    resource_id

    +

    String

    +

    Specifies the resource ID, which can be Endpoint Service ID or Endpoint ID.

    +

    tags

    +

    List<resource_tag>

    +

    Lists the tags. If no tag is matched, an empty array is returned.

    +

    resource_name

    +

    String

    +

    Specifies the resource name. If the resource does not have a name, the ID is returned.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 7 Data structure of field resource_tag

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the tag key.

    +

    value

    +

    String

    +

    Specifies the tag value.

    +
    +
    +
+
  • Example response
    • Response body when action is set to filter
      {
+    "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
+}
      +
    • Response body when action is set to count
      {
+    "total_count": 1000
+}
      +
    +
+
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: Tag Function
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0502.html b/docs/vpcep/api-ref/vpcep_06_0502.html new file mode 100644 index 000000000..2b19fbcbf --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0502.html @@ -0,0 +1,159 @@ + + +

Batch Adding or Deleting Tags of a Specified Resource

+

Function

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.
+
+

URI

POST /v1/{project_id}/{resource_type}/{resource_id}/tags/action

+

Table 1 describes the required parameters.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. The type is endpoint_service or endpoint.

+

resource_id

+

Yes

+

String

+

Specifies the resource ID, which can be Endpoint Service ID or Endpoint ID.

+
+
+
+

Request

  • Parameter description +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    No

    +

    List<resource_tag>

    +

    Lists the tags.

    +

    This parameter is mandatory for common tenants.

    +

    action

    +

    Yes

    +

    String

    +

    Specifies the operation to be performed, which can be create or delete

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Data structure of field resource_tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key. A tag key contains a maximum of 36 Unicode characters.

    +

    The key meets the requirements in Tag Character Set Specifications.

    +

    value

    +

    This parameter is mandatory when action is set to create and optional when action is set to delete.)

    +

    String

    +

    Specifies the tag value. Each value contains a maximum of 43 Unicode characters. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.

    +

    The value meets the requirements in Tag Character Set Specifications.

    +
    +
    +
  • Example request

    POST https://127.0.0.1:7443/v1/{project_id}/endpoint_service/{resource_id}/tags/action

    +

    or https://127.0.0.1:7443/v1/{project_id}/endpoint/{resource_id}/tags/action

    +
    POST /v1/{project_id}/{resource_type}/{resource_id}/tags/action 
    {
+    "action": "create",
+    "tags": [
+        {
+            "key": "key1",
+            "value": "value1"
+        },
+        {
+            "key": "key",
+            "value": "value3"
+        }
+]
+}
    +
    +
    or
    {
+    "action": "delete",
+    "tags": [
+        {
+            "key": "key1"
+         },
+        {
+            "key": "key2",
+            "value": "value3"
+        }
+]
+}
    +
    +
+
+

Response

None

+
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: Tag Function
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0503.html b/docs/vpcep/api-ref/vpcep_06_0503.html new file mode 100644 index 000000000..d1f9c65be --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0503.html @@ -0,0 +1,122 @@ + + +

Querying Tags of a Tenant's Resource

+

Function

This API is used to obtain tags of resources of a tenant based on the tenant ID and resource type.

+
+

URI

GET /v1/{project_id}/{resource_type}/tags

+

Table 1 describes the required parameters.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. The value is endpoint_service or endpoint.

+
+
+
+

Request

  • Parameter description

    None

    +
  • Example request

    GET https://127.0.0.1:7443/v1/{project_id}/endpoint_service/tags

    +

    or https://127.0.0.1:7443/v1/{project_id}/endpoint/tags GET /v1/{project_id}/{resource_type}/tags

    +
+
+

Response

  • Parameter description +
    + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    Yes

    +

    List<resource_tag>

    +

    Lists the tags.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Data structure of field resource_tag

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the tag key.

    +

    values

    +

    Yes

    +

    List<String>

    +

    Lists the tag values.

    +
    +
    +
  • Example response
    {
+    "tags": [
+        {
+            "key": "key1",
+            "values": [
+                "*value1",
+                "value2"
+            ]
+        }
+    ]
+}
    +
+
+

Status Code

For details about status codes, see Status Code.

+
+
+
+
+
Parent topic: Tag Function
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_06_0504.html b/docs/vpcep/api-ref/vpcep_06_0504.html new file mode 100644 index 000000000..5e6df796e --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_06_0504.html @@ -0,0 +1,14 @@ + + +

Tag Character Set Specifications

+

Character Set Specifications for Keys

The key should be Unicode characters, including only digits, letters, hyphens (-), and underscores (_). It cannot be empty.

+
+

Character Set Specifications for Values

The value should be Unicode characters, including only digits, letters, hyphens (-), and underscores (_).

+
+
+
+
+
Parent topic: Tag Function
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_08_0000.html b/docs/vpcep/api-ref/vpcep_08_0000.html new file mode 100644 index 000000000..173b41654 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_08_0000.html @@ -0,0 +1,15 @@ + + +

Appendix

+
+
+ +
+ diff --git a/docs/vpcep/api-ref/vpcep_08_0001.html b/docs/vpcep/api-ref/vpcep_08_0001.html new file mode 100644 index 000000000..8675e6696 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_08_0001.html @@ -0,0 +1,148 @@ + + +

Status Code

+
  • Normal +
    + + + + + + + + + + + + + +
    Table 1 Return values for successful requests

    Status Code

    +

    Returned Value

    +

    Description

    +

    200

    +

    OK

    +

    The results of POST, GET, and PUT operations are returned as expected.

    +

    204

    +

    No Content

    +

    The results of the DELETE operation are returned as expected.

    +
    +
    +
+
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Return code for failed requests

    Status Code

    +

    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.

    +
    +
    +
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_08_0002.html b/docs/vpcep/api-ref/vpcep_08_0002.html new file mode 100644 index 000000000..4b0b34670 --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_08_0002.html @@ -0,0 +1,1626 @@ + + +

Error Code

+

Function

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.

+
+

Error Code Structure Format

STATUS CODE 400
+
1
+2
+3
+4
{
+        "error_code": "EndPoint.0002",
+        "error_msg": "Parameter error."
+}
+
+
+
+

Error Code Description

An error code returned by an API does not correspond to an error message.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Error codes

Status Code

+

Error Code

+

Error Message

+

Description

+

Solution

+

500

+

EndPoint.0001

+

System error. Please retry.

+

System error. Please retry.

+

Try again. If the fault persists, contact customer service.

+

400

+

EndPoint.0002

+

Parameter error.

+

Parameter error.

+

Check whether the parameter is correct.

+

401

+

EndPoint.0003

+

Authentication failed or authentication information is invalid.

+

Authentication failed or authentication information is invalid.

+

Check whether the permission is enabled.

+

403

+

EndPoint.0004

+

Authentication information is incorrect or you have no permissions.

+

Authentication information is incorrect or you have no permissions.

+

Check whether the permission is enabled.

+

404

+

EndPoint.0005

+

The requested resource does not exist.

+

The requested resource is unavailable.

+

Check whether input parameters are correct.

+

400

+

EndPoint.0006

+

Invalid limit.

+

Invalid limit.

+

Enter a correct limit.

+

400

+

EndPoint.0007

+

Invalid action.

+

Invalid action.

+

Enter a correct action.

+

400

+

EndPoint.0009

+

The remote address does not match.

+

The remote address does not match.

+

Check whether you have the access permission.

+

400

+

EndPoint.0010

+

Invalid offset.

+

Invalid offset.

+

Enter a correct offset.

+

504

+

EndPoint.0011

+

The request body is null.

+

The request body is null.

+

Enter the request body again.

+

504

+

EndPoint.0012

+

The request header is null.

+

The request header is null.

+

Enter a request header.

+

504

+

EndPoint.0013

+

The request timed out.

+

The request timed out.

+

Contact customer service if the problem persists after a retry.

+

400

+

EndPoint.0014

+

Invalid project ID.

+

Invalid project ID.

+

Enter a correct project ID.

+

400

+

EndPoint.0015

+

Invalid specification.

+

Invalid specification.

+

Enter a correct specification.

+

400

+

EndPoint.0016

+

The number of batch operated resources exceeded the limit.

+

The number of batch operated resources exceeded the limit.

+

Reduce the number of resources to be batch operated.

+

400

+

EndPoint.0017

+

Invalid sort_key.

+

Invalid sort key.

+

Enter a correct sort key.

+

400

+

EndPoint.0018

+

Invalid sort_dir.

+

Invalid sort DIR.

+

Enter a correct sort DIR.

+

400

+

EndPoint.0019

+

Invalid status.

+

Invalid status.

+

Enter a correct status.

+

400

+

EndPoint.0020

+

Invalid VPC ID.

+

Invalid VPC ID.

+

Enter a correct VPC ID.

+

400

+

EndPoint.0021

+

Invalid marker_id.

+

Invalid marker ID.

+

Enter a correct marker ID.

+

400

+

EndPoint.0022

+

The number of requests exceeded the limit. Please try later.

+

The number of requests exceeded the limit. Please try later.

+

Try again later.

+

400

+

EndPoint.0023

+

Invalid subnet_id.

+

Invalid subnet ID.

+

Enter a correct subnet ID.

+

400

+

EndPoint.1003

+

Invalid service name.

+

Invalid service name.

+

Enter a correct service name.

+

400

+

EndPoint.1004

+

Invalid request.

+

Invalid request.

+

Enter a correct request body.

+

400

+

EndPoint.1008

+

Failed to obtain the token.

+

Failed to obtain the token.

+

Contact customer service.

+

400

+

Endpoint.1018

+

Quota exceeded.

+

Quota exceeded.

+

Contact customer service.

+

400

+

EndPoint.1019

+

Invalid route table ID.

+

Invalid route table ID.

+

Enter a correct route table ID.

+

400

+

EndPoint.2001

+

The VPC does not exist.

+

The VPC does not exist.

+

Enter a correct VPC ID for the current tenant.

+

400

+

EndPoint.2002

+

The request input parameter is empty.

+

The request input parameter is empty.

+

Please input a correct parameter.

+

400

+

EndPoint.2003

+

The endpoint service does not exist.

+

The VPC endpoint service does not exist.

+

Enter a VPC endpoint service.

+

400

+

EndPoint.2004

+

The endpoint service is unavailable.

+

The VPC endpoint service is unavailable.

+

Try again later. If the fault persists, contact customer service.

+

404

+

EndPoint.2006

+

The requested endpoint does not exist.

+

The requested VPC endpoint does not exist.

+

Enter a correct VPC endpoint.

+

404

+

EndPoint.2007

+

The endpoint information does not exist.

+

The VPC endpoint information is unavailable.

+

Enter a correct VPC endpoint and check whether the endpoint is deleted.

+

404

+

EndPoint.2008

+

The endpoint has been deleted.

+

The VPC endpoint has been deleted.

+

Check whether the VPC endpoint is deleted.

+

400

+

EndPoint.2009

+

The specification information does not exist.

+

The specification is unavailable.

+

Enter a correct specification.

+

400

+

EndPoint.2010

+

The input parameter subnet ID is empty.

+

The input parameter subnet_id is empty.

+

Enter a valid subnet ID.

+

400

+

EndPoint.2011

+

The input parameter VPC ID is empty.

+

The input parameter vpc_id is empty.

+

Enter a valid VPC ID.

+

400

+

EndPoint.2012

+

You have no permission to connect to the VPC endpoint service.

+

You have no permission to connect to the VPC endpoint service.

+

Check whether you have the access permission.

+

400

+

EndPoint.2013

+

The endpoint does not belong to the endpoint service.

+

The VPC endpoint does not belong to the VPC endpoint service.

+

Check whether the VPC endpoint is correct.

+

400

+

EndPoint.2014

+

The endpoint has been connected to the endpoint service.

+

The VPC endpoint has connected to the VPC endpoint service.

+

Connected. You do not need to connect again.

+

400

+

EndPoint.2015

+

The endpoint has been frozen.

+

The VPC endpoint has been frozen.

+

Contact customer service to confirm the freezing reason.

+

400

+

EndPoint.2016

+

The endpoint pool IP address does not exist.

+

The VPC endpoint pool IP address does not exist.

+

Contact customer service.

+

400

+

EndPoint.2017

+

Invalid endpoint ID.

+

The ID of the VPC endpoint is invalid.

+

Enter a correct VPC endpoint ID.

+

400

+

EndPoint.2018

+

The endpoint is being deleted.

+

The VPC endpoint is being deleted.

+

Select an available VPC endpoint.

+

400

+

EndPoint.2019

+

The endpoint is being created.

+

The VPC endpoint is being created.

+

Try again later.

+

400

+

EndPoint.2020

+

qrMac or sgMac does not exist.

+

qrMac or sgMac is not found.

+

Contact customer service.

+

400

+

EndPoint.2021

+

Failed to query the VPC.

+

Failed to query the VPC.

+

Contact customer service.

+

400

+

EndPoint.2022

+

Failed to create an endpoint.

+

Failed to create a VPC endpoint.

+

Contact customer service.

+

400

+

EndPoint.2023

+

CIDR is not found.

+

CIDR is not found.

+

Contact customer service.

+

400

+

EndPoint.2024

+

shadowVpc or shadowPort does not exist.

+

shadowVpc or shadowPort is null.

+

Contact customer service.

+

400

+

EndPoint.2025

+

The endpoint port does not exist.

+

The VPC endpoint port is not found.

+

Contact customer service.

+

400

+

EndPoint.2026

+

VNI is empty.

+

VNI is empty.

+

Contact customer service.

+

400

+

EndPoint.2027

+

Invalid action.

+

Invalid action.

+

Enter a valid action.

+

400

+

EndPoint.2028

+

The endpoint service port or protocol is empty.

+

The VPC endpoint service port or protocol is empty.

+

Enter a valid port number or protocol.

+

400

+

EndPoint.2029

+

The requested endpoint service ID is empty.

+

The ID of the requested VPC endpoint service is empty.

+

Enter a valid VPC endpoint service ID.

+

404

+

EndPoint.2030

+

markerId is empty.

+

markerId is empty.

+

Enter a valid marker ID.

+

400

+

EndPoint.2031

+

Only one endpoint is allowed.

+

Only one VPC endpoint is allowed.

+

A VPC endpoint service allows accepting or rejecting only one VPC endpoint.

+

400

+

EndPoint.2033

+

The entered parameter enable_dns is invalid.

+

Invalid parameter enable_dns.

+

Enter a valid parameter.

+

400

+

EndPoint.2034

+

The entered parameter enable_dns is incorrect.

+

The entered parameter enable_dns is incorrect.

+

Enter a valid parameter.

+

400

+

EndPoint.2035

+

The system parameter dns.enable is invalid.

+

System parameter dns.enable is invalid.

+

Contact customer service.

+

400

+

EndPoint.2037

+

The current network does not belong to the VPC.

+

The current network does not belong to the VPC.

+

Check whether the parameter is correct.

+

400

+

EndPoint.2038

+

The pool does not exist.

+

The resource pool is not found.

+

Contact customer service.

+

400

+

EndPoint.2039

+

The route table is being used by another VPC endpoint.

+

The route table is being used by another VPC endpoint.

+

Contact customer service.

+

400

+

EndPoint.2040

+

The VPC endpoint has no route table bound.

+

The VPC endpoint has no route table associated.

+

Contact customer service.

+

400

+

EndPoint.3001

+

Failed to create a port.

+

Failed to create a port.

+

Contact customer service.

+

400

+

EndPoint.3002

+

Invalid permission.

+

Invalid permission.

+

Contact customer service.

+

400

+

EndPoint.3003

+

Invalid port ID.

+

Invalid port ID.

+

Contact customer service.

+

400

+

EndPoint.3004

+

Invalid port.

+

Invalid port.

+

Contact customer service.

+

400

+

EndPoint.3005

+

Failed to delete the endpoint service.

+

Failed to delete the VPC endpoint service.

+

Contact customer service.

+

400

+

EndPoint.3006

+

The endpoint service is being used.

+

The VPC endpoint service is being used.

+

Contact customer service.

+

400

+

EndPoint.3008

+

The port does not exist.

+

The port is not found.

+

Contact customer service.

+

400

+

EndPoint.3009

+

Invalid CIDR.

+

Invalid CIDR.

+

Contact customer service.

+

400

+

EndPoint.3010

+

Invalid IP address.

+

Invalid IP address.

+

Enter a correct IP address.

+

400

+

EndPoint.3011

+

Parameter IP is not required to create an endpoint service (interface).

+

Parameter ip is not required to create a VPC endpoint service (interface).

+

Enter a correct request body.

+

400

+

EndPoint.3013

+

endpointService interface vlan can't have vpcId.

+

The request for accessing the VLAN VPC endpoint service cannot contain VPC ID information.

+

Enter a correct request body.

+

400

+

EndPoint.3014

+

endpointService interface can't have cidr.

+

The request for accessing the VPC endpoint service (interface) cannot contain CIDR.

+

Enter a correct request body.

+

400

+

EndPoint.3015

+

endpointService gateway vlan can't have portId.

+

The request for accessing the VLAN VPC endpoint service (gateway) cannot contain the port ID.

+

Enter a correct request body.

+

400

+

EndPoint.3016

+

endpointService gateway vlan can't have ip.

+

The request for accessing the VLAN VPC endpoint service cannot contain IP address information.

+

Enter a correct request body.

+

400

+

EndPoint.3017

+

Invalid CIDRs.

+

Invalid CIDRs.

+

Enter correct CIDRs.

+

400

+

EndPoint.3018

+

endpointService gateway vlan can't have vpcId.

+

The request for accessing the VLAN VPC endpoint service cannot contain VPC ID information.

+

Enter a correct request body.

+

400

+

EndPoint.3021

+

Invalid serverType.

+

Invalid parameter serverType.

+

Enter a valid parameter.

+

400

+

EndPoint.3022

+

Failed to create a network.

+

Failed to create a network.

+

Contact customer service.

+

400

+

EndPoint.3023

+

Failed to create a subnet.

+

Failed to create a subnet.

+

Contact customer service.

+

400

+

EndPoint.3035

+

Invalid action.

+

Invalid action.

+

Enter a correct action.

+

400

+

EndPoint.3036

+

Invalid permissions.

+

The permission list cannot be empty.

+

Enter a correct request body.

+

400

+

EndPoint.3040

+

Failed to add a rollback task.

+

Failed to add a rollback task.

+

Contact customer service.

+

400

+

EndPoint.3042

+

The port ID does not belong to the current VPC.

+

The port ID does not belong to the current VPC.

+

Enter a correct request body.

+

400

+

EndPoint.3043

+

The service port is invalid.

+

Invalid service port.

+

Enter a correct request body.

+

400

+

EndPoint.3044

+

The parameter ports conflicted with ports in an existing endpoint service.

+

This port conflicted with the port of an existing endpoint service.

+

Enter a correct request body.

+

400

+

EndPoint.3045

+

Other properties cannot be modified in the current endpoint service state.

+

Modifying other properties in the current endpoint service state is not supported.

+

Enter a correct request body.

+

400

+

EndPoint.3046

+

The IP address conflicted with an existing endpoint service.

+

The IP address conflicted with an existing VPC endpoint service.

+

Enter a correct request body.

+

400

+

EndPoint.3048

+

Invalid netType.

+

Invalid netType.

+

Enter a valid value.

+

400

+

EndPoint.3049

+

The maximum number of whitelist records has been reached.

+

The maximum number of whitelist records has been reached.

+

Delete invalid whitelist records or add an asterisk (*).

+

400

+

EndPoint.3051

+

Endpoint service vip port id is invalid.

+

Invalid parameter vip_port_id.

+

Enter a correct value.

+

400

+

EndPoint.3052

+

portId and ip cannot be modified at the same time.

+

portId and ip cannot be modified at the same time.

+

Enter a correct request body.

+

400

+

EndPoint.3053

+

vipPortId and ip cannot be modified at the same time.

+

vipPortId and ip cannot be modified at the same time.

+

Enter a correct request body.

+

400

+

EndPoint.3054

+

portId or vipPortId cannot be modified.

+

portId or vipPortId cannot be modified.

+

Enter a correct request body.

+

400

+

EndPoint.3055

+

ip cannot be modified.

+

ip cannot be modified.

+

Enter a correct request body.

+

400

+

EndPoint.3056

+

The maximum of VPC endpoint services using the same IP address has been reached.

+

The maximum of VPC endpoint services supported by a backend resource has been reached.

+

Contact customer service.

+

400

+

EndPoint.3057

+

cidr cannot be modified.

+

CIDR cannot be modified.

+

Enter a correct request body.

+

400

+

EndPoint.3058

+

The domain name is invalid.

+

Invalid domain name.

+

Enter a correct domain name.

+

400

+

EndPoint.3059

+

The domain name already exists.

+

The domain name already exists.

+

Contact customer service.

+

400

+

EndPoint.3060

+

You have no permission to add domain names.

+

You have no permission to add domain names.

+

Contact customer service.

+

400

+

EndPoint.3061

+

The maximum number of domain names has reached.

+

The maximum number of domain names has been reached.

+

Contact customer service.

+

400

+

EndPoint.3062

+

Invalid endpoint service ID.

+

Invalid VPC endpoint service ID.

+

Enter a correct parameter.

+

400

+

EndPoint.3063

+

Invalid port ID.

+

Invalid port ID.

+

Enter a correct port ID.

+

400

+

EndPoint.3066

+

The tag cannot be empty.

+

The tag cannot be empty.

+

Enter a correct request body.

+

400

+

EndPoint.3067

+

The tag key cannot be duplicated.

+

The tag key cannot be duplicated.

+

Enter a correct request body.

+

400

+

EndPoint.3068

+

Tag keys and values should meet relevant requirements.

+

Tag keys and values must meet relevant requirements.

+

Enter a correct request body.

+

400

+

EndPoint.3069

+

The maximum number of tags has been reached.

+

The maximum number of tags has been reached.

+

Contact customer service.

+

400

+

EndPoint.3070

+

Invalid resource type.

+

Incorrect resource type.

+

Contact customer service.

+

400

+

EndPoint.3071

+

The tag value cannot be duplicated.

+

Tag values cannot be duplicated.

+

Contact customer service.

+

400

+

EndPoint.3072

+

The tag key size is invalid.

+

The tag key size is invalid.

+

Enter a correct tag key.

+

400

+

EndPoint.3073

+

The tag value size is invalid.

+

The tag value size is invalid.

+

Enter a correct tag value.

+

400

+

EndPoint.3074

+

The maximum of ports has been reached.

+

The maximum of port mappings has been reached.

+

Contact customer service.

+

400

+

EndPoint.3075

+

The protocol is invalid.

+

Invalid protocol.

+

Contact customer service.

+

400

+

EndPoint.3076

+

Invalid service name.

+

Invalid service name.

+

Enter a valid service name.

+

400

+

EndPoint.4001

+

Failed to query the subnet.

+

Failed to query the subnet.

+

Contact customer service.

+

400

+

EndPoint.4002

+

Failed to create a subnet.

+

Failed to create a subnet.

+

Contact customer service.

+

400

+

EndPoint.4003

+

Failed to delete the subnet.

+

Failed to delete the subnet.

+

Contact customer service.

+

404

+

EndPoint.4004

+

The subnet is not found.

+

The subnet does not exist.

+

Check the entered subnet ID. If the fault persists, contact customer service.

+

400

+

EndPoint.4005

+

Failed to query the network.

+

Failed to query the network.

+

Contact customer service.

+

400

+

EndPoint.4006

+

Failed to create a network.

+

Failed to create a network.

+

Contact customer service.

+

400

+

EndPoint.4007

+

Failed to delete the network.

+

Failed to delete the network.

+

Contact customer service.

+

404

+

EndPoint.4008

+

Network is unavailable.

+

Network is unavailable.

+

Contact customer service.

+

400

+

EndPoint.4009

+

Failed to query the port.

+

Failed to query the port.

+

Contact customer service.

+

400

+

EndPoint.4010

+

Failed to create a port.

+

Failed to create a port.

+

Contact customer service.

+

400

+

EndPoint.4011

+

Failed to delete the port.

+

Failed to delete the port.

+

Contact customer service.

+

404

+

EndPoint.4012

+

The port is not found.

+

The port is not found.

+

Contact customer service.

+

400

+

EndPoint.4013

+

Failed to query the proxy.

+

Failed to query the proxy.

+

Contact customer service.

+

400

+

EndPoint.4014

+

Failed to query the router.

+

Failed to query the route.

+

Contact customer service.

+

400

+

EndPoint.4015

+

The router is not found.

+

The route is not found.

+

Contact customer service.

+

400

+

EndPoint.4016

+

Failed to add an interface router.

+

Failed to add an interface route.

+

Contact customer service.

+

400

+

EndPoint.4017

+

Failed to delete the interface router.

+

Failed to delete the interface route.

+

Contact customer service.

+

400

+

EndPoint.4018

+

Failed to add an extension router.

+

Failed to add the extended route.

+

Contact customer service.

+

400

+

EndPoint.4019

+

Failed to delete the extension router.

+

Failed to delete the extended route.

+

Contact customer service.

+

400

+

EndPoint.4020

+

Failed to query Neutron L3 Agent.

+

Failed to query Neutron L3 Agent.

+

Contact customer service.

+

404

+

EndPoint.4021

+

Neutron L3 Agent is not found.

+

Neutron L3 Agent is not found.

+

Contact customer service.

+

400

+

EndPoint.4025

+

The specification is being used.

+

The specification is being used.

+

Contact customer service.

+

400

+

EndPoint.4026

+

Failed to query the default route table of the VPC.

+

Failed to query the default route table of the VPC.

+

Contact customer service.

+

400

+

EndPoint.4027

+

Failed to query route tables of the VPC.

+

Failed to query route tables of the VPC.

+

Contact customer service.

+

400

+

EndPoint.4028

+

Failed to add routes to the VPC's route table.

+

Failed to add routes to the VPC's route table.

+

Contact customer service.

+

400

+

EndPoint.4029

+

Failed to remove routes from the VPC's route table.

+

Failed to remove routes from the VPC's route table.

+

Contact customer service.

+

404

+

EndPoint.4030

+

The route table is not found.

+

The route table is not found.

+

Contact customer service.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/vpcep/api-ref/vpcep_08_0003_0.html b/docs/vpcep/api-ref/vpcep_08_0003_0.html new file mode 100644 index 000000000..90444cdbb --- /dev/null +++ b/docs/vpcep/api-ref/vpcep_08_0003_0.html @@ -0,0 +1,15 @@ + + +

Obtaining a Project ID

+
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 obtain a project ID:
  1. Log in to the management console.
  2. Click the username and select My Credentials from the drop-down list.

    On the My Credentials page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

    In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.

    +
+
+
+
+
+
Parent topic: Appendix
+
+
+