الانتقال إلى المحتوى الرئيسي
POST
/
v1
/
organizations
/
{organizationId}
/
keys
إنشاء مفتاح
curl --request POST \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expireAt": "2023-11-07T05:31:56Z",
  "hashData": {
    "keyIdHash": "<string>",
    "keyIdSuffix": "<string>",
    "keySecretHash": "<string>"
  },
  "ipAccessList": [
    {
      "description": "<string>",
      "source": "<string>"
    }
  ],
  "name": "<string>",
  "roles": []
}
'
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "key": {
      "createdAt": "2023-11-07T05:31:56Z",
      "expireAt": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ipAccessList": [
        {
          "description": "<string>",
          "source": "<string>"
        }
      ],
      "keySuffix": "<string>",
      "name": "<string>",
      "roles": [],
      "usedAt": "2023-11-07T05:31:56Z"
    },
    "keyId": "<string>",
    "keySecret": "<string>"
  },
  "status": 200
}

التفويضات

​
Authorization
string
header
مطلوب

استخدم معرّف المفتاح والسرّ الخاص به اللذين تم الحصول عليهما من ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

معلمات المسار

​
organizationId
string<uuid>
مطلوب

معرّف المؤسسة التي ستملك المفتاح.

الجسم

application/json
​
expireAt
string<date-time> | null

الطابع الزمني لانتهاء صلاحية المفتاح. إذا لم يكن موجودًا، أو كانت قيمته null، أو كان فارغًا، فلن تنتهي صلاحية المفتاح مطلقًا. ISO-8601.

​
hashData
object
​
ipAccessList
object[]

قائمة عناوين IP المسموح لها بالوصول إلى API باستخدام هذا المفتاح

​
name
string

اسم المفتاح.

​
roles
enum<string>[]

قائمة الأدوار المعيّنة إلى المفتاح. تحتوي على عنصر واحد على الأقل.

الخيارات المتاحة:
admin,
developer,
query_endpoints
​
state
enum<string>

الحالة الأولية للمفتاح: 'enabled'، 'disabled'. وإذا لم يتم توفيرها فسيكون المفتاح الجديد 'enabled'.

الخيارات المتاحة:
enabled,
disabled

الاستجابة

استجابة ناجحة

​
requestId
string<uuid>

معرّف فريد يُخصَّص لكل طلب. UUIDv4

​
result
object
​
status
number

رمز حالة HTTP.

مثال:

200

آخر تعديل في ٢٩ يونيو ٢٠٢٦