summaryrefslogtreecommitdiff
path: root/data/en_us/devs/2023-07-14/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/devs/2023-07-14/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/devs/2023-07-14/api-docs.php')
-rw-r--r--data/en_us/devs/2023-07-14/api-docs.php8033
1 files changed, 3378 insertions, 4655 deletions
diff --git a/data/en_us/devs/2023-07-14/api-docs.php b/data/en_us/devs/2023-07-14/api-docs.php
index 0ffd4e8..fae4902 100644
--- a/data/en_us/devs/2023-07-14/api-docs.php
+++ b/data/en_us/devs/2023-07-14/api-docs.php
@@ -1,4376 +1,2714 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'Devs',
- 'version' => '2023-07-14',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'Devs', 'version' => '2023-07-14'],
'directories' => [
[
- 'id' => 208990,
- 'title' => null,
+ 'children' => ['UpdateToolset', 'ListToolsets', 'GetToolset', 'DeleteToolset', 'CreateToolset'],
'type' => 'directory',
- 'children' => [
- 'UpdateToolset',
- 'ListToolsets',
- 'GetToolset',
- 'DeleteToolset',
- 'CreateToolset',
- ],
+ 'title' => 'Toolkit',
],
[
- 'id' => 204324,
- 'title' => null,
+ 'children' => ['RenderServicesByTemplate'],
'type' => 'directory',
- 'children' => [
- 'RenderServicesByTemplate',
- ],
+ 'title' => 'Template',
],
[
- 'id' => 204326,
- 'title' => null,
+ 'children' => ['FetchArtifactDownloadUrl', 'FetchArtifactTempBucketToken', 'GetArtifact', 'PutArtifact', 'DeleteArtifact', 'CreateArtifact'],
'type' => 'directory',
- 'children' => [
- 'FetchArtifactDownloadUrl',
- 'FetchArtifactTempBucketToken',
- 'GetArtifact',
- 'PutArtifact',
- 'DeleteArtifact',
- 'CreateArtifact',
- ],
+ 'title' => 'Artifacts',
],
[
- 'id' => 190560,
- 'title' => null,
+ 'children' => ['DeployEnvironment', 'GetEnvironmentDeployment', 'GetServiceDeployment', 'ListServiceDeployments', 'PreviewEnvironment', 'CreateEnvironment', 'DeleteEnvironment', 'UpdateEnvironment', 'ListEnvironments', 'GetEnvironment'],
'type' => 'directory',
- 'children' => [
- 'CreateProject',
- 'DeleteProject',
- 'UpdateProject',
- 'ListProjects',
- 'GetProject',
- ],
+ 'title' => 'Environment',
],
[
- 'id' => 190562,
- 'title' => null,
+ 'children' => ['DeleteConnection', 'ListConnections'],
'type' => 'directory',
- 'children' => [
- 'DeployEnvironment',
- 'GetEnvironmentDeployment',
- 'GetServiceDeployment',
- 'ListServiceDeployments',
- 'PreviewEnvironment',
- 'CreateEnvironment',
- 'DeleteEnvironment',
- 'UpdateEnvironment',
- 'ListEnvironments',
- 'GetEnvironment',
- ],
+ 'title' => 'Identity binding',
],
[
- 'id' => 190564,
- 'title' => null,
+ 'children' => ['GetRepository'],
'type' => 'directory',
- 'children' => [
- 'DeleteConnection',
- 'ListConnections',
- ],
+ 'title' => 'Repository binding',
],
[
- 'id' => 190567,
- 'title' => null,
+ 'children' => ['CreatePipeline', 'ListPipelines', 'GetPipeline', 'StartPipeline', 'CancelPipeline', 'PutPipelineStatus'],
'type' => 'directory',
- 'children' => [
- 'GetRepository',
- ],
+ 'title' => 'Pipelines',
],
[
- 'id' => 190596,
- 'title' => null,
+ 'children' => ['CreateTask', 'ListTasks', 'GetTask', 'StartTask', 'RetryTask', 'ResumeTask', 'CancelTask', 'PutTaskStatus'],
'type' => 'directory',
- 'children' => [
- 'CreatePipeline',
- 'ListPipelines',
- 'GetPipeline',
- 'StartPipeline',
- 'CancelPipeline',
- 'PutPipelineStatus',
- ],
+ 'title' => 'Pipeline tasks',
],
[
- 'id' => 190601,
- 'title' => null,
+ 'children' => ['ActivateConnection', 'FetchConnectionCredential'],
'type' => 'directory',
- 'children' => [
- 'CreateTask',
- 'ListTasks',
- 'GetTask',
- 'StartTask',
- 'RetryTask',
- 'ResumeTask',
- 'CancelTask',
- 'PutTaskStatus',
- ],
+ 'title' => 'Other',
],
[
- 'id' => 208980,
- 'title' => null,
+ 'children' => ['CreateProject', 'DeleteProject', 'GetProject', 'ListProjects', 'UpdateProject'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'ActivateConnection',
- 'FetchConnectionCredential',
- ],
],
],
'components' => [
'schemas' => [
- 'Checkout' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'Authorization' => [
+ 'title' => '认证鉴权参数',
'type' => 'object',
'properties' => [
- 'remote' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'type' => [
+ 'title' => '鉴权类型。当前仅支持API Key鉴权（APIKey）',
+ 'description' => 'The authorization type.',
'type' => 'string',
- 'example' => 'https:/your_token/@github.com/buptwzj/test-initRepo4.git',
- 'backendName' => 'remote',
+ 'example' => 'APIKey',
+ 'required' => true,
+ 'enum' => ['APIKey', 'Credentials'],
],
- 'ref' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '+001691d0768ca49e9550beeb59fbc163f33b7e88:refs/remotes/origin/master',
- 'backendName' => 'ref',
+ 'parameters' => [
+ 'title' => '鉴权请求参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'apiKeyParameter' => ['title' => 'API Key鉴权参数', 'description' => 'The location and name of the API key.', 'example' => '', '$ref' => '#/components/schemas/APIKeyAuthParameter'],
+ 'credentials' => [
+ 'title' => '访问凭证',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/Variable'],
+ 'description' => 'The value of a credential property.',
+ 'example' => '',
+ ],
+ ],
+ 'required' => true,
+ 'description' => 'The parameters for the selected authorization type.',
+ 'example' => '',
],
],
+ 'description' => 'The API\'s authorization settings.',
+ 'example' => '',
+ ],
+ 'Checkout' => [
+ 'title' => '代码拉取信息',
+ 'description' => '拉取代码所需信息',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'remote' => ['title' => '拉取代码时所需的仓库信息', 'description' => '拉取代码时所需的仓库信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https:/your_token/@github.com/buptwzj/test-initRepo4.git', 'backendName' => 'remote'],
+ 'ref' => ['title' => '拉取代码时所需的版本信息', 'description' => '拉取代码时所需的版本信息', 'visibility' => 'Public', 'type' => 'string', 'example' => '+001691d0768ca49e9550beeb59fbc163f33b7e88:refs/remotes/origin/master', 'backendName' => 'ref'],
+ ],
],
'CodeupEventPayload' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => 'Code流水线触发事件消息体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'originalPayload' => [
+ 'originalPayload' => ['title' => 'Codeup原始消息体', 'description' => 'Codeup原始消息体', 'visibility' => 'Public', 'type' => 'string', 'format' => 'byte', 'example' => '{'."\n"
+ .' "before": "03b7be6d28af70ab38ca2ce8b42c3533c622d925",'."\n"
+ .' "checkout_sha": "baf09c10ee5f28b5f36cec35e5e0e5c0abdcfa8a",'."\n"
+ .' "object_kind": "push",'."\n"
+ .' "ref": "refs/heads/test",'."\n"
+ .' "commits": ['."\n"
+ .' {'."\n"
+ .' "id": "baf09c10ee5f28b5f36cec35e5e0e5c0abdcfa8a",'."\n"
+ .' "message": "fix:recommend\\n"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "after": "baf09c10ee5f28b5f36cec35e5e0e5c0abdcfa8a"'."\n"
+ .'}'."\n"
+ .'-- 必须使用原始的codeup发出的webhook事件', 'backendName' => 'originalPayload'],
+ ],
+ ],
+ 'ComfyUIWorkflowTemplate' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['description' => 'A unique name for the resource.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'kind' => ['description' => 'The resource type. The value is always `ComfyUIWorkflowTemplate`.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'uid' => ['description' => 'A system-generated, immutable, unique identifier (UID) for the resource.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'createdTime' => ['description' => 'The creation timestamp for the resource, in RFC 3339 format.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'description' => ['description' => '', 'title' => '', 'example' => '', 'type' => 'string'],
+ 'spec' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ComfyUIWorkflowTemplateSpec'],
+ 'installCount' => ['description' => 'The number of times the template has been installed.', 'type' => 'integer', 'title' => '', 'example' => '', 'format' => 'int32'],
+ 'viewerUids' => ['description' => 'A comma-separated list of user UIDs allowed to view this template.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'labels' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The value of a label.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'description' => 'A set of key-value pairs used to organize and categorize the resource. Labels can be used for filtering and querying.',
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'format' => 'byte',
'example' => '',
- 'backendName' => 'originalPayload',
],
],
+ 'description' => 'The `ComfyUIWorkflowTemplate` object represents a reusable workflow template for ComfyUI.',
+ 'title' => '',
+ 'example' => '',
],
'Condition' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '执行条件',
+ 'description' => 'Specifies an execution condition.',
'type' => 'object',
'properties' => [
- 'expression' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'expression',
- ],
+ 'expression' => ['title' => '返回值为bool类型的表达式', 'description' => 'An expression that evaluates to a boolean value.', 'type' => 'string', 'example' => 'enable == true'."\n"
+ .'-- 表示ctx.data.enable的值为true时为真', 'visibility' => 'Public', 'backendName' => 'expression'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'Connection' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '身份绑定',
+ 'description' => 'Represents a Connection.',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Connection',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-connection',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'spec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'required' => true,
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/ConnectionSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The unique ID of the Alibaba Cloud account. read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The resource type. read-only.', 'type' => 'string', 'example' => 'Connection', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'The time the resource was created. read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The name of the resource. Must be unique and immutable.', 'type' => 'string', 'required' => true, 'example' => 'my-connection', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'spec' => ['title' => '身份绑定配置', 'description' => 'The identity binding configuration.', 'required' => true, '$ref' => '#/components/schemas/ConnectionSpec', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'The resource labels.',
'type' => 'object',
- 'additionalProperties' => [
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'test-description',
- 'backendName' => 'description',
- ],
- 'status' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/ConnectionStatus',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['description' => 'A key-value pair used as a label.', 'type' => 'string', 'example' => 'key=value', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
+ 'backendName' => 'labels',
],
+ 'description' => ['title' => '描述信息', 'description' => 'A description of the resource.', 'type' => 'string', 'example' => 'test-description', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'status' => ['title' => '当前资源的状态信息，只读', 'description' => 'The current status of the resource. read-only.', '$ref' => '#/components/schemas/ConnectionStatus', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'ConnectionSpec' => [
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The repository configuration.',
'type' => 'object',
'properties' => [
- 'platform' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'github',
- 'backendName' => 'platform',
- ],
- 'account' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'account',
- '$ref' => '#/components/schemas/GitAccount',
- ],
- 'gitlabConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'gitlabConfig',
- '$ref' => '#/components/schemas/GitLabConfig',
- ],
+ 'platform' => ['title' => '', 'description' => 'The type of the third-party code hosting platform. Valid values: github, gitee, gitlab, and codeup.', 'type' => 'string', 'required' => true, 'example' => 'github'],
+ 'account' => ['title' => '', 'description' => 'The account information of the code hosting platform.', '$ref' => '#/components/schemas/GitAccount', 'example' => ''],
+ 'gitlabConfig' => ['title' => '', 'description' => 'The configuration required to connect to the GitLab code hosting platform.', '$ref' => '#/components/schemas/GitLabConfig', 'example' => ''],
],
+ 'example' => '',
],
'ConnectionStatus' => [
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The identity binding status.',
'type' => 'object',
'properties' => [
- 'installation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'installation',
- '$ref' => '#/components/schemas/Installation',
- ],
+ 'installation' => ['title' => '', 'description' => 'The current status of the identity binding process.', '$ref' => '#/components/schemas/Installation', 'example' => '', 'visibility' => 'Public', 'backendName' => 'installation'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'Context' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => 'json字符串，存储执行上下文',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'data' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'data' => ['title' => 'data是一个JSON结构的数据，描述执行的上下文数据', 'description' => 'data是一个JSON结构的数据，描述执行的上下文数据', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'data'],
+ ],
+ ],
+ 'DifyPluginInstallationConfig' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'provider' => ['title' => '插件供应商', 'description' => 'Specifies the plugin provider. Currently, only `dify` is supported.', 'type' => 'string', 'example' => ''],
+ 'source' => [
+ 'title' => '插件来源',
'type' => 'object',
- 'backendName' => 'data',
+ 'properties' => [
+ 'marketplace' => [
+ 'title' => 'Dify插件市场配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'pluginId' => ['title' => '插件市场中的插件ID', 'description' => 'The plugin ID from the marketplace.', 'type' => 'string', 'example' => ''],
+ 'version' => ['title' => '插件版本', 'description' => 'The plugin version to install.', 'type' => 'string', 'example' => ''],
+ 'uniqueIdentifier' => ['title' => '插件唯一定位符', 'description' => 'The unique identifier for the installation, often associated with a user or tenant.', 'type' => 'string', 'example' => ''],
+ ],
+ 'description' => 'Specifies the configuration to install a plugin from the marketplace.',
+ 'example' => '',
+ ],
+ 'github' => [
+ 'title' => 'Github仓库配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'repository' => ['title' => '仓库名称', 'description' => 'The GitHub repository path in the `owner/repo` format.', 'type' => 'string', 'example' => ''],
+ 'version' => ['title' => '仓库release版本', 'description' => 'The Git tag, branch, or commit hash specifying the plugin version.', 'type' => 'string', 'example' => ''],
+ 'package' => ['title' => '插件安装包名', 'description' => 'The name of the plugin package. Required if the repository contains multiple packages.', 'type' => 'string', 'example' => ''],
+ ],
+ 'description' => 'Specifies the configuration to install a plugin from a GitHub repository.',
+ 'example' => '',
+ ],
+ 'downloadUrl' => ['title' => '自定义下载地址', 'description' => 'The direct download URL of the plugin package. The package must be a publicly accessible ZIP file.', 'type' => 'string', 'example' => ''],
+ 'oss' => [
+ 'title' => 'OSS对象存储配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'bucket' => ['title' => '存储桶名称', 'description' => 'The name of the OSS bucket where the plugin object is stored.', 'type' => 'string', 'example' => ''],
+ 'object' => ['title' => '对象名称', 'description' => 'The object key (its file path) in the OSS bucket.', 'type' => 'string', 'example' => ''],
+ 'endpoint' => ['title' => 'oss服务端点', 'description' => 'The service endpoint for the OSS region. For example, `oss-us-west-1.aliyuncs.com`.', 'type' => 'string', 'example' => ''],
+ ],
+ 'description' => 'Specifies the configuration to install a plugin from an Alibaba Cloud OSS bucket.',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'Defines the plugin source configuration. You must specify one of the following sources: `marketplace`, `github`, `downloadUrl`, or `oss`.',
+ 'example' => '',
],
],
+ 'description' => 'Defines the configuration for installing a Dify plugin.',
+ 'title' => '',
+ 'example' => '',
],
- 'Environment' => [
+ 'DifyToolSchema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '工具名称', 'description' => 'The name of the tool. This name must be unique within the tool set.', 'type' => 'string', 'example' => ''],
+ 'description' => ['title' => '工具描述', 'description' => 'A detailed explanation of the tool\'s purpose, capabilities, and ideal use cases. The model uses this description to determine when to call the tool.', 'type' => 'string', 'example' => ''],
+ 'inputSchema' => ['title' => '输入schema', 'description' => 'A JSON Schema object that defines the tool\'s input parameters.', 'type' => 'object', 'example' => ''],
+ 'outputSchema' => ['title' => '自定义输出schema', 'description' => 'A JSON Schema object that defines the structure of the tool\'s output. This allows the model to interpret the tool\'s response.', 'type' => 'object', 'example' => ''],
+ ],
+ 'description' => 'Defines the schema for a tool. This schema specifies the tool\'s name, purpose, and input/output structures.',
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'example' => '',
+ ],
+ 'EfmModel' => [
+ 'title' => '部署单元模型服务',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- 'backendName' => 'name',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Environment',
- 'backendName' => 'kind',
- ],
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'test env',
- 'backendName' => 'description',
- ],
- 'spec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'required' => true,
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/EnvironmentSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'type' => 'string'],
+ 'kind' => ['title' => '当前资源类型的名称，只读', 'type' => 'string'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'type' => 'string'],
+ 'updatedTime' => ['title' => '表示最后更新此对象时服务器的时间，只读', 'type' => 'string'],
+ 'name' => ['title' => '当前模型服务的的名称。它需要是唯一的，且无法变更', 'type' => 'string', 'required' => true],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'type' => 'integer', 'format' => 'int32'],
+ 'description' => ['title' => '描述信息'."\n", 'type' => 'string'],
+ 'generation' => ['title' => '当前模型服务的自增的序列号，由系统填充，只读。当spec更新时递增', 'type' => 'string'],
+ 'spec' => ['title' => '部署单元模型服务配置', 'required' => true, '$ref' => '#/components/schemas/EfmModelSpec'],
+ 'status' => ['title' => '当前模型服务的状态信息，只读', '$ref' => '#/components/schemas/EfmModelStatus'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '模型服务部署单元的标签',
'type' => 'object',
- 'additionalProperties' => [
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
- ],
- 'status' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/EnvironmentStatus',
- ],
- 'projectName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'demo-project',
- 'backendName' => 'projectName',
+ 'additionalProperties' => ['type' => 'string'],
],
- 'generation' => [
- 'title' => '',
- 'description' => '',
+ ],
+ ],
+ 'EfmModelSpec' => [
+ 'title' => '部署单元配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'capacity' => ['title' => '表示实际分配给模型的资源单元数量，必须是base_capacity的整数倍', 'type' => 'integer', 'format' => 'int32', 'required' => true],
+ 'suffix' => ['title' => '模型部署后，将生成新的模型名称，suffix用于指定新模型名称的后缀，最大长度为8个字符且需全局唯一', 'type' => 'string'],
+ 'modelName' => ['title' => '模型名称', 'type' => 'string', 'required' => true],
+ 'token' => ['title' => '访问数据链路时候的 apiKey', 'type' => 'string'],
+ 'disableURLInternet' => ['title' => '是否禁用公网', 'type' => 'boolean', 'default' => 'false'],
+ 'modelUnitType' => ['title' => '模型单元', 'type' => 'string', 'required' => true],
+ ],
+ ],
+ 'EfmModelStatus' => [
+ 'title' => '模型服务状态， 比如 RUNNING',
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => ['title' => '', 'type' => 'string'],
+ 'deployedName' => ['type' => 'string'],
+ 'readyCapacity' => ['type' => 'integer', 'format' => 'int32'],
+ 'workspaceId' => ['type' => 'string'],
+ 'urlInternet' => ['type' => 'string'],
+ 'token' => ['type' => 'string'],
+ 'baseCapacity' => ['type' => 'integer', 'format' => 'int32'],
+ 'urlIntranet' => ['type' => 'string'],
+ 'disableURLInternet' => ['type' => 'boolean'],
+ ],
+ ],
+ 'Environment' => [
+ 'title' => '环境定义',
+ 'description' => 'An environment can be associated with a specific branch for development, or with an infrastructure stack to deploy services.',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '环境名称，项目下唯一，不可修改', 'description' => 'The name of the environment. It must be unique within the project and cannot be changed.', 'type' => 'string', 'required' => true, 'example' => 'demo-env', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'kind' => ['title' => '当前资源的类型，只读', 'description' => 'The type of the resource. This property is read-only.', 'type' => 'string', 'example' => 'Environment', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The ID of the owning Alibaba Cloud account. This property is read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'createdTime' => ['title' => '创建此对象时服务器的时间，只读', 'description' => 'The server-side timestamp indicating when the resource was created. This property is read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'description' => ['title' => '资源描述', 'description' => 'The description of the environment.', 'type' => 'string', 'example' => 'test env', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'spec' => ['title' => '环境配置', 'description' => 'The environment configuration.', 'required' => true, '$ref' => '#/components/schemas/EnvironmentSpec', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
+ 'labels' => [
+ 'title' => '资源的标签',
+ 'description' => 'The key-value labels for the environment.',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'example' => 'value to the label key.', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
+ 'backendName' => 'labels',
],
+ 'status' => ['title' => '当前环境的状态', 'description' => 'The current status of the environment.', '$ref' => '#/components/schemas/EnvironmentStatus', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'],
+ 'projectName' => ['title' => '环境所属的项目名称，只读', 'description' => 'The name of the project that contains the environment. This property is read-only.', 'type' => 'string', 'example' => 'demo-project', 'visibility' => 'Public', 'backendName' => 'projectName'],
+ 'generation' => ['title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致', 'description' => 'A system-generated, auto-incrementing number representing the configuration generation. This property is read-only and increments each time the `spec` is updated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'generation'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'EnvironmentSpec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '环境配置描述',
+ 'description' => 'The configuration settings for the environment.',
'type' => 'object',
'properties' => [
'type' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '环境类型，只能在testing、staging、production中选择',
+ 'description' => 'The environment type. Valid values are testing, staging, and production.',
'type' => 'string',
'example' => 'Testing',
- 'backendName' => 'type',
'default' => 'Production',
- 'enum' => [
- 'Testing',
- 'Staging',
- 'Production',
- ],
- ],
- 'alias' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'dev',
- 'backendName' => 'alias',
- ],
- 'roleArn' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'acs:ram::*******:role/aliyundevsdefaultrole',
- 'backendName' => 'roleArn',
- ],
- 'repositoryConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'repositoryConfig',
- '$ref' => '#/components/schemas/RepositoryConfig',
- ],
- 'templateConfig' => [
- 'title' => '',
- 'description' => '',
+ 'enum' => ['Testing', 'Staging', 'Production'],
'visibility' => 'Public',
- 'backendName' => 'templateConfig',
- '$ref' => '#/components/schemas/TemplateConfig',
- ],
- 'infraStackConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'infraStackConfig',
- '$ref' => '#/components/schemas/InfraStackSpec',
- ],
- 'serviceOverlay' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'object',
- 'properties' => [
- 'resources' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'object',
- 'example' => '{"dummyFunction":{"timeout":600}}',
- 'backendName' => 'resources',
- ],
- 'components' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'object',
- 'example' => '{"fc3":{"timeout":600}}',
- 'backendName' => 'components',
- ],
- ],
- 'backendName' => 'serviceOverlay',
- ],
- 'isAutoDeploy' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'boolean',
- 'backendName' => 'isAutoDeploy',
- 'default' => 'false',
+ 'backendName' => 'type',
],
+ 'roleArn' => ['title' => '环境角色', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the environment role.', 'type' => 'string', 'example' => 'acs:ram::*******:role/aliyundevsdefaultrole', 'visibility' => 'Public', 'backendName' => 'roleArn'],
+ 'stagedConfigs' => ['title' => '环境下保存的配置，可以通过部署达到该配置状态', 'description' => 'The staged configs for the environment, which can be applied by a deployment.', 'example' => '', '$ref' => '#/components/schemas/EnvironmentStagedConfigs', 'visibility' => 'Public', 'backendName' => 'stagedConfigs'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'EnvironmentStatus' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '环境状态',
+ 'description' => 'The current status of the environment.',
'type' => 'object',
'properties' => [
- 'infraStackStatus' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'infraStackStatus',
- '$ref' => '#/components/schemas/InfraStackStatus',
- ],
- 'latestReleaseDetail' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'latestReleaseDetail',
- '$ref' => '#/components/schemas/ReleaseDetail',
- ],
- 'observedGeneration' => [
- 'title' => '',
- 'description' => '',
+ 'servicesInstances' => [
+ 'title' => '项目下的服务使用当前环境中的配置进行部署后产生的服务实例',
+ 'description' => 'Service instances created by deploying project services using the current environment\'s configuration.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ServiceInstance', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'backendName' => 'observedGeneration',
+ 'backendName' => 'servicesInstances',
],
- 'observedTime' => [
- 'title' => '',
- 'description' => '',
+ 'latestEnvironmentDeploymentName' => ['title' => '最近一次部署计划的名称。每次环境部署都会产生一个部署计划，涉及若干个服务的部署', 'description' => 'The name of the deployment plan for the most recent deployment. Each environment deployment generates a deployment plan that may include one or more services.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestEnvironmentDeploymentName'],
+ 'servicesWithPendingChanges' => [
+ 'title' => '存在未部署的变更的服务名称列表',
+ 'description' => 'A list of service names that have pending changes.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '服务名称', 'visibility' => 'Public', 'extendType' => 'true'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'observedTime',
+ 'backendName' => 'servicesWithPendingChanges',
],
+ 'observedGeneration' => ['title' => '资源最近的一次状态更新时的资源generation', 'description' => 'The most recent generation of the resource observed by the system.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'observedGeneration'],
+ 'observedTime' => ['title' => '资源最近的一次状态更新时间', 'description' => 'The timestamp when the status was last observed.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'observedTime'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'EventFilterConfig' => [
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The event filtering configuration.',
'type' => 'object',
'properties' => [
- 'push' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'push',
- '$ref' => '#/components/schemas/PushFilter',
- ],
- 'pullRequest' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'pullRequest',
- '$ref' => '#/components/schemas/PullRequestFilter',
- ],
+ 'branch' => ['title' => '', 'description' => 'The branch where the change event occurs.', 'example' => '', '$ref' => '#/components/schemas/BranchFilter', 'visibility' => 'Public', 'backendName' => 'branch'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'EventPayload' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '流水线触发事件消息体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'github' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'github',
- '$ref' => '#/components/schemas/GithubEventPayload',
- ],
- 'gitlab' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'gitlab',
- '$ref' => '#/components/schemas/GitlabEventPayload',
- ],
- 'codeup' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'codeup',
- '$ref' => '#/components/schemas/CodeupEventPayload',
- ],
- 'gitee' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'gitee',
- '$ref' => '#/components/schemas/GiteeEventPayload',
- ],
- 'manual' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'manual',
- '$ref' => '#/components/schemas/ManualEventPayload',
+ 'github' => ['description' => 'Github流水线触发事件消息体', 'visibility' => 'Public', 'backendName' => 'github', '$ref' => '#/components/schemas/GithubEventPayload'],
+ 'gitlab' => ['description' => 'Gitlab流水线触发事件消息体', 'visibility' => 'Public', 'backendName' => 'gitlab', '$ref' => '#/components/schemas/GitlabEventPayload'],
+ 'codeup' => ['description' => 'Codeup流水线触发事件消息体', 'visibility' => 'Public', 'backendName' => 'codeup', '$ref' => '#/components/schemas/CodeupEventPayload'],
+ 'gitee' => ['description' => 'Gitee流水线触发事件消息体', 'visibility' => 'Public', 'backendName' => 'gitee', '$ref' => '#/components/schemas/GiteeEventPayload'],
+ 'manual' => ['description' => '手动触发流水线事件消息体', 'visibility' => 'Public', 'backendName' => 'manual', '$ref' => '#/components/schemas/ManualEventPayload'],
+ ],
+ ],
+ 'FileManagerTask' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['type' => 'string'],
+ 'id' => ['type' => 'string'],
+ 'startTime' => ['type' => 'integer', 'format' => 'int64'],
+ 'updateTime' => ['type' => 'integer', 'format' => 'int64'],
+ 'finishedTime' => ['type' => 'integer', 'format' => 'int64'],
+ 'finished' => ['type' => 'boolean'],
+ 'success' => ['type' => 'boolean'],
+ 'errorMessage' => ['type' => 'string'],
+ 'parameters' => ['type' => 'any'],
+ 'progress' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'currentBytes' => ['type' => 'integer', 'format' => 'int64'],
+ 'totalBytes' => ['type' => 'integer', 'format' => 'int64'],
+ ],
],
+ 'result' => ['type' => 'any'],
+ 'errorCode' => ['type' => 'string'],
],
],
'GitAccount' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Represents an OAuth credential.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'your_username',
- 'backendName' => 'name',
- ],
- 'displayName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'your_displayname',
- 'backendName' => 'displayName',
- ],
- 'id' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '1',
- 'backendName' => 'id',
- ],
- 'avatar' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://gitee.com/assets/no_portrait.png',
- 'backendName' => 'avatar',
- ],
- 'uri' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://gitlab.com',
- 'backendName' => 'uri',
- ],
+ 'name' => ['title' => '代码托管平台的登录账号名，在每种代码托管平台下唯一', 'description' => 'The username on the code hosting platform. This value is unique per platform.', 'type' => 'string', 'required' => false, 'example' => 'your_username', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'displayName' => ['title' => '代码托管平台中的昵称，可以为空且不唯一', 'description' => 'The display name on the code hosting platform. It can be empty and does not need to be unique.', 'type' => 'string', 'example' => 'your_displayname', 'visibility' => 'Public', 'backendName' => 'displayName'],
+ 'id' => ['title' => '代码托管平台账号的ID，在每种代码托管平台下唯一', 'description' => 'The ID of the account on the code hosting platform. This ID is unique per platform.', 'type' => 'string', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'id'],
+ 'avatar' => ['title' => '代码托管平台账号的头像链接', 'description' => 'The user\'s avatar URL on the code hosting platform.', 'type' => 'string', 'required' => false, 'example' => 'https://gitee.com/assets/no_portrait.png', 'visibility' => 'Public', 'backendName' => 'avatar'],
+ 'uri' => ['title' => '代码托管平台的地址，仅在自建GitLab时使用', 'description' => 'The URL of the code hosting platform. Used only for self-hosted GitLab instances.', 'type' => 'string', 'required' => false, 'example' => 'https://gitlab.com', 'visibility' => 'Public', 'backendName' => 'uri'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'GiteeEventPayload' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => 'Gitee流水线触发事件消息体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'originalPayload' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'format' => 'byte',
- 'example' => '',
- 'backendName' => 'originalPayload',
- ],
+ 'originalPayload' => ['title' => 'gitee原始消息体', 'description' => 'gitee原始消息体', 'visibility' => 'Public', 'type' => 'string', 'format' => 'byte', 'example' => '{}{'."\n"
+ .' "after": "75008ebafa504ffc6d3fe2236b780b1a04663fbb",'."\n"
+ .' "before": "f4abefc293a6df4d3be23945c4474f9d54f67645",'."\n"
+ .' "commits": ['."\n"
+ .' {'."\n"
+ .' "id": "75008ebafa504ffc6d3fe2236b780b1a04663fbb",'."\n"
+ .' "message": "update\\\\n"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "ref": "refs/heads/master"'."\n"
+ .'}'."\n"
+ .'-- 必须使用原始的gitee发出的webhook事件', 'backendName' => 'originalPayload'],
],
],
'GitEventSnapshot' => [
- 'title' => '',
- 'description' => '',
+ 'title' => 'Git提交事件快照',
+ 'description' => 'Git事件快照',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'branch' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'main',
- 'backendName' => 'branch',
- ],
- 'commitID' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '12721ec262d03a93809ba2bbc717963cb298ceca',
- 'backendName' => 'commitID',
- ],
- 'tag' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '1.0',
- 'backendName' => 'tag',
- ],
+ 'branch' => ['title' => '本次发布关联的分支，如果是PR或MR事件，为源分支', 'description' => '本次发布关联的分支，如果是PR或MR事件，为源分支', 'visibility' => 'Public', 'type' => 'string', 'example' => 'main', 'backendName' => 'branch'],
+ 'commitID' => ['title' => '本次发布关联的commitID', 'description' => '本次发布关联的commitID', 'visibility' => 'Public', 'type' => 'string', 'example' => '12721ec262d03a93809ba2bbc717963cb298ceca', 'backendName' => 'commitID'],
+ 'tag' => ['title' => '本次发布关联的tag', 'description' => '本次发布关联的tag', 'visibility' => 'Public', 'type' => 'string', 'example' => '1.0', 'backendName' => 'tag'],
],
],
'GithubEventPayload' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => 'Github流水线触发事件消息体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'originalPayload' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'format' => 'byte',
- 'example' => '',
- 'backendName' => 'originalPayload',
- ],
+ 'originalPayload' => ['title' => 'github事件原始消息体', 'description' => 'github事件原始消息体', 'visibility' => 'Public', 'type' => 'string', 'format' => 'byte', 'example' => '{'."\n"
+ .' "ref": "refs/heads/master",'."\n"
+ .' "before": "1d4344d7eeda61c26c8a6d945d83b205b422f3e3",'."\n"
+ .' "after": "9f3221a7e63f979281e3926bf619b193646ff561",'."\n"
+ .' "commits": ['."\n"
+ .' {'."\n"
+ .' "id": "9f3221a7e63f979281e3926bf619b193646ff561",'."\n"
+ .' "message": "update"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "head_commit": {'."\n"
+ .' "id": "9f3221a7e63f979281e3926bf619b193646ff561",'."\n"
+ .' "message": "update"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'-- 必须使用原始的github发出的webhook事件', 'backendName' => 'originalPayload'],
],
],
'GitLabConfig' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '描述连接GitLab代码托管平台所需的信息',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'uri' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/',
- 'backendName' => 'uri',
- ],
- 'token' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'your-token',
- 'backendName' => 'token',
- ],
+ 'isFixedIP' => ['title' => '是否固定公网IP访问Gitlab', 'description' => '是否固定公网IP访问Gitlab', 'visibility' => 'Public', 'type' => 'boolean', 'backendName' => 'isFixedIP'],
+ 'uri' => ['title' => 'GitLab的域名，默认为https://gitlab.com；当您使用自建GitLab时需要指定', 'description' => 'GitLab的域名，默认为https://gitlab.com；当您使用自建GitLab时需要指定', 'visibility' => 'Public', 'type' => 'string', 'example' => 'http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/', 'backendName' => 'uri'],
+ 'token' => ['title' => 'GitLab私有Token，参考以下文档在GitLab控制台获取：https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html?spm=5176.fcnext.0.0.1aa378c8E3yBHw#create-a-personal-access-token', 'description' => 'GitLab私有Token，参考以下文档在GitLab控制台获取：https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html?spm=5176.fcnext.0.0.1aa378c8E3yBHw#create-a-personal-access-token', 'visibility' => 'Public', 'type' => 'string', 'example' => 'your-token', 'backendName' => 'token'],
],
],
'GitlabEventPayload' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => 'Gitlab流水线触发事件消息体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'originalPayload' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'format' => 'byte',
- 'example' => '',
- 'backendName' => 'originalPayload',
- ],
+ 'originalPayload' => ['title' => 'gitlab事件原始消息体', 'description' => 'gitlab事件原始消息体', 'visibility' => 'Public', 'type' => 'string', 'format' => 'byte', 'example' => '{'."\n"
+ .' "object_kind": "push",'."\n"
+ .' "event_name": "push",'."\n"
+ .' "before": "a08b7d82ceaabc27394f526f35c22ff581a18a39",'."\n"
+ .' "after": "787ef6aa092e4b9ed30fe29c7fc5c9cf4ac194d8",'."\n"
+ .' "ref": "refs/heads/main",'."\n"
+ .' "checkout_sha": "787ef6aa092e4b9ed30fe29c7fc5c9cf4ac194d8",'."\n"
+ .' "commits": ['."\n"
+ .' {'."\n"
+ .' "id": "787ef6aa092e4b9ed30fe29c7fc5c9cf4ac194d8",'."\n"
+ .' "message": "my message",'."\n"
+ .' "title": "my message"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'-- 必须使用原始的gitlab发出的webhook事件', 'backendName' => 'originalPayload'],
],
],
'Installation' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '账号绑定流程',
+ 'description' => '指导用户完成OAuth授权流程',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'stage' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'finished',
- 'backendName' => 'stage',
- ],
- 'message' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Please click \'actionUri\' to complete the OAuth authorization process',
- 'backendName' => 'message',
- ],
- 'actionUri' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo',
- 'backendName' => 'actionUri',
- ],
+ 'stage' => ['title' => '账号绑定流程的当前阶段，包括：pending、finished、invalid', 'description' => '账号绑定流程的当前阶段，包括：pending、finished、invalid', 'visibility' => 'Public', 'type' => 'string', 'example' => 'finished', 'backendName' => 'stage'],
+ 'message' => ['title' => '账号绑定流程的指导信息，提示您如何完成账号绑定', 'description' => '账号绑定流程的指导信息，提示您如何完成账号绑定', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Please click \'actionUri\' to complete the OAuth authorization process', 'backendName' => 'message'],
+ 'actionUri' => ['title' => '完成账号绑定流程的当前步骤所需的链接', 'description' => '完成账号绑定流程的当前步骤所需的链接', 'visibility' => 'Public', 'type' => 'string', 'example' => 'https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo', 'backendName' => 'actionUri'],
],
],
'ManualEventPayload' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '手动触发流水线事件消息体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'commitID' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '090e797efdabd2347b93b1cf331a9a3009df05c8',
- 'backendName' => 'commitID',
- ],
- 'branch' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'master',
- 'backendName' => 'branch',
- ],
- 'tag' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'prod-v1',
- 'backendName' => 'tag',
- ],
- 'templateConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'templateConfig',
- '$ref' => '#/components/schemas/TemplateConfig',
- ],
+ 'commitID' => ['title' => '本次触发的commitID', 'description' => '本次触发的commitID', 'visibility' => 'Public', 'type' => 'string', 'example' => '090e797efdabd2347b93b1cf331a9a3009df05c8', 'backendName' => 'commitID'],
+ 'branch' => ['title' => '本次触发的分支名称', 'description' => '本次触发的分支名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'master', 'backendName' => 'branch'],
+ 'tag' => ['title' => '本次触发的tag名称', 'description' => '本次触发的tag名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'prod-v1', 'backendName' => 'tag'],
+ 'templateConfig' => ['title' => '本次触发的模板信息，比Git触发优先级更高', 'description' => '本次触发的模板信息，比Git触发优先级更高', 'visibility' => 'Public', 'backendName' => 'templateConfig', '$ref' => '#/components/schemas/TemplateConfig'],
],
],
- 'OAuthCredential' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'MCPGatewayConfig' => [
+ 'title' => 'MCP Gateway配置详情',
'type' => 'object',
'properties' => [
- 'token' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => '4e84246b6b3962cd3d207aad1ea2f911',
- 'backendName' => 'token',
- ],
- 'type' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'bearer',
- 'backendName' => 'type',
- ],
- 'scope' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'user_info projects pull_requests hook gists emails',
- 'backendName' => 'scope',
- ],
- 'expiration' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1716263324603',
- 'backendName' => 'expiration',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1716176924603',
- 'backendName' => 'createdTime',
- ],
- 'refreshToken' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '4d77bfae284770d94ebeed6b0199ebfd65e3943ba4f1e44dc36d792a93ba0d13',
- 'backendName' => 'refreshToken',
+ 'routes' => [
+ 'title' => '路由配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'backends' => [
+ 'title' => '后端配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => [
+ 'title' => '后端名称',
+ 'type' => 'string',
+ 'enum' => ['MCP', 'OpenAPI', 'Toolset'],
+ ],
+ 'type' => [
+ 'title' => '后端类型',
+ 'type' => 'string',
+ 'enum' => ['OpenAPI', 'MCP', 'Toolset'],
+ ],
+ 'details' => [
+ 'title' => '后端配置详情',
+ 'type' => 'object',
+ 'properties' => [
+ 'mcpInstallation' => ['title' => 'MCP服务器安装配置', '$ref' => '#/components/schemas/MCPServerInstallationConfig'],
+ 'toolsetSelector' => [
+ 'title' => '工具集选择器',
+ 'type' => 'object',
+ 'properties' => [
+ 'toolsetName' => ['title' => '工具集名称', 'type' => 'string'],
+ 'toolName' => ['title' => '工具名称', 'type' => 'string'],
+ ],
+ ],
+ 'openAPISchema' => ['title' => 'OpenAPI schema配置', 'type' => 'string'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'policies' => [
+ 'title' => '策略配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'authorization' => ['title' => '第三方鉴权配置', '$ref' => '#/components/schemas/Authorization'],
+ ],
+ ],
+ ],
+ ],
],
],
],
+ 'OAuthCredential' => [
+ 'title' => '身份绑定凭证',
+ 'description' => 'The OAuth credential.',
+ 'type' => 'object',
+ 'properties' => [
+ 'token' => ['title' => '代码托管平台访问凭证，开发平台使用该凭证访问第三方代码托管平台', 'description' => 'An access credential for a third-party code hosting platform.', 'type' => 'string', 'required' => true, 'example' => '4e84246b6b3962cd3d207aad1ea2f911', 'visibility' => 'Public', 'backendName' => 'token'],
+ 'type' => ['title' => '凭证的类型', 'description' => 'The type of the credential.', 'type' => 'string', 'example' => 'bearer', 'visibility' => 'Public', 'backendName' => 'type'],
+ 'scope' => ['title' => '凭证包含的权限范围', 'description' => 'The permissions granted by the credential.', 'type' => 'string', 'example' => 'user_info projects pull_requests hook gists emails', 'visibility' => 'Public', 'backendName' => 'scope'],
+ 'expiration' => ['title' => '凭证到期时间，时间戳形式，-1表示永久有效', 'description' => 'The credential\'s expiration time, specified as a Unix timestamp. A value of -1 means the credential never expires.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1716263324603', 'visibility' => 'Public', 'backendName' => 'expiration'],
+ 'createdTime' => ['title' => '凭证生成时间，时间戳形式', 'description' => 'The credential\'s creation time, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1716176924603', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'refreshToken' => ['title' => '刷新凭证时所需的信息', 'description' => 'Used to obtain a new access credential.', 'type' => 'string', 'example' => '4d77bfae284770d94ebeed6b0199ebfd65e3943ba4f1e44dc36d792a93ba0d13', 'visibility' => 'Public', 'backendName' => 'refreshToken'],
+ ],
+ 'example' => '',
+ 'visibility' => 'Public',
+ ],
'Pipeline' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'A Pipeline resource.',
'type' => 'object',
'properties' => [
- 'spec' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/PipelineSpec',
- ],
- 'status' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/PipelineStatus',
- ],
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Pipeline example.',
- 'backendName' => 'description',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Pipeline',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-pipeline',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'deletionTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'deletionTime',
- ],
+ 'spec' => ['description' => 'Specifies the desired state of the Pipeline.', '$ref' => '#/components/schemas/PipelineSpec', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
+ 'status' => ['description' => 'The observed, read-only state of the Pipeline, populated by the system.', '$ref' => '#/components/schemas/PipelineStatus', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The read-only ID of the Alibaba Cloud account that owns the resource.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'generation' => ['title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'description' => 'A read-only sequence number representing a specific generation of the desired state. The system increments this value each time the `spec` field is updated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'generation'],
+ 'description' => ['title' => '流水线描述信息', 'description' => 'A human-readable description of the Pipeline.', 'type' => 'string', 'example' => 'Pipeline example.', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The read-only type of the resource.', 'type' => 'string', 'example' => 'Pipeline', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'A read-only, server-generated timestamp indicating when the resource was created.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The unique, immutable name of the resource.', 'type' => 'string', 'required' => true, 'example' => 'my-pipeline', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'Key-value pairs used to organize and select resources.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['description' => 'The value of a label key.', 'type' => 'string', 'example' => 'value to the label key.', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
+ 'backendName' => 'labels',
],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => 'A read-only, monotonically increasing sequence number for the current state. The system increments this value each time the resource is updated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'resourceVersion'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'PipelineSpec' => [
- 'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '',
+ 'description' => 'The pipeline configuration.',
'type' => 'object',
'properties' => [
- 'templateName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-pipeline-template',
- 'backendName' => 'templateName',
- ],
- 'context' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'context',
- '$ref' => '#/components/schemas/Context',
- ],
- 'templateSpec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'templateSpec',
- '$ref' => '#/components/schemas/PipelineTemplateSpec',
- ],
+ 'templateName' => ['title' => '', 'description' => 'The name of the pipeline template.', 'type' => 'string', 'example' => 'my-pipeline-template', 'visibility' => 'Public', 'backendName' => 'templateName'],
+ 'context' => ['title' => '', 'description' => 'The execution context of the pipeline.', '$ref' => '#/components/schemas/Context', 'example' => '', 'visibility' => 'Public', 'backendName' => 'context'],
+ 'templateSpec' => ['title' => '', 'description' => 'The description of the pipeline execution flow. This parameter takes priority over templateName. When this parameter is specified, you do not need to create a PipelineTemplate in advance for pipeline execution.', '$ref' => '#/components/schemas/PipelineTemplateSpec', 'example' => '', 'visibility' => 'Public', 'backendName' => 'templateSpec'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'PipelineStatus' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Indicates the execution status of a pipeline.',
'type' => 'object',
'properties' => [
- 'phase' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Success',
- 'backendName' => 'phase',
- ],
- 'latestExecError' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'latestExecError',
- '$ref' => '#/components/schemas/TaskExecError',
- ],
+ 'phase' => ['title' => '当前流水线执行的阶段', 'description' => 'The pipeline\'s current phase.', 'type' => 'string', 'example' => 'Success', 'visibility' => 'Public', 'backendName' => 'phase'],
+ 'latestExecError' => ['title' => '流水线出现的最近一次任务异常', 'description' => 'Details about the latest task execution error.', '$ref' => '#/components/schemas/TaskExecError', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestExecError'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'PipelineTemplate' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'A Pipeline Template.',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'PipelineTemplate example.',
- 'backendName' => 'description',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'PipelineTemplate',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-pipeline-template',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'deletionTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'deletionTime',
- ],
- 'spec' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/PipelineTemplateSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The ID of the Alibaba Cloud Account. Read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'generation' => ['title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'description' => 'A system-populated Sequence Number that is incremented each time the `spec` is updated. Read-only.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'generation'],
+ 'description' => ['title' => '流水线模板描述信息', 'description' => 'The description of the Pipeline Template.', 'type' => 'string', 'example' => 'PipelineTemplate example.', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The Resource type. This value is always `PipelineTemplate`. Read-only.', 'type' => 'string', 'example' => 'PipelineTemplate', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'The server time when this Resource was created. Read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The unique and immutable name of the Resource.', 'type' => 'string', 'required' => true, 'example' => 'my-pipeline-template', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'deletionTime' => ['title' => '资源删除时间，只读', 'description' => 'The deletion timestamp for the Resource. Read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'deletionTime'],
+ 'spec' => ['description' => 'The Specification of the Pipeline Template.', '$ref' => '#/components/schemas/PipelineTemplateSpec', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'Key-value pairs attached to the Resource.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['description' => 'The value of the Label.', 'type' => 'string', 'example' => 'value to the label key.', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
+ 'backendName' => 'labels',
],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => 'A system-populated Sequence Number that tracks the current state of the Resource and is incremented with each update. Read-only.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'resourceVersion'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'PipelineTemplateSpec' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The pipeline template configuration.',
'type' => 'object',
'properties' => [
- 'context' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'context',
- '$ref' => '#/components/schemas/Context',
- ],
+ 'context' => ['title' => '流水线的执行上下文', 'description' => 'The pipeline\'s execution context.', '$ref' => '#/components/schemas/Context', 'example' => '', 'visibility' => 'Public', 'backendName' => 'context'],
'tasks' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '任务执行列表',
+ 'description' => 'The tasks to execute.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/TaskExec',
- ],
+ 'items' => ['description' => 'A task execution configuration.', '$ref' => '#/components/schemas/TaskExec', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'],
+ 'example' => '',
+ 'visibility' => 'Public',
'backendName' => 'tasks',
],
- 'contextSchema' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Private',
- 'type' => 'object',
- 'backendName' => 'contextSchema',
- ],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'PipelineTrigger' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '流水线触发器',
+ 'description' => '描述git事件触发流水线的规则',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'PipelineTrigger example.',
- 'backendName' => 'description',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'PipelineTrigger',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-pipeline-trigger',
- 'maxLength' => 63,
- 'minLength' => 1,
- 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$',
- 'backendName' => 'name',
- ],
- 'projectName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-project',
- 'maxLength' => 63,
- 'minLength' => 1,
- 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$',
- 'backendName' => 'projectName',
- ],
- 'deletionTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'deletionTime',
- ],
- 'spec' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/PipelineTriggerSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'backendName' => 'uid'],
+ 'generation' => ['title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'generation'],
+ 'description' => ['title' => '流水线触发器描述信息', 'description' => '流水线触发器描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'PipelineTrigger example.', 'backendName' => 'description'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => '当前资源的名称，只读', 'visibility' => 'Public', 'type' => 'string', 'example' => 'PipelineTrigger', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => '表示创建此对象时服务器的时间，只读', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。在项目中，它需要是唯一的，且无法变更', 'description' => '当前资源的名称。在项目中，它需要是唯一的，且无法变更', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-pipeline-trigger', 'maxLength' => 63, 'minLength' => 1, 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$', 'backendName' => 'name'],
+ 'spec' => ['description' => '流水线触发器配置', 'visibility' => 'Public', 'backendName' => 'spec', '$ref' => '#/components/schemas/PipelineTriggerSpec'],
'labels' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '资源的标签',
+ 'description' => '资源的标签',
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
+ 'additionalProperties' => ['description' => '标签', 'visibility' => 'Public', 'type' => 'string', 'example' => 'value to the label key.'],
'backendName' => 'labels',
],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
- ],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'resourceVersion'],
],
],
'PipelineTriggerEvent' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '流水线触发器触发事件',
+ 'description' => '记录触发器触发事件',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'PipelineTriggerEvent example.',
- 'backendName' => 'description',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'PipelineTriggerEvent',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-pipeline-trigger',
- 'maxLength' => 63,
- 'minLength' => 1,
- 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$',
- 'backendName' => 'name',
- ],
- 'deletionTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'deletionTime',
- ],
- 'status' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/PipelineTriggerEventStatus',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'backendName' => 'uid'],
+ 'generation' => ['title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'generation'],
+ 'description' => ['title' => '流水线触发器触发事件的描述信息', 'description' => '流水线触发器触发事件的描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'PipelineTriggerEvent example.', 'backendName' => 'description'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => '当前资源的名称，只读', 'visibility' => 'Public', 'type' => 'string', 'example' => 'PipelineTriggerEvent', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => '表示创建此对象时服务器的时间，只读', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。在项目中，它需要是唯一的，且无法变更', 'description' => '当前资源的名称。在项目中，它需要是唯一的，且无法变更', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-pipeline-trigger', 'maxLength' => 63, 'minLength' => 1, 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$', 'backendName' => 'name'],
+ 'status' => ['title' => '触发器触发记录的状态', 'description' => '触发器触发记录的状态', 'visibility' => 'Public', 'backendName' => 'status', '$ref' => '#/components/schemas/PipelineTriggerEventStatus'],
'labels' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '资源的标签',
+ 'description' => '资源的标签',
'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
+ 'additionalProperties' => ['description' => '标签', 'visibility' => 'Public', 'type' => 'string', 'example' => 'value to the label key.'],
'backendName' => 'labels',
],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
- ],
- 'spec' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/PipelineTriggerEventSpec',
- ],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'resourceVersion'],
+ 'spec' => ['description' => '流水线触发配置', 'visibility' => 'Public', 'backendName' => 'spec', '$ref' => '#/components/schemas/PipelineTriggerEventSpec'],
],
],
'PipelineTriggerEventSpec' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '流水线触发事件详情',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'payload' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'payload',
- '$ref' => '#/components/schemas/EventPayload',
- ],
- 'triggerName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-pipeline-trigger',
- 'backendName' => 'triggerName',
- ],
+ 'payload' => ['description' => '流水线触发事件消息体', 'visibility' => 'Public', 'backendName' => 'payload', '$ref' => '#/components/schemas/EventPayload'],
+ 'triggerName' => ['title' => '触发器名称', 'description' => '触发器名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my-pipeline-trigger', 'backendName' => 'triggerName'],
],
],
'PipelineTriggerEventStatus' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '流水线触发器触发历史记录状态',
+ 'description' => '流水线触发器触发历史记录状态',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'status' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Skipped,Fired,Running,Failed,Success',
- 'backendName' => 'status',
- ],
- 'firedPipelineName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-pipeline',
- 'backendName' => 'firedPipelineName',
- ],
- 'releaseDetail' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'releaseDetail',
- '$ref' => '#/components/schemas/ReleaseDetail',
- ],
- 'errorMessage' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'failed to create and start pipeline, error=message',
- 'backendName' => 'errorMessage',
- ],
+ 'status' => ['title' => '触发器触发记录的状态', 'description' => '触发器触发记录的状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Skipped,Fired,Running,Failed,Success', 'backendName' => 'status'],
+ 'firedPipelineName' => ['title' => '触发器触发记录的流水线名称', 'description' => '触发器触发记录的流水线名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my-pipeline', 'backendName' => 'firedPipelineName'],
+ 'releaseDetail' => ['title' => '发布详情', 'description' => '发布详情', 'visibility' => 'Public', 'backendName' => 'releaseDetail', '$ref' => '#/components/schemas/ReleaseDetail'],
+ 'errorMessage' => ['title' => '触发器触发的异常信息', 'description' => '触发器触发的异常信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'failed to create and start pipeline, error=message', 'backendName' => 'errorMessage'],
],
],
'PipelineTriggerSpec' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '流水线触发器配置',
+ 'description' => '描述触发器的触发规则与运行的流水线',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'roleArn' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acs:ram::1431999****8149:role/aliyundevsdefaultrole',
- 'backendName' => 'roleArn',
- ],
- 'eventFilter' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'required' => true,
- 'backendName' => 'eventFilter',
- '$ref' => '#/components/schemas/EventFilterConfig',
- ],
- 'runPipeline' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'runPipeline',
- '$ref' => '#/components/schemas/RunPipelineConfig',
- ],
+ 'eventFilter' => ['title' => '事件过滤配置，只有满足条件的事件才可以触发流水线', 'description' => '事件过滤配置，只有满足条件的事件才可以触发流水线', 'visibility' => 'Public', 'required' => true, 'backendName' => 'eventFilter', '$ref' => '#/components/schemas/EventFilterConfig'],
+ 'runPipeline' => ['title' => '触发流水线执行配置', 'description' => '触发流水线执行配置', 'visibility' => 'Public', 'backendName' => 'runPipeline', '$ref' => '#/components/schemas/RunPipelineConfig'],
],
],
'Project' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '项目',
+ 'description' => 'A container for organizing your resources.',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Project',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-project',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'spec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'required' => false,
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/ProjectSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The ID of the Alibaba Cloud master account. Read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The type of the resource. Read-only.', 'type' => 'string', 'example' => 'Project', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'The timestamp generated by the server when the resource was created. Read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The name of the resource. The name must be unique and cannot be changed after creation.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'Key-value pairs for organizing and categorizing resources.',
'type' => 'object',
- 'additionalProperties' => [
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
- ],
- 'updatedTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'updatedTime',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'test-description',
- 'backendName' => 'description',
- ],
- 'status' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/ProjectStatus',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'key=value', 'description' => '', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
+ 'backendName' => 'labels',
],
+ 'description' => ['title' => '描述信息', 'description' => 'A user-provided description of the resource.', 'type' => 'string', 'example' => 'test-description', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'status' => ['title' => '', 'description' => '', '$ref' => '#/components/schemas/ProjectStatus', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'ProjectSpec' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '项目配置',
+ 'description' => 'Configuration for one-click deployments.',
+ 'type' => 'object',
+ 'properties' => [],
+ 'example' => '',
'visibility' => 'Public',
+ ],
+ 'ProjectStatus' => [
+ 'title' => '项目状态',
+ 'description' => 'One-click deployment configuration.',
'type' => 'object',
'properties' => [
- 'templateConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'templateConfig',
- '$ref' => '#/components/schemas/TemplateConfig',
- ],
- 'roleArn' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'acs:ram::1431999****8149:role/aliyundevsdefaultrole',
- 'backendName' => 'roleArn',
- ],
- 'token' => [
- 'title' => '',
- 'description' => '',
+ 'services' => [
+ 'title' => '项目下的服务列表',
+ 'description' => 'A list of services in the project.',
+ 'type' => 'array',
+ 'items' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/ServiceMeta', 'visibility' => 'Public', 'extendType' => 'true'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '9D72DE01-C732-49C0-8E85-FFD9D695436B',
- 'backendName' => 'token',
+ 'backendName' => 'services',
],
],
- ],
- 'ProjectStatus' => [
- 'title' => '',
- 'description' => '',
+ 'example' => '',
'visibility' => 'Public',
+ ],
+ 'PublishTaskSpec' => [
'type' => 'object',
'properties' => [
- 'latestReleaseDetail' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'latestReleaseDetail',
- '$ref' => '#/components/schemas/ReleaseDetail',
+ 'type' => ['type' => 'string'],
+ 'options' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'autoSave' => ['type' => 'boolean'],
+ ],
],
- 'observedGeneration' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'backendName' => 'observedGeneration',
+ 'rawResourceConfig' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any'],
],
- 'observedTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'observedTime',
+ ],
+ ],
+ 'PublishTaskStatus' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'phase' => ['type' => 'string'],
+ 'phases' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'attempts' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'startTime' => ['type' => 'string'],
+ 'finishTime' => ['type' => 'string'],
+ 'details' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'any'],
+ ],
+ 'error' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'message' => ['type' => 'string'],
+ 'code' => ['type' => 'string'],
+ ],
+ ],
+ ],
+ ],
],
],
],
'PullRequestFilter' => [
- 'title' => '',
- 'description' => '',
+ 'title' => 'PR或MR事件过滤配置',
+ 'description' => 'PR或MR事件过滤配置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'sourceBranch' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'feature-.*',
- 'backendName' => 'sourceBranch',
- ],
- 'targetBranch' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'master',
- 'backendName' => 'targetBranch',
- ],
+ 'sourceBranch' => ['title' => 'PR或MR的来源分支名称正则表达式，不填则表示所有分支', 'description' => 'PR或MR的来源分支名称正则表达式，不填则表示所有分支', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'feature-.*', 'backendName' => 'sourceBranch'],
+ 'targetBranch' => ['title' => 'PR或MR的目标分支名称正则表达式，不填则表示所有分支', 'description' => 'PR或MR的目标分支名称正则表达式，不填则表示所有分支', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'master', 'backendName' => 'targetBranch'],
'types' => [
- 'title' => '',
- 'description' => '',
+ 'title' => 'PR或MR的类型，为空则表示所有类型。TODO：场景类型',
+ 'description' => 'PR或MR的类型，为空则表示所有类型。',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'opened',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => '可枚举的类型。包括：(opened、closed、merged、reopened、updated）', 'visibility' => 'Public', 'type' => 'string', 'example' => 'opened', 'extendType' => 'true'],
'backendName' => 'types',
],
],
],
'PushFilter' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '推送事件过滤配置',
+ 'description' => '推送事件过滤配置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'branch' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'master',
- 'backendName' => 'branch',
- ],
- 'tag' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'prod-.*',
- 'backendName' => 'tag',
- ],
+ 'branch' => ['title' => '推送的分支名称正则表达式', 'description' => '推送的分支名称正则表达式', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'master', 'backendName' => 'branch'],
+ 'tag' => ['title' => '推送的tag名称正则表达式', 'description' => '推送的tag名称正则表达式', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'prod-.*', 'backendName' => 'tag'],
],
],
'ReleaseDetail' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '流水线发布结果详情',
+ 'description' => '流水线发布结果的详情',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'pipelineTriggerEventName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'p-codeup-1714271977972-pa4w',
- 'backendName' => 'pipelineTriggerEventName',
- ],
- 'bizStatus' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Running',
- 'backendName' => 'bizStatus',
- ],
- 'pipelineName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'p-1704952599751-wUOczb',
- 'backendName' => 'pipelineName',
- ],
- 'templateConfigSnapshot' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'templateConfigSnapshot',
- '$ref' => '#/components/schemas/TemplateConfig',
- ],
- 'releaseOutputs' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'object',
- 'example' => '{"framework":{"region":"cn-hangzhou","service":{"serviceName":"web-framework","description":"Serverless Devs Web Framework Service","role":"","logConfig":{"project":"","logstore":"","enableRequestMetrics":false,"enableInstanceMetrics":false,"logBeginRule":"None"},"serviceId":"4c9d0e79-16b8-4951-a6b8-169d2037d217","createdTime":"2021-12-07T09:24:08Z","lastModifiedTime":"2022-04-09T09:16:51Z","vpcConfig":{"vpcId":"","vSwitchIds":[],"securityGroupId":"","role":""},"internetAccess":true,"nasConfig":{"userId":-1,"groupId":-1,"mountPoints":[]},"tracingConfig":{},"name":"web-framework"},"function":{"functionId":"e81904f0-24d0-45df-bb53-06da64d01395","functionName":"todolist","description":"Serverless Devs Web Framework Function","runtime":"nodejs12","handler":"index.handler","timeout":60,"initializer":"","initializationTimeout":3,"codeSize":1757093,"codeChecksum":"7185648203525194222","memorySize":256,"environmentVariables":{},"createdTime":"2022-03-15T15:36:22Z","lastModifiedTime":"2022-04-09T09:16:50Z","instanceConcurrency":1,"instanceType":"e1","instanceLifecycleConfig":{"preFreeze":{"handler":"","timeout":3},"preStop":{"handler":"","timeout":3}},"name":"todolist"},"triggers":[{"triggerName":"httpTrigger","description":"","triggerId":"7f2373ce-df1a-4013-b4e5-899989d9b27e","triggerType":"http","triggerConfig":{"methods":["GET","POST"],"authType":"anonymous"},"createdTime":"2022-03-15T15:36:23Z","lastModifiedTime":"2022-04-09T09:16:51Z","name":"httpTrigger"}],"customDomains":[{"domainName":"todolist.web-framework.1835799444022432.cn-hangzhou.fc.devsapp.net","accountId":"1835799444022432","protocol":"HTTP","certConfig":{},"tlsConfig":{},"apiVersion":"2016-08-15","routeConfig":{"routes":[{"path":"/*","serviceName":"web-framework","functionName":"todolist","methods":["GET","POST"]}]},"createdTime":"2022-03-15T15:36:28Z","lastModifiedTime":"2022-04-09T09:17:00Z"}]}}',
- 'backendName' => 'releaseOutputs',
- ],
- 'finishedTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'finishedTime',
- ],
- 'repositorySnapshot' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'repositorySnapshot',
- '$ref' => '#/components/schemas/RepositorySpec',
- ],
- 'gitEventSnapshot' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'gitEventSnapshot',
- '$ref' => '#/components/schemas/GitEventSnapshot',
- ],
- 'message' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Triggered manually.',
- 'backendName' => 'message',
- ],
- 'latestTaskExecError' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'latestTaskExecError',
- '$ref' => '#/components/schemas/TaskExecError',
- ],
- 'envName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'dev',
- 'backendName' => 'envName',
- ],
+ 'pipelineTriggerEventName' => ['title' => '本次发布对应的流水线触发事件名称', 'description' => '本次发布对应的流水线触发事件名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'p-codeup-1714271977972-pa4w', 'backendName' => 'pipelineTriggerEventName'],
+ 'bizStatus' => ['title' => '本次发布的状态，受流水线与流水线任务执行状态影响。包括的状态以及含义如下： Running: 部署中 HangUp: 挂起等待审批中 Finished: 部署完成 Failed: 部署失败 Canceled: 已取消', 'description' => '本次发布的状态，受流水线与流水线任务执行状态影响。包括的状态以及含义如下： Running: 部署中 HangUp: 挂起等待审批中 Finished: 部署完成 Failed: 部署失败 Canceled: 已取消', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running', 'backendName' => 'bizStatus'],
+ 'pipelineName' => ['title' => '本次发布对应的流水线名称', 'description' => '本次发布对应的流水线名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'p-1704952599751-wUOczb', 'backendName' => 'pipelineName'],
+ 'templateConfigSnapshot' => ['title' => '本次发布所使用的模板配置快照。只有关联模板的项目存在该字段', 'description' => '本次发布所使用的模板配置快照。只有关联模板的项目存在该字段', 'visibility' => 'Public', 'backendName' => 'templateConfigSnapshot', '$ref' => '#/components/schemas/TemplateConfig'],
+ 'releaseOutputs' => ['title' => '本次发布的输出结果。包含本次发布的资源信息等', 'description' => '本次发布的输出结果。包含本次发布的资源信息等', 'visibility' => 'Public', 'type' => 'object', 'example' => '{"framework":{"region":"cn-hangzhou","service":{"serviceName":"web-framework","description":"Serverless Devs Web Framework Service","role":"","logConfig":{"project":"","logstore":"","enableRequestMetrics":false,"enableInstanceMetrics":false,"logBeginRule":"None"},"serviceId":"4c9d0e79-16b8-4951-a6b8-169d2037d217","createdTime":"2021-12-07T09:24:08Z","lastModifiedTime":"2022-04-09T09:16:51Z","vpcConfig":{"vpcId":"","vSwitchIds":[],"securityGroupId":"","role":""},"internetAccess":true,"nasConfig":{"userId":-1,"groupId":-1,"mountPoints":[]},"tracingConfig":{},"name":"web-framework"},"function":{"functionId":"e81904f0-24d0-45df-bb53-06da64d01395","functionName":"todolist","description":"Serverless Devs Web Framework Function","runtime":"nodejs12","handler":"index.handler","timeout":60,"initializer":"","initializationTimeout":3,"codeSize":1757093,"codeChecksum":"7185648203525194222","memorySize":256,"environmentVariables":{},"createdTime":"2022-03-15T15:36:22Z","lastModifiedTime":"2022-04-09T09:16:50Z","instanceConcurrency":1,"instanceType":"e1","instanceLifecycleConfig":{"preFreeze":{"handler":"","timeout":3},"preStop":{"handler":"","timeout":3}},"name":"todolist"},"triggers":[{"triggerName":"httpTrigger","description":"","triggerId":"7f2373ce-df1a-4013-b4e5-899989d9b27e","triggerType":"http","triggerConfig":{"methods":["GET","POST"],"authType":"anonymous"},"createdTime":"2022-03-15T15:36:23Z","lastModifiedTime":"2022-04-09T09:16:51Z","name":"httpTrigger"}],"customDomains":[{"domainName":"todolist.web-framework.1835799444022432.cn-hangzhou.fc.devsapp.net","accountId":"1835799444022432","protocol":"HTTP","certConfig":{},"tlsConfig":{},"apiVersion":"2016-08-15","routeConfig":{"routes":[{"path":"/*","serviceName":"web-framework","functionName":"todolist","methods":["GET","POST"]}]},"createdTime":"2022-03-15T15:36:28Z","lastModifiedTime":"2022-04-09T09:17:00Z"}]}}', 'backendName' => 'releaseOutputs'],
+ 'finishedTime' => ['title' => '本次发布的完成时间', 'description' => '本次发布的完成时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'backendName' => 'finishedTime'],
+ 'repositorySnapshot' => ['title' => '本次发布所使用的仓库配置快照。只有关联仓库的项目存在该字段', 'description' => '本次发布所使用的仓库配置快照。只有关联仓库的项目存在该字段', 'visibility' => 'Public', 'backendName' => 'repositorySnapshot', '$ref' => '#/components/schemas/RepositorySpec'],
+ 'gitEventSnapshot' => ['title' => '本次发布的Git事件快照。只有关联仓库的项目存在该字段', 'description' => '本次发布的Git事件快照。只有关联仓库的项目存在该字段', 'visibility' => 'Public', 'backendName' => 'gitEventSnapshot', '$ref' => '#/components/schemas/GitEventSnapshot'],
+ 'message' => ['title' => '本次发布的信息', 'description' => '本次发布的信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Triggered manually.', 'backendName' => 'message'],
+ 'latestTaskExecError' => ['title' => '本次发布过程中，最近一次流水线任务执行失败的详情信息', 'description' => '本次发布过程中，最近一次流水线任务执行失败的详情信息', 'visibility' => 'Public', 'backendName' => 'latestTaskExecError', '$ref' => '#/components/schemas/TaskExecError'],
+ 'envName' => ['title' => '本次发布对应的环境名', 'description' => '本次发布对应的环境名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dev', 'backendName' => 'envName'],
],
],
'Repository' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '仓库绑定',
+ 'description' => 'The metadata of the repository.',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Repository',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-repository',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'spec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'required' => true,
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/RepositorySpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The read-only ID of the Alibaba Cloud main account.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The read-only type of the resource.', 'type' => 'string', 'example' => 'Repository', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'The read-only, server-generated timestamp that indicates when the resource was created.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The unique name of the repository. It cannot be changed after creation.', 'type' => 'string', 'required' => true, 'example' => 'my-repository', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'spec' => ['title' => '仓库绑定配置', 'description' => 'The configuration details for the repository.', 'required' => true, '$ref' => '#/components/schemas/RepositorySpec', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'The labels attached to the resource, formatted as key-value pairs.',
'type' => 'object',
- 'additionalProperties' => [
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'test-description',
- 'backendName' => 'description',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'key=value', 'description' => '', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
+ 'backendName' => 'labels',
],
+ 'description' => ['title' => '描述信息', 'description' => 'The description of the repository.', 'type' => 'string', 'example' => 'test-description', 'visibility' => 'Public', 'backendName' => 'description'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'RepositoryConfig' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '代码仓库配置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'repositoryName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-repository',
- 'backendName' => 'repositoryName',
- ],
- 'branchName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'master',
- 'backendName' => 'branchName',
- ],
- 'manifest' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'src/s.yaml',
- 'backendName' => 'manifest',
- ],
+ 'repositoryName' => ['title' => '关联的开发平台侧代码仓库实体的名称', 'description' => '关联的开发平台侧代码仓库实体的名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-repository', 'backendName' => 'repositoryName'],
+ 'branchName' => ['title' => '仓库分支名', 'description' => '仓库分支名', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'master', 'backendName' => 'branchName'],
+ 'manifest' => ['title' => '指定资源描述文件(s.yaml)的文件名，该路径为代码仓库下的相对路径', 'description' => '指定资源描述文件(s.yaml)的文件名，该路径为代码仓库下的相对路径', 'visibility' => 'Public', 'type' => 'string', 'example' => 'src/s.yaml', 'backendName' => 'manifest'],
],
],
'RepositorySpec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '仓库绑定配置',
+ 'description' => 'The repository configuration.',
'type' => 'object',
'properties' => [
- 'connectionName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'awesome-connection',
- 'backendName' => 'connectionName',
- ],
- 'cloneUrl' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://github.com/DDofDD/start-springboot-lfgy.git',
- 'backendName' => 'cloneUrl',
- ],
- 'platform' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'github',
- 'backendName' => 'platform',
- ],
- 'id' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '312649',
- 'backendName' => 'id',
- ],
- 'owner' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-org-name',
- 'backendName' => 'owner',
- ],
- 'displayName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-repo-name',
- 'backendName' => 'displayName',
- ],
- 'webUrl' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'https://github.com/my-org-name/my-repo-name',
- 'backendName' => 'webUrl',
- ],
- ],
+ 'connectionName' => ['title' => '仓库所使用的身份绑定信息。通过关联的Connection可以获取到代码托管平台账号和凭证等信息', 'description' => 'The identity binding information used by the repository. Through the associated Connection, you can obtain information such as the code hosting platform account and credentials.', 'type' => 'string', 'required' => true, 'example' => 'awesome-connection', 'visibility' => 'Public', 'backendName' => 'connectionName'],
+ 'cloneUrl' => ['title' => '拉取仓库代码(git clone)所需的链接，支持HTTPS和SSH形式。', 'description' => 'The link required to clone the repository code (git clone), supporting both HTTPS and SSH formats.', 'type' => 'string', 'required' => true, 'example' => 'https://github.com/DDofDD/start-springboot-lfgy.git', 'visibility' => 'Public', 'backendName' => 'cloneUrl'],
+ 'platform' => ['title' => '只读，仓库所属代码托管平台的类型，支持github、gitee、gitlab、codeup', 'description' => 'Read-only. The type of code hosting platform for the repository. Supported platforms include GitHub, Gitee, GitLab, and Codeup.', 'type' => 'string', 'example' => 'github', 'visibility' => 'Public', 'backendName' => 'platform'],
+ 'id' => ['title' => '只读，代码托管平台中的仓库ID，平台内唯一', 'description' => 'Read-only. The repository ID in the code hosting platform, unique within the platform.', 'type' => 'integer', 'format' => 'int64', 'example' => '312649', 'visibility' => 'Public', 'backendName' => 'id'],
+ 'owner' => ['title' => '只读，代码托管平台中仓库所属账号名或组织名', 'description' => 'Read-only. The account name or organization name to which the repository belongs in the code hosting platform.', 'type' => 'string', 'example' => 'my-org-name', 'visibility' => 'Public', 'backendName' => 'owner'],
+ 'displayName' => ['title' => '只读，代码托管平台中的仓库名', 'description' => 'Read-only. The repository name in the code hosting platform.', 'type' => 'string', 'example' => 'my-repo-name', 'visibility' => 'Public', 'backendName' => 'displayName'],
+ 'webUrl' => ['title' => '只读，仓库主页链接', 'description' => 'Read-only. The repository homepage link.', 'type' => 'string', 'example' => 'https://github.com/my-org-name/my-repo-name', 'visibility' => 'Public', 'backendName' => 'webUrl'],
+ ],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'ResourceDrift' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '基础设施堆栈资源漂移',
+ 'description' => '资源漂移',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'address' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'alicloud_fc_trigger.cn-shanghai-fc-stable-diffusion-sd',
- 'backendName' => 'address',
- ],
- 'mode' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'managed',
- 'backendName' => 'mode',
- ],
- 'type' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'alicloud_fc_trigger',
- 'backendName' => 'type',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'cn-shanghai-fc-stable-diffusion-sd',
- 'backendName' => 'name',
- ],
+ 'address' => ['title' => '资源全局地址，可以唯一定位一个资源', 'description' => '资源全局地址，可以唯一定位一个资源', 'visibility' => 'Public', 'type' => 'string', 'example' => 'alicloud_fc_trigger.cn-shanghai-fc-stable-diffusion-sd', 'backendName' => 'address'],
+ 'mode' => ['title' => '纳管方式', 'description' => '纳管方式', 'visibility' => 'Public', 'type' => 'string', 'example' => 'managed', 'backendName' => 'mode'],
+ 'type' => ['title' => '资源类型', 'description' => '资源类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'alicloud_fc_trigger', 'backendName' => 'type'],
+ 'name' => ['title' => '资源名称', 'description' => '资源名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai-fc-stable-diffusion-sd', 'backendName' => 'name'],
'change' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '详细漂移结果',
+ 'description' => '详细漂移结果',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'actions' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '漂移行为',
+ 'description' => '漂移行为',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'update',
- 'extendType' => 'true',
- ],
+ 'items' => ['visibility' => 'Public', 'type' => 'string', 'example' => 'update', 'extendType' => 'true'],
'backendName' => 'actions',
],
- 'before' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'any',
- 'example' => '{"description":"modelscope deployment","id":"fc-demo-model-scope","internet_access":true,"last_modified":"2024-04-17T13:20:56Z","log_config":[],"name":"fc-demo-model-scope","name_prefix":null,"nas_config":[{"group_id":0,"mount_points":[{"mount_dir":"/mnt/auto","server_addr":"mock-addr.cn-shanghai.nas.aliyuncs.com:/fc-demo-model-scope"}],"user_id":0}],"publish":null,"role":"acs:ram::mock-role:role/aliyunfcdefaultrole","service_id":"mock-service","tags":null,"tracing_config":[],"version":null,"vpc_config":[{"security_group_id":"sg-mock","vpc_id":"vpc-mock","vswitch_ids":["vsw-mock"]}]}',
- 'backendName' => 'before',
- ],
- 'after' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'any',
- 'example' => '{"description":"mock deployment","id":"fc-demo-model-scope","internet_access":true,"last_modified":"2024-04-17T13:20:56Z","log_config":[],"name":"fc-demo-model-scope","name_prefix":null,"nas_config":[{"group_id":0,"mount_points":[{"mount_dir":"/mnt/auto","server_addr":"mock-addr.cn-shanghai.nas.aliyuncs.com:/fc-demo-model-scope"}],"user_id":0}],"publish":null,"role":"acs:ram::mock-role:role/aliyunfcdefaultrole","service_id":"mock-service","tags":null,"tracing_config":[],"version":null,"vpc_config":[{"security_group_id":"sg-mock","vpc_id":"vpc-mock","vswitch_ids":["vsw-mock"]}]}',
- 'backendName' => 'after',
- ],
+ 'before' => ['title' => '执行漂移检查之前的详情', 'description' => '执行漂移检查之前的详情', 'visibility' => 'Public', 'type' => 'any', 'example' => '{"description":"modelscope deployment","id":"fc-demo-model-scope","internet_access":true,"last_modified":"2024-04-17T13:20:56Z","log_config":[],"name":"fc-demo-model-scope","name_prefix":null,"nas_config":[{"group_id":0,"mount_points":[{"mount_dir":"/mnt/auto","server_addr":"mock-addr.cn-shanghai.nas.aliyuncs.com:/fc-demo-model-scope"}],"user_id":0}],"publish":null,"role":"acs:ram::mock-role:role/aliyunfcdefaultrole","service_id":"mock-service","tags":null,"tracing_config":[],"version":null,"vpc_config":[{"security_group_id":"sg-mock","vpc_id":"vpc-mock","vswitch_ids":["vsw-mock"]}]}', 'backendName' => 'before'],
+ 'after' => ['title' => '执行漂移检查之后的详情', 'description' => '执行漂移检查之后的详情', 'visibility' => 'Public', 'type' => 'any', 'example' => '{"description":"mock deployment","id":"fc-demo-model-scope","internet_access":true,"last_modified":"2024-04-17T13:20:56Z","log_config":[],"name":"fc-demo-model-scope","name_prefix":null,"nas_config":[{"group_id":0,"mount_points":[{"mount_dir":"/mnt/auto","server_addr":"mock-addr.cn-shanghai.nas.aliyuncs.com:/fc-demo-model-scope"}],"user_id":0}],"publish":null,"role":"acs:ram::mock-role:role/aliyunfcdefaultrole","service_id":"mock-service","tags":null,"tracing_config":[],"version":null,"vpc_config":[{"security_group_id":"sg-mock","vpc_id":"vpc-mock","vswitch_ids":["vsw-mock"]}]}', 'backendName' => 'after'],
],
'backendName' => 'change',
],
],
],
'RunAfter' => [
- 'title' => '',
+ 'title' => '任务依赖，必须在依赖结束后执行',
'description' => 'Describe dependencies',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'task-1',
- 'backendName' => 'name',
- ],
+ 'name' => ['title' => '执行依赖的任务代称', 'description' => '执行依赖的任务代称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'task-1', 'backendName' => 'name'],
],
],
'RunPipelineConfig' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '触发后运行流水线配置',
+ 'description' => '触发后运行流水线配置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'yamlFilePath' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'cd.yaml',
- 'backendName' => 'yamlFilePath',
- ],
- 'yamlFileContent' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'yamlFileContent',
- ],
- 'pipelineSpec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'pipelineSpec',
- '$ref' => '#/components/schemas/PipelineSpec',
- ],
+ 'yamlFilePath' => ['title' => '触发流水线执行的cicd.yaml在仓库中的位置，适用于DevOps的场景。此配置拥有最高优先级，所有流水线执行相关的配置都需要在cicd.yaml文件中定义，其他流水线执行配置均不生效。如果cicd.yaml不存在，则在触发执行时会出错。', 'description' => '触发流水线执行的cicd.yaml在仓库中的位置，适用于DevOps的场景。此配置拥有最高优先级，所有流水线执行相关的配置都需要在cicd.yaml文件中定义，其他流水线执行配置均不生效。如果cicd.yaml不存在，则在触发执行时会出错。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cd.yaml', 'backendName' => 'yamlFilePath'],
+ 'yamlFileContent' => ['title' => '触发流水线执行的cicd.yaml的内容。此配置拥有仅次于yamlFilePath的优先级。所有流水线执行相关的配置都需要在cicd.yaml文件中定义，流水线执行配置均不生效。', 'description' => '触发流水线执行的cicd.yaml的内容。此配置拥有仅次于yamlFilePath的优先级。所有流水线执行相关的配置都需要在cicd.yaml文件中定义，流水线执行配置均不生效。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'kind: Pipeline'."\n"
+ .' # 流水线执行名称，需要全局唯一。如果流水线模板存在，则不能成功提交流水线执行'."\n"
+ .' # 推荐使用commitID与时间戳构造唯一的名称'."\n"
+ .' name: "p-<% .git.shortCommitId %>-<% .currentTimestampMs %>"'."\n"
+ .' # 一些任意的描述信息'."\n"
+ .' description: \'demo pipeline\''."\n"
+ .' # 添加任意的labels，用于查询过滤'."\n"
+ .' # 应用中心会在提交时也会添加其他labels'."\n"
+ .' labels:'."\n"
+ .' myLabel: my-cicd-example'."\n"
+ .' spec:'."\n"
+ .' context:'."\n"
+ .' data:'."\n"
+ .' appName: <% .appName %>'."\n"
+ .' envName: <% .envName %>'."\n"
+ .' deployFile: s.yaml'."\n"
+ .' templateSpec:'."\n"
+ .' # 要执行的任务，默认所有任务会一同尝试执行'."\n"
+ .' # 执行会满足runAfters引入的先后约束，任务必须在runAfters声明的任务执行完毕后才可以被执行'."\n"
+ .' # 用户可以使用此特性，达到DAG描述的效果'."\n"
+ .' tasks:'."\n"
+ .' # 构建前检查'."\n"
+ .' - name: pre-check'."\n"
+ .' context:'."\n"
+ .' data:'."\n"
+ .' displayName: "前置检查"'."\n"
+ .' # 打开任务执行，默认是关闭的'."\n"
+ .' enable: true'."\n"
+ .' # 同样可以在此处声明钉钉告警配置，修改告警模板'."\n"
+ .' # dingdingNotification:'."\n"
+ .' # 同样可以在此处声明或修改RunnerConfig'."\n"
+ .' # runnerConfig:'."\n"
+ .' # 执行步骤。下述步骤将会采用开源项目serverless-cd提供的engine进行执行'."\n"
+ .' steps:'."\n"
+ .' # 第一步，初始化s工具'."\n"
+ .' - plugin: "@serverless-cd/s-setup"'."\n"
+ .' # 第二步，checkout代码'."\n"
+ .' # 这里采用了plugin机制，运行serverless-cd社区的插件'."\n"
+ .' # @serverless-cd/checkout是一个社区提供的插件，它会将代码checkout到默认路径'."\n"
+ .' # 我们会陆续为社区提供更多的插件'."\n"
+ .' - plugin: "@serverless-cd/checkout"'."\n"
+ .' # 执行s-plan，并打印输出内容'."\n"
+ .' # 这里为了说明engine能力，将它拆分成了多个step执行'."\n"
+ .' - run: s plan -t ${{ ctx.data.deployFile || "s.yaml" }}'."\n"
+ .' - run: echo "s plan finished."'."\n"
+ .' # 任务模板。这里使用了内置的模板serverless-runner-task'."\n"
+ .' taskTemplate: serverless-runner-task'."\n"
+ .' # 执行顺序，当前任务执行依赖runAfters任务都执行成功'."\n"
+ .' runAfters: []'."\n"
+ .' # 构建并部署'."\n"
+ .' - name: build-and-deploy'."\n"
+ .' context:'."\n"
+ .' data:'."\n"
+ .' # 打开任务执行，默认是关闭的'."\n"
+ .' enable: true'."\n"
+ .' # 同样可以在此处声明钉钉告警配置，修改告警模板'."\n"
+ .' # dingdingNotification:'."\n"
+ .' # 同样可以在此处声明或修改RunnerConfig'."\n"
+ .' # runnerConfig:'."\n"
+ .' # 执行步骤。下述步骤将会采用开源项目serverless-cd提供的engine进行执行'."\n"
+ .' steps:'."\n"
+ .' # 每个Task都是独立运行的Serverless实例，需要再次初始化s工具'."\n"
+ .' - plugin: "@serverless-cd/s-setup"'."\n"
+ .' # 同理，需要重新checkout'."\n"
+ .' - plugin: "@serverless-cd/checkout"'."\n"
+ .' # 执行s-deploy'."\n"
+ .' - plugin: "@serverless-cd/s-deploy"'."\n"
+ .' taskTemplate: serverless-runner-task'."\n"
+ .' # 执行顺序，当前任务执行依赖runAfters任务都执行成功'."\n"
+ .' runAfters:'."\n"
+ .' # 在approval后执行'."\n"
+ .' - name: pre-check', 'backendName' => 'yamlFileContent'],
+ 'pipelineSpec' => ['title' => '流水线执行的配置描述', 'description' => '流水线执行的配置描述', 'visibility' => 'Public', 'backendName' => 'pipelineSpec', '$ref' => '#/components/schemas/PipelineSpec'],
'variables' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '流水线环境变量，可以在流水线执行时引用',
+ 'description' => '流水线环境变量，可以在流水线执行时引用',
'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/Variable',
- ],
+ 'items' => ['description' => '变量', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Variable'],
'backendName' => 'variables',
],
],
],
'Task' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Represents a task run.',
'type' => 'object',
'properties' => [
- 'spec' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/TaskSpec',
- ],
- 'status' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/TaskStatus',
- ],
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Task example.',
- 'backendName' => 'description',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Task',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-task',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'deletionTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'deletionTime',
- ],
+ 'spec' => ['description' => 'The desired state of the task.', '$ref' => '#/components/schemas/TaskSpec', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
+ 'status' => ['description' => 'The most recently observed state of the task.', '$ref' => '#/components/schemas/TaskStatus', 'title' => '', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The ID of the Alibaba Cloud account. This field is read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'generation' => ['title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'description' => 'A sequence number for the `spec` that the system increments when the spec is updated. This field is read-only.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'generation'],
+ 'description' => ['title' => '任务描述信息', 'description' => 'A description of the task.', 'type' => 'string', 'example' => 'Task example.', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The type of the resource. This field is read-only and its value is always `Task`.', 'type' => 'string', 'example' => 'Task', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'The server timestamp when the resource was created. This field is read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The name of the resource. The name must be unique and is immutable.', 'type' => 'string', 'required' => true, 'example' => 'my-task', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'Key-value pairs that categorize and organize the resource.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['description' => 'The value of the label.', 'type' => 'string', 'example' => 'value to the label key.', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
+ 'backendName' => 'labels',
],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => 'A sequence number for the resource that the system increments when the resource is updated. This field is read-only.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'resourceVersion'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskExec' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Represents a single task execution.',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'task-1',
- 'backendName' => 'name',
- ],
- 'context' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'context',
- '$ref' => '#/components/schemas/Context',
- ],
- 'taskTemplate' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'serverless-runner',
- 'backendName' => 'taskTemplate',
- ],
+ 'name' => ['title' => '当前任务代称', 'description' => 'The name of the task.', 'type' => 'string', 'example' => 'task-1', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'context' => ['title' => '执行上下文', 'description' => 'The execution context.', '$ref' => '#/components/schemas/Context', 'example' => '', 'visibility' => 'Public', 'backendName' => 'context'],
+ 'taskTemplate' => ['title' => '任务模板名称', 'description' => 'The name of the task template.', 'type' => 'string', 'example' => 'serverless-runner', 'visibility' => 'Public', 'backendName' => 'taskTemplate'],
'runAfters' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '执行顺序，必须在所有依赖任务执行完毕后才能被执行',
+ 'description' => 'Specifies the dependencies that must complete before this task runs.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/RunAfter',
- ],
+ 'items' => ['description' => 'The name of a dependency.', '$ref' => '#/components/schemas/RunAfter', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'],
+ 'example' => '',
+ 'visibility' => 'Public',
'backendName' => 'runAfters',
],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskExecError' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '任务执行出现的异常描述',
+ 'description' => 'Describes a task execution error.',
'type' => 'object',
'properties' => [
- 'title' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'title',
- ],
- 'message' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'message',
- ],
- 'code' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'AccessDenied',
- 'backendName' => 'code',
- ],
- 'requestId' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '1-26d1287xxxxx',
- 'backendName' => 'requestId',
- ],
- 'extraInfo' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '',
- 'backendName' => 'extraInfo',
- ],
+ 'title' => ['title' => '错误描述', 'description' => 'A summary of the error.', 'type' => 'string', 'example' => '权限不足错误', 'visibility' => 'Public', 'backendName' => 'title'],
+ 'message' => ['title' => '错误信息', 'description' => 'A detailed, human-readable description of the error.', 'type' => 'string', 'example' => '部署服务[_appcenter-xxx]失败，权限不足', 'visibility' => 'Public', 'backendName' => 'message'],
+ 'code' => ['title' => '错误码', 'description' => 'The error code returned by the service.', 'type' => 'string', 'example' => 'AccessDenied', 'visibility' => 'Public', 'backendName' => 'code'],
+ 'requestId' => ['title' => '请求ID', 'description' => 'The unique request ID for the operation. Use this ID for tracking and troubleshooting.', 'type' => 'string', 'example' => '1-26d1287xxxxx', 'visibility' => 'Public', 'backendName' => 'requestId'],
+ 'extraInfo' => ['title' => '对解决错误有帮助的额外信息', 'description' => 'Additional details to help resolve the error.', 'type' => 'string', 'example' => '部署辅助函数权限不足，需要添加额外的权限以解决问题', 'visibility' => 'Public', 'backendName' => 'extraInfo'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskInvocation' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Contains information about a task invocation.',
'type' => 'object',
'properties' => [
- 'invocationID' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'E099843B-10A2-4936-9964-4E0EE263D564',
- 'backendName' => 'invocationID',
- ],
- 'requestID' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '1B3058B1-F1C9-457C-B95C-2C250A4B3118',
- 'backendName' => 'requestID',
- ],
- 'invocationTarget' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx',
- 'backendName' => 'invocationTarget',
- ],
- 'status' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'success',
- 'backendName' => 'status',
- ],
- 'output' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{"key1":"value1","key2":"value2"}',
- 'backendName' => 'output',
- ],
- 'instanceID' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'c-nkj8shz7xxxx',
- 'backendName' => 'instanceID',
- ],
- 'slsProject' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-sls-project',
- 'backendName' => 'slsProject',
- ],
- 'slsLogStore' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-sls-logstore',
- 'backendName' => 'slsLogStore',
- ],
- ],
+ 'invocationID' => ['title' => '调用ID，任务在函数计算中的调用ID', 'description' => 'The unique invocation ID for the task in Function Compute.', 'type' => 'string', 'example' => 'E099843B-10A2-4936-9964-4E0EE263D564', 'visibility' => 'Public', 'backendName' => 'invocationID'],
+ 'requestID' => ['title' => '请求ID，任务在函数计算中的请求ID', 'description' => 'The unique request ID for the task in Function Compute.', 'type' => 'string', 'example' => '1B3058B1-F1C9-457C-B95C-2C250A4B3118', 'visibility' => 'Public', 'backendName' => 'requestID'],
+ 'invocationTarget' => ['title' => '调用目标', 'description' => 'The identifier for the invocation target.', 'type' => 'string', 'example' => 'acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx', 'visibility' => 'Public', 'backendName' => 'invocationTarget'],
+ 'status' => ['title' => '上一次观测到的调用状态。', 'description' => 'The latest reported invocation status.', 'type' => 'string', 'example' => 'success', 'visibility' => 'Public', 'backendName' => 'status'],
+ 'output' => ['title' => '调用结果', 'description' => 'The invocation result.', 'type' => 'string', 'example' => '{"key1":"value1","key2":"value2"}', 'visibility' => 'Public', 'backendName' => 'output'],
+ 'instanceID' => ['title' => '调用命中的实例ID', 'description' => 'The ID of the instance that processed the invocation.', 'type' => 'string', 'example' => 'c-nkj8shz7xxxx', 'visibility' => 'Public', 'backendName' => 'instanceID'],
+ 'slsProject' => ['title' => '日志投递到SLS产品的Project名称', 'description' => 'The name of the Project in Log Service that receives the logs.', 'type' => 'string', 'example' => 'my-sls-project', 'visibility' => 'Public', 'backendName' => 'slsProject'],
+ 'slsLogStore' => ['title' => '日志投递到SLS产品的Logstore名称', 'description' => 'The name of the Logstore in Log Service that receives the logs.', 'type' => 'string', 'example' => 'my-sls-logstore', 'visibility' => 'Public', 'backendName' => 'slsLogStore'],
+ ],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskSpec' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The execution configuration for a task.',
'type' => 'object',
'properties' => [
- 'templateName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'my-task-template',
- 'backendName' => 'templateName',
- ],
- 'context' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'context',
- '$ref' => '#/components/schemas/Context',
- ],
+ 'templateName' => ['title' => '任务模板名称', 'description' => 'The name of the task template.', 'type' => 'string', 'example' => 'my-task-template', 'visibility' => 'Public', 'backendName' => 'templateName'],
+ 'context' => ['title' => '任务的执行上下文', 'description' => 'The execution context for the task.', '$ref' => '#/components/schemas/Context', 'example' => '', 'visibility' => 'Public', 'backendName' => 'context'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskStatus' => [
'title' => 'A short description of struct',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Describes the current execution status of the task.',
'type' => 'object',
'properties' => [
- 'statusGeneration' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- 'backendName' => 'statusGeneration',
- ],
- 'phase' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Success',
- 'backendName' => 'phase',
- ],
+ 'statusGeneration' => ['title' => '状态版本号', 'description' => 'A version number that increments with each status update.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'visibility' => 'Public', 'backendName' => 'statusGeneration'],
+ 'phase' => ['title' => '当前执行阶段', 'description' => 'The current execution phase of the task.', 'type' => 'string', 'example' => 'Success', 'visibility' => 'Public', 'backendName' => 'phase'],
'executionDetails' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '执行详情',
+ 'description' => 'An array of strings containing details about the execution process.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'step1: start task.',
- 'extendType' => 'true',
- ],
+ 'items' => ['description' => 'Each string represents a step in the execution process.', 'type' => 'string', 'example' => 'step1: start task.', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'],
+ 'example' => '',
+ 'visibility' => 'Public',
'backendName' => 'executionDetails',
],
'invocations' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '执行历史',
+ 'description' => 'The task\'s invocation history.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/TaskInvocation',
- ],
- 'backendName' => 'invocations',
- ],
- 'latestExecError' => [
- 'title' => '',
- 'description' => '',
+ 'items' => ['description' => 'Each element represents a single invocation of the task.', '$ref' => '#/components/schemas/TaskInvocation', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'],
+ 'example' => '',
'visibility' => 'Public',
- 'backendName' => 'latestExecError',
- '$ref' => '#/components/schemas/TaskExecError',
+ 'backendName' => 'invocations',
],
+ 'latestExecError' => ['title' => '最近一次任务执行错误', 'description' => 'The most recent task execution error.', '$ref' => '#/components/schemas/TaskExecError', 'example' => '', 'visibility' => 'Public', 'backendName' => 'latestExecError'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskTemplate' => [
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'Represents a TaskTemplate resource.',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'TaskTemplate example.',
- 'backendName' => 'description',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'TaskTemplate',
- 'backendName' => 'kind',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-task-template',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- 'backendName' => 'name',
- ],
- 'deletionTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'deletionTime',
- ],
- 'spec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/TaskTemplateSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => 'The ID of the Alibaba Cloud account. Read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'generation' => ['title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'description' => 'A system-populated, auto-incrementing sequence number for the configuration. This value is incremented when the `spec` is updated. Read-only.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'generation'],
+ 'description' => ['title' => '任务模板描述信息', 'description' => 'A description of the task template.', 'type' => 'string', 'example' => 'TaskTemplate example.', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => 'The resource type identifier. Read-only.', 'type' => 'string', 'example' => 'TaskTemplate', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => 'The server-side creation timestamp for the resource. Read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => 'The unique and immutable name of the resource.', 'type' => 'string', 'required' => true, 'example' => 'my-task-template', 'maxLength' => 40, 'minLength' => 1, 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'deletionTime' => ['title' => '资源删除时间，只读', 'description' => 'The time when the resource was marked for deletion. Read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'deletionTime'],
+ 'spec' => ['title' => '资源的配置属性', 'description' => 'The specification of the resource.', '$ref' => '#/components/schemas/TaskTemplateSpec', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
'labels' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '资源的标签',
+ 'description' => 'Key-value pairs attached to the resource.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '',
- ],
- 'backendName' => 'labels',
- ],
- 'resourceVersion' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['description' => 'The key for the label.', 'type' => 'string', 'example' => '资源标签的值', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'backendName' => 'resourceVersion',
+ 'backendName' => 'labels',
],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => 'A system-populated, auto-incrementing sequence number for the resource\'s current state. This value is incremented on each update to the resource. Read-only.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'resourceVersion'],
],
+ 'title' => '',
+ 'example' => '',
+ 'visibility' => 'Public',
],
'TaskTemplateSpec' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '任务模板描述',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'build&deploy.',
- 'backendName' => 'description',
- ],
- 'worker' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'worker',
- '$ref' => '#/components/schemas/TaskWorker',
- ],
- 'context' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'context',
- '$ref' => '#/components/schemas/Context',
- ],
- 'contextSchema' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Private',
- 'type' => 'object',
- 'nullable' => false,
- 'backendName' => 'contextSchema',
- ],
- 'executeCondition' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'executeCondition',
- '$ref' => '#/components/schemas/Condition',
- ],
+ 'description' => ['title' => '任务执行的描述信息', 'description' => '任务执行的描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'build&deploy.', 'backendName' => 'description'],
+ 'worker' => ['title' => '任务节点的描述', 'description' => '任务节点的描述', 'visibility' => 'Public', 'backendName' => 'worker', '$ref' => '#/components/schemas/TaskWorker'],
+ 'context' => ['title' => '任务的执行上下文', 'description' => '任务的执行上下文', 'visibility' => 'Public', 'backendName' => 'context', '$ref' => '#/components/schemas/Context'],
+ 'contextSchema' => ['title' => '执行上下文的JSON Schema描述信息', 'description' => '执行上下文的JSON Schema描述信息', 'visibility' => 'Private', 'type' => 'object', 'nullable' => false, 'backendName' => 'contextSchema'],
+ 'executeCondition' => ['title' => '任务执行的条件', 'description' => '任务执行的条件', 'visibility' => 'Public', 'backendName' => 'executeCondition', '$ref' => '#/components/schemas/Condition'],
],
],
'TaskWorker' => [
'title' => 'A short description of struct',
- 'description' => '',
+ 'description' => '描述任务执行方式',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'presetWorker' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'serverless-runner',
- 'backendName' => 'presetWorker',
- ],
+ 'presetWorker' => ['title' => '系统预设的任务类型。它会执行预设的逻辑。', 'description' => '系统预设的任务类型。它会执行预设的逻辑。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'serverless-runner', 'backendName' => 'presetWorker'],
],
],
'TemplateConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '模板部署服务输入',
+ 'description' => 'Configuration for a project template.',
'type' => 'object',
'properties' => [
- 'templateName' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'start-springboot',
- 'backendName' => 'templateName',
- ],
+ 'variableValues' => ['title' => '模板变量', 'description' => 'The values for the template variables.', 'example' => '', '$ref' => '#/components/schemas/TemplateVariableValueMap', 'visibility' => 'Public', 'backendName' => 'variableValues'],
+ 'templateName' => ['title' => '模板名称', 'description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'start-springboot', 'visibility' => 'Public', 'backendName' => 'templateName'],
'parameters' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '模板参数',
+ 'description' => 'The template parameters.',
'type' => 'object',
'required' => false,
'example' => '{"region":"cn-hangzhou"}',
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '{"region":"cn-hangzhou"}', 'visibility' => 'Public'],
+ 'visibility' => 'Public',
'backendName' => 'parameters',
],
+ 'serviceNameChanges' => [
+ 'title' => '服务名称变化，key是模板原始服务名，value是需要修改的目标服务名',
+ 'description' => 'A map for renaming services from the template, where the key is the original service name and the value is the new name.',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => '{"originName": "newName"}', 'visibility' => 'Public'],
+ 'example' => '{"svc1":"svc2"}',
+ 'visibility' => 'Public',
+ 'backendName' => 'serviceNameChanges',
+ ],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'Toolset' => [
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The toolset.',
'type' => 'object',
'properties' => [
- 'generation' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- 'backendName' => 'generation',
- ],
- 'uid' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- 'backendName' => 'uid',
- ],
- 'kind' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Toolset',
- 'backendName' => 'kind',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-toolset',
- 'backendName' => 'name',
- ],
- 'createdTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- 'backendName' => 'createdTime',
- ],
- 'description' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'test-description',
- 'backendName' => 'description',
- ],
- 'spec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'spec',
- '$ref' => '#/components/schemas/ToolsetSpec',
- ],
+ 'generation' => ['title' => '', 'description' => 'The auto-increment sequence number of the current resource. This parameter is populated by the system and is read-only. The value increments when spec, labels, or description is updated. If specified, the system performs concurrent write verification, and the generation value must match the current state value in the system.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'visibility' => 'Public', 'backendName' => 'generation'],
+ 'uid' => ['title' => '', 'description' => 'The ID of the current Alibaba Cloud account. This parameter is read-only.', 'type' => 'string', 'required' => false, 'example' => '1455541096***548', 'visibility' => 'Public', 'backendName' => 'uid'],
+ 'kind' => ['title' => '', 'description' => 'The name of the current resource. This parameter is read-only.', 'type' => 'string', 'example' => 'Toolset', 'visibility' => 'Public', 'backendName' => 'kind'],
+ 'name' => ['title' => '', 'description' => 'The name of the current resource. The name must be unique and cannot be changed.', 'type' => 'string', 'required' => true, 'example' => 'my-toolset', 'visibility' => 'Public', 'backendName' => 'name'],
+ 'createdTime' => ['title' => '', 'description' => 'The server time when this object was created. This parameter is read-only.', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'visibility' => 'Public', 'backendName' => 'createdTime'],
+ 'description' => ['title' => '', 'description' => 'The description of the toolset.', 'type' => 'string', 'example' => 'test-description', 'visibility' => 'Public', 'backendName' => 'description'],
+ 'spec' => ['title' => '', 'description' => 'The specific configuration of the toolset.', '$ref' => '#/components/schemas/ToolsetSpec', 'example' => '', 'visibility' => 'Public', 'backendName' => 'spec'],
'labels' => [
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The labels of the resource.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- 'backendName' => 'labels',
- ],
- 'status' => [
- 'title' => '',
- 'description' => '',
+ 'additionalProperties' => ['description' => '标签', 'type' => 'string', 'example' => 'key=value', 'title' => '', 'visibility' => 'Public'],
+ 'example' => '',
'visibility' => 'Public',
- 'backendName' => 'status',
- '$ref' => '#/components/schemas/ToolsetStatus',
+ 'backendName' => 'labels',
],
+ 'status' => ['title' => '', 'description' => 'The status of the toolset.', '$ref' => '#/components/schemas/ToolsetStatus', 'example' => '', 'visibility' => 'Public', 'backendName' => 'status'],
],
+ 'example' => '',
+ 'visibility' => 'Public',
],
'ToolsetSchema' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '工具集接口规范与配置',
+ 'description' => 'Specifies the toolset schema.',
'type' => 'object',
'properties' => [
- 'detail' => [
+ 'type' => ['title' => '工具集 Schema 类型', 'description' => 'The toolset schema type.', 'type' => 'string', 'example' => 'OpenAPI'],
+ 'detail' => ['title' => '工具集 Schema 详情', 'description' => 'The OpenAPI specification that defines the toolset schema.', 'type' => 'string', 'example' => 'openapi: 3.0.1'."\n"
+ .'info:'."\n"
+ .' title: web-search-baidu-balabala'."\n"
+ .' description: 使用百度搜索查询实时新闻消息。'."\n"
+ .' version: v1'."\n"
+ .'servers:'."\n"
+ .' - url: https://baidu-ehd-brwxrpgffd.cn-hangzhou.fcapp.run'."\n"
+ .'paths:'."\n"
+ .' /invoke:'."\n"
+ .' post:'."\n"
+ .' operationId: baidu_search'."\n"
+ .' summary: 使用百度查询信息获取信息列表'."\n"
+ .' requestBody:'."\n"
+ .' required: true'."\n"
+ .' content:'."\n"
+ .' application/json:'."\n"
+ .' schema:'."\n"
+ .' type: object'."\n"
+ .' required:'."\n"
+ .' - search_input'."\n"
+ .' properties:'."\n"
+ .' search_input:'."\n"
+ .' type: string'."\n"
+ .' description: 要搜索的内容'."\n"
+ .' responses:'."\n"
+ .' \'200\':'."\n"
+ .' description: 查询成功'."\n"
+ .' content:'."\n"
+ .' application/json:'."\n"
+ .' schema:'."\n"
+ .' type: object'."\n"
+ .' required:'."\n"
+ .' - content'."\n"
+ .' properties:'."\n"
+ .' content:'."\n"
+ .' type: string'."\n"
+ .' description: 查询结果'."\n", 'deprecated' => false],
+ 'config' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'mcpInstallation' => ['title' => 'MCP服务器安装配置，只针对type为MCP时有效', '$ref' => '#/components/schemas/MCPInstallationConfig', 'description' => '', 'example' => ''],
+ 'openAPISchema' => ['title' => 'OpenAPI Schema详情，仅针对type为OpenAPI时有效', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'mcpGateway' => ['title' => 'MCP网关配置，仅针对type为MCPGateway时有效', '$ref' => '#/components/schemas/MCPGatewayConfig', 'description' => '', 'example' => ''],
+ 'difyPluginInstallation' => ['title' => 'Dify插件安装配置', '$ref' => '#/components/schemas/DifyPluginInstallationConfig', 'description' => '', 'example' => ''],
+ ],
+ 'description' => 'Configuration settings for the toolset.',
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
'example' => '',
- 'backendName' => 'detail',
- ],
- 'type' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'OpenAPI',
- 'backendName' => 'type',
],
],
+ 'example' => '',
],
'ToolsetSpec' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '工具集配置',
+ 'description' => 'The toolset configuration.',
'type' => 'object',
'properties' => [
- 'schema' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'type',
- '$ref' => '#/components/schemas/ToolsetSchema',
- ],
- 'authorization' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Private',
- 'backendName' => 'authorization',
- '$ref' => '#/components/schemas/ToolsetAuthorization',
- ],
- 'authConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'backendName' => 'authConfig',
- '$ref' => '#/components/schemas/Authorization',
+ 'schema' => ['title' => '工具集schema结构', 'description' => 'The toolset schema.', '$ref' => '#/components/schemas/ToolsetSchema', 'example' => ''],
+ 'networkConfig' => [
+ 'title' => '工具集网络配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'internetAccess' => ['title' => '是否允许工具集函数访问公网', 'type' => 'boolean', 'description' => '', 'example' => ''],
+ 'vpcConfig' => [
+ 'title' => '工具集vpc配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'vpcId' => ['title' => 'vpd id', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'vSwitchIds' => [
+ 'title' => '交换机列表',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'example' => '',
+ ],
+ 'securityGroupId' => ['title' => '安全组id', 'type' => 'string', 'description' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'example' => '',
+ ],
+ ],
+ 'description' => 'The network configuration.',
+ 'example' => '',
],
+ 'authConfig' => ['description' => 'The authorization configuration.', 'title' => '', '$ref' => '#/components/schemas/Authorization', 'example' => ''],
],
+ 'example' => '',
],
'ToolsetStatus' => [
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The status of the toolset.',
'type' => 'object',
'properties' => [
- 'phase' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'Installed',
- 'backendName' => 'phase',
- ],
+ 'phase' => ['title' => '工具集状态。Pending：初始状态；Installing：安装中，只有uvx、npx托管时才进入该状态；Installed：成功状态，表示成功安装；Failed：失败状态，安装失败会进入到该状；Invalid：无效状态，当导入存量的mcp server时，访问该server的url执行listTools失败会进入到该状态', 'description' => 'The current phase of the toolset. Valid values include: `Pending`: The initial phase. `Installing`: The toolset is being installed. This phase applies only to managed toolsets such as `uvx` and `npx`. `Installed`: The toolset is successfully installed. `Failed`: The toolset installation failed. `Invalid`: Occurs when an existing MCP server is imported and the `listTools` operation on the server\'s URL fails.', 'type' => 'string', 'example' => 'Installed'],
'outputs' => [
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The outputs generated by the toolset.',
'type' => 'object',
'properties' => [
+ 'functionArn' => ['title' => '函数资源定位符。当工具集托管资源时存在该字段', 'description' => 'The Amazon Resource Name (ARN) of the function. Available only when the toolset includes a managed resource.', 'type' => 'string', 'example' => 'acs:fc:cn-qingdao:0000:functions/aliyun_merchant_login_egistration'],
'urls' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => '工具集访问地址。仅当工具集托管资源时存在该字段',
+ 'description' => 'The access URLs for the toolset. Available only when the toolset includes a managed resource.',
'type' => 'object',
'properties' => [
- 'internetUrl' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse',
- 'backendName' => 'internetUrl',
- ],
- 'intranetUrl' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'https://mock.cn-hangzhou-vpc.fcapp.run/sse',
- 'backendName' => 'intranetUrl',
- ],
- ],
- 'backendName' => 'urls',
- ],
- 'openApiTools' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/OpenAPIToolMeta',
+ 'internetUrl' => ['title' => '公网访问地址', 'description' => 'The public access URL.', 'type' => 'string', 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse'],
+ 'intranetUrl' => ['title' => '内网访问地址', 'description' => 'The internal access URL.', 'type' => 'string', 'example' => 'https://mock.cn-hangzhou-vpc.fcapp.run/sse'],
],
- 'backendName' => 'tools',
+ 'example' => '',
],
'mcpServerConfig' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => 'MCP服务器访问配置。仅当MCP类型的工具集存在该字段',
+ 'description' => 'The MCP server access configuration. Available only for toolsets of type `MCP`.',
'type' => 'object',
'properties' => [
+ 'url' => ['title' => 'MCP服务器访问地址', 'description' => 'The access URL for the MCP server.', 'type' => 'string', 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse'],
+ 'transportType' => ['title' => 'MCP服务器传输类型。SSE、StreamableHttp', 'description' => 'The transport type for the MCP server. Supported values: `sse` and `StreamableHttp`.', 'type' => 'string', 'example' => 'sse'],
'headers' => [
- 'description' => '',
- 'visibility' => 'Public',
+ 'description' => 'The request headers.',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '{\'Authorization\': Bearer xxxx}',
- ],
- ],
- 'transportType' => [
+ 'additionalProperties' => ['description' => 'The value of the request header.', 'type' => 'string', 'example' => '{\'Authorization\': Bearer xxxx}', 'title' => ''],
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'sse',
- 'backendName' => 'transportType',
- ],
- 'url' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse',
- 'backendName' => 'url',
+ 'example' => '',
],
],
- 'backendName' => 'mcpServerConfig',
+ 'example' => '',
+ ],
+ 'openApiTools' => [
+ 'title' => 'OpenAPI类型的工具集工具列表，仅当OpenAPI类型的工具集存在该字段',
+ 'description' => 'A list of tools, available only for toolsets of type `OpenAPI`.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Information about an OpenAPI tool.', '$ref' => '#/components/schemas/OpenAPIToolMeta', 'title' => '', 'example' => ''],
+ 'example' => '',
],
'tools' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
+ 'title' => 'MCP类型的工具集工具列表，仅当MCP类型的工具集存在该字段',
+ 'description' => 'A list of tools, available only for toolsets of type `MCP`.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'visibility' => 'Public',
- 'extendType' => 'true',
- '$ref' => '#/components/schemas/MCPToolMeta',
- ],
- 'backendName' => 'tools',
+ 'items' => ['description' => 'Information about an MCP tool.', '$ref' => '#/components/schemas/MCPToolMeta', 'title' => '', 'example' => ''],
+ 'example' => '',
],
- 'functionArn' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'acs:fc:cn-qingdao:0000:functions/aliyun_merchant_login_egistration',
- 'backendName' => 'functionArn',
+ 'difyTools' => [
+ 'title' => 'Dify类型的工具集工具列表，仅当DifyPlugin类型的工具集存在该字段',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/DifyToolSchema', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => 'A list of Dify tools.',
+ 'example' => '',
],
],
- 'backendName' => 'outputs',
- ],
- 'observedTime' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => '2025-07-28T14:03:19Z',
- 'backendName' => 'observedTime',
- ],
- 'observedGeneration' => [
'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- 'backendName' => 'observedGeneration',
+ 'example' => '',
],
+ 'observedGeneration' => ['title' => '资源最近的一次状态更新时的资源generation', 'description' => 'The resource generation observed during the last status update.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'observedTime' => ['title' => '资源最近的一次状态更新时间', 'description' => 'The timestamp of the last status observation.', 'type' => 'string', 'example' => '2025-07-28T14:03:19Z'],
],
+ 'title' => '',
+ 'example' => '',
],
'Variable' => [
- 'title' => '',
- 'description' => '',
+ 'title' => '变量',
+ 'description' => '变量',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'value' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'object_value',
- 'backendName' => 'value',
- ],
- 'name' => [
- 'title' => '',
- 'description' => '',
- 'visibility' => 'Public',
- 'type' => 'string',
- 'example' => 'object_key',
- 'backendName' => 'name',
- ],
+ 'value' => ['title' => '变量的值', 'description' => '变量的值', 'visibility' => 'Public', 'type' => 'any', 'example' => 'object_value', 'backendName' => 'value'],
+ 'sensitive' => ['title' => '变量是否敏感', 'description' => '变量是否敏感', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'sensitive'],
+ 'encrypted' => ['title' => '变量是否被加密', 'description' => '变量是否被加密', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false', 'backendName' => 'encrypted'],
],
],
],
],
'apis' => [
- 'UpdateToolset' => [
- 'summary' => '更新工具集',
- 'path' => '/2023-07-14/toolsets/{name}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ActivateConnection' => [
+ 'path' => '/2023-07-14/connections/{name}/activate',
+ 'methods' => ['patch'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevs6LLJT1',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREdevsTN0KZI'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the connection.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => '计划更新的工具集实体。您指定的可写字段将被更新，未指定的字段将保持不变',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Toolset',
- ],
- ],
- [
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '工具集名称',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'The information required to activate the connection.',
+ 'type' => 'object',
+ 'properties' => [
+ 'account' => ['description' => 'The account information on the code hosting platform.', '$ref' => '#/components/schemas/GitAccount', 'title' => '', 'required' => false, 'example' => ''],
+ 'credential' => ['description' => 'The credential obtained from the OAuth authorization flow. It grants access to the code hosting platform\'s APIs.', '$ref' => '#/components/schemas/OAuthCredential', 'title' => '', 'required' => false, 'example' => ''],
+ ],
'required' => false,
- 'example' => 'my-toolset',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '成功更新后的工具集实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['description' => 'The activated connection.', '$ref' => '#/components/schemas/Connection', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Activate Identity Binding',
+ 'summary' => 'This operation activates a connection. After a user completes the OAuth authorization flow, the development platform activates the specified connection. Third-party code hosting platforms such as GitHub, Gitee, and Codeup use this authorization method.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:ActivateConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"generation\\": 1,\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Toolset\\",\\n \\"name\\": \\"my-toolset\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"schema\\": {\\n \\"type\\": \\"OpenAPI\\",\\n \\"detail\\": \\"\\",\\n \\"config\\": {\\n \\"mcpInstallation\\": {\\n \\"mcpServers\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n }\\n },\\n \\"openAPISchema\\": \\"\\",\\n \\"mcpGateway\\": {\\n \\"routes\\": [\\n {\\n \\"backends\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"details\\": {\\n \\"mcpInstallation\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n },\\n \\"toolsetSelector\\": {\\n \\"toolsetName\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n },\\n \\"openAPISchema\\": \\"\\"\\n }\\n }\\n ],\\n \\"policies\\": {\\n \\"authorization\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n }\\n }\\n }\\n ]\\n }\\n }\\n },\\n \\"authorization\\": {\\n \\"authConfig\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"type\\": \\"apiKey\\"\\n },\\n \\"authConfig\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n },\\n \\"networkConfig\\": {\\n \\"internetAccess\\": true,\\n \\"vpcConfig\\": {\\n \\"vpcId\\": \\"\\",\\n \\"vSwitchIds\\": [\\n \\"\\"\\n ],\\n \\"securityGroupId\\": \\"\\"\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Installed\\",\\n \\"outputs\\": {\\n \\"urls\\": {\\n \\"internetUrl\\": \\"\\",\\n \\"intranetUrl\\": \\"\\"\\n },\\n \\"openApiTools\\": [\\n {\\n \\"toolId\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"method\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n }\\n ],\\n \\"mcpServerConfig\\": {\\n \\"headers\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"transportType\\": \\"\\",\\n \\"url\\": \\"\\"\\n },\\n \\"tools\\": [\\n {\\n \\"inputSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"name\\": \\"demo-tool\\",\\n \\"description\\": \\"Here is an example\\"\\n }\\n ],\\n \\"functionArn\\": \\"\\"\\n },\\n \\"observedTime\\": \\"\\",\\n \\"observedGeneration\\": 0\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Connection\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-connection\\",\\n \\"spec\\": {\\n \\"platform\\": \\"github\\",\\n \\"account\\": {\\n \\"name\\": \\"your_username\\",\\n \\"displayName\\": \\"your_displayname\\",\\n \\"id\\": \\"1\\",\\n \\"avatar\\": \\"https://gitee.com/assets/no_portrait.png\\",\\n \\"uri\\": \\"https://gitlab.com\\"\\n },\\n \\"gitlabConfig\\": {\\n \\"isFixedIP\\": true,\\n \\"uri\\": \\"http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/\\",\\n \\"token\\": \\"your-token\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"installation\\": {\\n \\"stage\\": \\"finished\\",\\n \\"message\\": \\"Please click \'actionUri\' to complete the OAuth authorization process\\",\\n \\"actionUri\\": \\"https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo\\"\\n }\\n }\\n}","type":"json"}]',
],
- 'ListToolsets' => [
- 'summary' => '批量查询工具集',
- 'path' => '/2023-07-14/toolsets',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CancelPipeline' => [
+ 'summary' => 'Cancels the specified pipeline execution and its associated tasks as soon as possible.',
+ 'path' => '/2023-07-14/pipelines/{name}/cancel',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJVP2BW',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'labelSelector',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'keyword',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo',
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '查询的分页结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'pageNumber' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'totalCount' => [
- 'title' => '查询到的结果数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'data' => [
- 'title' => '查询的资源实体列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '查询的一个满足条件的项目实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Toolset',
- ],
- ],
+ 'schema' => ['description' => 'The pipeline execution object.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'title' => 'Cancel pipeline execution',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 10,\\n \\"data\\": [\\n {\\n \\"generation\\": 1,\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Toolset\\",\\n \\"name\\": \\"my-toolset\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"schema\\": {\\n \\"type\\": \\"OpenAPI\\",\\n \\"detail\\": \\"\\",\\n \\"config\\": {\\n \\"mcpInstallation\\": {\\n \\"mcpServers\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n }\\n },\\n \\"openAPISchema\\": \\"\\",\\n \\"mcpGateway\\": {\\n \\"routes\\": [\\n {\\n \\"backends\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"details\\": {\\n \\"mcpInstallation\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n },\\n \\"toolsetSelector\\": {\\n \\"toolsetName\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n },\\n \\"openAPISchema\\": \\"\\"\\n }\\n }\\n ],\\n \\"policies\\": {\\n \\"authorization\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n }\\n }\\n }\\n ]\\n }\\n }\\n },\\n \\"authorization\\": {\\n \\"authConfig\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"type\\": \\"apiKey\\"\\n },\\n \\"authConfig\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n },\\n \\"networkConfig\\": {\\n \\"internetAccess\\": true,\\n \\"vpcConfig\\": {\\n \\"vpcId\\": \\"\\",\\n \\"vSwitchIds\\": [\\n \\"\\"\\n ],\\n \\"securityGroupId\\": \\"\\"\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Installed\\",\\n \\"outputs\\": {\\n \\"urls\\": {\\n \\"internetUrl\\": \\"\\",\\n \\"intranetUrl\\": \\"\\"\\n },\\n \\"openApiTools\\": [\\n {\\n \\"toolId\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"method\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n }\\n ],\\n \\"mcpServerConfig\\": {\\n \\"headers\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"transportType\\": \\"\\",\\n \\"url\\": \\"\\"\\n },\\n \\"tools\\": [\\n {\\n \\"inputSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"name\\": \\"demo-tool\\",\\n \\"description\\": \\"Here is an example\\"\\n }\\n ],\\n \\"functionArn\\": \\"\\"\\n },\\n \\"observedTime\\": \\"\\",\\n \\"observedGeneration\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
],
- 'GetToolset' => [
- 'summary' => '查询工具集',
- 'path' => '/2023-07-14/toolsets/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CancelTask' => [
+ 'summary' => 'Cancels a pipeline task.',
+ 'path' => '/2023-07-14/tasks/{name}/cancel',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJVP2BW',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '工具集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my-toolset',
- ],
+ 'schema' => ['description' => 'The name of the pipeline task.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['description' => 'The details of the pipeline task.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Cancel pipeline job execution',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"generation\\": 1,\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Toolset\\",\\n \\"name\\": \\"my-toolset\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"schema\\": {\\n \\"type\\": \\"OpenAPI\\",\\n \\"detail\\": \\"\\",\\n \\"config\\": {\\n \\"mcpInstallation\\": {\\n \\"mcpServers\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n }\\n },\\n \\"openAPISchema\\": \\"\\",\\n \\"mcpGateway\\": {\\n \\"routes\\": [\\n {\\n \\"backends\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"details\\": {\\n \\"mcpInstallation\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n },\\n \\"toolsetSelector\\": {\\n \\"toolsetName\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n },\\n \\"openAPISchema\\": \\"\\"\\n }\\n }\\n ],\\n \\"policies\\": {\\n \\"authorization\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n }\\n }\\n }\\n ]\\n }\\n }\\n },\\n \\"authorization\\": {\\n \\"authConfig\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"type\\": \\"apiKey\\"\\n },\\n \\"authConfig\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n },\\n \\"networkConfig\\": {\\n \\"internetAccess\\": true,\\n \\"vpcConfig\\": {\\n \\"vpcId\\": \\"\\",\\n \\"vSwitchIds\\": [\\n \\"\\"\\n ],\\n \\"securityGroupId\\": \\"\\"\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Installed\\",\\n \\"outputs\\": {\\n \\"urls\\": {\\n \\"internetUrl\\": \\"\\",\\n \\"intranetUrl\\": \\"\\"\\n },\\n \\"openApiTools\\": [\\n {\\n \\"toolId\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"method\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n }\\n ],\\n \\"mcpServerConfig\\": {\\n \\"headers\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"transportType\\": \\"\\",\\n \\"url\\": \\"\\"\\n },\\n \\"tools\\": [\\n {\\n \\"inputSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"name\\": \\"demo-tool\\",\\n \\"description\\": \\"Here is an example\\"\\n }\\n ],\\n \\"functionArn\\": \\"\\"\\n },\\n \\"observedTime\\": \\"\\",\\n \\"observedGeneration\\": 0\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
],
- 'DeleteToolset' => [
- 'summary' => '删除工具集',
- 'path' => '/2023-07-14/toolsets/{name}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateArtifact' => [
+ 'path' => '/2023-07-14/artifacts',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevs6LLJT1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '工具集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my-toolset',
- ],
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The artifact configuration.', '$ref' => '#/components/schemas/Artifact', 'title' => '', 'required' => false, 'example' => ''],
],
],
- 'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => 'The artifact configuration.', '$ref' => '#/components/schemas/Artifact', 'title' => '', 'example' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
- ],
- 'CreateToolset' => [
- 'summary' => '创建工具集',
- 'path' => '/2023-07-14/toolsets',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Create artifact ',
+ 'summary' => 'Creates an artifact.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateEnvironment' => [
+ 'summary' => 'Creates an environment within a project and optionally deploys it automatically from a template. You deploy services to a specific environment. You can link an environment to a branch in a code repository or to a project template. An environment can also have a dedicated infrastructure stack, which is shared by all services running within it.',
+ 'path' => '/2023-07-14/projects/{projectName}/environments',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJVP2BW',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['description' => 'The environment entity.', '$ref' => '#/components/schemas/Environment', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['title' => 'Project name ', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['description' => 'The environment entity.', '$ref' => '#/components/schemas/Environment', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"generation\\": 1,\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Toolset\\",\\n \\"name\\": \\"my-toolset\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"schema\\": {\\n \\"type\\": \\"OpenAPI\\",\\n \\"detail\\": \\"\\",\\n \\"config\\": {\\n \\"mcpInstallation\\": {\\n \\"mcpServers\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n }\\n },\\n \\"openAPISchema\\": \\"\\",\\n \\"mcpGateway\\": {\\n \\"routes\\": [\\n {\\n \\"backends\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"type\\": \\"\\",\\n \\"details\\": {\\n \\"mcpInstallation\\": {\\n \\"args\\": \\"\\",\\n \\"transportType\\": \\"\\",\\n \\"env\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"url\\": \\"\\",\\n \\"command\\": \\"\\"\\n },\\n \\"toolsetSelector\\": {\\n \\"toolsetName\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n },\\n \\"openAPISchema\\": \\"\\"\\n }\\n }\\n ],\\n \\"policies\\": {\\n \\"authorization\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n }\\n }\\n }\\n ]\\n }\\n }\\n },\\n \\"authorization\\": {\\n \\"authConfig\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"type\\": \\"apiKey\\"\\n },\\n \\"authConfig\\": {\\n \\"type\\": \\"APIKey\\",\\n \\"parameters\\": {\\n \\"apiKeyParameter\\": {\\n \\"encrypted\\": true,\\n \\"in\\": \\"header\\",\\n \\"value\\": \\"mock_value\\",\\n \\"key\\": \\"Authorization\\"\\n }\\n }\\n },\\n \\"networkConfig\\": {\\n \\"internetAccess\\": true,\\n \\"vpcConfig\\": {\\n \\"vpcId\\": \\"\\",\\n \\"vSwitchIds\\": [\\n \\"\\"\\n ],\\n \\"securityGroupId\\": \\"\\"\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Installed\\",\\n \\"outputs\\": {\\n \\"urls\\": {\\n \\"internetUrl\\": \\"\\",\\n \\"intranetUrl\\": \\"\\"\\n },\\n \\"openApiTools\\": [\\n {\\n \\"toolId\\": \\"\\",\\n \\"path\\": \\"\\",\\n \\"method\\": \\"\\",\\n \\"toolName\\": \\"\\"\\n }\\n ],\\n \\"mcpServerConfig\\": {\\n \\"headers\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"transportType\\": \\"\\",\\n \\"url\\": \\"\\"\\n },\\n \\"tools\\": [\\n {\\n \\"inputSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"name\\": \\"demo-tool\\",\\n \\"description\\": \\"Here is an example\\"\\n }\\n ],\\n \\"functionArn\\": \\"\\"\\n },\\n \\"observedTime\\": \\"\\",\\n \\"observedGeneration\\": 0\\n }\\n}","type":"json"}]',
- ],
- 'RenderServicesByTemplate' => [
- 'summary' => '解析模板中的服务、变量配置',
- 'path' => '/2023-07-14/templates/action/renderServices',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'Create Environment ',
+ 'description' => 'Usage notes:'."\n"
+ ."\n"
+ .'- If the `Environment.Spec.TemplateConfig` parameter is not empty, the development platform uses the specified template information to asynchronously deploy the project after the environment is created. This process creates `PipelineTrigger`, `PipelineTriggerEvent`, and `Pipeline` entities.'."\n"
+ ."\n"
+ .'- If the `Environment.Spec.TemplateConfig` parameter is empty, this operation only creates the environment entity. You must then manually complete the deployment by calling the relevant `PipelineTrigger` and `PipelineTriggerEvent` APIs.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'Deploying a project from a template is free of charge. After deployment, the cloud resources specified in the project template are billed according to the pricing of their respective cloud products.'."\n"
+ ."\n"
+ .'></notice>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreatePipeline' => [
+ 'summary' => 'Creates a pipeline execution that runs asynchronously and generates pipeline tasks based on its configuration.',
+ 'path' => '/2023-07-14/pipelines',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '231991',
- 'abilityTreeNodes' => [
- 'FEATUREdevsRH0LAC',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
- 'schema' => [
- 'title' => '模板配置',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'templateName' => [
- 'title' => '模板名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'start-springboot',
- ],
- 'parameters' => [
- 'title' => '模板参数',
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"region":"cn-hangzhou"}',
- ],
- 'variableValues' => [
- 'title' => '模板变量',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/TemplateVariableValueMap',
- ],
- 'serviceNameChanges' => [
- 'title' => '服务名称变化，key是模板原始服务名，value是需要修改的目标服务名',
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"originName": "newName"}',
- 'description' => '',
- 'title' => '修改后的目标服务名称',
- ],
- 'example' => '{"svc1":"svc2"}',
- ],
- 'projectName' => [
- 'title' => '项目名称，用于在已有项目中通过模板新增服务的场景。当指定时，会检测模板中的服务名和指定项目中的服务是否存在命名冲突，如果冲突时会自动生成新的服务名称。',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my-project',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The pipeline execution to create.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'services' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/ServiceConfig',
- 'description' => '',
- 'title' => '服务配置',
- ],
- 'title' => '解析后的服务集合',
- ],
- 'variables' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/Variable',
- 'description' => '',
- 'title' => '变量配置',
- ],
- 'title' => '解析后的变量集合',
- ],
- 'changedServiceNames' => [
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'demo-service',
- 'description' => '',
- 'title' => '原始服务名称',
- ],
- 'title' => '变化后的服务名称。key是新的服务名称，value是原始服务名称。'."\n"
- .'通过这个字段，可以记录模板的原始服务名称，实现部署前的不断修改名称',
- ],
+ 'schema' => ['description' => 'The created pipeline execution.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'title' => 'Create pipeline execution',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreatePipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"changedServiceNames\\": {\\n \\"key\\": \\"demo-service\\"\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
],
- 'FetchArtifactDownloadUrl' => [
- 'summary' => '获取交付物的zip包临时下载地址url',
- 'path' => '/2023-07-14/artifacts/{name}/fetchCode',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateProject' => [
+ 'summary' => 'Creates a project and automatically deploys it if a template configuration is specified.',
+ 'path' => '/2023-07-14/projects',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsQ39RNT',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '交付物名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The project entity.', '$ref' => '#/components/schemas/Project', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '交付物临时下载地址',
- 'description' => '',
- '$ref' => '#/components/schemas/ArtifactCode',
- ],
+ 'schema' => ['description' => 'The created project entity.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"checksum\\": \\"\\",\\n \\"url\\": \\"\\"\\n}","type":"json"}]',
- ],
- 'FetchArtifactTempBucketToken' => [
- 'summary' => '获取交付物临时上传的bucket、object和临时sts',
- 'path' => '/2023-07-14/artifacts/action/fetchTempBucketToken',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'security' => [
+ 'title' => 'Create Project',
+ 'description' => '1. If a template configuration is provided in `Project.Spec.TemplateConfig`, the development platform automatically starts an asynchronous deployment after the project is created. This process creates the `Environment`, `PipelineTrigger`, `PipelineTriggerEvent`, and `Pipeline` entities.'."\n"
+ ."\n"
+ .'2. If `Project.Spec.TemplateConfig` is not specified, the operation creates only the project entity. You must then manually call the `Environment`, `PipelineTrigger`, and `PipelineTriggerEvent` APIs to complete the deployment.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'Deployment from a template is free. After the deployment, the resulting cloud resources are billed according to the pricing of each cloud product.'."\n"
+ ."\n"
+ .'></notice>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'AK' => [],
- ],
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsQ39RNT',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '交付上传临时地址',
- 'description' => '',
- '$ref' => '#/components/schemas/ArtifactTempBucketToken',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ossObjectName\\": \\"\\",\\n \\"ossBucketName\\": \\"\\",\\n \\"ossRegion\\": \\"\\",\\n \\"credentials\\": {\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"securityToken\\": \\"\\"\\n }\\n}","type":"json"}]',
],
- 'GetArtifact' => [
- 'summary' => '查询交付物',
- 'path' => '/2023-07-14/artifacts/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateTask' => [
+ 'path' => '/2023-07-14/tasks',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsQ39RNT',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '交付物名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-artifact',
- ],
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'Specifies the pipeline task to create.', '$ref' => '#/components/schemas/Task', 'title' => '', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '交付物配置',
- 'description' => '',
- '$ref' => '#/components/schemas/Artifact',
- ],
+ 'schema' => ['description' => 'The created pipeline task.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Artifact\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"updatedTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-artifact\\",\\n \\"spec\\": {\\n \\"runtime\\": \\"custom.debian10\\",\\n \\"type\\": \\"FC代码包、工作流yaml\\",\\n \\"uri\\": \\"oss://cn-hangzhou/my-bucket/my.zip\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"resourceVersion\\": 1,\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"size\\": 1024,\\n \\"checksum\\": \\"2825179536350****\\",\\n \\"arn\\": \\"acs:devs:cn-hangzhou:123456:artifacts/my-first-artifact\\"\\n },\\n \\"generation\\": 1\\n}","type":"json"}]',
- ],
- 'PutArtifact' => [
- 'summary' => '更新交付物',
- 'path' => '/2023-07-14/artifacts/{name}',
- 'methods' => [
- 'put',
+ 'title' => 'Create a pipeline job execution',
+ 'summary' => 'Starts a pipeline task.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'CreateToolset' => [
+ 'path' => '/2023-07-14/toolsets',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsQ39RNT',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJVP2BW'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
- 'schema' => [
- 'title' => '交付物配置',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Artifact',
- ],
- ],
- [
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '交付物名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-artifact',
- ],
- ],
- [
- 'name' => 'force',
- 'in' => 'query',
- 'schema' => [
- 'title' => '强制更新',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'The toolset entity.', '$ref' => '#/components/schemas/Toolset', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '交付物配置',
- 'description' => '',
- '$ref' => '#/components/schemas/Artifact',
- ],
+ 'schema' => ['description' => 'The created toolset entity.', '$ref' => '#/components/schemas/Toolset', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Create a tool set ',
+ 'summary' => 'Creates a toolset.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Artifact\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"updatedTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-artifact\\",\\n \\"spec\\": {\\n \\"runtime\\": \\"custom.debian10\\",\\n \\"type\\": \\"FC代码包、工作流yaml\\",\\n \\"uri\\": \\"oss://cn-hangzhou/my-bucket/my.zip\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"resourceVersion\\": 1,\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"size\\": 1024,\\n \\"checksum\\": \\"2825179536350****\\",\\n \\"arn\\": \\"acs:devs:cn-hangzhou:123456:artifacts/my-first-artifact\\"\\n },\\n \\"generation\\": 1\\n}","type":"json"}]',
],
'DeleteArtifact' => [
- 'summary' => '删除交付物',
'path' => '/2023-07-14/artifacts/{name}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsQ39RNT',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsQ39RNT'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '交付物名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-artifact',
- ],
+ 'schema' => ['description' => 'The name of the artifact.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo-artifact'],
],
],
'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete deliverable ',
+ 'summary' => 'Deletes an artifact.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
],
- 'CreateArtifact' => [
- 'summary' => '创建交付物存储',
- 'path' => '/2023-07-14/artifacts',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteConnection' => [
+ 'summary' => 'Deletes a connection.',
+ 'path' => '/2023-07-14/connections/{name}',
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsTN0KZI'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '交付物配置',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Artifact',
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the connection to delete.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to forcibly delete the connection. By default, you cannot delete a connection that is associated with a repository. Set this parameter to `true` to force the deletion.'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'Deleting a connection does not delete any associated repository.'."\n"
+ ."\n"
+ .'></notice>', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '交付物配置',
- 'description' => '',
- '$ref' => '#/components/schemas/Artifact',
+ 'title' => 'Schema of Response',
+ 'description' => 'The data returned for the request.',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A5152937-1C8A-5260-90FA-520CEF028D2D'],
+ ],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Artifact\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"updatedTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-artifact\\",\\n \\"spec\\": {\\n \\"runtime\\": \\"custom.debian10\\",\\n \\"type\\": \\"FC代码包、工作流yaml\\",\\n \\"uri\\": \\"oss://cn-hangzhou/my-bucket/my.zip\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"resourceVersion\\": 1,\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"size\\": 1024,\\n \\"checksum\\": \\"2825179536350****\\",\\n \\"arn\\": \\"acs:devs:cn-hangzhou:123456:artifacts/my-first-artifact\\"\\n },\\n \\"generation\\": 1\\n}","type":"json"}]',
- ],
- 'CreateProject' => [
- 'summary' => 'Creates a project. If a template is specified for the project, the project is automatically deployed.',
- 'path' => '/2023-07-14/projects',
- 'methods' => [
- 'post',
+ 'title' => 'Delete identity binding',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5152937-1C8A-5260-90FA-520CEF028D2D\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteEnvironment' => [
+ 'summary' => 'Deletes a specified environment along with its associated entities in the project, including pipeline triggers, pipeline trigger records, pipeline templates, and pipelines.',
+ 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Project',
- ],
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['title' => 'Project name', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The environment name.', 'type' => 'string', 'required' => true, 'example' => 'demo-env', 'title' => ''],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/Project',
+ 'responses' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete Environment',
+ 'description' => 'Deleting an environment does not currently delete its associated cloud resources. You must delete these resources manually.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Project\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-project\\",\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\"\\n },\\n \\"status\\": {\\n \\"services\\": [\\n {\\n \\"name\\": \\"my-service\\",\\n \\"type\\": \\"fc3\\"\\n }\\n ],\\n \\"isDeleting\\": true\\n }\\n}","type":"json"}]',
- 'title' => 'CreateProject',
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
],
'DeleteProject' => [
- 'summary' => 'Deletes a project and entities in the project, including the environments, pipeline triggers, pipeline trigger events, pipeline templates, and pipelines.',
+ 'summary' => 'Deletes a project and cascades the deletion to all its related entities, including environments, pipeline triggers, pipeline trigger records, pipeline templates, and pipelines.',
'path' => '/2023-07-14/projects/{name}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['delete'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
[
'name' => 'force',
'in' => 'query',
- 'schema' => [
- 'title' => '当项目下不存在任何环境或仅存在一个默认环境时，才允许删除该项目；而force可以强制删除项目并级联删除其下环境',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Specifies whether to forcibly delete a project that contains multiple environments. If this parameter is set to `true`, this operation deletes the project and all its related entities. If this parameter is set to `false` or omitted, the operation fails with an exception. You must first delete the additional environments.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
],
],
'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete Project',
+ 'description' => '1. If a project contains no environments or only the default environment, this operation deletes the project and all its related entities. These entities include pipeline triggers, pipeline trigger records, pipeline templates, and pipelines.'."\n"
+ ."\n"
+ .'2. If a project has multiple environments and the `force` parameter is set to `true`, this operation forcibly deletes the project and all entities in every environment. If `force` is set to `false` or is omitted, the operation fails with an exception. You must first delete the additional environments.'."\n"
+ ."\n"
+ .'> This operation does not delete cloud resources deployed within the project, such as functions and custom domain names.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
- 'title' => 'DeleteProject',
],
- 'UpdateProject' => [
- 'summary' => 'Updates a project. If one or more template parameters are changed, the project is automatically deployed.',
- 'path' => '/2023-07-14/projects/{name}',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteToolset' => [
+ 'summary' => 'Deletes a specified toolset.',
+ 'path' => '/2023-07-14/toolsets/{name}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevs6LLJT1'],
+ 'tenantRelevance' => 'publicInformation',
],
- 'produces' => [
- 'application/json',
+ 'parameters' => [
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the toolset.', 'type' => 'string', 'example' => 'my-toolset', 'title' => '', 'required' => false],
+ ],
+ ],
+ 'responses' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Delete Tool Set ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ ],
+ 'DeployEnvironment' => [
+ 'summary' => 'Triggers a manual environment deployment.',
+ 'path' => '/2023-07-14/projects/{projectName}/environments/{name}/deploy',
+ 'methods' => ['patch'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '计划更新的项目实体内容。您指定的可写字段将被更新，未指定的字段将保持不变',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Project',
- ],
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The environment name.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The deployment options.', '$ref' => '#/components/schemas/DeployEnvironmentOptions', 'title' => '', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '成功更新后的项目实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Project',
- ],
+ 'schema' => ['description' => 'Details of the environment deployment.', '$ref' => '#/components/schemas/EnvironmentDeployment', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Project\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-project\\",\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\"\\n },\\n \\"status\\": {\\n \\"services\\": [\\n {\\n \\"name\\": \\"my-service\\",\\n \\"type\\": \\"fc3\\"\\n }\\n ],\\n \\"isDeleting\\": true\\n }\\n}","type":"json"}]',
- 'title' => 'UpdateProject',
- ],
- 'ListProjects' => [
- 'summary' => 'Queries a list of projects.',
- 'path' => '/2023-07-14/projects',
- 'methods' => [
- 'get',
+ 'title' => 'Deploy environment',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:DeployEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'FetchArtifactDownloadUrl' => [
+ 'path' => '/2023-07-14/artifacts/{name}/fetchCode',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeNodes' => ['FEATUREdevsQ39RNT'],
],
'parameters' => [
[
- 'name' => 'labelSelector',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'templateName=spring-boot-v3',
- ],
- 'required' => false,
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The artifact name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo-name'],
],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始。',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => 'An object that contains the artifact\'s temporary download URL and checksum.', '$ref' => '#/components/schemas/ArtifactCode', 'title' => '', 'example' => ''],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Obtain the temporary download URL of the deliverable ',
+ 'summary' => 'Retrieves a temporary download URL for an artifact\'s ZIP package.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'FetchArtifactTempBucketToken' => [
+ 'summary' => 'Retrieves the `bucket`, `object` path, and temporary Security Token Service (STS) credentials for uploading an `artifact`.',
+ 'path' => '/2023-07-14/artifacts/action/fetchTempBucketToken',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'keyword',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'spring-boot',
- ],
+ 'AK' => [],
],
],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsQ39RNT'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '查询的分页结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'pageNumber' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalCount' => [
- 'title' => '查询到的结果数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'data' => [
- 'title' => '查询的资源实体列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '查询的一个满足条件的项目实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Project',
- ],
- ],
+ 'schema' => ['description' => 'Contains the `object` name, `bucket` name, `region`, and temporary `credentials` for uploading an `artifact`.', '$ref' => '#/components/schemas/ArtifactTempBucketToken', 'title' => '', 'example' => ''],
+ ],
+ [],
+ ],
+ 'title' => 'Obtain temporary upload token for deliverables',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactTempBucketToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"totalCount\\": 1,\\n \\"data\\": [\\n {\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Project\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-project\\",\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\"\\n },\\n \\"status\\": {\\n \\"services\\": [\\n {\\n \\"name\\": \\"my-service\\",\\n \\"type\\": \\"fc3\\"\\n }\\n ],\\n \\"isDeleting\\": true\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListProjects',
],
- 'GetProject' => [
- 'summary' => 'Queries the information about a project.',
- 'path' => '/2023-07-14/projects/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'FetchConnectionCredential' => [
+ 'path' => '/2023-07-14/connections/{name}/fetchCredential',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the connection.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/Project',
- ],
+ 'schema' => ['description' => 'The identity-bound credential.', '$ref' => '#/components/schemas/OAuthCredential', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Obtain identity binding Credential ',
+ 'summary' => 'Retrieves the identity-bound credential created after the authorization flow is complete. The development platform uses this credential to access a third-party code hosting platform.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchConnectionCredential',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Project\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-project\\",\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"spec\\": {\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\"\\n },\\n \\"status\\": {\\n \\"services\\": [\\n {\\n \\"name\\": \\"my-service\\",\\n \\"type\\": \\"fc3\\"\\n }\\n ],\\n \\"isDeleting\\": true\\n }\\n}","type":"json"}]',
- 'title' => 'GetProject',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"token\\": \\"4e84246b6b3962cd3d207aad1ea2f911\\",\\n \\"type\\": \\"bearer\\",\\n \\"scope\\": \\"user_info projects pull_requests hook gists emails\\",\\n \\"expiration\\": 1716263324603,\\n \\"createdTime\\": 1716176924603,\\n \\"refreshToken\\": \\"4d77bfae284770d94ebeed6b0199ebfd65e3943ba4f1e44dc36d792a93ba0d13\\"\\n}","type":"json"}]',
],
- 'DeployEnvironment' => [
- 'summary' => '手动触发环境部署',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}/deploy',
- 'methods' => [
- 'patch',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetArtifact' => [
+ 'summary' => 'Retrieves a specific artifact.',
+ 'path' => '/2023-07-14/artifacts/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsQ39RNT'],
],
- 'produces' => [
- 'application/json',
+ 'parameters' => [
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the artifact.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo-artifact'],
+ ],
],
- 'operationType' => 'readAndWrite',
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => 'Contains details of the artifact.', '$ref' => '#/components/schemas/Artifact', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Query deliverables ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetEnvironment' => [
+ 'summary' => 'Retrieves information about an environment.',
+ 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'projectName',
'in' => 'path',
- 'schema' => [
- 'title' => '所属应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => 'Project name', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
],
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
- ],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/DeployEnvironmentOptions',
- 'title' => '部署环境选项',
- ],
+ 'schema' => ['description' => 'The environment name.', 'type' => 'string', 'required' => true, 'example' => 'demo-env', 'title' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/EnvironmentDeployment',
- 'title' => '环境部署信息',
- ],
+ 'schema' => ['description' => 'The environment entity.', '$ref' => '#/components/schemas/Environment', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"description\\": \\"commit by xxx.\\",\\n \\"kind\\": \\"Deployment\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-deployment\\",\\n \\"status\\": {\\n \\"phase\\": \\"Running\\",\\n \\"pipelineName\\": \\"my-pipeline\\",\\n \\"finishedTime\\": \\"\\",\\n \\"serviceDeployments\\": {\\n \\"key\\": \\"服务部署名称\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"spec\\": {\\n \\"changes\\": {\\n \\"services\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"baseline\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n }\\n },\\n \\"target\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {}\\n },\\n \\"skipRemoveResources\\": false,\\n \\"webhookCodeContext\\": {\\n \\"description\\": \\"my PR decscription\\",\\n \\"message\\": \\"commit message\\",\\n \\"eventType\\": \\"PUSH\\",\\n \\"commitID\\": \\"b1dd9ba168dfef1cb3a1dd608b6054c771a93959\\",\\n \\"branch\\": \\"master\\",\\n \\"sourceBranch\\": \\"master\\",\\n \\"title\\": \\"# FIX\\",\\n \\"tag\\": \\"release-0.0.1\\",\\n \\"prType\\": \\"merged\\",\\n \\"targetBranch\\": \\"master\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/my-namespace/my-repo.git\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query environment',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'GetEnvironmentDeployment' => [
- 'summary' => '查询环境部署信息',
'path' => '/2023-07-14/environmentdeployments/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -4378,823 +2716,630 @@
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境部署名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the environment deployment.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/EnvironmentDeployment',
- 'title' => '环境部署详情',
- ],
+ 'schema' => ['description' => 'Details of the environment deployment.', '$ref' => '#/components/schemas/EnvironmentDeployment', 'title' => '', 'example' => ''],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"description\\": \\"commit by xxx.\\",\\n \\"kind\\": \\"Deployment\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-deployment\\",\\n \\"status\\": {\\n \\"phase\\": \\"Running\\",\\n \\"pipelineName\\": \\"my-pipeline\\",\\n \\"finishedTime\\": \\"\\",\\n \\"serviceDeployments\\": {\\n \\"key\\": \\"服务部署名称\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"spec\\": {\\n \\"changes\\": {\\n \\"services\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"baseline\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n }\\n },\\n \\"target\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {}\\n },\\n \\"skipRemoveResources\\": false,\\n \\"webhookCodeContext\\": {\\n \\"description\\": \\"my PR decscription\\",\\n \\"message\\": \\"commit message\\",\\n \\"eventType\\": \\"PUSH\\",\\n \\"commitID\\": \\"b1dd9ba168dfef1cb3a1dd608b6054c771a93959\\",\\n \\"branch\\": \\"master\\",\\n \\"sourceBranch\\": \\"master\\",\\n \\"title\\": \\"# FIX\\",\\n \\"tag\\": \\"release-0.0.1\\",\\n \\"prType\\": \\"merged\\",\\n \\"targetBranch\\": \\"master\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/my-namespace/my-repo.git\\"\\n }\\n }\\n}","type":"json"}]',
- ],
- 'GetServiceDeployment' => [
- 'summary' => '查询服务部署信息',
- 'path' => '/2023-07-14/servicedeployments/{name}',
- 'methods' => [
- 'get',
+ 'title' => 'Query environment deployment details ',
+ 'summary' => 'Retrieves the details of an environment deployment.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironmentDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetPipeline' => [
+ 'path' => '/2023-07-14/pipelines/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '服务部署名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/ServiceDeployment',
- 'title' => '服务部署详情',
- ],
+ 'schema' => ['description' => 'The pipeline execution.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"description\\": \\"commit by xxx.\\",\\n \\"kind\\": \\"Deployment\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"environmentDeploymentName\\": \\"my-environment-deployment\\",\\n \\"name\\": \\"my-deployment\\",\\n \\"status\\": {\\n \\"phase\\": \\"Running\\",\\n \\"pipelineName\\": \\"my-pipeline\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"taskName\\": \\"my-task\\",\\n \\"message\\": \\"部署失败，被取消\\",\\n \\"webhookCodeContext\\": {\\n \\"description\\": \\"my PR decscription\\",\\n \\"message\\": \\"commit message\\",\\n \\"eventType\\": \\"PUSH\\",\\n \\"commitID\\": \\"b1dd9ba168dfef1cb3a1dd608b6054c771a93959\\",\\n \\"branch\\": \\"master\\",\\n \\"sourceBranch\\": \\"master\\",\\n \\"title\\": \\"# FIX\\",\\n \\"tag\\": \\"release-0.0.1\\",\\n \\"prType\\": \\"merged\\",\\n \\"targetBranch\\": \\"master\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/my-namespace/my-repo.git\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n }\\n}","type":"json"}]',
- ],
- 'ListServiceDeployments' => [
- 'summary' => '批量查询服务部署信息',
- 'path' => '/2023-07-14/servicedeployments',
- 'methods' => [
- 'get',
+ 'title' => 'Query pipeline executions',
+ 'summary' => 'Retrieves a pipeline execution.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'GetProject' => [
+ 'summary' => 'Gets a specified project.',
+ 'path' => '/2023-07-14/projects/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'labelSelector',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '只返回含有这些label的对象',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'label表达式，例如: appName=my-app',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '分页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'keyword',
- 'in' => 'query',
- 'schema' => [
- 'title' => '关键字',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo',
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '返回结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'pageNumber' => [
- 'title' => '分页页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '分页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'totalCount' => [
- 'title' => '总数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'data' => [
- 'title' => '返回结果列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- '$ref' => '#/components/schemas/ServiceDeployment',
- 'title' => '服务部署详情',
- ],
- ],
+ 'schema' => ['description' => 'The project entity.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Query project ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"totalCount\\": 50,\\n \\"data\\": [\\n {\\n \\"uid\\": \\"1455541096***548\\",\\n \\"description\\": \\"commit by xxx.\\",\\n \\"kind\\": \\"Deployment\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"environmentDeploymentName\\": \\"my-environment-deployment\\",\\n \\"name\\": \\"my-deployment\\",\\n \\"status\\": {\\n \\"phase\\": \\"Running\\",\\n \\"pipelineName\\": \\"my-pipeline\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"taskName\\": \\"my-task\\",\\n \\"message\\": \\"部署失败，被取消\\",\\n \\"webhookCodeContext\\": {\\n \\"description\\": \\"my PR decscription\\",\\n \\"message\\": \\"commit message\\",\\n \\"eventType\\": \\"PUSH\\",\\n \\"commitID\\": \\"b1dd9ba168dfef1cb3a1dd608b6054c771a93959\\",\\n \\"branch\\": \\"master\\",\\n \\"sourceBranch\\": \\"master\\",\\n \\"title\\": \\"# FIX\\",\\n \\"tag\\": \\"release-0.0.1\\",\\n \\"prType\\": \\"merged\\",\\n \\"targetBranch\\": \\"master\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/my-namespace/my-repo.git\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
],
- 'PreviewEnvironment' => [
- 'summary' => '预览环境变更信息',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}/preview',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetRepository' => [
+ 'path' => '/2023-07-14/repositories/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsTN0KZI'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'projectName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '项目名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'schema' => ['description' => 'The name of the repository.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/EnvironmentDeploymentSpec',
- ],
+ 'schema' => ['description' => 'The repository binding entity.', '$ref' => '#/components/schemas/Repository', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Query repository binding',
+ 'summary' => 'Retrieves a repository binding entity.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetRepository',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"changes\\": {\\n \\"services\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"baseline\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n }\\n },\\n \\"target\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {}\\n },\\n \\"skipRemoveResources\\": false,\\n \\"webhookCodeContext\\": {\\n \\"description\\": \\"my PR decscription\\",\\n \\"message\\": \\"commit message\\",\\n \\"eventType\\": \\"PUSH\\",\\n \\"commitID\\": \\"b1dd9ba168dfef1cb3a1dd608b6054c771a93959\\",\\n \\"branch\\": \\"master\\",\\n \\"sourceBranch\\": \\"master\\",\\n \\"title\\": \\"# FIX\\",\\n \\"tag\\": \\"release-0.0.1\\",\\n \\"prType\\": \\"merged\\",\\n \\"targetBranch\\": \\"master\\",\\n \\"repoUrl\\": \\"https://codeup.aliyun.com/my-namespace/my-repo.git\\"\\n }\\n}","type":"json"}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Repository\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-repository\\",\\n \\"spec\\": {\\n \\"connectionName\\": \\"awesome-connection\\",\\n \\"cloneUrl\\": \\"https://github.com/DDofDD/start-springboot-lfgy.git\\",\\n \\"platform\\": \\"github\\",\\n \\"id\\": 312649,\\n \\"owner\\": \\"my-org-name\\",\\n \\"displayName\\": \\"my-repo-name\\",\\n \\"webUrl\\": \\"https://github.com/my-org-name/my-repo-name\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\"\\n}","type":"json"}]',
],
- 'CreateEnvironment' => [
- 'summary' => 'Creates an environment. The environment can be automatically deployed based on a template. Cloud services are deployed to the specified environment. The environment can be associated with a branch of a code repository or a project template. You can also configure an infrastructure stack in the environment. The infrastructure stack can be shared by all cloud services in the environment.',
- 'path' => '/2023-07-14/projects/{projectName}/environments',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetServiceDeployment' => [
+ 'path' => '/2023-07-14/servicedeployments/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'schema' => [
- 'title' => '环境实体',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Environment',
- ],
- ],
- [
- 'name' => 'projectName',
+ 'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '项目名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
+ 'schema' => ['description' => 'The name of the service deployment.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '环境实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Environment',
- ],
+ 'schema' => ['description' => 'Details of the service deployment.', '$ref' => '#/components/schemas/ServiceDeployment', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'Query service deployment details ',
+ 'summary' => 'Retrieves information about a service deployment.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetServiceDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"demo-env\\",\\n \\"kind\\": \\"Environment\\",\\n \\"uid\\": \\"1455541096***548\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test env\\",\\n \\"spec\\": {\\n \\"type\\": \\"Testing\\",\\n \\"roleArn\\": \\"acs:ram::*******:role/aliyundevsdefaultrole\\",\\n \\"stagedConfigs\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"status\\": {\\n \\"servicesInstances\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {},\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n },\\n \\"latestEnvironmentDeploymentName\\": \\"\\",\\n \\"servicesWithPendingChanges\\": [\\n \\"服务名称\\"\\n ],\\n \\"observedGeneration\\": 1,\\n \\"observedTime\\": \\"2021-11-19T09:34:38Z\\"\\n },\\n \\"projectName\\": \\"demo-project\\",\\n \\"generation\\": 1\\n}","type":"json"}]',
- 'title' => 'CreateEnvironment',
],
- 'DeleteEnvironment' => [
- 'summary' => 'Deletes an environment in a project and other entities in the environment, including pipeline triggers, pipeline trigger events, pipeline templates, and pipelines.',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetTask' => [
+ 'summary' => 'Retrieves the execution details of a specific pipeline task.',
+ 'path' => '/2023-07-14/tasks/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'high',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'projectName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'schema' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
- 'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => 'The execution details of the pipeline task.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
- 'title' => 'DeleteEnvironment',
- ],
- 'UpdateEnvironment' => [
- 'summary' => 'Updates an environment. If one or more template parameters are changed, the environment is automatically deployed.',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
- 'methods' => [
- 'put',
+ 'title' => 'Query pipeline job execution',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'GetToolset' => [
+ 'summary' => 'Gets a specific toolset.',
+ 'path' => '/2023-07-14/toolsets/{name}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJVP2BW'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'schema' => [
- 'title' => '环境实体。您指定的可写字段将被更新，未指定的字段将保持不变',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Environment',
- ],
- ],
- [
- 'name' => 'projectName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'schema' => ['description' => 'The name of the toolset.', 'type' => 'string', 'example' => 'my-toolset', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '环境实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Environment',
- ],
+ 'schema' => ['description' => 'The toolset object.', '$ref' => '#/components/schemas/Toolset', 'title' => '', 'example' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"demo-env\\",\\n \\"kind\\": \\"Environment\\",\\n \\"uid\\": \\"1455541096***548\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test env\\",\\n \\"spec\\": {\\n \\"type\\": \\"Testing\\",\\n \\"roleArn\\": \\"acs:ram::*******:role/aliyundevsdefaultrole\\",\\n \\"stagedConfigs\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"status\\": {\\n \\"servicesInstances\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {},\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n },\\n \\"latestEnvironmentDeploymentName\\": \\"\\",\\n \\"servicesWithPendingChanges\\": [\\n \\"服务名称\\"\\n ],\\n \\"observedGeneration\\": 1,\\n \\"observedTime\\": \\"2021-11-19T09:34:38Z\\"\\n },\\n \\"projectName\\": \\"demo-project\\",\\n \\"generation\\": 1\\n}","type":"json"}]',
- 'title' => 'UpdateEnvironment',
- ],
- 'ListEnvironments' => [
- 'summary' => 'Queries a list of environments.',
- 'path' => '/2023-07-14/projects/{projectName}/environments/',
- 'methods' => [
- 'get',
+ 'title' => 'Obtain a tool set ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListConnections' => [
+ 'summary' => 'Retrieves a list of connections that match the specified filters.',
+ 'path' => '/2023-07-14/connections',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => [],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsTN0KZI'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'projectName',
- 'in' => 'path',
- 'schema' => [
- 'title' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'labelSelector',
'in' => 'query',
'style' => 'simple',
'schema' => [
- 'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'An array of label selectors to filter results. Returns connections that match all specified labels. Each selector acts as an AND condition.',
'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'branch=main',
- ],
+ 'items' => ['description' => 'A single filter condition in the `labelSelector` array. The format must be `key=value`.', 'type' => 'string', 'example' => 'platform=github'."\n", 'title' => '', 'required' => false],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'pageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number of the results to return. The value must be 1 or greater and defaults to 1 if not specified.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
],
[
'name' => 'pageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The number of results to return on each page. The value must be between 1 and 100 and defaults to 100 if not specified.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100'],
],
[
'name' => 'keyword',
'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dev',
- ],
+ 'schema' => ['description' => 'A keyword for a fuzzy search on the `name` field of the entity. The search is case-insensitive.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'auto-'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '查询的分页结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Paginated query results.',
'type' => 'object',
'properties' => [
- 'pageNumber' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'totalCount' => [
- 'title' => '查询到的结果数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
+ 'pageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'pageSize' => ['description' => 'The number of results on the current page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalCount' => ['description' => 'The total number of results that match the query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
'data' => [
- 'title' => '查询的资源实体列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'An array of `Connection` objects.',
'type' => 'array',
- 'items' => [
- 'title' => '查询的一个满足条件的环境实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Environment',
- ],
+ 'items' => ['description' => 'A `Connection` object that matches the query criteria.', '$ref' => '#/components/schemas/Connection', 'title' => '', 'example' => ''],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 50,\\n \\"totalCount\\": 100,\\n \\"data\\": [\\n {\\n \\"name\\": \\"demo-env\\",\\n \\"kind\\": \\"Environment\\",\\n \\"uid\\": \\"1455541096***548\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test env\\",\\n \\"spec\\": {\\n \\"type\\": \\"Testing\\",\\n \\"roleArn\\": \\"acs:ram::*******:role/aliyundevsdefaultrole\\",\\n \\"stagedConfigs\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"status\\": {\\n \\"servicesInstances\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {},\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n },\\n \\"latestEnvironmentDeploymentName\\": \\"\\",\\n \\"servicesWithPendingChanges\\": [\\n \\"服务名称\\"\\n ],\\n \\"observedGeneration\\": 1,\\n \\"observedTime\\": \\"2021-11-19T09:34:38Z\\"\\n },\\n \\"projectName\\": \\"demo-project\\",\\n \\"generation\\": 1\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListEnvironments',
- ],
- 'GetEnvironment' => [
- 'summary' => 'Queries the information about an environment.',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
- 'methods' => [
- 'get',
+ 'title' => 'Batch query identity bindings',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListConnections',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"totalCount\\": 1,\\n \\"data\\": [\\n {\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Connection\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-connection\\",\\n \\"spec\\": {\\n \\"platform\\": \\"github\\",\\n \\"account\\": {\\n \\"name\\": \\"your_username\\",\\n \\"displayName\\": \\"your_displayname\\",\\n \\"id\\": \\"1\\",\\n \\"avatar\\": \\"https://gitee.com/assets/no_portrait.png\\",\\n \\"uri\\": \\"https://gitlab.com\\"\\n },\\n \\"gitlabConfig\\": {\\n \\"isFixedIP\\": true,\\n \\"uri\\": \\"http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/\\",\\n \\"token\\": \\"your-token\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"installation\\": {\\n \\"stage\\": \\"finished\\",\\n \\"message\\": \\"Please click \'actionUri\' to complete the OAuth authorization process\\",\\n \\"actionUri\\": \\"https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListEnvironments' => [
+ 'path' => '/2023-07-14/projects/{projectName}/environments/',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsXL1PN1',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'projectName',
'in' => 'path',
+ 'schema' => ['title' => 'Project Name ', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
+ ],
+ [
+ 'name' => 'labelSelector',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => '项目名称',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '',
+ 'description' => 'Selectors used to filter environments by their `labels`. Only environments that match all selectors are returned. The selectors are combined by using AND logic.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A filter condition in the `labelSelector` array, in the format `key=value`.', 'type' => 'string', 'example' => 'branch=main', 'title' => '', 'required' => false],
+ 'required' => false,
'example' => 'demo-project',
],
],
[
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number to retrieve, starting from 1. Defaults to 1 if not specified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page. Defaults to 100. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The keyword for a case-insensitive fuzzy search on the `name` field of the entity.', 'type' => 'string', 'example' => 'dev', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '环境实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Environment',
+ 'title' => '',
+ 'description' => 'The paginated results of the query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'pageNumber' => ['description' => 'The current page number. This value starts from 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'pageSize' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''],
+ 'totalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'An array of environment objects.',
+ 'type' => 'array',
+ 'items' => ['description' => 'An environment object.', '$ref' => '#/components/schemas/Environment', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Batch query environments',
+ 'summary' => 'Lists environments that match the specified criteria.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListEnvironments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"demo-env\\",\\n \\"kind\\": \\"Environment\\",\\n \\"uid\\": \\"1455541096***548\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"description\\": \\"test env\\",\\n \\"spec\\": {\\n \\"type\\": \\"Testing\\",\\n \\"roleArn\\": \\"acs:ram::*******:role/aliyundevsdefaultrole\\",\\n \\"stagedConfigs\\": {\\n \\"services\\": {\\n \\"key\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n }\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"status\\": {\\n \\"servicesInstances\\": {\\n \\"key\\": {\\n \\"config\\": {\\n \\"props\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"source\\": {\\n \\"template\\": {\\n \\"downloadUrl\\": \\"https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6\\",\\n \\"name\\": \\"start-springboot-cap\\"\\n },\\n \\"repository\\": {\\n \\"repositoryName\\": \\"my-repository\\",\\n \\"codeVersion\\": {\\n \\"branch\\": \\"main\\",\\n \\"commitID\\": \\"12721ec262d03a93809ba2bbc717963cb298ceca\\"\\n },\\n \\"filter\\": {\\n \\"branch\\": {\\n \\"name\\": \\"master\\"\\n }\\n }\\n },\\n \\"oss\\": {\\n \\"bucket\\": \\"demo-bucket\\",\\n \\"object\\": \\"demo-object\\"\\n }\\n },\\n \\"build\\": {\\n \\"default\\": {\\n \\"cache\\": {\\n \\"driver\\": \\"\\",\\n \\"paths\\": [\\n \\"~/.npm\\"\\n ],\\n \\"keyPath\\": {\\n \\"3C75C832-0EAD-40D6-8FA1-2BA9171C926B\\": \\"~/.npm\\",\\n \\"D256BB7A-1886-4A19-A75B-A1FDC23D5A00\\": \\"~/.cache\\"\\n }\\n },\\n \\"languages\\": [\\n \\"Python3.9\\"\\n ],\\n \\"rootPath\\": \\"./src\\",\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n }\\n },\\n \\"variables\\": {\\n \\"key\\": {\\n \\"value\\": \\"object_value\\",\\n \\"sensitive\\": false,\\n \\"encrypted\\": false\\n }\\n },\\n \\"initialize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"npm build\\\\\\"}\\"\\n ]\\n },\\n \\"type\\": \\"Function\\",\\n \\"finalize\\": {\\n \\"steps\\": [\\n \\"{\\\\\\"run\\\\\\": \\\\\\"echo \'deleted\'\\\\\\"}\\"\\n ]\\n },\\n \\"token\\": \\"9D72DE01-C732-49C0-8E85-FFD9D695436B\\",\\n \\"component\\": \\"fc3@1.0.0\\",\\n \\"artifact\\": {\\n \\"name\\": \\"my-artifact\\",\\n \\"checksum\\": \\"CRC-64 code\\"\\n }\\n },\\n \\"variables\\": {},\\n \\"outputs\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"latestDeployment\\": {\\n \\"name\\": \\"\\",\\n \\"startTime\\": \\"\\",\\n \\"finishedTime\\": \\"\\",\\n \\"phase\\": \\"Running\\"\\n },\\n \\"status\\": \\"\\\\\\"RUNNING\\\\\\"\\",\\n \\"message\\": \\"\\\\\\"OK\\\\\\"\\"\\n }\\n },\\n \\"latestEnvironmentDeploymentName\\": \\"\\",\\n \\"servicesWithPendingChanges\\": [\\n \\"服务名称\\"\\n ],\\n \\"observedGeneration\\": 1,\\n \\"observedTime\\": \\"2021-11-19T09:34:38Z\\"\\n },\\n \\"projectName\\": \\"demo-project\\",\\n \\"generation\\": 1\\n}","type":"json"}]',
- 'title' => 'GetEnvironment',
],
- 'DeleteConnection' => [
- 'summary' => 'Deletes an identity connection.',
- 'path' => '/2023-07-14/connections/{name}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPipelines' => [
+ 'path' => '/2023-07-14/pipelines',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'write',
+ 'consumes' => [],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsTN0KZI',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
- ],
- [
- 'name' => 'force',
+ 'name' => 'labelSelector',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => '若存在其他Repository实体关联了该Connection，则无法直接删除；指定force=true后可以强制删除Connection(但不级联删除Repository)',
- 'description' => '',
- 'type' => 'boolean',
+ 'title' => '',
+ 'description' => 'A selector to filter resources by labels. The API returns only resources that match all specified `key=value` pairs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A single label query in the `key=value` format.', 'type' => 'string', 'example' => 'label_key1=value1', 'title' => '', 'required' => false],
'required' => false,
- 'example' => 'true',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'A5152937-1C8A-5260-90FA-520CEF028D2D',
- ],
- ],
+ 'title' => '',
+ 'description' => 'A list of Pipeline objects.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A Pipeline object.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'example' => ''],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5152937-1C8A-5260-90FA-520CEF028D2D\\"\\n}","type":"json"}]',
- 'title' => 'DeleteConnection',
- ],
- 'ListConnections' => [
- 'summary' => 'Queries a list of identity connections.',
- 'path' => '/2023-07-14/connections',
- 'methods' => [
- 'get',
+ 'title' => 'Batch query pipeline executions ',
+ 'summary' => 'Lists Pipeline resources. Specify query parameters to narrow the results.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListPipelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n }\\n]","type":"json"}]',
+ ],
+ 'ListProjects' => [
+ 'summary' => 'Lists projects that match the specified criteria.',
+ 'path' => '/2023-07-14/projects',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsTN0KZI',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -5203,234 +3348,253 @@
'in' => 'query',
'style' => 'simple',
'schema' => [
- 'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'An array of label selectors to filter projects based on the `labels` field. The operation returns only projects that match all specified selectors. The selectors are combined with a logical AND.',
'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'platform=github'."\n",
- ],
+ 'items' => ['description' => 'A single filter condition in the `labelSelector` array, in the format `key=value`.', 'type' => 'string', 'example' => 'templateName=spring-boot-v3', 'title' => '', 'required' => false],
'required' => false,
+ 'example' => '',
],
],
[
'name' => 'pageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number to return. Defaults to 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
],
[
'name' => 'pageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'The number of projects to return per page. The value must be between 1 and 100. Defaults to 100.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100'],
],
[
'name' => 'keyword',
'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'auto-',
- ],
+ 'schema' => ['description' => 'A keyword for a case-insensitive fuzzy search on the `name` field of projects.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'spring-boot'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '查询的分页结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'A paginated result of the query.',
'type' => 'object',
'properties' => [
- 'pageNumber' => [
- 'title' => '当前页码',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalCount' => [
- 'title' => '查询到的结果数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'pageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'pageSize' => ['description' => 'The number of projects per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'],
+ 'totalCount' => ['description' => 'The total number of matching projects.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
'data' => [
- 'title' => '查询的资源实体列表',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'A list of projects.',
'type' => 'array',
- 'items' => [
- 'title' => '查询的一个满足条件的身份绑定实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Connection',
- ],
+ 'items' => ['description' => 'A Project object.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Batch Query Projects',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"totalCount\\": 1,\\n \\"data\\": [\\n {\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Connection\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-connection\\",\\n \\"spec\\": {\\n \\"platform\\": \\"github\\",\\n \\"account\\": {\\n \\"name\\": \\"your_username\\",\\n \\"displayName\\": \\"your_displayname\\",\\n \\"id\\": \\"1\\",\\n \\"avatar\\": \\"https://gitee.com/assets/no_portrait.png\\",\\n \\"uri\\": \\"https://gitlab.com\\"\\n },\\n \\"gitlabConfig\\": {\\n \\"isFixedIP\\": true,\\n \\"uri\\": \\"http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/\\",\\n \\"token\\": \\"your-token\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"installation\\": {\\n \\"stage\\": \\"finished\\",\\n \\"message\\": \\"Please click \'actionUri\' to complete the OAuth authorization process\\",\\n \\"actionUri\\": \\"https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => 'ListConnections',
- ],
- 'GetRepository' => [
- 'summary' => 'Queries the information about a repository connection.',
- 'path' => '/2023-07-14/repositories/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListProjects',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListServiceDeployments' => [
+ 'summary' => 'Lists service deployments.',
+ 'path' => '/2023-07-14/servicedeployments',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => [],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsTN0KZI',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'name',
- 'in' => 'path',
+ 'name' => 'labelSelector',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'description' => 'Filters service deployments by the specified labels.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A label expression, such as `appName=my-app`.', 'type' => 'string', 'example' => 'label_key1=value1', 'title' => '', 'required' => false],
'required' => false,
- 'example' => 'demo-name',
+ 'example' => '',
],
],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of items to return on each page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The keyword used to filter service deployments.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/Repository',
+ 'title' => '',
+ 'description' => 'The result of the request.',
+ 'type' => 'object',
+ 'properties' => [
+ 'pageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'pageSize' => ['description' => 'The number of items per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
+ 'totalCount' => ['description' => 'The total count of matching items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '50'],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'An array of service deployment objects.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A service deployment object.', '$ref' => '#/components/schemas/ServiceDeployment', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Repository\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-repository\\",\\n \\"spec\\": {\\n \\"connectionName\\": \\"awesome-connection\\",\\n \\"cloneUrl\\": \\"https://github.com/DDofDD/start-springboot-lfgy.git\\",\\n \\"platform\\": \\"github\\",\\n \\"id\\": 312649,\\n \\"owner\\": \\"my-org-name\\",\\n \\"displayName\\": \\"my-repo-name\\",\\n \\"webUrl\\": \\"https://github.com/my-org-name/my-repo-name\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\"\\n}","type":"json"}]',
- 'title' => 'GetRepository',
- ],
- 'CreatePipeline' => [
- 'summary' => 'Creates a pipeline. After you call this operation, the pipeline is executed in asynchronous mode and pipeline tasks are generated based on the pipeline configuration.',
- 'path' => '/2023-07-14/pipelines',
- 'methods' => [
- 'post',
+ 'title' => 'Batch query service deployment information',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListServiceDeployments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTasks' => [
+ 'summary' => 'Lists pipeline task executions.',
+ 'path' => '/2023-07-14/tasks',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => [],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'labelSelector',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => '创建的流水线执行',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The labels used to filter the results. This operation returns only the tasks that match all specified labels. These labels are combined with a logical AND.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A label for filtering, specified in the \'key=value\' format.', 'type' => 'string', 'example' => 'label_key1=value1', 'title' => '', 'required' => false],
'required' => false,
- '$ref' => '#/components/schemas/Pipeline',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '创建的流水线执行',
- 'description' => '',
- '$ref' => '#/components/schemas/Pipeline',
+ 'title' => '',
+ 'description' => 'A list of pipeline tasks.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A pipeline task.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ],\\n \\"contextSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'CreatePipeline',
- ],
- 'ListPipelines' => [
- 'summary' => 'Queries a list of pipelines. We recommend that you specify more query conditions to narrow the query scope.',
- 'path' => '/2023-07-14/pipelines',
- 'methods' => [
- 'get',
+ 'title' => 'Batch query pipeline task executions',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n }\\n]","type":"json"}]',
+ ],
+ 'ListToolsets' => [
+ 'summary' => 'Lists toolsets.',
+ 'path' => '/2023-07-14/toolsets',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsJVP2BW'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
@@ -5438,292 +3602,334 @@
'in' => 'query',
'style' => 'simple',
'schema' => [
- 'title' => '只返回含有这些label的对象',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Filters the list by the `labels` field of each entity. All conditions in the array must match (logical AND).',
'type' => 'array',
- 'items' => [
- 'title' => 'label表达式，例如: appName=my-app',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
+ 'items' => ['description' => 'A filter condition in the `labelSelector` array. The format is ${key}=${value}.', 'type' => 'string', 'example' => 'label_key1=value1', 'title' => '', 'required' => false],
'required' => false,
+ 'example' => '',
],
],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The page number. Pages are 1-indexed. The default is 1.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries per page. The default value is 100. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => 'A keyword for a case-insensitive fuzzy search on the entity\'s `name` field.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '流水线执行列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '流水线执行',
- 'description' => '',
- '$ref' => '#/components/schemas/Pipeline',
+ 'title' => '',
+ 'description' => 'The paginated result of the query.',
+ 'type' => 'object',
+ 'properties' => [
+ 'pageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'],
+ 'pageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
+ 'totalCount' => ['description' => 'The total number of matched toolsets.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
+ 'data' => [
+ 'title' => '',
+ 'description' => 'The list of resource entities returned by the query.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A toolset that matches the query.', '$ref' => '#/components/schemas/Toolset', 'title' => '', 'example' => ''],
+ 'example' => '',
+ ],
],
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ],\\n \\"contextSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n }\\n]","type":"json"}]',
- 'title' => 'ListPipelines',
- ],
- 'GetPipeline' => [
- 'summary' => 'Queries the information about a pipeline.',
- 'path' => '/2023-07-14/pipelines/{name}',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Batch Query Toolset ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListToolsets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PreviewEnvironment' => [
+ 'summary' => 'Gets a preview of changes for an environment.',
+ 'path' => '/2023-07-14/projects/{projectName}/environments/{name}/preview',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'demo-project', 'title' => ''],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The environment name.', 'type' => 'string', 'required' => true, 'example' => 'demo-env', 'title' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['description' => 'The environment deployment specification.', '$ref' => '#/components/schemas/EnvironmentDeploymentSpec', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ],\\n \\"contextSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'GetPipeline',
- ],
- 'StartPipeline' => [
- 'summary' => 'Starts a pipeline.',
- 'path' => '/2023-07-14/pipelines/{name}/start',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Preview environment change information ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:PreviewEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PutArtifact' => [
+ 'summary' => 'Updates an artifact.',
+ 'path' => '/2023-07-14/artifacts/{name}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsQ39RNT'],
],
'parameters' => [
[
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The configuration of the artifact.', '$ref' => '#/components/schemas/Artifact', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the artifact.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo-artifact'],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Forces an update of the artifact.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['description' => 'The configuration of the artifact.', '$ref' => '#/components/schemas/Artifact', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ],\\n \\"contextSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'StartPipeline',
- ],
- 'CancelPipeline' => [
- 'summary' => 'Cancels the execution of a pipeline. After you call this operation, the executions of the pipeline and tasks in the pipeline are canceled at the earliest opportunity.',
- 'path' => '/2023-07-14/pipelines/{name}/cancel',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Update deliverable',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:PutArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PutPipelineStatus' => [
+ 'path' => '/2023-07-14/pipelines/{name}/status',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the pipeline.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => ['description' => 'The object representing the pipeline execution.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Specifies whether to force the update. If set to `true`, the request overwrites the current pipeline regardless of its version.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['description' => 'The object representing the pipeline execution.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ],\\n \\"contextSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'CancelPipeline',
- ],
- 'PutPipelineStatus' => [
- 'summary' => 'Updates the status of a pipeline.',
- 'path' => '/2023-07-14/pipelines/{name}/status',
- 'methods' => [
- 'put',
+ 'title' => 'Replace pipeline execution status',
+ 'summary' => 'Updates the pipeline execution status.',
+ 'description' => 'This API uses optimistic locking to prevent conflicting updates. If you omit the `force` parameter, the request must use the latest pipeline version. Submitting a request with an outdated version causes a conflict error.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutPipelineStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'PutTaskStatus' => [
+ 'summary' => 'Updates the execution status of a pipeline task.',
+ 'path' => '/2023-07-14/tasks/{name}/status',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The pipeline task name.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
[
'name' => 'body',
'in' => 'body',
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['description' => 'The pipeline task object.', '$ref' => '#/components/schemas/Task', 'title' => '', 'required' => false, 'example' => ''],
],
[
'name' => 'force',
'in' => 'query',
- 'schema' => [
- 'title' => '强制更新',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Specifies whether to force the update, which ignores the resource version check.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['description' => 'The pipeline task object.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ],\\n \\"contextSchema\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'PutPipelineStatus',
- ],
- 'CreateTask' => [
- 'summary' => 'Creates a pipeline task.',
- 'path' => '/2023-07-14/tasks',
- 'methods' => [
- 'post',
+ 'title' => 'Replace the execution status of a pipeline Job',
+ 'description' => 'This API uses optimistic locking to prevent conflicting updates. When you update a pipeline task, your request must be based on the most recent resource version. If a newer version exists, the update fails unless you set the `force` parameter to true.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutTaskStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'RenderServicesByTemplate' => [
+ 'summary' => 'Parses service and variable configurations from a template.',
+ 'path' => '/2023-07-14/templates/action/renderServices',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'readAndWrite',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeCode' => '231991',
+ 'abilityTreeNodes' => ['FEATUREdevsRH0LAC'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -5732,596 +3938,1113 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Template configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'templateName' => ['description' => 'Template name', 'type' => 'string', 'required' => true, 'example' => 'start-springboot', 'title' => ''],
+ 'parameters' => ['description' => 'Template parameters', 'type' => 'object', 'required' => false, 'example' => '{"region":"cn-hangzhou"}', 'title' => ''],
+ 'variableValues' => ['description' => 'Template variables', '$ref' => '#/components/schemas/TemplateVariableValueMap', 'title' => '', 'required' => false, 'example' => ''],
+ 'serviceNameChanges' => [
+ 'title' => '',
+ 'description' => 'A map for renaming services. The key is the original service name from the template, and the value is the new service name.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'New service name', 'type' => 'string', 'example' => '{"originName": "newName"}', 'title' => ''],
+ 'example' => '{"svc1":"svc2"}',
+ ],
+ 'projectName' => ['description' => 'The name of the project to which services will be added. When a project name is provided, the operation checks for naming conflicts between services in the template and those already in the project. If a conflict is found, the operation automatically generates a unique service name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'my-project'],
+ ],
'required' => false,
- '$ref' => '#/components/schemas/Task',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '流水线任务',
+ 'type' => 'object',
+ 'properties' => [
+ 'services' => [
+ 'description' => 'A map of the parsed services.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Service configuration', '$ref' => '#/components/schemas/ServiceConfig', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'variables' => [
+ 'description' => 'A map of the parsed variables.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Variable configuration', '$ref' => '#/components/schemas/Variable', 'title' => '', 'example' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'changedServiceNames' => [
+ 'description' => 'A map of changed service names where the key is the new service name and the value is the original service name. This tracking enables you to modify names multiple times before deployment.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Original service name', 'type' => 'string', 'title' => '', 'example' => 'demo-service'],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'description' => '',
- '$ref' => '#/components/schemas/Task',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'CreateTask',
- ],
- 'ListTasks' => [
- 'summary' => 'Queries a list of pipeline tasks.',
- 'path' => '/2023-07-14/tasks',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Parse the service and variable configuration in the template.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:RenderServicesByTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ResumeTask' => [
+ 'path' => '/2023-07-14/tasks/{name}/resume',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'labelSelector',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '只返回含有这些label的对象',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => 'label表达式，例如: appName=my-app',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
- 'required' => false,
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
+ 'schema' => ['description' => 'Represents a pipeline task.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'title' => 'Recover pipeline job execution',
+ 'summary' => 'Resumes the execution of a pipeline task.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:ResumeTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n }\\n]","type":"json"}]',
- 'title' => 'ListTasks',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
],
- 'GetTask' => [
- 'summary' => 'Queries the information about a pipeline task.',
- 'path' => '/2023-07-14/tasks/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RetryTask' => [
+ 'summary' => 'Retries a pipeline task execution.',
+ 'path' => '/2023-07-14/tasks/{name}/retry',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
+ 'schema' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => 'The pipeline task.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'title' => 'Retry pipeline job execution',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:RetryTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'StartPipeline' => [
+ 'summary' => 'Starts a pipeline execution.',
+ 'path' => '/2023-07-14/pipelines/{name}/start',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['description' => 'The pipeline name.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
+ ],
+ ],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
+ 'schema' => ['description' => 'The pipeline execution.', '$ref' => '#/components/schemas/Pipeline', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'title' => 'Start pipeline execution',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'GetTask',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-pipeline-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"templateSpec\\": {\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"tasks\\": [\\n {\\n \\"name\\": \\"task-1\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"taskTemplate\\": \\"serverless-runner\\",\\n \\"runAfters\\": [\\n {\\n \\"name\\": \\"task-1\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"status\\": {\\n \\"phase\\": \\"Success\\",\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Pipeline example.\\",\\n \\"kind\\": \\"Pipeline\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-pipeline\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
],
'StartTask' => [
- 'summary' => 'Starts a pipeline task.',
'path' => '/2023-07-14/tasks/{name}/start',
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsJWJ2XN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
- ],
+ 'schema' => ['description' => 'The task object.', '$ref' => '#/components/schemas/Task', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'StartTask',
- ],
- 'RetryTask' => [
- 'summary' => 'Retries a pipeline task.',
- 'path' => '/2023-07-14/tasks/{name}/retry',
- 'methods' => [
- 'put',
+ 'title' => 'Start pipeline job execution',
+ 'summary' => 'Starts a task execution.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
+ ],
+ 'UpdateEnvironment' => [
+ 'summary' => 'Updates an environment and triggers an automatic deployment when its template parameters change.',
+ 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => ['description' => 'The environment object. This operation updates only the specified writable fields. Unspecified fields remain unchanged.', '$ref' => '#/components/schemas/Environment', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['title' => 'Project name ', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The environment name.', 'type' => 'string', 'required' => true, 'example' => 'demo-env', 'title' => ''],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
- ],
+ 'schema' => ['description' => 'The updated environment object.', '$ref' => '#/components/schemas/Environment', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'RetryTask',
- ],
- 'ResumeTask' => [
- 'summary' => 'Resumes a pipeline task.',
- 'path' => '/2023-07-14/tasks/{name}/resume',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Modify environment ',
+ 'description' => '- This operation updates only the specified writable fields. Unspecified fields remain unchanged.'."\n"
+ ."\n"
+ .'- This operation triggers an automatic deployment only if the template parameters (spec.templateConfig.parameters) change.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UpdateProject' => [
+ 'summary' => 'Updates a project and triggers an automatic deployment if its template parameters change.',
+ 'path' => '/2023-07-14/projects/{name}',
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevsXL1PN1'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The project entity to update. Only specified writable fields are updated; unspecified fields remain unchanged.', '$ref' => '#/components/schemas/Project', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'example' => 'demo-name', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
- ],
+ 'schema' => ['description' => 'The updated project entity.', '$ref' => '#/components/schemas/Project', 'title' => '', 'example' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'ResumeTask',
- ],
- 'CancelTask' => [
- 'summary' => 'Cancels the execution of a pipeline task.',
- 'path' => '/2023-07-14/tasks/{name}/cancel',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => 'Modify a project',
+ 'description' => '1. Only the specified writable fields are updated. Unspecified fields remain unchanged.'."\n"
+ ."\n"
+ .'2. An automatic deployment is triggered only if the template parameters (spec.templateConfig.parameters) change.'."\n"
+ ."\n"
+ .'3. A project can no longer be updated after its default environment configuration is modified using environment-related APIs.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'Project', 'arn' => 'acs:devs:{#regionId}:{#accountId}:project/{#name}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateToolset' => [
+ 'summary' => 'Updates toolset information.',
+ 'path' => '/2023-07-14/toolsets/{name}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
- ],
+ 'abilityTreeNodes' => ['FEATUREdevs6LLJT1'],
+ 'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => 'The toolset entity to update. The operation updates only the writable fields that you specify.', '$ref' => '#/components/schemas/Toolset', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['description' => 'The toolset name.', 'type' => 'string', 'example' => 'my-toolset', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
+ 'schema' => ['description' => 'The updated toolset entity.', '$ref' => '#/components/schemas/Toolset', 'title' => '', 'example' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => 'Update tool set ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'Toolset', 'arn' => 'acs:devs:{#regionId}:{#accountId}:toolset/{#name}'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'CancelTask',
],
- 'PutTaskStatus' => [
- 'summary' => 'Updates the status of a pipeline task.',
- 'path' => '/2023-07-14/tasks/{name}/status',
- 'methods' => [
- 'put',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'devs.cn-shenzhen.aliyuncs.com', 'endpoint' => 'devs.cn-shenzhen.aliyuncs.com', 'vpc' => 'devs-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'devs.cn-beijing.aliyuncs.com', 'endpoint' => 'devs.cn-beijing.aliyuncs.com', 'vpc' => 'devs-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'devs.cn-shanghai.aliyuncs.com', 'endpoint' => 'devs.cn-shanghai.aliyuncs.com', 'vpc' => 'devs-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'devs.ap-southeast-1.aliyuncs.com', 'endpoint' => 'devs.ap-southeast-1.aliyuncs.com', 'vpc' => 'devs-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'devs.cn-hangzhou.aliyuncs.com', 'endpoint' => 'devs.cn-hangzhou.aliyuncs.com', 'vpc' => 'devs-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'devs.us-west-1.aliyuncs.com', 'endpoint' => 'devs.us-west-1.aliyuncs.com', 'vpc' => 'devs-vpc.us-west-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ram' => [
+ 'productCode' => 'Devs',
+ 'productName' => 'Cloud Application Platform',
+ 'ramCodes' => ['devs'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'PutArtifact',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:PutArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'CancelPipeline',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreatePipeline',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreatePipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'DeleteConnection',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'PutTaskStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutTaskStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'ListToolsets',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListToolsets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteToolset',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProject',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'Project', 'arn' => 'acs:devs:{#regionId}:{#accountId}:project/{#name}'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
+ [
+ 'apiName' => 'CreateProject',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/Task',
+ ],
+ [
+ 'apiName' => 'ListProjects',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListProjects',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'force',
- 'in' => 'query',
- 'schema' => [
- 'title' => '强制更新',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ ],
+ [
+ 'apiName' => 'ListConnections',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListConnections',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '',
- '$ref' => '#/components/schemas/Task',
+ [
+ 'apiName' => 'RetryTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:RetryTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"spec\\": {\\n \\"templateName\\": \\"my-task-template\\",\\n \\"context\\": {\\n \\"data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n },\\n \\"status\\": {\\n \\"statusGeneration\\": 123,\\n \\"phase\\": \\"Success\\",\\n \\"executionDetails\\": [\\n \\"step1: start task.\\"\\n ],\\n \\"invocations\\": [\\n {\\n \\"invocationID\\": \\"E099843B-10A2-4936-9964-4E0EE263D564\\",\\n \\"requestID\\": \\"1B3058B1-F1C9-457C-B95C-2C250A4B3118\\",\\n \\"invocationTarget\\": \\"acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx\\",\\n \\"status\\": \\"success\\",\\n \\"output\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"instanceID\\": \\"c-nkj8shz7xxxx\\",\\n \\"slsProject\\": \\"my-sls-project\\",\\n \\"slsLogStore\\": \\"my-sls-logstore\\"\\n }\\n ],\\n \\"latestExecError\\": {\\n \\"title\\": \\"权限不足错误\\",\\n \\"message\\": \\"部署服务[_appcenter-xxx]失败，权限不足\\",\\n \\"code\\": \\"AccessDenied\\",\\n \\"requestId\\": \\"1-26d1287xxxxx\\",\\n \\"extraInfo\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题。https://help.aliyun.com\\"\\n }\\n },\\n \\"uid\\": \\"1455541096***548\\",\\n \\"generation\\": 1,\\n \\"description\\": \\"Task example.\\",\\n \\"kind\\": \\"Task\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-task\\",\\n \\"labels\\": {\\n \\"key\\": \\"value to the label key.\\"\\n },\\n \\"resourceVersion\\": 1\\n}","type":"json"}]',
- 'title' => 'PutTaskStatus',
- ],
- 'ActivateConnection' => [
- 'summary' => 'Activates an identity connection. After you click the URL in the status parameter of the identity connection to complete the Open Authorization (OAuth) authorization, you can call this operation to activate the identity connection. Third-party code hosting platforms that support OAuth authorization include GitHub, Gitee, and Codeup.',
- 'path' => '/2023-07-14/connections/{name}/activate',
- 'methods' => [
- 'patch',
+ [
+ 'apiName' => 'UpdateToolset',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'Toolset', 'arn' => 'acs:devs:{#regionId}:{#accountId}:toolset/{#name}'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListPipelines',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListPipelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'PreviewEnvironment',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:PreviewEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'GetPipeline',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'GetToolset',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DeleteProject',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchArtifactTempBucketToken',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactTempBucketToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEnvironment',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteArtifact',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ActivateConnection',
+ 'description' => '',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsTN0KZI',
+ 'ramAction' => [
+ 'action' => 'devs:ActivateConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
+ [
+ 'apiName' => 'GetServiceDeployment',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetServiceDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'title' => '激活内容',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'account' => [
- 'title' => '代码托管平台中的账号信息',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/GitAccount',
- ],
- 'credential' => [
- 'title' => '完成OAuth授权流程后获取的凭证信息，使用该凭证可以访问代码托管平台相关API',
- 'description' => '',
- 'required' => false,
- '$ref' => '#/components/schemas/OAuthCredential',
- ],
- ],
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'GetTask',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '激活后的身份绑定实体',
- 'description' => '',
- '$ref' => '#/components/schemas/Connection',
+ [
+ 'apiName' => 'CreateEnvironment',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"uid\\": \\"1455541096***548\\",\\n \\"kind\\": \\"Connection\\",\\n \\"createdTime\\": \\"2021-11-19T09:34:38Z\\",\\n \\"name\\": \\"my-connection\\",\\n \\"spec\\": {\\n \\"platform\\": \\"github\\",\\n \\"account\\": {\\n \\"name\\": \\"your_username\\",\\n \\"displayName\\": \\"your_displayname\\",\\n \\"id\\": \\"1\\",\\n \\"avatar\\": \\"https://gitee.com/assets/no_portrait.png\\",\\n \\"uri\\": \\"https://gitlab.com\\"\\n },\\n \\"gitlabConfig\\": {\\n \\"isFixedIP\\": true,\\n \\"uri\\": \\"http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/\\",\\n \\"token\\": \\"your-token\\"\\n }\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"description\\": \\"test-description\\",\\n \\"status\\": {\\n \\"installation\\": {\\n \\"stage\\": \\"finished\\",\\n \\"message\\": \\"Please click \'actionUri\' to complete the OAuth authorization process\\",\\n \\"actionUri\\": \\"https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => 'ActivateConnection',
- ],
- 'FetchConnectionCredential' => [
- 'summary' => 'Queries the credential of an identity connection for authorization. The credential is used to access a third-party code hosting platform.',
- 'path' => '/2023-07-14/connections/{name}/fetchCredential',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'ResumeTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:ResumeTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListServiceDeployments',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListServiceDeployments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetEnvironment',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'ListTasks',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'CreateArtifact',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'StartPipeline',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRepository',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
+ 'ramAction' => [
+ 'action' => 'devs:GetRepository',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
+ [
+ 'apiName' => 'CreateToolset',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '',
- '$ref' => '#/components/schemas/OAuthCredential',
+ [
+ 'apiName' => 'GetProject',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEnvironmentDeployment',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironmentDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchConnectionCredential',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchConnectionCredential',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchArtifactDownloadUrl',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenderServicesByTemplate',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:RenderServicesByTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateEnvironment',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PutPipelineStatus',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutPipelineStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTask',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetArtifact',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelTask',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeployEnvironment',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:DeployEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEnvironments',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListEnvironments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"token\\": \\"4e84246b6b3962cd3d207aad1ea2f911\\",\\n \\"type\\": \\"bearer\\",\\n \\"scope\\": \\"user_info projects pull_requests hook gists emails\\",\\n \\"expiration\\": 1716263324603,\\n \\"createdTime\\": 1716176924603,\\n \\"refreshToken\\": \\"4d77bfae284770d94ebeed6b0199ebfd65e3943ba4f1e44dc36d792a93ba0d13\\"\\n}","type":"json"}]',
- 'title' => 'FetchConnectionCredential',
],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'devs.cn-hangzhou.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:devs:{#regionId}:{#accountId}:project/{#name}'],
+ ['validationType' => 'always', 'resourceType' => 'Toolset', 'arn' => 'acs:devs:{#regionId}:{#accountId}:toolset/{#name}'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 20:59:08 +0000