检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 交换数据空间服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 offer管理 包括搜索offer列表、查询offer详情等接口。 订阅管理 包括订阅offer、我的订阅等接口。 合约管理 提供查询合约、终止合约等接口。 应用管理 提供新增应用、查询应用模板列表等接口。
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。
获取实例ID 在调用接口的时候,部分请求中需要填入实例ID,所以需要获取到实例ID,目前实例ID只支持从控制台获取。 从控制台获取实例ID 从控制台获取实例ID(instance_id)的步骤如下: 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,即可查看到实例ID。
获取连接器ID 在调用接口的时候,部分请求中需要填入连接器ID,所以需要获取到连接器ID。有如下两种获取方式: 从控制台获取连接器ID 调用API获取连接器ID 从控制台获取连接器ID 从控制台获取连接器ID(connector_id)的步骤如下: 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数说明,将消息体加入后的请求如下所示,其中加粗的字段需要根据实际值填写。
就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标移动到右上角的用户名处,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
面,设置API数据源的基本信息,具体参数如表1所示。 表1 参数说明 参数 说明 数据源类型 API:数据资源需要通过调用API接口获取。 数据源名称 自定义数据源名称,建议按照一定的命名规则填写任务名称,方便快速识别和查找。要求长度范围为2位~50位。 用途 新增API数据源适用于“采集数据”,系统默认,无需填写。
查询指定offer详情、订阅Offer、查询合约详情接口的限制使用时间参数(when)和策略的扩展属性参数(additional_attributes)类型。 查询用户连接器列表,查询连接器列表接口出参新增protocol_signed参数。 实例添加客租户接口入参增加iam_user_id和iam_user_name参数。
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来商品列表,那么这个IAM用户被授予的策略中必须包含允许“eds:connect
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表4 响应Body参数
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 响应参数 状态码: 200 表3 响应Body参数
EDS权限分类 表1 细化权限说明 权限 对应API接口 授权项 依赖的授权项 IAM项目 企业项目 查询指定空间实例下所有连接器 - eds:connector:list - √ × 申请开通连接器 - eds:connector:apply - √ × 创建实例 - eds:instance:create
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 iam_user_id 是
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 x-eds-proxy-userid 否 String
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 request_id 是
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data