GridDB Cloud REST API认证：API Key与Basic Auth的使用方法、常见问题及免费版支持说明

我来一步步帮你解决这些问题，我之前也在GridDB Cloud上折腾过WebAPI，踩过不少类似的坑：

1. 集群主机名格式 #

GridDB Cloud免费版的集群主机名确实是 <cluster-name>.griddb.net，你需要把URL里的<cluster-host>替换成这个完整的主机名——比如你的集群叫my-test-cluster，那主机名就是my-test-cluster.griddb.net。

2. 免费版是否支持WebAPI？ #

是的，GridDB Cloud免费版完全支持WebAPI，但有个关键前提：你需要在GridDB Cloud控制台的集群设置里先启用WebAPI服务。如果没开启的话，所有WebAPI请求都会返回401或403，这很可能是你当前遇到401的原因之一。

3. Basic Auth的问题排查 #

你的代码逻辑本身是对的，但401错误大概率来自这几个点：

• 用户名密码不匹配：GridDB Cloud的数据库用户不是控制台的登录账号，而是你在集群内创建的专属数据库用户（可以在控制台的「数据库用户」页面创建）。默认的admin用户可能未启用，或者密码和你设置的控制台密码不一致。
• 未启用Basic Auth开关：在Cloud控制台的WebAPI设置里，需要确保Basic Authentication处于开启状态，否则用Basic Auth发起的请求会直接被拒绝。
• URL路径错误：正确的WebAPI容器列表路径应该是 https://<cluster-name>.griddb.net/griddb/v2/dbs/public/containers —— 注意这里不需要重复<cluster-name>，路径里的dbs/public已经指向了你的集群的公共数据库，你之前的URL多写了一次<cluster-name>，这几乎是导致401的核心原因！

修正后的Basic Auth代码示例：

import requests
import base64

# 替换成你在集群里创建的数据库用户名和密码
credentials = base64.b64encode(b"db-username:db-password").decode("utf-8")
headers = {
    "Authorization": f"Basic {credentials}",
    "Content-Type": "application/json"
}
# 修正后的URL，去掉多余的<cluster-name>
url = "https://my-test-cluster.griddb.net/griddb/v2/dbs/public/containers"
response = requests.get(url, headers=headers)
print(response.status_code, response.text)

4. API密钥认证的正确格式 #

GridDB Cloud的API密钥认证使用的是X-API-Key请求头，而非Authorization: Bearer格式。你可以在控制台的「API密钥」页面生成专属密钥，然后在请求中添加这个头即可：

import requests

headers = {
    "X-API-Key": "your-generated-api-key-here",
    "Content-Type": "application/json"
}
url = "https://my-test-cluster.griddb.net/griddb/v2/dbs/public/containers"
response = requests.get(url, headers=headers)
print(response.status_code, response.text)

5. 生产环境认证方式选择 #

生产环境优先选择API密钥认证，原因如下：

• Basic Auth的base64编码是可逆的，本质上和明文传输用户名密码没有区别，安全风险更高；
• API密钥可以单独生成、轮换和撤销，不需要暴露数据库的用户名密码；
• GridDB Cloud对API密钥的权限控制更灵活，可以针对不同操作设置细粒度的权限。

内容的提问来源于stack exchange，提问作者AS Ansari