移除环境变量
按键名删除一个或多个环境变量（DELETE /v2/apps//envs）。不存在的键会被忽略，并返回剩余的变量。
DELETE
/
v2
/
apps
/
{app_id}
/
envs
移除环境变量
curl --request DELETE \
--url https://api.squarecloud.app/v2/apps/{app_id}/envs \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"envs": [
"<string>"
]
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/envs"
payload = { "envs": ["<string>"] }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({envs: ['<string>']})
};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/envs', 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.squarecloud.app/v2/apps/{app_id}/envs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'envs' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.squarecloud.app/v2/apps/{app_id}/envs"
payload := strings.NewReader("{\n \"envs\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.delete("https://api.squarecloud.app/v2/apps/{app_id}/envs")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"envs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/envs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"envs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"REMAINING": "secret"
}
}
需要具有
envs:write 权限范围的 API 密钥。
按键删除一个或多个环境变量，其余变量保持不变。当前不存在的键会被静默忽略，因此可以安全地传入一个混合了有效键和已删除键的列表。
静态应用不支持环境变量，会返回错误。在工作区共享的应用上，调用者需要具有 admin 角色或为所有者。响应会返回剩余的完整变量集，因此你无需再单独调用列出变量即可确认删除结果。
要重新添加变量或替换整个变量集，请参阅添加/编辑变量和覆盖变量。
参数
string
必填
应用程序 ID。
string[]
必填
包含要移除的键的数组。
响应
string
指示调用是否成功。成功时为
success，否则为 error。object
所有剩余环境变量的键和值。
{
"status": "success",
"response": {
"REMAINING": "secret"
}
}
常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
STATIC_APP_ENV_NOT_SUPPORTED | 400 | 该应用为静态应用；静态应用不支持环境变量。 |
INVALID_ENV_CONTENT | 400 | envs 缺失、不是数组，或为空。 |
ENV_NAME_TOO_LONG | 400 | envs 中的某个键不是字符串，或超过 1024 个字符。 |
相关内容
- CLI：
squarecloud app env remove - SDK：
api.apps.envs.delete()（JavaScript）、client.apps.envs.delete()（Python）、c.Apps.Envs.Delete()（Go）
⌘I
移除环境变量
curl --request DELETE \
--url https://api.squarecloud.app/v2/apps/{app_id}/envs \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"envs": [
"<string>"
]
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/envs"
payload = { "envs": ["<string>"] }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({envs: ['<string>']})
};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/envs', 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.squarecloud.app/v2/apps/{app_id}/envs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'envs' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.squarecloud.app/v2/apps/{app_id}/envs"
payload := strings.NewReader("{\n \"envs\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.delete("https://api.squarecloud.app/v2/apps/{app_id}/envs")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"envs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/envs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"envs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"REMAINING": "secret"
}
}