yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
9ced3b3fb0feb61e3a1e973d46dca4beb8ce2a90
doc-exports/docs/apig/umn/CLASS.TXT.json
Chen, Junjie 91c429e341 APIG UMN 20230331 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2023-06-01 08:59:08 +00:00

1487 lines
58 KiB
JSON
Raw Blame History

[
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Service Overview",
"uri":"apig-ug-0016.html",
"doc_type":"usermanual",
"p_code":"",
"code":"1"
},
{
"desc":"API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps you build, manage, and deploy APIs at any scale. With just a",
"product_code":"apig",
"title":"What Is APIG?",
"uri":"apig-ug-0017.html",
"doc_type":"usermanual",
"p_code":"1",
"code":"2"
},
{
"desc":"You can quickly create APIs by configuring the required settings on the API Gateway console. API Gateway provides an inline debugging tool to simplify API development, an",
"product_code":"apig",
"title":"Product Advantages",
"uri":"apig-zh-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-zh-pd-180307003.html",
"doc_type":"usermanual",
"p_code":"1",
"code":"4"
},
{
"desc":"Table 1 lists the specifications of dedicated API gateways.For dedicated gateways, you can adjust the maximum number of requests per second for each API.The specification",
"product_code":"apig",
"title":"Specifications",
"uri":"apig-specifications.html",
"doc_type":"usermanual",
"p_code":"1",
"code":"5"
},
{
"desc":"To change the default restrictions, increase the quota by referring to Help Center > Others > FAQs > How Do I Apply for a Higher Quota?",
"product_code":"apig",
"title":"Notes and Constraints",
"uri":"apig-zh-pd-180307005.html",
"doc_type":"usermanual",
"p_code":"1",
"code":"6"
},
{
"desc":"If you need to assign different permissions to employees 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-zh-pd-180307004.html",
"doc_type":"usermanual",
"p_code":"1",
"code":"8"
},
{
"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":"Using APIG",
"uri":"en-us_topic_0080101651.html",
"doc_type":"usermanual",
"p_code":"",
"code":"9"
},
{
"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-ug-0012.html",
"doc_type":"usermanual",
"p_code":"",
"code":"10"
},
{
"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":"10",
"code":"11"
},
{
"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-en-ug-180307001.html",
"doc_type":"usermanual",
"p_code":"10",
"code":"12"
},
{
"desc":"The following figure shows the process of exposing an API.Creating a GatewayBuy a dedicated gateway. For details, see Buying a Dedicated Gateway.Buy a dedicated gateway. ",
"product_code":"apig",
"title":"Process Flow",
"uri":"apig-en-ug-180307002.html",
"doc_type":"usermanual",
"p_code":"12",
"code":"13"
},
{
"desc":"API group informationParameterDescriptionNameAPI group name. It is recommended that you enter a name based on naming rules to facilitate search.DescriptionDescription of ",
"product_code":"apig",
"title":"Creating an API Group",
"uri":"apig-en-ug-180307003.html",
"doc_type":"usermanual",
"p_code":"12",
"code":"14"
},
{
"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":"12",
"code":"15"
},
{
"desc":"Create an API with the following steps:Setting Basic InformationDefining API RequestDefining Backend ServiceDefining ResponsesSetting basic informationParameterDescriptio",
"product_code":"apig",
"title":"Creating an API",
"uri":"en-us_topic_0080101678.html",
"doc_type":"usermanual",
"p_code":"12",
"code":"16"
},
{
"desc":"If the API is called successfully, the status code 200 is displayed.",
"product_code":"apig",
"title":"Debugging an API",
"uri":"apig-ug-190419108.html",
"doc_type":"usermanual",
"p_code":"12",
"code":"17"
},
{
"desc":"Environment informationParameterDescriptionNameEnvironment name. It is recommended that you enter a name based on naming rules to facilitate search.DescriptionDescription",
"product_code":"apig",
"title":"(Optional) Creating an Environment",
"uri":"apig-en-ug-180307004.html",
"doc_type":"usermanual",
"p_code":"12",
"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":"Publishing an API",
"uri":"apig-en-ug-180307005.html",
"doc_type":"usermanual",
"p_code":"12",
"code":"19"
},
{
"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-en-ug-180307007.html",
"doc_type":"usermanual",
"p_code":"10",
"code":"20"
},
{
"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-en-ug-180307008.html",
"doc_type":"usermanual",
"p_code":"20",
"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":"Creating an App and Getting Authorized",
"uri":"apig-en-ug-180307010.html",
"doc_type":"usermanual",
"p_code":"20",
"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":"apig",
"title":"Adding an AppCode for Simple Authentication",
"uri":"apig-en-ug-180307009.html",
"doc_type":"usermanual",
"p_code":"20",
"code":"23"
},
{
"desc":"Use an API test tool to configure the API calling information.For illustration purposes, an API and its documentation are obtained through offline channels. You can also ",
"product_code":"apig",
"title":"Calling an API",
"uri":"apig-en-ug-180307011.html",
"doc_type":"usermanual",
"p_code":"20",
"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":"Gateway Management",
"uri":"apig-ug-0006.html",
"doc_type":"usermanual",
"p_code":"",
"code":"25"
},
{
"desc":"This section describes how to buy a dedicated gateway. You can create APIs and use them to provide services only after a dedicated gateway is created.There are some limit",
"product_code":"apig",
"title":"Buying a Dedicated Gateway",
"uri":"apig-ug-191004.html",
"doc_type":"usermanual",
"p_code":"25",
"code":"26"
},
{
"desc":"You can modify the basic information and configuration parameters of dedicated gateways.To modify the basic information about a dedicated gateway, do as follows:",
"product_code":"apig",
"title":"Modifying a Dedicated Gateway",
"uri":"apig-ug-200801.html",
"doc_type":"usermanual",
"p_code":"25",
"code":"27"
},
{
"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-ug-0019.html",
"doc_type":"usermanual",
"p_code":"25",
"code":"28"
},
{
"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 Opening",
"uri":"apig-ug-0008.html",
"doc_type":"usermanual",
"p_code":"",
"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":"apig",
"title":"API Group Management",
"uri":"apig-en-ug-180307014.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"30"
},
{
"desc":"Before creating an API, you must create an API group. An API group contains different APIs used for the same service.Each API can only belong to one API group.After the A",
"product_code":"apig",
"title":"Creating an API Group",
"uri":"apig-en-ug-180307015.html",
"doc_type":"usermanual",
"p_code":"30",
"code":"31"
},
{
"desc":"Before you open an API, you must bind one or more independent domain names to the group to which the API belongs.In a dedicated gateway, you cannot bind the same independ",
"product_code":"apig",
"title":"Binding a Domain Name",
"uri":"apig-en-ug-180327076.html",
"doc_type":"usermanual",
"p_code":"30",
"code":"32"
},
{
"desc":"You can delete an API group if you do not require it.API groups that contain APIs cannot be deleted.You have created an API group.In the Operation column of the target AP",
"product_code":"apig",
"title":"Deleting an API Group",
"uri":"apig-en-ug-180307018.html",
"doc_type":"usermanual",
"p_code":"30",
"code":"33"
},
{
"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 gateway responses with cus",
"product_code":"apig",
"title":"Adding a Gateway Response",
"uri":"apig-lgug-200226001.html",
"doc_type":"usermanual",
"p_code":"30",
"code":"34"
},
{
"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-en-ug-180307019.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"35"
},
{
"desc":"You can selectively expose your services by configuring their APIs in APIG.To create an API, set the basic information and define the API request, backend service, and re",
"product_code":"apig",
"title":"Creating an API",
"uri":"apig-en-ug-180307020.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"36"
},
{
"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-en-ug-180621094.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"37"
},
{
"desc":"After creating an API, debug it on the APIG console by setting HTTP headers and body parameters to verify whether the API is running normally.APIs with backend request pa",
"product_code":"apig",
"title":"Debugging an API",
"uri":"apig-en-ug-180307025.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"38"
},
{
"desc":"APIs using app authentication can only be called by apps that have been authorized to call them.You can only authorize apps to call published APIs.You can authorize apps ",
"product_code":"apig",
"title":"Authorizing Apps to Call an API",
"uri":"apig-en-ug-180307021.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"39"
},
{
"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-en-ug-180307023.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"40"
},
{
"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-en-ug-180307024.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"41"
},
{
"desc":"You can delete published APIs you no longer require.Deleted APIs cannot be accessed by apps or users who were using the APIs, so make sure you notify users before the del",
"product_code":"apig",
"title":"Deleting an API",
"uri":"apig-en-ug-180307027.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"42"
},
{
"desc":"APIG allows you to import Swagger 2.0 APIs to existing or new API groups. Swagger is an open-source tool built based on OpenAPI specifications to design, build, record, a",
"product_code":"apig",
"title":"Importing APIs",
"uri":"apig-en-ug-181025104.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"43"
},
{
"desc":"You can export APIs one by one or in batches as JSON or YAML files.You have created an API group and API.The export result is displayed on the right.",
"product_code":"apig",
"title":"Exporting APIs",
"uri":"apig-en-ug-181204105.html",
"doc_type":"usermanual",
"p_code":"35",
"code":"44"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Request Throttling",
"uri":"apig-en-ug-180307028.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"45"
},
{
"desc":"Request throttling controls the number of times an API can be called within a time period to protect backend services.To provide stable, uninterrupted services, you can c",
"product_code":"apig",
"title":"Creating a Request Throttling Policy",
"uri":"apig-en-ug-180307029.html",
"doc_type":"usermanual",
"p_code":"45",
"code":"46"
},
{
"desc":"You can delete request throttling policies you no longer require.You have created a request throttling policy.In the Operation column of the request throttling policy you",
"product_code":"apig",
"title":"Deleting a Request Throttling Policy",
"uri":"apig-en-ug-180307032.html",
"doc_type":"usermanual",
"p_code":"45",
"code":"47"
},
{
"desc":"If you want to control the number of API calls received from a specific app or tenant, add an excluded app or tenant to a request throttling policy.You have created an ap",
"product_code":"apig",
"title":"Adding an Excluded App or Tenant",
"uri":"apig-en-ug-180307033.html",
"doc_type":"usermanual",
"p_code":"45",
"code":"48"
},
{
"desc":"You can remove excluded apps or tenants from a request throttling policy. This section takes an excluded app as an example.You have created a request throttling policy.Yo",
"product_code":"apig",
"title":"Removing an Excluded App or Tenant",
"uri":"apig-en-ug-180307035.html",
"doc_type":"usermanual",
"p_code":"45",
"code":"49"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Access Control",
"uri":"apig-en-ug-180712096.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"50"
},
{
"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 or accounts.Access contr",
"product_code":"apig",
"title":"Creating an Access Control Policy",
"uri":"apig-en-ug-180712097.html",
"doc_type":"usermanual",
"p_code":"50",
"code":"51"
},
{
"desc":"You can delete access control policies you no longer require.You have created an access control policy.In the Operation column of the access control policy you want to de",
"product_code":"apig",
"title":"Deleting an Access Control Policy",
"uri":"apig-en-ug-180712100.html",
"doc_type":"usermanual",
"p_code":"50",
"code":"52"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Environment Management",
"uri":"apig-en-ug-180307036.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"53"
},
{
"desc":"An API can be called in different environments, such as production, testing, and development environments. RELEASE is the default environment provided by APIG. You can de",
"product_code":"apig",
"title":"Creating an Environment and Environment Variable",
"uri":"apig-en-ug-180307037.html",
"doc_type":"usermanual",
"p_code":"53",
"code":"54"
},
{
"desc":"You can delete environments you no longer require.You have created an environment.You can delete an environment only if no APIs have been published in the environment.",
"product_code":"apig",
"title":"Deleting an Environment",
"uri":"apig-en-ug-180307039.html",
"doc_type":"usermanual",
"p_code":"53",
"code":"55"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Signature Key Management",
"uri":"apig-en-ug-180307040.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"56"
},
{
"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":"Creating and Using a Signature Key",
"uri":"apig-en-ug-180307041.html",
"doc_type":"usermanual",
"p_code":"56",
"code":"57"
},
{
"desc":"You can delete signature keys you no longer require.You have created a signature key.In the Operation column of the signature key you want to delete, click Delete.Click t",
"product_code":"apig",
"title":"Deleting a Signature Key",
"uri":"apig-en-ug-180307045.html",
"doc_type":"usermanual",
"p_code":"56",
"code":"58"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"VPC Channel Management",
"uri":"apig-en-ug-180425080.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"59"
},
{
"desc":"VPC channels allow services deployed in VPCs to be accessed through their subnets, lowering latency and balancing loads of backend services.After creating a VPC channel, ",
"product_code":"apig",
"title":"Creating a VPC Channel",
"uri":"apig-en-ug-180425081.html",
"doc_type":"usermanual",
"p_code":"59",
"code":"60"
},
{
"desc":"You can delete VPC channels you no longer require.VPC channels that are currently in use by published APIs cannot be deleted.You have created a VPC channel.In the Operati",
"product_code":"apig",
"title":"Deleting a VPC Channel",
"uri":"apig-en-ug-180425083.html",
"doc_type":"usermanual",
"p_code":"59",
"code":"61"
},
{
"desc":"You can modify the health check configurations of a VPC channel to meet service requirements.You have created a VPC channel.Health check configurationsParameterDescriptio",
"product_code":"apig",
"title":"Editing Health Check Configurations",
"uri":"apig-en-ug-180425084.html",
"doc_type":"usermanual",
"p_code":"59",
"code":"62"
},
{
"desc":"You can add or remove cloud servers and edit cloud server weights for VPC channels to meet service requirements.You have created a VPC channel.Adding cloud serversClick S",
"product_code":"apig",
"title":"Editing Cloud Server Configurations of a VPC Channel",
"uri":"apig-en-ug-180502087.html",
"doc_type":"usermanual",
"p_code":"59",
"code":"63"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Custom Authorizers",
"uri":"apic-ug-190430104.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"64"
},
{
"desc":"This feature is currently unavailable because FunctionGraph has not been launched.APIG supports custom authentication of both frontend and backend requests.Frontend custo",
"product_code":"apig",
"title":"Creating a Custom Authorizer",
"uri":"apic-ug-190430105.html",
"doc_type":"usermanual",
"p_code":"64",
"code":"65"
},
{
"desc":"You can delete custom authorizers you no longer require.Custom authentication is implemented using FunctionGraph and not supported if FunctionGraph is unavailable in the ",
"product_code":"apig",
"title":"Deleting a Custom Authorizer",
"uri":"apic-ug-190430106.html",
"doc_type":"usermanual",
"p_code":"64",
"code":"66"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Plug-ins",
"uri":"apig-ug-0001.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"67"
},
{
"desc":"APIG provides flexible extension capabilities for APIs through plug-ins.Plug-in parameters will be stored as plaintext. To prevent information leakage, do not contain sen",
"product_code":"apig",
"title":"Creating a Plug-in",
"uri":"apig-ug-0004.html",
"doc_type":"usermanual",
"p_code":"67",
"code":"68"
},
{
"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 Plug-in",
"uri":"apig-ug-0002.html",
"doc_type":"usermanual",
"p_code":"67",
"code":"69"
},
{
"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 Plug-in",
"uri":"apig-ug-0005.html",
"doc_type":"usermanual",
"p_code":"67",
"code":"70"
},
{
"desc":"The request throttling plug-in limits the number of times an API can be called within a specific time period. It supports parameter-based, basic, and excluded throttling.",
"product_code":"apig",
"title":"Request Throttling Plug-in",
"uri":"apig-ug-0015.html",
"doc_type":"usermanual",
"p_code":"67",
"code":"71"
},
{
"desc":"You can delete plug-ins you no longer require. To delete a plug-in that has been bound to APIs, unbind the plug-in from the APIs and then delete it.You have created a plu",
"product_code":"apig",
"title":"Deleting a Plug-in",
"uri":"apig-ug-0003.html",
"doc_type":"usermanual",
"p_code":"67",
"code":"72"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"Monitoring",
"uri":"apig-en-ug-180413077.html",
"doc_type":"usermanual",
"p_code":"29",
"code":"73"
},
{
"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.Dedicated gateway: SYS.APIC",
"product_code":"apig",
"title":"APIG Metrics",
"uri":"apig-en-ug-180427085.html",
"doc_type":"usermanual",
"p_code":"73",
"code":"74"
},
{
"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-en-ug-180524089.html",
"doc_type":"usermanual",
"p_code":"73",
"code":"75"
},
{
"desc":"Cloud Eye monitors the status of your APIs and allows you to view their metrics.You have created an API group and API.API metrics are displayed on the Dashboard tab page.",
"product_code":"apig",
"title":"Viewing Metrics",
"uri":"apig-en-ug-180427086.html",
"doc_type":"usermanual",
"p_code":"73",
"code":"76"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"API Calling",
"uri":"apig-ug-0009.html",
"doc_type":"usermanual",
"p_code":"",
"code":"77"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"apig",
"title":"App Management",
"uri":"apig-en-ug-180307048.html",
"doc_type":"usermanual",
"p_code":"77",
"code":"78"
},
{
"desc":"For an API that uses app authentication, you can create an app and use the app and its ID and key pair (AppKey and AppSecret) to call the API. You can use an app to call ",
"product_code":"apig",
"title":"Creating an App and Obtaining Authorization",
"uri":"apig-en-ug-180307049.html",
"doc_type":"usermanual",
"p_code":"78",
"code":"79"
},
{
"desc":"You can delete apps you no longer require.You have created an app.In the Operation column of the app you want to delete, click Delete.Click the name of the target app, an",
"product_code":"apig",
"title":"Deleting an App",
"uri":"apig-en-ug-180307051.html",
"doc_type":"usermanual",
"p_code":"78",
"code":"80"
},
{
"desc":"You can reset the AppSecret of an app. The AppKey is unique and cannot be reset. When you reset the AppSecret, it becomes invalid and APIs bound to the app cannot be call",
"product_code":"apig",
"title":"Resetting the AppSecret of an App",
"uri":"apig-en-ug-180307053.html",
"doc_type":"usermanual",
"p_code":"78",
"code":"81"
},
{
"desc":"AppCodes are identity credentials of an app used to call APIs in simple authentication mode. In this mode, the X-Apig-AppCode parameter (whose value is an AppCode on the ",
"product_code":"apig",
"title":"Adding an AppCode for Simple Authentication",
"uri":"apig-lgug-200227001.html",
"doc_type":"usermanual",
"p_code":"78",
"code":"82"
},
{
"desc":"You can view the details of an API to which an app has been bound.You have created an app.The app has been bound to an API.",
"product_code":"apig",
"title":"Viewing API Details",
"uri":"apig-en-ug-180307054.html",
"doc_type":"usermanual",
"p_code":"78",
"code":"83"
},
{
"desc":"This section describes how to obtain and analyze the API calling logs of dedicated gateways.APIs have been called.Fields in access logs are separated using spaces. The fo",
"product_code":"apig",
"title":"Log Analysis",
"uri":"en-us_topic_0000001174497029.html",
"doc_type":"usermanual",
"p_code":"77",
"code":"84"
},
{
"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 Published APIs",
"uri":"apig-ug-0010.html",
"doc_type":"usermanual",
"p_code":"77",
"code":"85"
},
{
"desc":"Before calling APIs, obtain the request information from the API provider, including the access domain name, protocol, method, path, and request parameters.Obtain APIs: f",
"product_code":"apig",
"title":"Calling APIs",
"uri":"apig-ug-0011.html",
"doc_type":"usermanual",
"p_code":"85",
"code":"86"
},
{
"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-en-ug-180830102.html",
"doc_type":"usermanual",
"p_code":"85",
"code":"87"
},
{
"desc":"Table 1 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 \"Error Codes\" in",
"product_code":"apig",
"title":"Error Codes",
"uri":"apig-en-ug-180530090.html",
"doc_type":"usermanual",
"p_code":"85",
"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":"Permissions Management",
"uri":"apig-ug-190529107.html",
"doc_type":"usermanual",
"p_code":"",
"code":"89"
},
{
"desc":"This topic describes how to use Identity and Access Management (IAM) to implement permissions control for your APIG resources. With IAM, you can:Create IAM users for empl",
"product_code":"apig",
"title":"Creating a User and Granting APIG Permissions",
"uri":"apig-ug-190529109.html",
"doc_type":"usermanual",
"p_code":"89",
"code":"90"
},
{
"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 section \"Permissions Policies ",
"product_code":"apig",
"title":"APIG Custom Policies",
"uri":"apig-custom-policy.html",
"doc_type":"usermanual",
"p_code":"89",
"code":"91"
},
{
"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":"Key Operations Recorded by CTS",
"uri":"apig-ug-0020.html",
"doc_type":"usermanual",
"p_code":"",
"code":"92"
},
{
"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 that can be recorded by CTS",
"uri":"apig-en-ug-180307058.html",
"doc_type":"usermanual",
"p_code":"92",
"code":"93"
},
{
"desc":"Query audit logs by following the procedure in section \"Querying Real-Time Traces\" in the Cloud Trace Service User Guide.",
"product_code":"apig",
"title":"Querying Audit Logs",
"uri":"apig-ug-0021.html",
"doc_type":"usermanual",
"p_code":"92",
"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":"FAQs",
"uri":"apig-ug-cmccfaq.html",
"doc_type":"usermanual",
"p_code":"",
"code":"95"
},
{
"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":"apig-faq-190803.html",
"doc_type":"usermanual",
"p_code":"95",
"code":"96"
},
{
"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":"95",
"code":"97"
},
{
"desc":"The creation of APIs is free of charge. If you cannot create APIs, your account must be in arrears.",
"product_code":"apig",
"title":"Why Can't I Create APIs?",
"uri":"apig-faq-2005007.html",
"doc_type":"usermanual",
"p_code":"97",
"code":"98"
},
{
"desc":"API responses are defined by backend services (API providers). API Gateway (APIG) only transparently transmits responses to API callers.",
"product_code":"apig",
"title":"How Do I Define Response Codes for an API?",
"uri":"apig-faq-2005001.html",
"doc_type":"usermanual",
"p_code":"97",
"code":"99"
},
{
"desc":"Use the port of the API backend service.",
"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":"97",
"code":"100"
},
{
"desc":"You can 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).",
"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":"97",
"code":"101"
},
{
"desc":"Configure the backend service address as an ECS EIP, or the public IP address or domain name of your own server.",
"product_code":"apig",
"title":"How Can I Configure the Backend Service Address?",
"uri":"apig-faq-190627028.html",
"doc_type":"usermanual",
"p_code":"97",
"code":"102"
},
{
"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":"97",
"code":"103"
},
{
"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":"97",
"code":"104"
},
{
"desc":"Yes. APIG supports the configuration of multiple backend endpoints through a VPC channel (also called \"load balance channel\"). You can add multiple cloud servers to each ",
"product_code":"apig",
"title":"Does APIG Support Multiple Backend Endpoints?",
"uri":"apig-en-faq-180606012.html",
"doc_type":"usermanual",
"p_code":"97",
"code":"105"
},
{
"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":"97",
"code":"106"
},
{
"desc":"In a dedicated gateway, you can add a private domain name, 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":"97",
"code":"107"
},
{
"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":"97",
"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":"API Calling",
"uri":"apig-en-faq-180919017.html",
"doc_type":"usermanual",
"p_code":"95",
"code":"109"
},
{
"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":"109",
"code":"110"
},
{
"desc":"If an error code is returned when you call your own APIs, see User Guide > Calling Published APIs > Error Codes.If an error code is returned when you manage your APIs, se",
"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":"109",
"code":"111"
},
{
"desc":"The request URL (including request parameters) is too long. Place the request parameters in the request body and try again.",
"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":"109",
"code":"112"
},
{
"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":"109",
"code":"113"
},
{
"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-en-faq-181016018.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"114"
},
{
"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":"en-us_topic_0087908599.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"115"
},
{
"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":"109",
"code":"116"
},
{
"desc":"Modification of the backend_timeout parameter in a dedicated gateway does not take effect.The Timeout (ms) parameter on the Define Backend Request page is not modified.Lo",
"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":"109",
"code":"117"
},
{
"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 environme",
"product_code":"apig",
"title":"How Do I Switch the Environment for API Calling?",
"uri":"apig-faq-2005011.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"118"
},
{
"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-en-faq-180606013.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"119"
},
{
"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 Dev",
"product_code":"apig",
"title":"How Do I Perform App Authentication in iOS System?",
"uri":"apig-faq-190515025.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"120"
},
{
"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":"109",
"code":"121"
},
{
"desc":"How many apps can I create?You can create a maximum of 50 apps.How do I isolate the calling information among the third parties that call the same API through app authent",
"product_code":"apig",
"title":"App FAQs",
"uri":"apig-faq-190627030.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"122"
},
{
"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-en-faq-180307004.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"123"
},
{
"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-en-faq-180307008.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"124"
},
{
"desc":"APIG supports WebSocket data transmission. When creating an API, you can select HTTP, HTTPS, or HTTP&HTTPS. HTTP is equivalent to WebSocket (ws), and HTTPS is equivalent ",
"product_code":"apig",
"title":"How Do I Implement WebSocket Data Transmission?",
"uri":"apig-faq-190627033.html",
"doc_type":"usermanual",
"p_code":"109",
"code":"125"
},
{
"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":"109",
"code":"126"
},
{
"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":"109",
"code":"127"
},
{
"desc":"No.",
"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":"109",
"code":"128"
},
{
"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":"109",
"code":"129"
},
{
"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":"95",
"code":"130"
},
{
"desc":"Dedicated gateway: Yes.Backend two-way authentication: When creating an API, enable two-way authentication for the backend service. For details, see the description about",
"product_code":"apig",
"title":"Does APIG Support HTTPS Two-Way Authentication?",
"uri":"apig-faq-2005013.html",
"doc_type":"usermanual",
"p_code":"130",
"code":"131"
},
{
"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":"130",
"code":"132"
},
{
"desc":"APIG supports TLS 1.1 and TLS 1.2, but does not support TLS 1.0 or TLS 1.3.",
"product_code":"apig",
"title":"Which TLS Versions Does APIG Support?",
"uri":"apig-faq-2005015.html",
"doc_type":"usermanual",
"p_code":"130",
"code":"133"
},
{
"desc":"Yes. For details, see \"Custom Authorizers\" in the User Guide.",
"product_code":"apig",
"title":"Does APIG Support Custom Authentication?",
"uri":"apig-faq-2005016.html",
"doc_type":"usermanual",
"p_code":"130",
"code":"134"
},
{
"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":"130",
"code":"135"
},
{
"desc":"You may encounter the following errors related to IAM authentication information:Incorrect IAM authentication information: verify aksk signature failIncorrect IAM authent",
"product_code":"apig",
"title":"Common Errors Related to IAM Authentication Information",
"uri":"apig-faq-0003.html",
"doc_type":"usermanual",
"p_code":"130",
"code":"136"
},
{
"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":"95",
"code":"137"
},
{
"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":"137",
"code":"138"
},
{
"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":"138",
"code":"139"
},
{
"desc":"Yes.",
"product_code":"apig",
"title":"Is the Restriction of 1000 Requests to a Subdomain Name Applied to Enterprise Accounts?",
"uri":"apig-faq-190627032.html",
"doc_type":"usermanual",
"p_code":"138",
"code":"140"
},
{
"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 Has Bandwidth Limits?",
"uri":"apig-faq-19122002.html",
"doc_type":"usermanual",
"p_code":"138",
"code":"141"
},
{
"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":"138",
"code":"142"
},
{
"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":"137",
"code":"143"
},
{
"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":"143",
"code":"144"
},
{
"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":"143",
"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 Publishing",
"uri":"apig-en-faq-180919016.html",
"doc_type":"usermanual",
"p_code":"95",
"code":"146"
},
{
"desc":"Yes. After you modify the parameters of a published API, you must publish the API again to synchronize the modifications to the environment.",
"product_code":"apig",
"title":"Do I Need to Publish an API Again After Modification?",
"uri":"apig-en-faq-180307002.html",
"doc_type":"usermanual",
"p_code":"146",
"code":"147"
},
{
"desc":"To make an API published in a non-RELEASE environment accessible, add the x-stage header to the API request.Example:",
"product_code":"apig",
"title":"Why Can't APIs Published in a Non-RELEASE Environment Be Accessed?",
"uri":"apig-en-faq-180606011.html",
"doc_type":"usermanual",
"p_code":"146",
"code":"148"
},
{
"desc":"Yes, you can invoke different backend services by publishing an API in different environments while specifying environment variables and backend parameters.",
"product_code":"apig",
"title":"Can I Invoke Different Backend Services by Publishing an API in Different Environments?",
"uri":"apig-en-faq-181016019.html",
"doc_type":"usermanual",
"p_code":"146",
"code":"149"
},
{
"desc":"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 X-S",
"product_code":"apig",
"title":"How Do I Specify an Environment for API Debugging?",
"uri":"apig-faq-2005027.html",
"doc_type":"usermanual",
"p_code":"146",
"code":"150"
},
{
"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":"95",
"code":"151"
},
{
"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":"151",
"code":"152"
},
{
"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":"151",
"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 Security",
"uri":"apig-en-faq-180919015.html",
"doc_type":"usermanual",
"p_code":"95",
"code":"154"
},
{
"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-en-faq-180307003.html",
"doc_type":"usermanual",
"p_code":"154",
"code":"155"
},
{
"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-en-faq-180307009.html",
"doc_type":"usermanual",
"p_code":"154",
"code":"156"
},
{
"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":"154",
"code":"157"
},
{
"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-en-faq-180919014.html",
"doc_type":"usermanual",
"p_code":"95",
"code":"158"
},
{
"desc":"An API can be published in different environments, such as RELEASE (online environment) and BETA (test environment).An app refers to the identity of an API caller. After ",
"product_code":"apig",
"title":"What Are the Relationships Between an API, Environment, and App?",
"uri":"en-us_topic_0084464485.html",
"doc_type":"usermanual",
"p_code":"158",
"code":"159"
},
{
"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":"en-us_topic_0084464486.html",
"doc_type":"usermanual",
"p_code":"158",
"code":"160"
},
{
"desc":"APIG supports Java, Go, Python, C#, JavaScript, PHP, C++, C, and Android SDKs.",
"product_code":"apig",
"title":"What SDK Languages Does APIG Support?",
"uri":"apig-en-faq-180606010.html",
"doc_type":"usermanual",
"p_code":"158",
"code":"161"
},
{
"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-en-faq-180307006.html",
"doc_type":"usermanual",
"p_code":"158",
"code":"162"
},
{
"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-en-faq-180307001.html",
"doc_type":"usermanual",
"p_code":"158",
"code":"163"
},
{
"desc":"No. APIG cannot be deployed in a local data center.",
"product_code":"apig",
"title":"Can APIG Be Deployed in a Local Data Center?",
"uri":"apig-faq-20210414.html",
"doc_type":"usermanual",
"p_code":"158",
"code":"164"
},
{
"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-en-ug-180307075.html",
"doc_type":"usermanual",
"p_code":"",
"code":"165"
}
]
View Git Blame Copy Permalink