服务访问

最近更新时间:2024-11-14 10:55:01

我的收藏

操作场景

在服务完成发布后,您可以通过服务的默认子域名测试。如需将服务发布至公网对外,请您绑定您的自有域名访问 API。
注意:
API 网关为用户提供的默认子域名仅供联调测试使用,不建议在您的正式生产服务中使用。在您联调结束后,强烈推荐您使用自有域名,详见 绑定自定义域名。绑定后通过自定义域名及 API 路径访问。

操作步骤

以下视频将为您介绍 API 网关访问的基本流程:


服务的默认子域名规则

服务的默认子域名在创建服务后自动生成,可在下图位置中查看。



API 网关的每个服务都提供默认子域名,其规则包含:
第一种:2023年11月22日正式启用全新子域名
http://{service-id}-{your-unique-id}.{region}.tencentapigw.com
第二种:使用此域名的用户也将逐步替换为最新tencentapigw.com域名
http://{service-id}-{your-unique-id}.{region}.apigw.tencentcs.com
第三种:只在2021年以前 service 会出现
http://{your-unique-id}.{region}.apigateway.myqcloud.com

服务的 API 路径访问规则

API 路径,是用户创建 API 时在前端访问路径中自定义的,创建 API 完成后可在下列位置查看到。



下文以上述第一种默认子域名为例:
在发布服务后,具体 API 的访问路径形如:
仅带环境时,根据已支持的3条环境区分如下:
发布环境 http://{your-unique-id}.{region}.tencentapigw.com/release
预发布环境 http://{your-unique-id}.{region}.tencentapigw.com/prepub
测试环境 http://{your-unique-id}.{region}.tencentapigw.com/test
带环境和 API 路径时,需要先指定环境、再指定路径:
例如访问发布环境的某个/getUser路径 http://{your-unique-id}.{region}.tencentapigw.com/release/getUser

示例说明

您的用户 ID 为123456789,在广州区(gz)创建了名为 register 的服务,其服务 ID 为 service-n904iiau ,并在其中添加了路径为 /user 的 API,现在发布了 register 服务在3套环境。在这种情况下,如果有其他用户或 应用或终端 需要访问 /user 的 API,正确的访问路径为:
发布环境:http://service-n904iiau-123456789.gz.tencentapigw.com/release/user
预发布环境:http://service-n904iiau-123456789.gz.tencentapigw.com/prepub/user
测试环境:http://service-n904iiau-123456789.gz.tencentapigw.com/test/user
说明
因国际链路质量问题,影响因素较多,运营商短时间内难以优化和改进,因此 API 网关跨境访问可能存在丢包或超时。如果您主要访问境外业务,建议您在国内和境外区分别创建资源,国内服务覆盖国内业务,境外服务覆盖境外业务,避开跨境拥塞网段,以获得更好的业务体验。感谢您的理解与支持。