通用参数

通用参数

为了满足多样化的应用场景，TOPIAM平台提供了丰富的API，供开发者调用。这些API会涉及到一些通用参数，在此进行统一介绍。通用参数可能作为请求参数，也可能作为响应参数。在使用TOPIAM平台提供的API之前，建议先了解一下这些通用参数的含义。

请求头

名称	类型	是否必填	描述
x-TOPIAM-access-token	string	是	调用该接口的访问凭证，调用获取 访问凭证 接口获取。
request-id	string	否	客户端随机生成的ID，TOPIAM平台会将相关日志与request-id关联并返回。为空则会由TOPIAM平台自行生成后返回。

响应参数

名称	类型	是否必填	示例值	描述
code	string	是	0	返回码。
msg	string	是	success	返回码描述。
result	string	否	success	返回结果。
requestId	string	是	4a8bd9ec7d54456f6b39f7c9008b0132	请求 ID。