cloud-create-project

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create Serverless Project

创建Serverless项目

Create Elastic Cloud Serverless projects using the Serverless REST API. Use the
cloud-manage-project
skill for day-2 operations like listing, updating, or deleting projects.
使用Serverless REST API创建Elastic Cloud Serverless项目。日常运维操作(如列出、更新或删除项目)请使用
cloud-manage-project
技能。

Prerequisites and permissions

前提条件与权限

  • Ensure
    EC_API_KEY
    is configured. If not, run
    cloud-setup
    skill first.
  • Creating projects requires a Cloud API key with Admin or Organization owner role.
  • This skill does not perform a separate role pre-check. Attempt the requested operation and let the API enforce authorization. If the API returns an authorization error (for example,
    403 Forbidden
    ), stop and ask the user to verify the provided API key permissions.
  • 确保已配置
    EC_API_KEY
    。若未配置,请先运行
    cloud-setup
    技能。
  • 创建项目需要拥有管理员组织所有者角色的Cloud API密钥。
  • 本技能不会单独进行角色预检查。直接执行请求的操作,由API来强制授权。如果API返回授权错误(例如
    403 Forbidden
    ),请停止操作并告知用户验证其提供的API密钥权限。

Manual setup fallback (when
cloud-setup
is unavailable)

手动设置备选方案(当
cloud-setup
不可用时)

If this skill is installed standalone and
cloud-setup
is not available, instruct the user to configure Cloud environment variables manually before running commands. Never ask the user to paste API keys in chat.
VariableRequiredDescription
EC_API_KEY
YesElastic Cloud API key used for project creation operations.
EC_BASE_URL
NoCloud API base URL (default:
https://api.elastic-cloud.com
).
Note: If
EC_API_KEY
is missing, or the user does not have a Cloud API key yet, direct the user to generate one at Elastic Cloud API keys, then configure it locally using the steps below.
Preferred method (agent-friendly): create a
.env
file in the project root:
bash
EC_API_KEY=your-api-key
EC_BASE_URL=https://api.elastic-cloud.com
All
cloud/*
scripts auto-load
.env
from the working directory.
Alternative: export directly in the terminal:
bash
export EC_API_KEY="<your-cloud-api-key>"
export EC_BASE_URL="https://api.elastic-cloud.com"
Terminal exports may not be visible to sandboxed agents running in separate shell sessions, so prefer
.env
when using an agent.
如果本技能是独立安装且
cloud-setup
不可用,请指导用户在运行命令前手动配置Cloud环境变量。切勿要求用户在聊天中粘贴API密钥。
变量名是否必填描述
EC_API_KEY
用于项目创建操作的Elastic Cloud API密钥。
EC_BASE_URL
Cloud API基础URL(默认值:
https://api.elastic-cloud.com
)。
注意: 如果缺少
EC_API_KEY
,或者用户还没有Cloud API密钥,请引导用户前往Elastic Cloud API keys生成,然后按照以下步骤在本地配置。
首选方式(适用于Agent):在项目根目录创建
.env
文件:
bash
EC_API_KEY=your-api-key
EC_BASE_URL=https://api.elastic-cloud.com
所有
cloud/*
脚本会自动从工作目录加载
.env
文件。
备选方式:在终端中直接导出:
bash
export EC_API_KEY="<your-cloud-api-key>"
export EC_BASE_URL="https://api.elastic-cloud.com"
终端导出的变量可能对在独立shell会话中运行的沙箱Agent不可见,因此使用Agent时优先选择
.env
方式。

Critical principles

核心原则

  • Never display secrets in chat. Do not echo, log, or repeat API keys, passwords, or credentials in conversation messages or agent thinking. Direct the user to the
    .elastic-credentials
    file instead. The admin password must never appear in chat history, thinking traces, or agent output.
  • Confirm before creating. Always present the project configuration to the user and ask for confirmation before running the creation script.
  • Admin credentials are for API key creation only. The script saves the
    admin
    password to
    .elastic-credentials
    for bootstrapping a scoped API key. The
    admin
    user has full privileges and cannot be modified in serverless. Never use admin credentials for direct Elasticsearch operations (querying, indexing, etc.) — always create a scoped API key first (see Step 8). The
    load-credentials
    command excludes admin credentials by default — use
    --include-admin
    only during Step 7/8, then reload without it once the API key is created. Never read or display the contents of
    .elastic-credentials
    in chat.
  • Recover lost credentials. If the script fails to write
    .elastic-credentials
    (disk full, permissions, etc.), the save may be incomplete. Check
    .elastic-credentials
    for the password first. If missing, use the
    cloud-manage-project
    skill's
    reset-credentials
    command to generate a new password.
  • Region is permanent. A project's region cannot be changed after creation.
  • Prefer automatic readiness checks. Pass
    --wait
    to the creation script so it polls until the phase changes from
    initializing
    to
    initialized
    . Only fall back to manually polling the status endpoint if
    --wait
    is unavailable.
  • 切勿在聊天中显示机密信息。不要在对话消息或Agent的思考过程中回显、记录或重复API密钥、密码或凭据。请引导用户查看
    .elastic-credentials
    文件。管理员密码绝对不能出现在聊天历史、思考痕迹或Agent输出中。
  • 创建前确认。在运行创建脚本前,务必向用户展示项目配置并请求确认。
  • 管理员凭据仅用于API密钥创建。脚本会将
    admin
    密码保存到
    .elastic-credentials
    中,用于引导生成范围受限的API密钥。
    admin
    用户拥有全部权限,且在serverless环境中无法修改。切勿使用管理员凭据直接执行Elasticsearch操作(查询、索引等)——务必先创建范围受限的API密钥(见步骤8)。
    load-credentials
    命令默认会排除管理员凭据——仅在步骤7/8中使用
    --include-admin
    ,创建完API密钥后重新加载时去掉该参数。切勿在聊天中读取或显示
    .elastic-credentials
    的内容。
  • 恢复丢失的凭据。如果脚本无法写入
    .elastic-credentials
    (磁盘已满、权限问题等),可能会导致保存不完整。首先检查
    .elastic-credentials
    中是否有密码。如果缺失,请立即使用
    cloud-manage-project
    技能的
    reset-credentials
    命令生成新密码。
  • 区域不可更改。项目创建后,其区域无法修改。
  • 优先使用自动就绪检查。在创建脚本中传入
    --wait
    参数,使其轮询直到项目阶段从
    initializing
    变为
    initialized
    。仅当
    --wait
    不可用时,才回退到手动轮询状态端点。

Project types

项目类型

TypeDescriptionKey endpoints
elasticsearch
Search, analytics, and vector workloadsElasticsearch, Kibana
observability
Logs, metrics, traces, and APMElasticsearch, Kibana, APM, OTLP
security
SIEM, endpoint protection, cloud securityElasticsearch, Kibana, OTLP
类型描述关键端点
elasticsearch
搜索、分析和向量工作负载Elasticsearch、Kibana
observability
日志、指标、追踪和APM(应用性能监控)Elasticsearch、Kibana、APM、OTLP
security
SIEM、端点防护、云安全Elasticsearch、Kibana、OTLP

Project type inference

项目类型推断

Map the user's request to the correct
--type
value:
User says
--type
"search project", "elasticsearch project", vector search
elasticsearch
"observability project", "o11y", logs, metrics, traces, APM
observability
"security project", "SIEM", detections, endpoint protection
security
Do not silently default to any type. If the user does not specify a type, infer it from the conversation context (for example, discussing log ingestion suggests
observability
, discussing detections or SIEM suggests
security
, discussing search or vector workloads suggests
elasticsearch
). Always present the inferred type to the user and ask for confirmation before proceeding. If context is insufficient to infer a type, ask the user to choose.
将用户的请求映射到正确的
--type
值:
用户表述内容
--type
"搜索项目"、"elasticsearch项目"、向量搜索
elasticsearch
"可观测性项目"、"o11y"、日志、指标、追踪、APM
observability
"安全项目"、"SIEM"、检测、端点防护
security
不要默认任何类型。如果用户未指定类型,请从对话上下文推断(例如,讨论日志摄入意味着
observability
,讨论检测或SIEM意味着
security
,讨论搜索或向量工作负载意味着
elasticsearch
)。在继续之前,务必将推断的类型告知用户并请求确认。如果上下文不足以推断类型,请让用户选择。

Product tiers

产品层级

Observability and security projects support a
--product-tier
flag. Default to
complete
unless the user explicitly requests a different tier.
Project typeTierDescription
observability
complete
Full observability suite (logs, metrics, traces, APM)
observability
logs_essentials
Log management only
security
complete
Full security suite (SIEM, cloud, endpoint)
security
essentials
Core SIEM only
Elasticsearch projects do not have a product tier — use
--optimized-for
instead.
可观测性和安全项目支持
--product-tier
参数。除非用户明确要求其他层级,否则默认使用
complete
项目类型层级描述
observability
complete
完整可观测性套件(日志、指标、追踪、APM)
observability
logs_essentials
仅日志管理
security
complete
完整安全套件(SIEM、云安全、端点防护)
security
essentials
仅核心SIEM功能
Elasticsearch项目没有产品层级——请使用
--optimized-for
参数替代。

Sensible defaults

合理默认值

Present these defaults to the user before creation. Ask if they want to use or change them:
SettingDefault
Region
gcp-us-central1
Project type must be confirmed with the user — do not assume a default. See "Project type inference" above.
Always use
--optimized-for general_purpose
unless the user explicitly requests
vector
. Do not proactively offer the
vector
option.
If the user does not specify a name, ask for one — it is required.
创建前向用户展示以下默认值,询问他们是否要使用或修改:
设置默认值
区域
gcp-us-central1
必须与用户确认项目类型——不要假设默认值。请参阅上方的“项目类型推断”。
除非用户明确要求
vector
,否则始终使用
--optimized-for general_purpose
。不要主动提供
vector
选项。
如果用户未指定名称,请询问用户——项目名称是必填项。

Workflow: Create a project

工作流:创建项目

text
Project Creation:
- [ ] Step 1: Verify API key is set
- [ ] Step 2: Present defaults and confirm with user
- [ ] Step 3: List available regions (optional)
- [ ] Step 4: Create the project
- [ ] Step 5: Save credentials and endpoints
- [ ] Step 6: Wait for project to initialize
- [ ] Step 7: Set environment variables
- [ ] Step 8: Recommend creating a scoped API key
text
项目创建:
- [ ] 步骤1:验证API密钥已设置
- [ ] 步骤2:展示默认值并请求用户确认
- [ ] 步骤3:列出可用区域(可选)
- [ ] 步骤4:创建项目
- [ ] 步骤5:保存凭据和端点
- [ ] 步骤6:等待项目初始化完成
- [ ] 步骤7:设置环境变量
- [ ] 步骤8:建议创建范围受限的API密钥

Step 1: Verify API key is set

步骤1:验证API密钥已设置

bash
echo "${EC_API_KEY:?Not set}"
If
EC_API_KEY
is not set, run the
cloud-setup
skill first to configure authentication and defaults.
bash
echo "${EC_API_KEY:?Not set}"
如果
EC_API_KEY
未设置,请先运行
cloud-setup
技能配置身份验证和默认值。

Step 2: Present summary and confirm with user

步骤2:展示摘要并请求用户确认

Before presenting the summary, ensure the project type has been explicitly confirmed by the user. If no type was specified, infer one from the conversation context and propose it. If the context is ambiguous, ask the user to choose from
elasticsearch
,
observability
, or
security
.
Always show a confirmation summary before creating. Include different fields depending on project type:
Elasticsearch project:
text
Project Summary:
  Type:          elasticsearch
  Name:          my-project
  Region:        gcp-us-central1
Observability project:
text
Project Summary:
  Type:          observability
  Name:          my-project
  Region:        gcp-us-central1
  Product tier:  complete
Security project:
text
Project Summary:
  Type:          security
  Name:          my-project
  Region:        gcp-us-central1
  Product tier:  complete
Ask the user to confirm or override any values before proceeding.
在展示摘要前,确保项目类型已得到用户明确确认。如果用户未指定类型,请从对话上下文推断并提出建议。如果上下文模糊,请让用户从
elasticsearch
observability
security
中选择。
创建前始终展示确认摘要。根据项目类型包含不同字段:
Elasticsearch项目:
text
项目摘要:
  类型:          elasticsearch
  名称:          my-project
  区域:        gcp-us-central1
可观测性项目:
text
项目摘要:
  类型:          observability
  名称:          my-project
  区域:        gcp-us-central1
  产品层级:  complete
安全项目:
text
项目摘要:
  类型:          security
  名称:          my-project
  区域:        gcp-us-central1
  产品层级:  complete
请用户确认或修改任何值后再继续。

Step 3: List available regions (optional)

步骤3:列出可用区域(可选)

bash
python3 skills/cloud/create-project/scripts/create-project.py list-regions
The output is grouped by cloud provider (AWS, Azure, GCP) and sorted alphabetically. Regions marked with
*
do not support project creation.
bash
python3 skills/cloud/create-project/scripts/create-project.py list-regions
输出按云提供商(AWS、Azure、GCP)分组,并按字母顺序排序。标记有
*
的区域不支持项目创建。

Step 4: Create the project

步骤4:创建项目

bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type elasticsearch \
  --name "my-project" \
  --region gcp-us-central1 \
  --optimized-for general_purpose \
  --wait
Always pass
--optimized-for general_purpose
for Elasticsearch projects. Only use
vector
if the user explicitly requests it.
For observability and security projects, pass
--product-tier complete
unless the user explicitly requests a different tier.
Always pass
--wait
so the script automatically polls until the project is ready.
bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type elasticsearch \
  --name "my-project" \
  --region gcp-us-central1 \
  --optimized-for general_purpose \
  --wait
对于Elasticsearch项目,始终传入
--optimized-for general_purpose
。仅当用户明确要求时才使用
vector
对于可观测性和安全项目,传入
--product-tier complete
,除非用户明确要求其他层级。
始终传入
--wait
,以便脚本自动轮询直到项目就绪。

Step 5: Save credentials and endpoints

步骤5:保存凭据和端点

The script automatically writes credentials to
.elastic-credentials
in the working directory. The password is redacted from the JSON output on stdout.
If saving succeeds, tell the user:
text
Credentials saved to .elastic-credentials — open that file to retrieve your password.
Do not read, cat, or display the contents of
.elastic-credentials
in chat.
If saving fails, the script prints an error to stderr. Check whether
.elastic-credentials
exists and contains a password (a partial write is possible). If the password is missing or the file does not exist, immediately run the
cloud-manage-project
skill's
reset-credentials
command to generate a new password.
The creation response also contains:
  • Project ID — needed for all subsequent operations
  • Cloud ID — for client libraries
  • Elasticsearch and Kibana endpoints — safe to display in chat
The admin credentials are for initial bootstrap only. Recommend creating a scoped API key for ongoing access (Step 8).
脚本会自动将凭据写入工作目录下的
.elastic-credentials
文件。标准输出的JSON结果中会隐藏密码。
如果保存成功,告知用户:
text
凭据已保存到.elastic-credentials文件中——请打开该文件获取密码。
不要在聊天中读取、打印或显示
.elastic-credentials
的内容。
如果保存失败,脚本会将错误打印到标准错误流。检查
.elastic-credentials
是否存在且包含密码(可能会出现部分写入的情况)。如果密码缺失或文件不存在,请立即使用
cloud-manage-project
技能的
reset-credentials
命令生成新密码。
创建响应还包含:
  • 项目ID——后续所有操作都需要该ID
  • Cloud ID——用于客户端库
  • Elasticsearch和Kibana端点——可安全地在聊天中展示
管理员凭据仅用于初始引导。建议创建范围受限的API密钥用于日常访问(步骤8)。

Step 6: Wait for project to initialize

步骤6:等待项目初始化完成

When
--wait
is passed (recommended), the script polls automatically until the project phase becomes
initialized
. No manual polling is needed.
If the agent ran without
--wait
, poll manually:
bash
python3 skills/cloud/create-project/scripts/create-project.py status \
  --type elasticsearch \
  --id <project-id>
Repeat until
phase
changes from
initializing
to
initialized
.
当传入
--wait
参数(推荐)时,脚本会自动轮询直到项目阶段变为
initialized
。无需手动轮询。
如果Agent运行时未使用
--wait
,则手动轮询:
bash
python3 skills/cloud/create-project/scripts/create-project.py status \
  --type elasticsearch \
  --id <project-id>
重复执行直到
phase
initializing
变为
initialized

Step 7: Set environment variables

步骤7:设置环境变量

The creation script saves credentials and endpoints to
.elastic-credentials
with the project name in the header. Load them into the current shell with
--include-admin
so admin credentials are available for API key creation in Step 8:
bash
eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
  --name "<project-name>" --include-admin)
This sets
ELASTICSEARCH_URL
,
KIBANA_URL
, any project-type specific endpoints (
APM_URL
,
INGEST_URL
), and the admin
ELASTICSEARCH_USERNAME
/
ELASTICSEARCH_PASSWORD
needed to bootstrap an API key.
创建脚本会将凭据和端点保存到
.elastic-credentials
文件中,文件头部包含项目名称。使用
--include-admin
参数将其加载到当前shell中,以便步骤8中创建API密钥时能使用管理员凭据:
bash
eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
  --name "<project-name>" --include-admin)
这会设置
ELASTICSEARCH_URL
KIBANA_URL
、项目类型特定的端点(
APM_URL
INGEST_URL
),以及引导生成API密钥所需的管理员
ELASTICSEARCH_USERNAME
/
ELASTICSEARCH_PASSWORD

Step 8: Create a scoped API key

步骤8:创建范围受限的API密钥

The
admin
user has full privileges and cannot be modified in serverless projects. Do not proceed with Elasticsearch operations using admin credentials. Create a scoped Elasticsearch API key with only the permissions the user needs.
If the
elasticsearch-authn
skill is available, use it for API key creation — it covers the full lifecycle (create, grant, invalidate, query) and handles scoping privileges correctly. If the skill is not installed, ask the user to either install it or create the API key manually through Kibana > Stack Management > API keys. After creation, save the API key to
.elastic-credentials
using the project-specific header format (see
manage-project
skill's "Credential file format" section), then reload without
--include-admin
to drop admin credentials from the environment:
bash
eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
  --name "<project-name>")
admin
用户拥有全部权限,且在serverless项目中无法修改。不要使用管理员凭据执行Elasticsearch操作。请创建仅包含用户所需权限的范围受限的Elasticsearch API密钥。
如果
elasticsearch-authn
技能可用,请使用它来创建API密钥——它涵盖了完整的生命周期(创建、授权、失效、查询),并能正确处理权限范围。如果未安装该技能,请让用户选择安装它,或通过Kibana > 堆栈管理 > API密钥手动创建。创建完成后,使用项目特定的头部格式将API密钥保存到
.elastic-credentials
中(请参阅
manage-project
技能的“凭据文件格式”部分),然后**不使用
--include-admin
**重新加载,从环境中移除管理员凭据:
bash
eval $(python3 skills/cloud/manage-project/scripts/manage-project.py load-credentials \
  --name "<project-name>")

Examples

示例

Create an Elasticsearch project with defaults

使用默认值创建Elasticsearch项目

bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type elasticsearch \
  --name "my-search-project" \
  --region gcp-us-central1 \
  --optimized-for general_purpose \
  --wait
bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type elasticsearch \
  --name "my-search-project" \
  --region gcp-us-central1 \
  --optimized-for general_purpose \
  --wait

Create an observability project

创建可观测性项目

bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type observability \
  --name "prod-o11y" \
  --region aws-eu-west-1 \
  --product-tier complete \
  --wait
bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type observability \
  --name "prod-o11y" \
  --region aws-eu-west-1 \
  --product-tier complete \
  --wait

Create a security project

创建安全项目

bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type security \
  --name "siem-prod" \
  --region gcp-us-central1 \
  --product-tier complete \
  --wait
bash
python3 skills/cloud/create-project/scripts/create-project.py create \
  --type security \
  --name "siem-prod" \
  --region gcp-us-central1 \
  --product-tier complete \
  --wait

Guidelines

指导原则

  • Run the
    cloud-setup
    skill first if
    EC_API_KEY
    is not set.
  • Always confirm the project configuration with the user before creating.
  • Never display passwords or API keys in chat. Direct the user to
    .elastic-credentials
    .
  • Never silently default to a project type. Infer from context and confirm with the user.
  • Default to
    general_purpose
    optimization. Only use
    vector
    if the user explicitly requests it.
  • Default to
    complete
    product tier for observability and security projects. Only use
    logs_essentials
    or
    essentials
    if the user explicitly requests it.
  • Always pass
    --wait
    so the script polls until the project is ready.
  • If credential saving fails, immediately reset credentials using the
    cloud-manage-project
    skill.
  • After creation, recommend creating a scoped API key instead of relying on admin credentials.
  • Region cannot be changed after creation — confirm the choice before proceeding.
  • 如果未设置
    EC_API_KEY
    ,请先运行
    cloud-setup
    技能。
  • 创建前务必与用户确认项目配置。
  • 切勿在聊天中显示密码或API密钥。引导用户查看
    .elastic-credentials
    文件。
  • 不要默认任何项目类型。从上下文推断并与用户确认。
  • 默认使用
    general_purpose
    优化。仅当用户明确要求时才使用
    vector
  • 对于可观测性和安全项目,默认使用
    complete
    产品层级。仅当用户明确要求时才使用
    logs_essentials
    essentials
  • 始终传入
    --wait
    参数,以便脚本轮询直到项目就绪。
  • 如果凭据保存失败,请立即使用
    cloud-manage-project
    技能重置凭据。
  • 创建完成后,建议创建范围受限的API密钥,而不是依赖管理员凭据。
  • 项目创建后区域无法更改——继续前请确认用户的选择。

Script reference

脚本参考

CommandDescription
create
Create a new serverless project
status
Get project initialization status
list-regions
List available regions
FlagCommandsDescription
--type
create, statusProject type:
elasticsearch
,
observability
,
security
--name
createProject name (required)
--region
createRegion ID (default:
gcp-us-central1
)
--id
statusProject ID
--optimized-for
createElasticsearch subtype:
general_purpose
or
vector
--product-tier
createObservability/security tier (see "Product tiers" section)
--wait
createPoll until project is initialized before exiting
命令描述
create
创建新的serverless项目
status
获取项目初始化状态
list-regions
列出可用区域
参数适用命令描述
--type
create, status项目类型:
elasticsearch
observability
security
--name
create项目名称(必填)
--region
create区域ID(默认值:
gcp-us-central1
--id
status项目ID
--optimized-for
createElasticsearch子类型:
general_purpose
vector
--product-tier
create可观测性/安全项目层级(请参阅“产品层级”部分)
--wait
create轮询直到项目初始化完成后再退出

Environment variables

环境变量

VariableRequiredDescription
EC_API_KEY
YesElastic Cloud API key
EC_BASE_URL
NoCloud API base URL (default:
https://api.elastic-cloud.com
)
ELASTICSEARCH_URL
OutputElasticsearch URL (loaded via
load-credentials
after creation)
KIBANA_URL
OutputKibana URL (loaded via
load-credentials
after creation)
APM_URL
OutputAPM endpoint (observability projects only)
INGEST_URL
OutputOTLP ingest endpoint (observability and security projects)
ELASTICSEARCH_API_KEY
OutputElasticsearch API key (created in Step 8, loaded via
load-credentials
)
变量名是否必填描述
EC_API_KEY
Elastic Cloud API密钥
EC_BASE_URL
Cloud API基础URL(默认值:
https://api.elastic-cloud.com
ELASTICSEARCH_URL
输出项Elasticsearch URL(创建后通过
load-credentials
加载)
KIBANA_URL
输出项Kibana URL(创建后通过
load-credentials
加载)
APM_URL
输出项APM端点(仅适用于可观测性项目)
INGEST_URL
输出项OTLP摄入端点(适用于可观测性和安全项目)
ELASTICSEARCH_API_KEY
输出项Elasticsearch API密钥(步骤8中创建,通过
load-credentials
加载)

Additional resources

额外资源

  • For full API details, request/response schemas, and project-type options, see references/api-reference.md
  • 如需完整的API详情、请求/响应架构和项目类型选项,请参阅 references/api-reference.md