Help Center/ API Gateway/ User Guide (Kuala Lumpur Region)/ FAQs/ API Calling/ What Should I Do If "The API does not exist or has not been published in the environment." Is Displayed?
Updated on 2024-08-07 GMT+08:00
View PDF
Share

What Should I Do If "The API does not exist or has not been published in the environment." Is Displayed?

If an open API in APIG failed to be called, troubleshoot the failure by performing the following operations:

  1. The domain name, request method, or path used for calling the API is incorrect.
    • For example, an API created using the POST method is called with GET.
    • Missing a slash (/) in the access URL will lead to a failure in matching the URL in the API details. For example, URLs http://7383ea59c0cd49a2b61d0fd1d351a619.apigw.region.cloud.com/test/ and http://7383ea59c0cd49a2b61d0fd1d351a619.apigw.region.cloud.com/test represent two different APIs.
  2. The API has not been published. APIs can be called only after they have been published in an environment. For details, see section "Publishing an API" in the API Gateway User Guide. If the API has been published in a non-production environment, check whether the X-Stage header in the request is the name of the environment.
  3. The domain name is resolved incorrectly. If the domain name, request method, and path for calling the API are correct and the API has been published in an environment, the API may not be correctly resolved to the group to which the API belongs. For example, if you have multiple API groups and each group has an independent domain name, the API may be called using the independent domain name of another group. Ensure that the API is being called using the correct domain name.
  4. Check whether the API allows OPTIONS cross-region requests. If yes, enable cross-origin resource sharing (CORS) for the API, and create an API that uses the OPTIONS method. For details, see section "CORS" in the API Gateway User Guide.
Parent topic: API Calling