- 最新动态
- 产品介绍
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- 如何调用API
- API列表
-
错误码参考
-
错误码
-
公共错误码
- IoTA.99000001 Demo用户无操作权限
- IoTA.99000002 子用户无操作权限
- IoTA.99000003 未授权
- IoTA.99000004 帐号受限
- IoTA.99000005 帐号冻结
- IoTA.99000006 SDR用户无操作权限
- IoTA.99000007 未开通数据分析服务
- IoTA.99000008 数据分析服务被冻结
- IoTA.99000009 无该项目访问权限
- IoTA.99000010 请求参数不正确
- IoTA.99000011 系统繁忙
- IoTA.99000012 许可证已过期
- IoTA.99000013 超过许可资源使用量
- IoTA.99999998 网关服务内部错误
- IoTA.99999999 服务内部错误
-
业务面错误码
- 数据源相关错误码
-
数据管道相关错误码
- IoTA.03011001 作业定义错误
- IoTA.03011002 作业名称错误
- IoTA.03011003 作业描述错误
- IoTA.03011006 作业名已存在
- IoTA.03011007 作业数量超出限制
- IoTA.03011011 作业配置无法正常解析,请检查是否为JSON格式
- IoTA.03011012 作业不存在
- IoTA.03011013 数据源不存在
- IoTA.03011014 获取数据源失败
- IoTA.03011015 作业状态不允许当前操作
- IoTA.03011016 RTU个数不正确
- IoTA.03011018 作业未运行
- IoTA.03011019 作业启动失败
- IoTA.03011020 作业停止失败
- IoTA.03011022 作业无可用保存点
- IoTA.03011023 不允许触发savepoint
-
存储管理相关错误码
- IoTA.02010102 存储组名称重复
- IoTA.02010103 默认存储组名称禁止修改
- IoTA.02010104 老化时间非法
- IoTA.02010105 存储组类型错误
- IoTA.02010106 存储组数量超过单个项目的限制
- IoTA.02010107 存储组中包含存储,无法删除
- IoTA.02010108 指定的存储组不存在
- IoTA.02010201 此存储或存储组正在操作中,请稍后重试
- IoTA.02010202 存储名称重复
- IoTA.02010203 存储实例被数据管道使用中,无法删除
- IoTA.02010204 指定的存储不存在
- IoTA.02010205 存储数量已超过限制
- IoTA.02010206 不允许修改属性的数据类型
- IoTA.02010207 属性的类型应为 string、double、integer、object 其中之一
- IoTA.02010208 此标签或属性名称包含非法字符
- IoTA.02010209 此标签或属性名称已存在
- IoTA.02010210 标签数量超过限制
- IoTA.02010211 属性数量超过限制
-
资产建模相关错误码
- IoTA.01010012 不允许同时操作同一资产树下的资产
- IoTA.01010021 资产模型名称已存在
- IoTA.01010022 不能删除已有资产的资产模型
- IoTA.01010023 资产模型不存在
- IoTA.01010024 属性个数超过限制
- IoTA.01010025 分析任务个数超过限制
- IoTA.01010026 资产模型个数超过配额限制
- IoTA.01010027 资产模型存在循环依赖
- IoTA.01010028 资产个数超过配额限制
- IoTA.01010029 根资产个数超过配额限制
- IoTA.01010030 资产正在发布中
- IoTA.01010032 存在异常资产
- IoTA.01010033 模型已被其他模型引用
- IoTA.01010034 不能修改数据类型
- IoTA.01010035 子资产个数超过配额限制
- IoTA.01010036 属性引用深度超过配额限制
- IoTA.01010037 属性被引用数超过配额限制
- IoTA.01010038 实时分析作业类型不匹配或者作业不存在
- IoTA.01010039 实时分析作业状态不可用
- IoTA.01010040 属性已被引用
- IoTA.01010041 公式错误
- IoTA.01010042 属性名重复
- IoTA.01010043 输入参数名重复
- IoTA.01010045 分析任务名重复
- IoTA.01010046 聚合计算不能直接或间接引用聚合计算
- IoTA.01010047 文件大小超过30MB
- IoTA.01010048 资产总属性数超过配额限制
- IoTA.01010049 资产总分析任务数超过配额限制
- IoTA.01010050 资产正在导入中
- IoTA.01010051 导入资产任务不存在
- IoTA.01010052 文件不存在
- IoTA.01010053 当前状态下不能停止任务
- IoTA.01010054 资产正在导出中
- IoTA.01010055 导出资产任务不存在
- IoTA.01010056 引用的资产属性数超过限制
- IoTA.01010201 父资产不存在
- IoTA.01010202 资产不存在
- IoTA.01010203 资产名称已存在
- IoTA.01010204 资产树深度超过配额限制
- IoTA.01010307 查询的指标数超过限制
- IoTA.01010308 查询的属性数超过限制
- IoTA.01010309 属性不存在
- IoTA.01020301 公式语法错误
- IoTA.01020302 公式引用的函数不支持
- IoTA.01020303 分析任务不支持该类型函数
- IoTA.01020304 分析任务输出的属性在模型中不存在
- IoTA.01020305 “子资产”类型参数实际上引用不到子资产
- IoTA.01020306 分析任务中未配置具体引用的资产ID
- IoTA.01020307 “测量数据”类型属性未配置设备ID
- IoTA.01020308 “静态配置”类型属性未配置属性值
- IoTA.01020309 聚合计算不能直接或间接引用聚合计算
- IoTA.01020101 当前根资产正在操作中
-
实时分析相关错误码
- IoTA.03011001 作业定义错误
- IoTA.03011002 作业名称错误
- IoTA.03011003 作业描述错误
- IoTA.03011004 作业类型错误
- IoTA.03011006 作业名已存在
- IoTA.03011007 作业数量超出限制
- IoTA.03011009 该实时作业正在被资产模型使用,无法进行当前操作
- IoTA.03011010 从资产模型获取作业使用信息失败
- IoTA.03011011 作业配置无法正常解析,请检查是否为JSON格式
- IoTA.03011012 作业不存在
- IoTA.03011015 作业状态不允许当前操作
- IoTA.03011016 RTU个数不正确
- IoTA.03011018 作业未运行
- IoTA.03011019 作业启动失败
- IoTA.03011020 作业停止失败
- IoTA.03011021 作业监控失败
- IoTA.03011022 作业无可用保存点
- IoTA.03011023 不允许触发savepoint
-
公共错误码
-
错误码
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
构造请求
本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
请求URI
请求URI由如下部分组成:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
参数 |
描述 |
---|---|
URI-scheme |
表示用于传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint |
指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 |
resource-path |
资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 |
query-string |
查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 |
例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。
https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens


为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
请求方法
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。
方法 |
说明 |
---|---|
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
POST |
请求服务器新增资源或执行特殊操作。 |
DELETE |
请求服务器删除指定资源,如删除对象等。 |
HEAD |
请求服务器资源头部。 |
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 |
在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为:
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
请求消息头
附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
详细的公共请求消息头字段请参见表3。
名称 |
描述 |
是否必选 |
示例 |
---|---|---|---|
Host |
请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 |
否 使用AK/SK认证时该字段必选。 |
code.test.com or code.test.com:443 |
Content-Type |
发送的实体的MIME类型。推荐用户默认使用application/json,有其他取值时会在具体接口中专门说明。 |
是 |
application/json |
Content-Length |
请求body长度,单位为Byte。 |
否 |
3495 |
X-Project-Id |
project id,项目编号。请参考获取项目ID章节获取项目编号。 |
否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Auth-Token |
用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
否 使用Token认证时该字段必选。 |
注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |

API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。
AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。
对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
请求消息体(可选)
该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。

scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。
- 如果您将scope设置为domain,该Token适用于全局级服务;如果将scope设置为project,该Token适用于项目级服务。
- 如果您将scope同时设置为project和domain,将以project参数为准,获取到项目级服务的Token。
POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domianname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } }
到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。