检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
面,设置API数据源的基本信息,具体参数如表1所示。 表1 参数说明 参数 说明 数据源类型 API:数据资源需要通过调用API接口获取。 数据源名称 自定义数据源名称,建议按照一定的命名规则填写任务名称,方便快速识别和查找。要求长度范围为2位~50位。 用途 新增API数据源适用于“采集数据”,系统默认,无需填写。
API概览 交换数据空间服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 offer管理 包括搜索offer列表、查询offer详情等接口。 订阅管理 包括订阅offer、我的订阅等接口。 合约管理 提供查询合约、终止合约等接口。 应用管理 提供新增应用、查询应用模板列表等接口。
API 连接器管理 实例管理 offer管理 订阅管理 合约管理 应用管理 审计日志 团队管理 用户管理
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。
权限和授权项 权限及授权项说明 EDS权限分类
就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
EDS权限分类 表1 细化权限说明 权限 对应API接口 授权项 依赖的授权项 IAM项目 企业项目 查询指定空间实例下所有连接器 - eds:connector:list - √ × 申请开通连接器 - eds:connector:apply - √ × 创建实例 - eds:instance:create
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要
是否必选 参数类型 描述 subscription_id 否 String 订阅ID。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 status 否 String 审批状态。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。
实例管理 实例添加客租户 移除空间成员 查询用户实例列表 父主题: API
应用管理 查询应用模板列表 新增应用 查看实例化应用列表 父主题: API
审计日志 查询数据资产的审计日志列表 查询数据资产统计列表 父主题: API
订阅管理 订阅Offer 我的订阅 撤销订阅 订阅待审批列表 审批订阅请求 父主题: API
合约管理 查询合约列表 查询合约详情 点对点生成合约 终止合约 查询接收的合约数据 归档接收的合约数据 合约资产使用控制策略执行 父主题: API
团队管理 查询指定连接器下的团队列表 父主题: API