正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 交换数据空间服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 offer管理 包括搜索offer列表、查询offer详情等接口。 订阅管理 包括订阅offer、我的订阅等接口。 合约管理 提供查询合约、提交合约、终止合约等接口。 应用管理 提供新增应用、查询应用模板列表等接口。
API offer管理 订阅管理 合约管理 应用管理 资产管理 审计日志 实例管理 连接器管理 团队管理 用户管理
如何调用API 构造请求 认证鉴权 返回结果
源”,进入“接入数据源”界面,设置API数据源的基本信息,具体参数如表1所示。 表1 参数说明 参数 说明 数据源类型 API:数据资源需要通过调用API接口获取。 数据源名称 自定义数据源名称,建议按照一定的命名规则填写任务名称,方便快速识别和查找。要求如下: 长度范围为1位~50位。
必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于查询指定连接器下的offer列表接口,可以从接口的请求部分看到所需的请求参数及
权限和授权项 权限及授权项说明 应用内部授权
应用内部授权 OpenApi接口需要通过应用内部进行用户角色授权,API权限参见下表: API 拥有API的角色 查询搜索条件(不限连接器) 不限 搜索offer列表(不限连接器) 不限 查询offer详情(不限连接器) 不限 查询指定offer资源列表(不限连接器) 不限 查询指定连接器下的offer列表
由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,用户可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,用户需要用到账号、用户和密码信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 String
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于查询指定连接器下的offer列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
认证鉴权 EDS调用接口仅支持Token认证鉴权。 Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ
获取账号ID 在调用接口的时候,部分请求中需要填入账号名(domain name)和账号ID(domain_id)。获取步骤如下: 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 鼠标移动至用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面的查看“账号名”和“账号ID”。
获取项目ID 在调用接口的时候,部分请求中需要填入项目ID或项目名称,所以需要获取到项目ID和名称。有如下两种获取方式: 从控制台获取项目ID和名称(推荐使用) 调用API获取项目ID 从控制台获取项目ID 从控制台获取项目ID(project_id)和名称(project name)的步骤如下:
是否必选 参数类型 描述 subscription_id 否 String 订阅ID。 参数校验规则:最小长度1,最大长度50,匹配字母数字和符号-。 status 否 String 审批状态。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EDS.00031001 Invalid parameter 无效的参数。 检查参数是否正确。 400 EDS.00031002 User
资产管理 下载文件 资产使用次数统计 父主题: API
团队管理 查询指定连接器下的团队列表 父主题: API
用户管理 添加连接器用户 从连接器移除用户 查询指定连接器的数据接收者列表 父主题: API
订阅管理 订阅Offer 我的订阅 撤销订阅 订阅待审批列表 审批订阅请求 父主题: API