检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3 请求消息 无。 响应消息 参数说明 表1 参数说明 名称 参数类型 是否必选 描述 versions Array of objects 否 API版本详细信息列表。详情请参见表2。
文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。 命名空间 SYS.DDS 监控指标 表1 DDS推荐的监控指标 指标ID 指标名称 指标含义
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。 命名空间 SYS.DDS 监控指标 表1 DDS推荐的监控指标 指标ID 指标名称 指标含义
https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/ 请求消息 无。 响应消息 参数说明 表1 参数说明 名称 参数类型 是否必选 描述 versions Array of objects 否 API版本详细信息列表。详情请参见表2。
操作场景 本章节指导用户创建事件监控的告警通知。 操作步骤 登录管理控制台。 在页面左上角单击,选择“管理与监管 > 云监控服务 CES”,进入“云监控服务”信息页面。 在左侧导航栏选择“事件监控”,进入“事件监控”页面。 在事件列表页面,单击页面右上角的“创建告警规则”。 在“创建告警规则”界面,配置参数。
、已下线,系统会通过短信、邮件等渠道进行提前通知,并在可维护时间段内下发升级任务。 图1 升级 注意事项 DDS不允许降级操作,比如4.0版本降至3.4版本。 当有对应的补丁更新时(定期同步开源社区问题、漏洞修复),请及时进行升级。 补丁升级会重启实例,服务每个节点可能会出现1次
设置可维护时间段 登录管理控制台。 单击管理控制台左上方的,选择区域和项目。 在页面左上角单击,选择“数据库 > 文档数据库服务 DDS”,进入文档数据库服务信息页面。 在“实例管理”页面,单击目标实例名称,进入“基本信息”页面,在“数据库信息”模块的“可维护时间段”处,单击“修改”。
与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
连接管理 查询实例节点会话 终结实例节点会话 查询实例节点连接数统计 父主题: API v3(推荐)
LTS日志组ID。可通过云日志服务-“查询账号下所有日志组”API接口获取。 lts_stream_id String 是 LTS日志流ID。可通过云日志服务-“查询指定日志组下的所有日志流”API接口获取。 请求示例 为实例审计日志配置LTS服务。 POST https://{
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。
欠费说明 用户在使用云服务时,帐户的可用额度小于待结算的账单,即被判定为帐户欠费。欠费后,可能会影响云服务资源的正常运行,请及时充值。 欠费原因 未购买包年包月实例,在按需计费模式下帐户的余额不足。 欠费影响 包年/包月 对于包年/包月DDS实例,用户已经预先支付了资源费用,因此
如果您需要对您所拥有的DDS服务进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),如果云平台账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用DDS服务的其它功能。 默认情况下,
虚拟私有云ID,获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表。 subnet_id String 是 子网的网络ID,获取方法如下: 方法1:登录虚拟私有云服务的控制台界面,单击VPC
进入Jar驱动下载地址下载连接DDS使用的驱动包“mongo-java-driver-3.12.9.jar”,此安装包提供了访问DDS数据库实例的API接口。 驱动安装请参考官方指南。 环境类 客户端需配置JDK1.8。JDK是跨平台的,支持Windows,Linux等多种平台。 下面以Windows为例,介绍JDK配置流程: