检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
重启实例 接口说明 重启实例的数据库服务。 文档数据库实例重启过程中将不可用，请谨慎操作。 约束说明 实例状态非“normal”时，不允许重启实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{
数据库补丁升级 接口说明 升级数据库补丁版本。 约束说明 冻结实例、异常实例，无法升级补丁版本。 实例中存在异常节点，无法升级补丁版本。 请根据实例详情查询接口返回结果中的“patch_available”字段判断是否支持升级。 请选择在业务低峰期进行升级。 调试 您可以在API Explorer中调试该接口。
方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id String 是 子网的网络ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。
删除实例 接口说明 删除数据库实例。 约束说明 暂不支持删除包周期实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI样例
lts_group_id String 是 LTS日志组ID。可通过云日志服务-“查询账号下所有日志组”API接口获取。 lts_stream_id String 是 LTS日志流ID。可通过云日志服务-“查询指定日志组下的所有日志流”API接口获取。 请求示例 为实例审计日志配置LTS服务。 POST
切换SSL开关 接口说明 切换实例的SSL开关。 约束说明 冻结实例，异常实例不支持该操作。 切换SSL后，后台会重启实例，请谨慎操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{projec
修改实例备注 接口说明 修改实例的备注。 约束说明 不支持修改已删除实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/remark
实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 node_id String 否 查询审计日志的节点ID。 不传值，默认查询所有的节点，集群实例审计日志分布在mongos节点上。 start_time String 是 查询开始时间，格式为
重置参数模板 接口说明 重置参数模板。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式 POST https://{Endpoint}/v3/{proje
修改实例名称 接口说明 修改实例的名称。 约束说明 创建中和创建失败的实例不支持修改实例名称。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
node_id_list Array of strings 否 节点ID列表，取空值，表示查询实例下所有允许查询的节点。 使用请参考《DDS API参考》的“查询实例列表”响应消息表“nodes 数据结构说明”的“id”。 允许查询的节点如下： 集群下面的mongos、shard、config节点。 副本集、单节点下面的所有节点。
完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-tok
获取备份下载链接 接口说明 获取备份下载链接。 约束说明 备份下载链接在更新时间后15分钟内有效。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/backups/download-file
停止备份 接口说明 支持紧急情况下停止备份功能。 约束说明 仅支持状态为备份中或备份上传中的实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/backups/{backup_id}
删除参数模板 接口说明 删除指定参数模板。 约束说明 该接口仅支持DDS社区版。 默认参数模板不允许删除。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式
就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 Token可通过调用获取用户Token接口获取，调用
node_id_list Array of strings 否 节点ID列表，取空值，表示查询实例下所有允许查询的节点。 使用请参考《DDS API参考》的“查询实例列表”响应消息表“nodes 数据结构说明”的“id”。 允许查询的节点如下： 集群下面的shard节点。 副本集、单节点下面的所有节点。
实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 请求消息 参数说明 表2 请求Body参数 名称 是否必选 参数类型 说明 entity_id 是 String 实例ID或组ID或节点ID。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
应用参数模板 接口说明 指定实例变更参数模板。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式 PUT https://{Endpoint}/v3/{pr
复制参数模板 接口说明 复制参数模板。 约束说明 只支持复制自定义的参数模板。 参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
