تحديث المفتاح
يحدّث خصائص مفتاح API.
PATCH
/
v1
/
organizations
/
{organizationId}
/
keys
/
{keyId}
تحديث المفتاح
curl --request PATCH \
--url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
'import requests
url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}"
payload = {
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expireAt: '2023-11-07T05:31:56Z',
ipAccessList: [{description: '<string>', source: '<string>'}],
name: '<string>',
roles: []
})
};
fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expireAt' => '2023-11-07T05:31:56Z',
'ipAccessList' => [
[
'description' => '<string>',
'source' => '<string>'
]
],
'name' => '<string>',
'roles' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}"
payload := strings.NewReader("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}"
response = http.request(request)
puts response.read_body{
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"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"
},
"status": 200
}{
"error": "<string>",
"status": 400
}التفويضات
استخدم معرّف المفتاح والسرّ الخاص به اللذين تم الحصول عليهما من ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi
معلمات المسار
معرّف المؤسسة المالكة للمفتاح.
معرّف المفتاح المطلوب تحديثه.
الجسم
application/json
الطابع الزمني لانتهاء صلاحية المفتاح. إذا كانت القيمة null أو كانت فارغة، فلن تنتهي صلاحية المفتاح مطلقًا. ISO-8601.
قائمة عناوين IP المسموح لها بالوصول إلى واجهة برمجة التطبيقات باستخدام هذا المفتاح
Show child attributes
Show child attributes
اسم المفتاح
قائمة الأدوار المعيّنة للمفتاح. تحتوي على عنصر واحد على الأقل.
الخيارات المتاحة:
admin, developer, query_endpoints حالة المفتاح: 'enabled'، 'disabled'.
الخيارات المتاحة:
enabled, disabled آخر تعديل في ٢ يوليو ٢٠٢٦
هل كانت هذه الصفحة مفيدة؟
⌘I
تحديث المفتاح
curl --request PATCH \
--url https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
'import requests
url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}"
payload = {
"expireAt": "2023-11-07T05:31:56Z",
"ipAccessList": [
{
"description": "<string>",
"source": "<string>"
}
],
"name": "<string>",
"roles": []
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expireAt: '2023-11-07T05:31:56Z',
ipAccessList: [{description: '<string>', source: '<string>'}],
name: '<string>',
roles: []
})
};
fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expireAt' => '2023-11-07T05:31:56Z',
'ipAccessList' => [
[
'description' => '<string>',
'source' => '<string>'
]
],
'name' => '<string>',
'roles' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}"
payload := strings.NewReader("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/keys/{keyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expireAt\": \"2023-11-07T05:31:56Z\",\n \"ipAccessList\": [\n {\n \"description\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"roles\": []\n}"
response = http.request(request)
puts response.read_body{
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"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"
},
"status": 200
}{
"error": "<string>",
"status": 400
}