检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用说明 GeminiDB提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
如何调用API 构造请求 认证鉴权 返回结果
免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。 有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET h
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
终端节点 终端节点(Endpoint)即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询所有服务的终端节点。 父主题: 使用前必读
租户在某一Region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID,可以调用查询实例列表和详情接口获取。如果未申请实例,可以调用创建实例接口创建。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
设置实例负载均衡的IP访问黑白名单 功能介绍 设置实例负载均衡的IP访问黑白名单,黑名单、白名单只能选一种,每次调用此接口覆盖之前的设置。关闭后不限制连接的源IP地址。 接口约束 该接口支持如下数据库实例: GeminiDB Redis 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API
快速入门 本节通过调用API创建GeminiDB Cassandra数据库实例。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token
用户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例Id,可以调用5.3.3 查询实例列表和详情接口获取。如果未申请实例,可以调用5.3.1 创建实例接口创建。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
GeminiDB。您可以使用本文档提供的API对云数据库 GeminiDB进行相关操作,如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用云数据库 GeminiDB API之前,请确保已经充分了解云数据库 GeminiDB相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询GeminiDB
租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID,可以调用查询实例列表和详情接口获取。如果未申请实例,可以调用创建实例接口创建。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
租户在某一Region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID,可以调用查询实例列表和详情接口获取。如果未申请实例,可以调用创建实例接口创建。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。 instance_id 否 String 实例ID,可以调用查询实例列表和详情接口获取。如果未申请实例,可以调用创建实例接口创建。 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
使用前必读 概述 调用说明 终端节点 约束限制 基本概念
一个数据库实例具有20个标签配额,且标签key唯一。 添加标签时,如果请求体中存在重复key,调用该接口将会报错。 添加标签时,如果请求体中的key与指定实例已有的key重复,将会覆盖已有key对应的value的值。 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。 调试 您可以在API
租户在某一Region下的Project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID,可以调用查询实例列表和详情接口获取。如果未申请实例,可以调用创建实例接口创建。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token