Workspace
创建 Workspace
在你的 Square Cloud 账户中创建一个新的 workspace。
POST
/
v2
/
workspaces
创建 Workspace
curl --request POST \
--url https://api.squarecloud.app/v2/workspaces \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/workspaces"
payload = { "name": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://api.squarecloud.app/v2/workspaces', 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/workspaces",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<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/workspaces"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.squarecloud.app/v2/workspaces")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body
{
"status": "success",
"response": {
"id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
"name": "Test"
}
}
创建一个归经过身份验证的用户所有的 workspace，以便通过基于角色的权限模型将应用共享给其他 Square Cloud 账户，而无需转移应用所有权。workspace 功能仅适用于 Standard、Pro 和 Enterprise 套餐，该范围内的每个套餐等级都将账户的 workspace 数量上限设为 5 个。
name 长度必须为 1-32 个字符（字母、数字、空格、连字符或下划线）。创建 workspace 后，可使用添加应用将应用共享进来，并使用邀请成员添加协作者。此端点速率限制为每个用户每 10 秒 1 次创建操作。
参数
string
表示 workspace 名称的字符串。
必须符合 a 到 z、A 到 Z、0 到 9、空格和 _ 的规则。（1-32 个字符）
必须符合 a 到 z、A 到 Z、0 到 9、空格和 _ 的规则。（1-32 个字符）
响应
string
指示调用是否成功。成功时为
success，否则为 error。
{
"status": "success",
"response": {
"id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
"name": "Test"
}
}
常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
INVALID_NAME | 400 | 缺少 name，或不符合 1-32 个字符的规则。 |
UPGRADE_REQUIRED | 403 | 当前套餐不是 Standard、Pro 或 Enterprise。 |
WORKSPACE_LIMIT_REACHED | 400 | 该账户的 workspace 数量已达到套餐上限。 |
WORKSPACE_CREATION_FAILED | 400 | 无法创建该 workspace。 |
⌘I
创建 Workspace
curl --request POST \
--url https://api.squarecloud.app/v2/workspaces \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/workspaces"
payload = { "name": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://api.squarecloud.app/v2/workspaces', 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/workspaces",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<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/workspaces"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.squarecloud.app/v2/workspaces")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body
{
"status": "success",
"response": {
"id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
"name": "Test"
}
}