更新时间:2026-02-09 GMT+08:00

获取API信息

API调用需要获取以下信息:
  • 用于组成请求URL的Endpoint和URI。
  • 用于签名和认证的AK/SK。
  • 用于区分租户的项目ID、子项目ID。
  • 用于区分租户的账号名、账号ID。
  • 用于API的环境信息。
  • 用于Host的域名信息。
表1 信息收集项

信息项

说明

Endpoint

地区与终端节点,即云服务在不同Region有不同的访问域名。

获取方式请参考地区和终端节点

说明:

本手册所有关于请求URL的举例,其中Endpoint以service.region.example.com为例。

URI

API接口的调用路径及参数。

请参考各云服务的详细接口章节获取。

AK/SK

访问密钥对,包含密钥ID与密钥。AK/SK用于对请求内容进行签名。

获取方式请参考获取AK/SK

Project_Id

项目ID,在大多数API接口调用时需要配置在URI中,用以识别不同的项目。

获取项目ID的步骤如下:

  1. 进入控制台首页
  1. 将鼠标移至页面右上角的用户名处,在下拉列表中单击“我的凭证”,查看“项目ID”。

    项目用于对云服务器资源进行物理隔离,默认有region级别的隔离,也可在Region下建立多项目,做更细级别的隔离。因此,在页面右侧列表中找到您的服务器资源对应的Region(所属区域),在其左侧列表中获取项目ID。

X-Project-Id

子项目ID,在多项目场景中使用。如果云服务资源创建在子项目中,AK/SK认证方式下,操作该资源的接口调用需要在请求消息头中携带X-Project-Id。

获取项目ID的步骤如下:

  1. 进入控制台首页
  1. 将鼠标移至页面右上角的用户名处,在下拉列表中单击“我的凭证”。
  2. 找到对应的项目,单击该项目左侧的加号图标,展开子项目列表后获取子项目ID。

X-Domain-Id

账号ID,用途:

  • Token认证方式下获取Token。
  • AK/SK认证方式下,全局服务的接口调用,需在请求消息头中配置X-Domain-Id。(全局服务:服务部署时不区分物理区域。如IAM、OBS、CDN等。)

获取账号ID的步骤如下:

  1. 进入控制台首页
  2. 将鼠标移至页面右上角的用户名处,在下拉列表中单击“我的凭证”。
  3. 查看“账号名”和“账号ID”。

x-stage

API接口的环境,请参考各云服务的接口API的环境信息。

Host

API接口所属分组的调试域名或独立域名。

请参考各云服务的接口所属API分组中的域名信息。