forked from docs/doc-exports
Chen, Junjie
324aa7d3c4
Reviewed-by: Mützel, Andrea <andrea.muetzel@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
1640 lines
63 KiB
JSON
1640 lines
63 KiB
JSON
[
|
|
{
|
|
"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":"apig",
|
|
"title":"Service Overview",
|
|
"uri":"apig_03_0200.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"API Gateway (APIG) is your fully managed API hosting service. With APIG, you can build, manage, and deploy APIs at any scale to package your capabilities. With just a few",
|
|
"product_code":"apig",
|
|
"title":"What Is APIG?",
|
|
"uri":"apig_0080101651.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"You can quickly create APIs by configuring the required settings on the APIG console. APIG provides an inline debugging tool to simplify API development, and allows you t",
|
|
"product_code":"apig",
|
|
"title":"Product Advantages",
|
|
"uri":"apig-pd-180307002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"3"
|
|
},
|
|
{
|
|
"desc":"As enterprises develop rapidly with quick business changes, internal systems of enterprises need to keep pace with the development. However, it is difficult to ensure sys",
|
|
"product_code":"apig",
|
|
"title":"Application Scenarios",
|
|
"uri":"apig-pd-180307003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"The following table lists the specifications of dedicated gateways.For dedicated gateways, you can adjust the maximum number of requests per second for each API.The speci",
|
|
"product_code":"apig",
|
|
"title":"Specifications",
|
|
"uri":"apig-specifications.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"To change the default restrictions, contact technical support to increase the quota.It takes 5 to 10 seconds for a new or modified APIG resource to take effect.The maximu",
|
|
"product_code":"apig",
|
|
"title":"Notes and Constraints",
|
|
"uri":"apig-pd-180307005.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"If you need to assign different permissions to personnel in your enterprise to access your APIG resources, Identity and Access Management (IAM) is a good choice for fine-",
|
|
"product_code":"apig",
|
|
"title":"Permissions Management",
|
|
"uri":"apig-pd-190529006.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"A set of predefined functions that encapsulates application capabilities. You can create APIs and make them accessible to users.When creating an API, you need to configur",
|
|
"product_code":"apig",
|
|
"title":"Basic Concepts",
|
|
"uri":"apig-pd-180307004.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"1",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"Getting Started",
|
|
"uri":"apig_03_1002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"API Gateway (APIG) is a fully managed service that enables you to securely build, manage, and deploy APIs at any scale with high performance and availability. With APIG, ",
|
|
"product_code":"apig",
|
|
"title":"Introduction",
|
|
"uri":"apig-ug-0013.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"9",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Opening APIs",
|
|
"uri":"apig-ug-180307001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"9",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"desc":"The following figure shows the process of exposing an API.Creating a GatewayCreate a dedicated gateway.Create a dedicated gateway.Creating an API GroupAn API group facili",
|
|
"product_code":"apig",
|
|
"title":"Process Flow",
|
|
"uri":"apig_02_0001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Creating an API Group",
|
|
"uri":"apig-ug-180307003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"The independent domain name must be registered and resolved. For details, see \"Prerequisites\" in Binding a Domain Name.",
|
|
"product_code":"apig",
|
|
"title":"Binding a Domain Name",
|
|
"uri":"apig-ug-190419107.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"Procedure:Configuring Frontend SettingsConfiguring Backend SettingsFrontend definitionParameterDescriptionNameAPI name. It is recommended that you enter a name based on n",
|
|
"product_code":"apig",
|
|
"title":"Creating an API",
|
|
"uri":"apig_0080101678.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"If the API is called successfully, the status code 200 is displayed. Otherwise, rectify the fault by referring to Error Codes.",
|
|
"product_code":"apig",
|
|
"title":"Debugging an API",
|
|
"uri":"apig-ug-190419108.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"(Optional) Creating an Environment",
|
|
"uri":"apig-ug-180307004.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Publishing an API",
|
|
"uri":"apig-ug-180307005.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"11",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Calling APIs",
|
|
"uri":"apig-ug-180307007.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"9",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"The following figure shows the process of calling an API.Obtaining an APIObtain an API and its documentation from an API provider.Obtain an API and its documentation from",
|
|
"product_code":"apig",
|
|
"title":"Process Flow",
|
|
"uri":"apig-ug-180307008.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"19",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"Creating a Credential and Getting Authorized",
|
|
"uri":"apig-ug-180307010.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"19",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Adding an AppCode for Simple Authentication",
|
|
"uri":"apig-ug-180307009.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"19",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"Use the API test tool to configure the API request and authentication. For details about how to call an API, see section \"Calling Published APIs\" > Calling APIs.For illus",
|
|
"product_code":"apig",
|
|
"title":"Calling an API",
|
|
"uri":"apig-ug-180307011.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"19",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"APIG is a fully managed service that enables you to securely build, manage, and deploy APIs at any scale with high performance and availability. With APIG, you can easily",
|
|
"product_code":"apig",
|
|
"title":"Overview",
|
|
"uri":"apig_03_0001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"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":"apig",
|
|
"title":"API Management",
|
|
"uri":"apig_03_0003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"An API group contains APIs used for the same service. You can manage APIs by group, and must create a group before creating an API.You can create an API group using the f",
|
|
"product_code":"apig",
|
|
"title":"Creating an API Group",
|
|
"uri":"apig_03_0005.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"By importing Cloud Container Engine (CCE) workloads, you can open your CCE service capabilities through APIs.If your gateway does not support CCE workload import, contact",
|
|
"product_code":"apig",
|
|
"title":"Importing a CCE Workload",
|
|
"uri":"apig_03_0071.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"Before you expose an API, bind an independent domain name to the API group so that APIs in the group can be accessed with the domain name. A maximum of five independent d",
|
|
"product_code":"apig",
|
|
"title":"Binding a Domain Name",
|
|
"uri":"apig_03_0006.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"You can define environment variables to allow an API to be called in different environments.Environment variables are manageable and specific to environments. You can add",
|
|
"product_code":"apig",
|
|
"title":"Creating an Environment Variable",
|
|
"uri":"apig_03_0007.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"29"
|
|
},
|
|
{
|
|
"desc":"A gateway response is displayed if APIG fails to process an API request. APIG provides a set of default responses and also allows you to create responses with custom stat",
|
|
"product_code":"apig",
|
|
"title":"Creating a Gateway Response",
|
|
"uri":"apig_03_0008.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"You can selectively expose your backends by configuring their APIs in APIG. To create an API, perform the following steps:Configuring Frontend SettingsFrontend definition",
|
|
"product_code":"apig",
|
|
"title":"Creating an API",
|
|
"uri":"apig_03_0010.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"APIG supports gRPC API creation. gRPC is a modern, open-source, high-performance Remote Procedure Call (RPC) framework that can run in any environment. You only need to d",
|
|
"product_code":"apig",
|
|
"title":"Creating a gRPC API",
|
|
"uri":"apig_03_0078.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"32"
|
|
},
|
|
{
|
|
"desc":"To improve API creation efficiency, you can clone an API with a custom name and path.Policies bound to an API cannot be cloned and can only be manually bound to the new A",
|
|
"product_code":"apig",
|
|
"title":"Cloning an API",
|
|
"uri":"apig_03_0076.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"For security reasons, browsers restrict cross-origin requests initiated from within scripts. This means that a web application can only request resources from its origin.",
|
|
"product_code":"apig",
|
|
"title":"CORS",
|
|
"uri":"apig_03_0011.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"After creating an API, debug it on the APIG console by setting HTTP headers and body to verify whether the API is running normally.APIs with backend request paths contain",
|
|
"product_code":"apig",
|
|
"title":"Debugging an API",
|
|
"uri":"apig_03_0012.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"APIs using app authentication can only be called by credentials that have been authorized to call them.You can authorize credentials only to call APIs that use app authen",
|
|
"product_code":"apig",
|
|
"title":"Authorizing API Access",
|
|
"uri":"apig_03_0013.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"desc":"APIs can be called only after they have been published in an environment. You can publish APIs in different environments. APIG allows you to view the publication history ",
|
|
"product_code":"apig",
|
|
"title":"Publishing an API",
|
|
"uri":"apig_03_0014.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"desc":"You can remove APIs that you do not need from the environments where the APIs have been published.This operation will cause the APIs to be inaccessible in the environment",
|
|
"product_code":"apig",
|
|
"title":"Taking an API Offline",
|
|
"uri":"apig_03_0070.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"Importing and Exorting APIs",
|
|
"uri":"apig_03_0082.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"desc":"Note the following restrictions and compatibility issues when importing or exporting APIs on APIG:APIG parameter restrictions:APIG does not support the configuration of r",
|
|
"product_code":"apig",
|
|
"title":"Restrictions and Compatibility",
|
|
"uri":"apig_03_0083.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"39",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"desc":"You can import Swagger and OpenAPI APIs to a new or existing API group on APIG. Before importing APIs, complete the extended definition of APIG.When you import APIs to a ",
|
|
"product_code":"apig",
|
|
"title":"Importing APIs",
|
|
"uri":"apig_03_0067.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"39",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"You can export APIs one by one or in batches as JSON, YAML, or YML files.Or choose API Management > APIs, and click Export APIs.",
|
|
"product_code":"apig",
|
|
"title":"Exporting APIs",
|
|
"uri":"apig_03_0015.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"39",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Extended Definition",
|
|
"uri":"apig_03_0084.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"39",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"Meaning: Swagger-based apiKey authentication format, which defines an authentication mode provided by APIG.Scope of effect: Security Scheme Object (2.0)/Security Scheme O",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-auth-type",
|
|
"uri":"apig_03_0085.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"Meaning: API request type, which can be public or private.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-request-type",
|
|
"uri":"apig_03_0086.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"desc":"Meaning: Request URL matching mode, which can be NORMAL or SWA.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-match-mode",
|
|
"uri":"apig_03_0087.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"desc":"Meaning: Specifies whether CORS is supported. The value is of the Boolean type.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:For the API request f",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-cors",
|
|
"uri":"apig_03_0088.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"desc":"Meaning: Whether to perform Base64 encoding on the request body used for interaction with FunctionGraph. The value is of the Boolean type.Scope of effect: Operation Objec",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-is-send-fg-body-base64",
|
|
"uri":"apig_03_0106.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"48"
|
|
},
|
|
{
|
|
"desc":"Meaning: API request method used by default if no HTTP request method is specified.Scope of effect: Path Item Object (2.0)/Path Item Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-any-method",
|
|
"uri":"apig_03_0089.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"49"
|
|
},
|
|
{
|
|
"desc":"Meaning: API backend definition.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend",
|
|
"uri":"apig_03_0090.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"desc":"Meaning: API backend service definition.Scope of effect: x-apigateway-backendExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend.parameters",
|
|
"uri":"apig_03_0091.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"desc":"Meaning: HTTP backend service definition.Scope of effect: x-apigateway-backendExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend.httpEndpoints",
|
|
"uri":"apig_03_0092.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"desc":"Meaning: HTTP VPC backend service definition.Scope of effect: x-apigateway-backendExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend.httpVpcEndpoints",
|
|
"uri":"apig_03_0093.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"53"
|
|
},
|
|
{
|
|
"desc":"Meaning: Function backend service definition.Scope of effect: x-apigateway-backendExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend.functionEndpoints",
|
|
"uri":"apig_03_0094.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"54"
|
|
},
|
|
{
|
|
"desc":"Meaning: Mock backend service definition.Scope of effect: x-apigateway-backendExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend.mockEndpoints",
|
|
"uri":"apig_03_0095.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"55"
|
|
},
|
|
{
|
|
"desc":"Meaning: API backend policy.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend-policies",
|
|
"uri":"apig_03_0096.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"56"
|
|
},
|
|
{
|
|
"desc":"Meaning: API backend policy conditions.Scope of effect: x-apigateway-backend-policiesExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-backend-policies.conditions",
|
|
"uri":"apig_03_0097.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"57"
|
|
},
|
|
{
|
|
"desc":"Meaning: Request throttling policy.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-ratelimit",
|
|
"uri":"apig_03_0098.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"58"
|
|
},
|
|
{
|
|
"desc":"Meaning: Mapping between a request throttling policy name and limit values.Scope of effect: Swagger ObjectExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-ratelimits",
|
|
"uri":"apig_03_0099.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"59"
|
|
},
|
|
{
|
|
"desc":"Meaning: Definition of a request throttling policy.Scope of effect: x-apigateway-ratelimitsExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-ratelimits.policy",
|
|
"uri":"apig_03_0100.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"60"
|
|
},
|
|
{
|
|
"desc":"Meaning: Definition of a special request throttling policy.Scope of effect: x-apigateway-ratelimits.policyExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-ratelimits.policy.special",
|
|
"uri":"apig_03_0101.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"61"
|
|
},
|
|
{
|
|
"desc":"Meaning: Access control policy.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-access-control",
|
|
"uri":"apig_03_0102.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"62"
|
|
},
|
|
{
|
|
"desc":"Meaning: Mapping between an access control policy name and limit settings.Scope of effect: Swagger ObjectExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-access-controls",
|
|
"uri":"apig_03_0103.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"63"
|
|
},
|
|
{
|
|
"desc":"Meaning: Definition of an access control policy.Scope of effect: x-apigateway-access-controlsExample:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-access-controls.policy",
|
|
"uri":"apig_03_0104.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"64"
|
|
},
|
|
{
|
|
"desc":"Meaning: API plug-in service.Scope of effect: Operation Object (2.0)/Operation Object (3.0)Example:",
|
|
"product_code":"apig",
|
|
"title":"x-apigateway-plugins",
|
|
"uri":"apig_03_0105.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"43",
|
|
"code":"65"
|
|
},
|
|
{
|
|
"desc":"The APIs page displays all APIs of the current gateway, including the URL, running environment, and authentication mode.",
|
|
"product_code":"apig",
|
|
"title":"Viewing APIs",
|
|
"uri":"apig_03_0016.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"66"
|
|
},
|
|
{
|
|
"desc":"APIG supports HTTP/2, which is a major revision of HTTP and was originally named HTTP 2.0. It provides binary encoding, request multiplexing over a single connection, and",
|
|
"product_code":"apig",
|
|
"title":"HTTP 2.0",
|
|
"uri":"apig_03_0069.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"25",
|
|
"code":"67"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"API Policies",
|
|
"uri":"apig_03_0017.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"68"
|
|
},
|
|
{
|
|
"desc":"APIG provides flexible API control policies.Policy parameters will be stored as plaintext. To prevent information leakage, do not contain sensitive information in these p",
|
|
"product_code":"apig",
|
|
"title":"Creating a Policy and Binding It to APIs",
|
|
"uri":"apig_03_0019.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"69"
|
|
},
|
|
{
|
|
"desc":"For security purposes, the browser restricts cross-domain requests from being initiated from a page script. In this case, the page can access only the resources from the ",
|
|
"product_code":"apig",
|
|
"title":"CORS",
|
|
"uri":"apig_03_0021.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"70"
|
|
},
|
|
{
|
|
"desc":"HTTP response headers are part of the response returned by APIG to a client that calls an API. You can customize HTTP response headers that will be contained in an API re",
|
|
"product_code":"apig",
|
|
"title":"HTTP Response Header Management",
|
|
"uri":"apig_03_0022.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"71"
|
|
},
|
|
{
|
|
"desc":"A request throttling 2.0 policy limits the number of times that an API can be called within a specific time period. Parameter-based, basic, and excluded throttling is sup",
|
|
"product_code":"apig",
|
|
"title":"Request Throttling 2.0",
|
|
"uri":"apig_03_0054.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"72"
|
|
},
|
|
{
|
|
"desc":"Kafka log push policies push calling logs of open APIs to Kafka for analysis.If your gateway does not support this policy, contact technical support to upgrade the gatewa",
|
|
"product_code":"apig",
|
|
"title":"Kafka Log Push",
|
|
"uri":"apig_03_0061.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"73"
|
|
},
|
|
{
|
|
"desc":"Circuit breaker policies protect your backend services when a performance issue occurs. If the backend service of an API times out for N consecutive times or if the laten",
|
|
"product_code":"apig",
|
|
"title":"Circuit Breaker",
|
|
"uri":"apig_03_0023.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"74"
|
|
},
|
|
{
|
|
"desc":"You can configure your own service to authenticate API requests. APIG first invokes this service for authentication, and then invokes the backend service after receiving ",
|
|
"product_code":"apig",
|
|
"title":"Third-Party Authorizer",
|
|
"uri":"apig_03_0077.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"75"
|
|
},
|
|
{
|
|
"desc":"Request throttling limits the number of times APIs can be called by a user or app within a specific time period to protect backend services. The throttling can be down to",
|
|
"product_code":"apig",
|
|
"title":"Request Throttling",
|
|
"uri":"apig_03_0025.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"76"
|
|
},
|
|
{
|
|
"desc":"Access control policies are a type of security measures provided by APIG. You can use them to allow or deny API access from specific IP addresses, account names, or accou",
|
|
"product_code":"apig",
|
|
"title":"Access Control",
|
|
"uri":"apig_03_0027.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"77"
|
|
},
|
|
{
|
|
"desc":"Signature keys are used by backend services to verify the identity of APIG.A signature key consists of a key and secret, and can be used only after being bound to an API.",
|
|
"product_code":"apig",
|
|
"title":"Signature Keys",
|
|
"uri":"apig_03_0028.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"78"
|
|
},
|
|
{
|
|
"desc":"APIG supports custom authentication of both frontend and backend requests.Frontend custom authentication: If you already have an authentication system, you can configure ",
|
|
"product_code":"apig",
|
|
"title":"Custom Authorizers",
|
|
"uri":"apig_03_0029.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"79"
|
|
},
|
|
{
|
|
"desc":"API groups that contain HTTPS-compatible APIs must have their independent domain names bound with SSL certificates. SSL certificates are used for data encryption and iden",
|
|
"product_code":"apig",
|
|
"title":"SSL Certificates",
|
|
"uri":"apig_03_0055.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"80"
|
|
},
|
|
{
|
|
"desc":"Load balance channels expose your services through dedicated gateways, and are accessed through subnets in VPCs for lower latency. The server channel balances loads of ba",
|
|
"product_code":"apig",
|
|
"title":"Load Balance Channels",
|
|
"uri":"apig_03_0040.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"81"
|
|
},
|
|
{
|
|
"desc":"An API can be called in different environments, such as production, testing, and development environments. RELEASE is the default environment provided by APIG.After the e",
|
|
"product_code":"apig",
|
|
"title":"Managing Environments",
|
|
"uri":"apig_03_0041.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"68",
|
|
"code":"82"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Credentials",
|
|
"uri":"apig_03_0030.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"83"
|
|
},
|
|
{
|
|
"desc":"For APIs that use app authentication, create credentials to generate credential IDs and key/secret pairs. When calling such an API, bind a credential to the API, use the ",
|
|
"product_code":"apig",
|
|
"title":"Creating a Credential and Binding It to APIs",
|
|
"uri":"apig_03_0056.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"83",
|
|
"code":"84"
|
|
},
|
|
{
|
|
"desc":"Reset the secret of a credential as necessary. After resetting, the original secret becomes invalid and APIs to which the credential is bound cannot be called. To call th",
|
|
"product_code":"apig",
|
|
"title":"Resetting Secret",
|
|
"uri":"apig_03_0057.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"83",
|
|
"code":"85"
|
|
},
|
|
{
|
|
"desc":"AppCodes are identity credentials of a credential used to call APIs in simple authentication mode. In this mode, the X-Apig-AppCode parameter (whose value is an AppCode o",
|
|
"product_code":"apig",
|
|
"title":"Adding an AppCode for Simple Authentication",
|
|
"uri":"apig_03_0058.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"83",
|
|
"code":"86"
|
|
},
|
|
{
|
|
"desc":"A credential quota policy limits the number of API calls that a credential can make during a specified period.Existing policy: Select a policy.New policy: Configure a pol",
|
|
"product_code":"apig",
|
|
"title":"Binding a Credential Quota Policy",
|
|
"uri":"apig_03_0059.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"83",
|
|
"code":"87"
|
|
},
|
|
{
|
|
"desc":"As a protection mechanism for backend services, access control policies control the client (API caller) IP addresses that can access APIs. You can bind an access control ",
|
|
"product_code":"apig",
|
|
"title":"Binding an Access Control Policy",
|
|
"uri":"apig_03_0060.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"83",
|
|
"code":"88"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Monitoring & Analysis",
|
|
"uri":"apig_03_0031.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"89"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"API Monitoring",
|
|
"uri":"apig_03_0072.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"89",
|
|
"code":"90"
|
|
},
|
|
{
|
|
"desc":"This section describes the metrics that APIG reports to the Cloud Eye service. You can view metrics and alarms by using the Cloud Eye console.SYS.APIC",
|
|
"product_code":"apig",
|
|
"title":"Monitoring Metrics",
|
|
"uri":"apig_03_0032.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"90",
|
|
"code":"91"
|
|
},
|
|
{
|
|
"desc":"You can create alarm rules to monitor the status of your APIs.An alarm rule consists of a rule name, monitored objects, metrics, alarm thresholds, monitoring interval, an",
|
|
"product_code":"apig",
|
|
"title":"Creating Alarm Rules",
|
|
"uri":"apig_03_0033.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"90",
|
|
"code":"92"
|
|
},
|
|
{
|
|
"desc":"Cloud Eye monitors the status of your APIs and allows you to view their metrics.View the call statistics of an API, including Requests, Latency (ms), Data Traffic (bytes)",
|
|
"product_code":"apig",
|
|
"title":"Viewing Metrics",
|
|
"uri":"apig_03_0034.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"90",
|
|
"code":"93"
|
|
},
|
|
{
|
|
"desc":"This section describes how to obtain and analyze the API calling logs of a dedicatedgateway.APIs have been called.Fields in access logs are separated using spaces. The fo",
|
|
"product_code":"apig",
|
|
"title":"Log Analysis",
|
|
"uri":"apig_03_0042.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"89",
|
|
"code":"94"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Gateway Management",
|
|
"uri":"apig_03_0035.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"95"
|
|
},
|
|
{
|
|
"desc":"This section describes how to create a gateway. You can create APIs and use them to provide services only after a gateway is created.There are some limitations on creatin",
|
|
"product_code":"apig",
|
|
"title":"Creating a Gateway",
|
|
"uri":"apig_03_0037.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"95",
|
|
"code":"96"
|
|
},
|
|
{
|
|
"desc":"You can view and modify the configuration of your gateways on the console.",
|
|
"product_code":"apig",
|
|
"title":"Viewing or Modifying Gateway Information",
|
|
"uri":"apig_03_0038.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"95",
|
|
"code":"97"
|
|
},
|
|
{
|
|
"desc":"This section describes how to configure common parameters for a gateway to adjust component functions.Modifying gateway configuration parameters will interrupt services. ",
|
|
"product_code":"apig",
|
|
"title":"Configuring Parameters",
|
|
"uri":"apig_03_0039.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"95",
|
|
"code":"98"
|
|
},
|
|
{
|
|
"desc":"Tags classify your gateways to facilitate search, analysis, and management.You can search, analyze, and manage your resources on the Tag Management Service (TMS) console.",
|
|
"product_code":"apig",
|
|
"title":"Managing Tags",
|
|
"uri":"apig_03_0075.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"95",
|
|
"code":"99"
|
|
},
|
|
{
|
|
"desc":"VPC endpoints are secure and private channels for connecting VPCs to VPC endpoint services.APIs can be exposed and accessed across VPCs in the same region of the same clo",
|
|
"product_code":"apig",
|
|
"title":"Managing VPC Endpoints",
|
|
"uri":"apig_03_0063.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"95",
|
|
"code":"100"
|
|
},
|
|
{
|
|
"desc":"If the specifications of a gateway cannot meet your service requirements, upgrade the specifications.During the specification change, the persistent connection is intermi",
|
|
"product_code":"apig",
|
|
"title":"Modifying Specifications",
|
|
"uri":"apig_03_0064.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"95",
|
|
"code":"101"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"Published API Calling",
|
|
"uri":"apig_03_0045.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"102"
|
|
},
|
|
{
|
|
"desc":"You can call APIs opened by others in APIG.An API can be accessed 1000 times by using the debugging domain name allocated when the API's group is created.If the CA parame",
|
|
"product_code":"apig",
|
|
"title":"Calling APIs",
|
|
"uri":"apig_03_0046.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"102",
|
|
"code":"103"
|
|
},
|
|
{
|
|
"desc":"The following table describes the response headers that APIG adds to the response returned when an API is called.X-Apig-Mode: debug indicates API debugging information.",
|
|
"product_code":"apig",
|
|
"title":"Response Headers",
|
|
"uri":"apig_03_0047.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"102",
|
|
"code":"104"
|
|
},
|
|
{
|
|
"desc":"The following table lists the error codes that you may encounter when calling APIs.For details about the error codes that may occur when you manage APIs, see section \"Err",
|
|
"product_code":"apig",
|
|
"title":"Error Codes",
|
|
"uri":"apig_03_0048.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"102",
|
|
"code":"105"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Permissions Management",
|
|
"uri":"apig_03_0049.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"106"
|
|
},
|
|
{
|
|
"desc":"This topic describes how to use Identity and Access Management (IAM) to implement fine-grained permissions control for your APIG resources. With IAM, you can:Create IAM u",
|
|
"product_code":"apig",
|
|
"title":"Creating a User and Granting APIG Permissions",
|
|
"uri":"apig_03_0050.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"106",
|
|
"code":"107"
|
|
},
|
|
{
|
|
"desc":"Custom policies can be created to supplement the system-defined policies of APIG. For the actions that can be added to custom policies, see .You can create custom policie",
|
|
"product_code":"apig",
|
|
"title":"APIG Custom Policies",
|
|
"uri":"apig_03_0051.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"106",
|
|
"code":"108"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"Auditing",
|
|
"uri":"apig_03_0065.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"109"
|
|
},
|
|
{
|
|
"desc":"If you want to collect, record, or query operation logs for APIG in common scenarios such as security analysis, audit, and problem locating, enable Cloud Trace Service (C",
|
|
"product_code":"apig",
|
|
"title":"APIG Operations Recorded by CTS",
|
|
"uri":"apig_03_0052.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"109",
|
|
"code":"110"
|
|
},
|
|
{
|
|
"desc":"After you enable CTS and the management tracker is created, CTS starts recording operations on cloud resources. CTS stores operation records generated in the last seven d",
|
|
"product_code":"apig",
|
|
"title":"Querying Real-Time Traces",
|
|
"uri":"apig_03_0053.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"109",
|
|
"code":"111"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"FAQs",
|
|
"uri":"apig_03_0079.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"112"
|
|
},
|
|
{
|
|
"desc":"How Do I Set the Backend Address If I Will Not Use a VPC Channel (or Load Balance Channel)?How Can I Configure the Backend Service Address?Can I Specify a Private Network",
|
|
"product_code":"apig",
|
|
"title":"Common FAQs",
|
|
"uri":"index.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"113"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"apig",
|
|
"title":"API Creation",
|
|
"uri":"apig-faq-create.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"114"
|
|
},
|
|
{
|
|
"desc":"There are two types of responses:Gateway response codes: returned by the gateway for API requests that are throttled, denied, or failed in authentication. For details abo",
|
|
"product_code":"apig",
|
|
"title":"How Do I Define Response Codes for an API?",
|
|
"uri":"apig-faq-2005001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"115"
|
|
},
|
|
{
|
|
"desc":"Use the port of the API backend service.For details about how to configure the API backend, see section \"Creating an API\" in the API Gateway User Guide.",
|
|
"product_code":"apig",
|
|
"title":"How Do I Specify the Host Port for a VPC Channel (or Load Balance Channel)?",
|
|
"uri":"apig-faq-2005002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"116"
|
|
},
|
|
{
|
|
"desc":"Specify the backend address as a public domain name or a public IP address, such as the Elastic IP (EIP) of an Elastic Cloud Server (ECS). To do this, enable public outbo",
|
|
"product_code":"apig",
|
|
"title":"How Do I Set the Backend Address If I Will Not Use a VPC Channel (or Load Balance Channel)?",
|
|
"uri":"apig-faq-2005004.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"117"
|
|
},
|
|
{
|
|
"desc":"Configure the backend service address as an ECS EIP, or the public IP address or domain name of your own server.For details about how to configure the API backend, see se",
|
|
"product_code":"apig",
|
|
"title":"How Can I Configure the Backend Service Address?",
|
|
"uri":"apig-faq-190627028.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"118"
|
|
},
|
|
{
|
|
"desc":"For dedicated gateways, you can use private network load balancer addresses.Alternatively, you can use the EIP bound to a public network load balancer.",
|
|
"product_code":"apig",
|
|
"title":"Can I Specify a Private Network Load Balancer Address for the Backend Service?",
|
|
"uri":"apig-faq-2005003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"119"
|
|
},
|
|
{
|
|
"desc":"If you use a dedicated gateway, you can specify either an IP address that belongs to the same subnet where the gateway is deployed, or the private address of a local data",
|
|
"product_code":"apig",
|
|
"title":"Can I Specify the Backend Address as a Subnet IP Address?",
|
|
"uri":"apig-faq-2005006.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"120"
|
|
},
|
|
{
|
|
"desc":"YesAPIG supports the configuration of multiple backend endpoints through a VPC channel (also called \"load balance channel\"). You can add multiple cloud servers to each VP",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Support Multiple Backend Endpoints?",
|
|
"uri":"apig-faq-180606012.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"121"
|
|
},
|
|
{
|
|
"desc":"If you are using a dedicated gateway, add an A record that points the independent domain name to the inbound access address of the gateway. You can bind five independent ",
|
|
"product_code":"apig",
|
|
"title":"What Should I Do After Applying for an Independent Domain Name?",
|
|
"uri":"apig-faq-2005009.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"122"
|
|
},
|
|
{
|
|
"desc":"In a dedicated gateway, you can add a private domain name (filing not required), and add an A record to point the domain name to the inbound access address of the gateway",
|
|
"product_code":"apig",
|
|
"title":"Can I Bind Private Domain Names for API Access?",
|
|
"uri":"apig-faq-2005021.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"123"
|
|
},
|
|
{
|
|
"desc":"Ensure that CORS has been enabled for the API.Go to the API details page, click Edit, and check whether CORS is enabled. If it is not, enable it.Go to the API details pag",
|
|
"product_code":"apig",
|
|
"title":"Why Does an API Failed to Be Called Across Domains?",
|
|
"uri":"apig-faq-190627027.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"114",
|
|
"code":"124"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"API Calling",
|
|
"uri":"apig-faq-180919017.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"125"
|
|
},
|
|
{
|
|
"desc":"API calling failures may occur in three scenarios: within a VPC, between VPCs, and on a public network.Within a VPC: Check whether the domain name is the same as that aut",
|
|
"product_code":"apig",
|
|
"title":"What Are the Possible Causes for an API Calling Failure?",
|
|
"uri":"apig-faq-2005010.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"126"
|
|
},
|
|
{
|
|
"desc":"If an error code is returned when you call your own APIs, see Error Codes.If an error code is returned when you manage your APIs,see section \"Error Codes\" in the API Gate",
|
|
"product_code":"apig",
|
|
"title":"What Should I Do If an Error Code Is Returned During API Calling?",
|
|
"uri":"apig-faq-2005012.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"127"
|
|
},
|
|
{
|
|
"desc":"The request URL (including request parameters) is too long. Place the request parameters in the request body and try again.For details about API calling errors, see secti",
|
|
"product_code":"apig",
|
|
"title":"Why Am I Seeing the Error Message \"414 Request URI too large\" When I Call an API?",
|
|
"uri":"apig-faq-2005022.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"128"
|
|
},
|
|
{
|
|
"desc":"If an open API in APIG failed to be called, troubleshoot the failure by performing the following operations:The domain name, request method, or path used for calling the ",
|
|
"product_code":"apig",
|
|
"title":"What Should I Do If \"The API does not exist or has not been published in the environment.\" Is Displayed?",
|
|
"uri":"apig-faq-19123002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"129"
|
|
},
|
|
{
|
|
"desc":"Check whether the backend service is accessible, and modify the backend service if it is inaccessible.Check the ECS security group configurations of the backend service a",
|
|
"product_code":"apig",
|
|
"title":"Why Am I Seeing the Message \"No backend available\"?",
|
|
"uri":"apig-faq-181016018.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"130"
|
|
},
|
|
{
|
|
"desc":"The following table lists the possible causes if a backend service fails to be invoked or the invocation times out.",
|
|
"product_code":"apig",
|
|
"title":"What Are the Possible Causes If the Message \"Backend unavailable\" or \"Backend timeout\" Is Displayed?",
|
|
"uri":"apig_0087908599.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"131"
|
|
},
|
|
{
|
|
"desc":"An error message indicating a domain name resolution failure is displayed when the backend service is called, although private domain name resolution is completed for the",
|
|
"product_code":"apig",
|
|
"title":"Why Am I Seeing the Message \"Backend domain name resolution failed\" When a Backend Service Is Called?",
|
|
"uri":"apig-faq-0004.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"132"
|
|
},
|
|
{
|
|
"desc":"Modification of the backend_timeout parameter in gateways does not take effect.The Timeout (ms) parameter on the Define Backend Request page is not modified.Log in to the",
|
|
"product_code":"apig",
|
|
"title":"Why Doesn't Modification of the backend_timeout Parameter Take Effect?",
|
|
"uri":"apig-faq-19122004.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"133"
|
|
},
|
|
{
|
|
"desc":"By default, the API in the RELEASE environment is called.If you want to call the same API in another environment, add the request header X-Stage to specify the environmen",
|
|
"product_code":"apig",
|
|
"title":"How Do I Switch the Environment for API Calling?",
|
|
"uri":"apig-faq-2005011.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"134"
|
|
},
|
|
{
|
|
"desc":"Dedicated gateway: APIG forwards only API requests whose body is no larger than 12 MB. If your gateway will receive requests with a body larger than 12 MB, modify the req",
|
|
"product_code":"apig",
|
|
"title":"What Is the Maximum Size of an API Request Package?",
|
|
"uri":"apig-faq-180606013.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"135"
|
|
},
|
|
{
|
|
"desc":"APIG provides SDKs and demos in multiple languages, such as Java, Python, C, PHP, and Go, for app authentication.To use Objective-C (for iOS) or other languages, see Deve",
|
|
"product_code":"apig",
|
|
"title":"How Do I Perform App Authentication in iOS System?",
|
|
"uri":"apig-faq-190515025.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"136"
|
|
},
|
|
{
|
|
"desc":"The header parameter x-auth-token has already been defined in APIG.To use this parameter to call an API, add the parameter and its value to the request header.",
|
|
"product_code":"apig",
|
|
"title":"Why Can't I Create a Header Parameter Named x-auth-token for an API Called Through IAM Authentication?",
|
|
"uri":"apig-faq-190627029.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"137"
|
|
},
|
|
{
|
|
"desc":"How many apps (credentials) can I create?You can create a maximum of 50 apps (credentials).How do I isolate the calling information among the third parties that call the ",
|
|
"product_code":"apig",
|
|
"title":"App (Credential) FAQs",
|
|
"uri":"apig-faq-190627030.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"138"
|
|
},
|
|
{
|
|
"desc":"Yes, mobile apps can call APIs.In app authentication mode, the AppKey and AppSecret of a mobile app are replaced with those in the relevant SDK to sign the app.",
|
|
"product_code":"apig",
|
|
"title":"Can Mobile Apps Call APIs?",
|
|
"uri":"apig-faq-180307004.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"139"
|
|
},
|
|
{
|
|
"desc":"Yes, applications deployed in a VPC can call APIs by default. If domain name resolution fails, configure a DNS server on the current endpoint by following the instruction",
|
|
"product_code":"apig",
|
|
"title":"Can Applications Deployed in a VPC Call APIs?",
|
|
"uri":"apig-faq-180307008.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"140"
|
|
},
|
|
{
|
|
"desc":"Yes.When creating an API, you can select HTTP, HTTPS, or HTTP&HTTPS. HTTP is equivalent to WebSocket (ws), and HTTPS is equivalent to WebSocket Secure (wss).",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Support WebSocket Data Transmission?",
|
|
"uri":"apig-faq-190627033.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"141"
|
|
},
|
|
{
|
|
"desc":"Yes.But you should use persistent connections properly to avoid occupying too many resources.",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Support Persistent Connections?",
|
|
"uri":"apig-faq-19122001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"142"
|
|
},
|
|
{
|
|
"desc":"If multiple backend policies are configured for an API, APIG will match the backend policies in sequence. If an API request matches one of the backend policies, APIG imme",
|
|
"product_code":"apig",
|
|
"title":"How Will the Requests for an API with Multiple Backend Policies Be Matched and Executed?",
|
|
"uri":"apig-faq-19123001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"143"
|
|
},
|
|
{
|
|
"desc":"No.But there is a limit on the size of the request body. For details, see the request_body_size parameter in the API Gateway User Guide.",
|
|
"product_code":"apig",
|
|
"title":"Is There a Limit on the Size of the Response to an API Request?",
|
|
"uri":"apig-faq-19122003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"144"
|
|
},
|
|
{
|
|
"desc":"Enable public access for the relevant gateway to allow external services to call APIs.If you encounter a network problem when calling APIs, see What Are the Possible Caus",
|
|
"product_code":"apig",
|
|
"title":"How Can I Access Backend Services over Public Networks Through APIG?",
|
|
"uri":"apig-faq-0007.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"125",
|
|
"code":"145"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"API Authentication",
|
|
"uri":"apig-faq-auth.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"146"
|
|
},
|
|
{
|
|
"desc":"Dedicated gateway: Yes.Frontend two-way authentication: When binding an independent domain name, select an SSL certificate that contains a CA certificate. Client authenti",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Support HTTPS Two-Way Authentication?",
|
|
"uri":"apig-faq-2005013.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"147"
|
|
},
|
|
{
|
|
"desc":"To call APIs that do not require authentication, construct standard HTTP requests and send them to APIG.APIG transparently transmits requests to call an API that does not",
|
|
"product_code":"apig",
|
|
"title":"How Do I Call an API That Does Not Require Authentication?",
|
|
"uri":"apig-faq-2005020.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"148"
|
|
},
|
|
{
|
|
"desc":"APIG supports TLS 1.1 and TLS 1.2, but does not support TLS 1.0 or TLS 1.3.For details, see section \"Binding a Domain Name\" in the API Gateway User Guide.",
|
|
"product_code":"apig",
|
|
"title":"Which TLS Versions Does APIG Support?",
|
|
"uri":"apig-faq-2005015.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"149"
|
|
},
|
|
{
|
|
"desc":"Yes.For details, see section \"Custom Authorizers\" in the API Gateway User Guide.",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Support Custom Authentication?",
|
|
"uri":"apig-faq-2005016.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"150"
|
|
},
|
|
{
|
|
"desc":"Yes. The request body is another element that needs to be signed in addition to the mandatory request header parameters. For example, when an API used to upload a file us",
|
|
"product_code":"apig",
|
|
"title":"Will the Request Body Be Signed for Security Authentication?",
|
|
"uri":"apig-faq-2005018.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"151"
|
|
},
|
|
{
|
|
"desc":"You may encounter the following errors related to IAM authentication information:Incorrect IAM authentication information: AK access failed to reach the limit,forbiddenIn",
|
|
"product_code":"apig",
|
|
"title":"Common Errors Related to IAM Authentication Information",
|
|
"uri":"apig-faq-0003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"152"
|
|
},
|
|
{
|
|
"desc":"You may encounter the following errors related to app authentication information:Incorrect app authentication information: app not found, appkey xxxIncorrect app authenti",
|
|
"product_code":"apig",
|
|
"title":"What Should I Do If the App Authentication Information Is Incorrect?",
|
|
"uri":"apig-faq-0009.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"146",
|
|
"code":"153"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"API Control Policies",
|
|
"uri":"apig-faq-0002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"154"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Request Throttling",
|
|
"uri":"apig-faq-2005032.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"154",
|
|
"code":"155"
|
|
},
|
|
{
|
|
"desc":"No,but you can limit the maximum number of API calls allowed within a specific period of time.",
|
|
"product_code":"apig",
|
|
"title":"Can I Configure the Maximum Number of Concurrent Requests?",
|
|
"uri":"apig-faq-2005026.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"155",
|
|
"code":"156"
|
|
},
|
|
{
|
|
"desc":"Yes.For details about subdomain names (debugging domain names), see section \"Binding a Domain Name\" in the API Gateway User Guide.",
|
|
"product_code":"apig",
|
|
"title":"Is the Restriction of 1000 Requests per Day to a Subdomain Name (Debugging Domain Name) Applied to Enterprise Accounts?",
|
|
"uri":"apig-faq-190627032.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"155",
|
|
"code":"157"
|
|
},
|
|
{
|
|
"desc":"Dedicated gateways have bandwidth limits. When you create a dedicated gateway, you can set the bandwidth for public inbound and outbound access.",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Have Bandwidth Limits?",
|
|
"uri":"apig-faq-19122002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"155",
|
|
"code":"158"
|
|
},
|
|
{
|
|
"desc":"API call limit or source IP address request limit of the policy does not take effect.Check whether the policy has been bound to an API.Check whether the policy has been b",
|
|
"product_code":"apig",
|
|
"title":"Why Doesn't a Request Throttling Policy Take Effect?",
|
|
"uri":"apig-faq-0001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"155",
|
|
"code":"159"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Access Control",
|
|
"uri":"apig-faq-2005033.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"154",
|
|
"code":"160"
|
|
},
|
|
{
|
|
"desc":"You can provide an open API to specific users in either of the following ways:Select app authentication when you create the API, and share the AppKey and AppSecret with t",
|
|
"product_code":"apig",
|
|
"title":"How Do I Provide an Open API to Specific Users?",
|
|
"uri":"apig-faq-2005008.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"160",
|
|
"code":"161"
|
|
},
|
|
{
|
|
"desc":"You can choose either of the following solutions:Solution 1: Create an API that does not require authentication, and configure an access control policy to whitelist the I",
|
|
"product_code":"apig",
|
|
"title":"How Do I Exclude a Specific IP Address for Identity Authentication of an API?",
|
|
"uri":"apig-faq-2005023.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"160",
|
|
"code":"162"
|
|
},
|
|
{
|
|
"desc":"Not necessarily.In APIG, access control is based on the value of $remote_addr. $remote_addr indicates a client IP address and is determined by the access mode. If a clien",
|
|
"product_code":"apig",
|
|
"title":"Are Client IP Addresses Verified for Access Control?",
|
|
"uri":"apig-faq-0008.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"160",
|
|
"code":"163"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"API Publishing",
|
|
"uri":"apig-faq-180919016.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"164"
|
|
},
|
|
{
|
|
"desc":"Yes.After you modify the parameters of a published API, you must publish the API again to synchronize the modifications to the environment.For details, see section \"Publi",
|
|
"product_code":"apig",
|
|
"title":"Do I Need to Publish an API Again After Modification?",
|
|
"uri":"apig-faq-180307002.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"164",
|
|
"code":"165"
|
|
},
|
|
{
|
|
"desc":"Yes. To access an API published in a non-RELEASE environment, add the x-stage header to the API request.Example:You can also refer to examples of section \"Quickly Opening",
|
|
"product_code":"apig",
|
|
"title":"Can I Access an API Published in a Non-RELEASE Environment?",
|
|
"uri":"apig-faq-180606011.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"164",
|
|
"code":"166"
|
|
},
|
|
{
|
|
"desc":"Yes, you can invoke different backend services by publishing an API in different environments while specifying environment variables and backend parameters.For details ab",
|
|
"product_code":"apig",
|
|
"title":"Can I Invoke Different Backend Services by Publishing an API in Different Environments?",
|
|
"uri":"apig-faq-181016019.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"164",
|
|
"code":"167"
|
|
},
|
|
{
|
|
"desc":"No.APIG debugs APIs in a specific debugging environment. After debugging is completed, you need to publish your API in an environment, and use code or Postman to add the ",
|
|
"product_code":"apig",
|
|
"title":"Can I Specify an Environment for API Debugging?",
|
|
"uri":"apig-faq-2005027.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"164",
|
|
"code":"168"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"API Import and Export",
|
|
"uri":"apig-faq-2005035.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"169"
|
|
},
|
|
{
|
|
"desc":"Possible cause 1: The number of APIs exceeds the maximum allowed limit for a single import. For more APIs (300), import them in batches or submit a service ticket to incr",
|
|
"product_code":"apig",
|
|
"title":"Why Does API Import Fail?",
|
|
"uri":"apig-faq-2005024.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"169",
|
|
"code":"170"
|
|
},
|
|
{
|
|
"desc":"The template is being developed.Currently, you can configure one or two APIs in APIG, and then export them to use as templates.",
|
|
"product_code":"apig",
|
|
"title":"Does APIG Provide a Template for Importing APIs from Swagger Files?",
|
|
"uri":"apig-faq-2005025.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"169",
|
|
"code":"171"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"API Security",
|
|
"uri":"apig-faq-180919015.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"172"
|
|
},
|
|
{
|
|
"desc":"Identity authenticationConfigure IAM or App authentication for APIs to prevent malicious calling.Configure IAM or App authentication for APIs to prevent malicious calling",
|
|
"product_code":"apig",
|
|
"title":"How Can I Protect My APIs?",
|
|
"uri":"apig-faq-180307003.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"172",
|
|
"code":"173"
|
|
},
|
|
{
|
|
"desc":"You can ensure the security of backend services invoked by APIG by using the following methods:Bind signature keys to APIsAfter a signature key is bound to an API, APIG a",
|
|
"product_code":"apig",
|
|
"title":"How Do I Ensure the Security of Backend Services Invoked by APIG?",
|
|
"uri":"apig-faq-180307009.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"172",
|
|
"code":"174"
|
|
},
|
|
{
|
|
"desc":"No.",
|
|
"product_code":"apig",
|
|
"title":"Can I Control Access to the Private IP Addresses of the ECSs in a VPC Channel (or Load Balance Channel)?",
|
|
"uri":"apig-faq-191201.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"172",
|
|
"code":"175"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Other FAQs",
|
|
"uri":"apig-faq-180919014.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"112",
|
|
"code":"176"
|
|
},
|
|
{
|
|
"desc":"An API can be published in different environments, such as RELEASE (online environment) and BETA (test environment).An app (credential) refers to the identity of an API c",
|
|
"product_code":"apig",
|
|
"title":"What Are the Relationships Between an API, Environment, and App (Credential)?",
|
|
"uri":"apig_0084464485.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"176",
|
|
"code":"177"
|
|
},
|
|
{
|
|
"desc":"You can use APIG to manage and call APIs in the following ways:Management console, a web-based service management platformIf you have already registered an account, log i",
|
|
"product_code":"apig",
|
|
"title":"How Can I Use APIG?",
|
|
"uri":"apig_0084464486.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"176",
|
|
"code":"178"
|
|
},
|
|
{
|
|
"desc":"APIG supports Java, Go, Python, C#, JavaScript, PHP, C++, C, and Android SDKs.For details about SDKs, see the API Gateway Developer Guide.",
|
|
"product_code":"apig",
|
|
"title":"What SDK Languages Does APIG Support?",
|
|
"uri":"apig-faq-180606010.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"176",
|
|
"code":"179"
|
|
},
|
|
{
|
|
"desc":"Yes.If you are using dedicated gateways, configure the maximum request body size allowed by setting the request_body_size parameter. The value ranges from 1 MB to 9536 MB",
|
|
"product_code":"apig",
|
|
"title":"Can I Upload Files Using the POST Method?",
|
|
"uri":"apig-faq-180307006.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"176",
|
|
"code":"180"
|
|
},
|
|
{
|
|
"desc":"When receiving an API request, APIG returns a response. A similar response body is as follows:\"error_code\": error code\"error_msg\": description of the error",
|
|
"product_code":"apig",
|
|
"title":"What Are the Error Messages Returned by APIG Like?",
|
|
"uri":"apig-faq-180307001.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"176",
|
|
"code":"181"
|
|
},
|
|
{
|
|
"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":"apig",
|
|
"title":"Change History",
|
|
"uri":"apig_03_0081.html",
|
|
"doc_type":"usermanual",
|
|
"p_code":"",
|
|
"code":"182"
|
|
}
|
|
] |