检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式:项目级服务和全局级服务。其中: 项目级服务需要获取项目级别的Token,此时请求body中auth
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET ht
如何调用API 构造请求 认证鉴权 返回结果
获取实例配置 功能介绍 获取实例配置。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/instances/{instance_id}/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
API V2 生命周期管理 实例管理 消费组管理 Smart Connect 其他接口 父主题: 历史API
API概览 表1 实例管理类接口 API 说明 生命周期管理 包括: 创建实例 查询所有实例列表 查询指定实例 删除指定的实例 修改实例信息 批量重启或删除实例 获取实例配置 修改实例配置 实例升级 实例管理 包括: 重置密码 重置Manager密码 重启Manager 开启或关闭实例自动创建Topic功能
如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。
历史API API V1 API V2
API V1 实例管理类接口 实例使用类接口 其他接口 父主题: 历史API
API V2(推荐) 生命周期管理 实例管理 Smart Connect 规格变更管理 主题管理 消费组管理 用户管理 消息管理 后台任务管理 标签管理 诊断管理 其他接口
获取账号名和账号ID 在调用接口的时候,部分URL中需要填入账号名和账号ID,所以需要先在管理控制台上获取到账号名和账号ID。账号名和账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”。 查看账号名和账号ID。 图1 查看账号名和账号ID
sspolicy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 topic_name 是 String Topic名称。 请求参数 无 响应参数
请参见如何调用API。 URI POST /v1/{project_id}/instances/{instance_id}/topics/accesspolicy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
查询指定实例 当前页面API为历史版本API,未来可能停止维护。请使用查询指定实例。 功能介绍 查询指定实例的详细信息。 URI GET /v1.0/{project_id}/instances/{instance_id} 参数说明见表1。 表1 参数说明 参数 类型 必选 说明
查询配额详情。 当前页面API为历史版本API,未来可能停止维护。 调用方法 请参见如何调用API。 URI GET /v1.0/{project_id}/quotas/dms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询安全组列表。 subnet_id String 是 子网信息。 获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表。
String 引擎。 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。
查询转储任务列表 功能介绍 查询转储任务列表。 当前页面API为历史版本API,未来可能停止维护。请使用查询Smart Connect任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/connectors/{connector_id}/sink-tasks
查询单个转储任务 功能介绍 查询单个转储任务。 当前页面API为历史版本API,未来可能停止维护。请使用查询Smart Connector任务详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/connectors/{connector_i
新增Kafka实例指定Topic分区 功能介绍 新增Kafka实例指定Topic分区。 当前页面API为历史版本API,未来可能停止维护。请使用修改Kafka实例Topic。 URI POST /v2/{project_id}/instances/{instance_id}/ma