summaryrefslogtreecommitdiff
path: root/data/zh_cn/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/zh_cn/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/zh_cn/devs/2023-07-14/api-docs.php')
-rw-r--r--data/zh_cn/devs/2023-07-14/api-docs.php12539
1 files changed, 3193 insertions, 9346 deletions
diff --git a/data/zh_cn/devs/2023-07-14/api-docs.php b/data/zh_cn/devs/2023-07-14/api-docs.php
index afcae38..6cbd6f6 100644
--- a/data/zh_cn/devs/2023-07-14/api-docs.php
+++ b/data/zh_cn/devs/2023-07-14/api-docs.php
@@ -1,126 +1,60 @@
<?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' => '工具集',
+ 'children' => ['UpdateToolset', 'ListToolsets', 'GetToolset', 'DeleteToolset', 'CreateToolset'],
'type' => 'directory',
- 'children' => [
- 'UpdateToolset',
- 'ListToolsets',
- 'GetToolset',
- 'DeleteToolset',
- 'CreateToolset',
- ],
+ 'title' => '工具集',
+ 'id' => 136668,
],
[
- 'id' => 204324,
- 'title' => '模板',
+ 'children' => ['RenderServicesByTemplate'],
'type' => 'directory',
- 'children' => [
- 'RenderServicesByTemplate',
- ],
+ 'title' => '模板',
+ 'id' => 136656,
],
[
- 'id' => 204326,
- 'title' => '制品',
+ 'children' => ['FetchArtifactDownloadUrl', 'FetchArtifactTempBucketToken', 'GetArtifact', 'PutArtifact', 'DeleteArtifact', 'CreateArtifact'],
'type' => 'directory',
- 'children' => [
- 'FetchArtifactDownloadUrl',
- 'FetchArtifactTempBucketToken',
- 'GetArtifact',
- 'PutArtifact',
- 'DeleteArtifact',
- 'CreateArtifact',
- ],
+ 'title' => '制品',
+ 'id' => 136658,
],
[
- 'id' => 190560,
- 'title' => '项目',
+ 'children' => ['DeployEnvironment', 'GetEnvironmentDeployment', 'GetServiceDeployment', 'ListServiceDeployments', 'PreviewEnvironment', 'CreateEnvironment', 'DeleteEnvironment', 'UpdateEnvironment', 'ListEnvironments', 'GetEnvironment'],
'type' => 'directory',
- 'children' => [
- 'CreateProject',
- 'DeleteProject',
- 'UpdateProject',
- 'ListProjects',
- 'GetProject',
- ],
- ],
- [
- 'id' => 190562,
'title' => '环境',
- 'type' => 'directory',
- 'children' => [
- 'DeployEnvironment',
- 'GetEnvironmentDeployment',
- 'GetServiceDeployment',
- 'ListServiceDeployments',
- 'PreviewEnvironment',
- 'CreateEnvironment',
- 'DeleteEnvironment',
- 'UpdateEnvironment',
- 'ListEnvironments',
- 'GetEnvironment',
- ],
+ 'id' => 136624,
],
[
- 'id' => 190564,
- 'title' => '身份绑定',
+ 'children' => ['DeleteConnection', 'ListConnections'],
'type' => 'directory',
- 'children' => [
- 'DeleteConnection',
- 'ListConnections',
- ],
+ 'title' => '身份绑定',
+ 'id' => 136635,
],
[
- 'id' => 190567,
- 'title' => '仓库绑定',
+ 'children' => ['GetRepository'],
'type' => 'directory',
- 'children' => [
- 'GetRepository',
- ],
+ 'title' => '仓库绑定',
+ 'id' => 136638,
],
[
- 'id' => 190596,
- 'title' => '流水线',
+ 'children' => ['CreatePipeline', 'ListPipelines', 'GetPipeline', 'StartPipeline', 'CancelPipeline', 'PutPipelineStatus'],
'type' => 'directory',
- 'children' => [
- 'CreatePipeline',
- 'ListPipelines',
- 'GetPipeline',
- 'StartPipeline',
- 'CancelPipeline',
- 'PutPipelineStatus',
- ],
+ 'title' => '流水线',
+ 'id' => 136640,
],
[
- 'id' => 190601,
- 'title' => '流水线任务',
+ 'children' => ['CreateTask', 'ListTasks', 'GetTask', 'StartTask', 'RetryTask', 'ResumeTask', 'CancelTask', 'PutTaskStatus'],
'type' => 'directory',
- 'children' => [
- 'CreateTask',
- 'ListTasks',
- 'GetTask',
- 'StartTask',
- 'RetryTask',
- 'ResumeTask',
- 'CancelTask',
- 'PutTaskStatus',
- ],
+ 'title' => '流水线任务',
+ 'id' => 136647,
],
[
- 'id' => 208980,
- 'title' => '其他',
+ 'children' => ['ActivateConnection', 'FetchConnectionCredential', 'CreateProject', 'DeleteProject', 'GetProject', 'ListProjects', 'UpdateProject'],
'type' => 'directory',
- 'children' => [
- 'ActivateConnection',
- 'FetchConnectionCredential',
- ],
+ 'title' => '其他',
+ 'id' => 136665,
],
],
'components' => [
@@ -129,214 +63,15 @@
'title' => 'API Key鉴权参数',
'type' => 'object',
'properties' => [
- 'encrypted' => [
- 'title' => 'API Key加密状态，只读',
- 'type' => 'boolean',
- ],
'in' => [
'title' => '鉴权API key所在HTTP请求位置',
'type' => 'string',
'example' => 'header',
- 'enum' => [
- 'header',
- 'query',
- ],
- ],
- 'value' => [
- 'title' => 'API Key的值',
- 'type' => 'string',
- 'example' => 'mock_value',
- ],
- 'key' => [
- 'title' => '鉴权使用的API Key ',
- 'type' => 'string',
- 'example' => 'Authorization',
- ],
- ],
- ],
- 'Artifact' => [
- 'title' => '交付物',
- 'description' => '交付物',
- 'type' => 'object',
- 'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源类型的名称，只读',
- 'type' => 'string',
- 'example' => 'Artifact',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'updatedTime' => [
- 'title' => '表示最后更新此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前交付物的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-artifact',
- 'maxLength' => 64,
- 'minLength' => 1,
- 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_-]{0,63}$',
- ],
- 'spec' => [
- 'title' => '交付物配置',
- 'required' => false,
- '$ref' => '#/components/schemas/ArtifactSpec',
- ],
- 'labels' => [
- 'title' => '交付物的标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- ],
- 'resourceVersion' => [
- 'title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'description' => [
- 'title' => '描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
- ],
- 'status' => [
- 'title' => '当前交付物的状态信息，只读',
- '$ref' => '#/components/schemas/ArtifactStatus',
- ],
- 'generation' => [
- 'title' => '当前交付物的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'ArtifactCode' => [
- 'title' => '交付物内容下载信息',
- 'type' => 'object',
- 'properties' => [
- 'checksum' => [
- 'title' => '交付物内容CRC64 值',
- 'type' => 'string',
- ],
- 'url' => [
- 'title' => '交付物内容临时下载URL',
- 'type' => 'string',
- ],
- ],
- ],
- 'ArtifactMeta' => [
- 'title' => '产物的元数据内容，能唯一标识一个产物',
- 'description' => '产物的元数据内容',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '产物的名称',
- 'type' => 'string',
- 'example' => 'my-artifact',
- ],
- 'checksum' => [
- 'title' => '产物的CRC-64校验和。如果指定，则只有当制品当前的校验和指定的相同时才进行部署。',
- 'type' => 'string',
- 'example' => 'CRC-64 code',
- ],
- ],
- ],
- 'ArtifactSpec' => [
- 'title' => '交付物配置',
- 'type' => 'object',
- 'properties' => [
- 'runtime' => [
- 'title' => '交付物函数runtime',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'custom.debian10',
- ],
- 'type' => [
- 'title' => '交付物类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC代码包、工作流yaml',
- ],
- 'uri' => [
- 'title' => '交付物的输入资源定位符，比如 oss 地址为 oss://{region}/{bucketName}/{objectName}',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://cn-hangzhou/my-bucket/my.zip',
- ],
- ],
- ],
- 'ArtifactStatus' => [
- 'title' => '交付物的状态',
- 'type' => 'object',
- 'properties' => [
- 'size' => [
- 'title' => '交付物的大小的， 单位为Byte',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1024',
- ],
- 'checksum' => [
- 'title' => '交付物的CRC-64 值',
- 'type' => 'string',
- 'example' => '2825179536350****',
- ],
- 'arn' => [
- 'title' => '交付物资源标识',
- 'type' => 'string',
- 'example' => 'acs:devs:cn-hangzhou:123456:artifacts/my-first-artifact',
- ],
- ],
- ],
- 'ArtifactTempBucketToken' => [
- 'title' => '交付物上传临时sts 和 bucket/object',
- 'type' => 'object',
- 'properties' => [
- 'ossObjectName' => [
- 'title' => '交付物上传临时bucket',
- 'type' => 'string',
- ],
- 'ossBucketName' => [
- 'title' => '交付物上传临时object',
- 'type' => 'string',
- ],
- 'ossRegion' => [
- 'title' => '交付物上传区域',
- 'type' => 'string',
- ],
- 'credentials' => [
- 'title' => '交付物上传临时sts',
- 'type' => 'object',
- 'properties' => [
- 'accessKeyId' => [
- 'title' => '交付物上传临时accessKeyId',
- 'type' => 'string',
- ],
- 'accessKeySecret' => [
- 'title' => '交付物上传临时accessKeySecret',
- 'type' => 'string',
- ],
- 'securityToken' => [
- 'title' => '交付物上传临时securityToken',
- 'type' => 'string',
- ],
- ],
+ 'enum' => ['header', 'query'],
],
+ 'key' => ['title' => '鉴权使用的API Key ', 'type' => 'string', 'example' => 'Authorization'],
+ 'value' => ['title' => 'API Key的值', 'type' => 'string', 'example' => 'mock_value'],
+ 'encrypted' => ['title' => 'API Key加密状态，只读', 'type' => 'boolean'],
],
],
'Authorization' => [
@@ -348,177 +83,100 @@
'type' => 'string',
'required' => true,
'example' => 'APIKey',
- 'enum' => [
- 'APIKey',
- ],
+ 'enum' => ['APIKey', 'Credentials'],
],
'parameters' => [
'title' => '鉴权请求参数',
'type' => 'object',
'properties' => [
- 'apiKeyParameter' => [
- 'title' => 'API Key鉴权参数',
- '$ref' => '#/components/schemas/APIKeyAuthParameter',
+ 'apiKeyParameter' => ['title' => 'API Key鉴权参数', '$ref' => '#/components/schemas/APIKeyAuthParameter'],
+ 'credentials' => [
+ 'title' => '访问凭证',
+ 'type' => 'object',
+ 'additionalProperties' => ['$ref' => '#/components/schemas/Variable'],
],
],
'required' => true,
],
],
],
- 'BranchFilter' => [
- 'title' => '分支过滤规则',
- 'description' => '分支过滤规则',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '目标分支发生变更则触发',
- 'type' => 'string',
- 'example' => 'master',
- ],
- ],
- ],
- 'BuildCacheConfig' => [
- 'title' => '构建时的缓存配置，拉取代码后，缓存文件会被放入指定位置，任务成功后，缓存文件将被更新',
- 'description' => '构建缓存配置',
- 'type' => 'object',
- 'properties' => [
- 'paths' => [
- 'title' => '需要缓存的路径',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => '~/.npm',
- ],
- ],
- 'keyPath' => [
- 'title' => '缓存唯一标识符与缓存路径的映射关系，可以由系统自动生成',
- 'type' => 'object',
- 'example' => '{ "3C75C832-0EAD-40D6-8FA1-2BA9171C926B": "~/.npm", "D256BB7A-1886-4A19-A75B-A1FDC23D5A00": "~/.cache" }',
- ],
- ],
- ],
- 'BuildConfig' => [
- 'title' => '描述一个服务的代码应该如何被构建',
- 'description' => '构架配置',
- 'type' => 'object',
- 'properties' => [
- 'default' => [
- 'title' => '基于默认构建器的构建配置',
- '$ref' => '#/components/schemas/DefaultBuilderConfig',
- ],
- ],
- ],
'Checkout' => [
'title' => '代码拉取信息',
'description' => '拉取代码所需信息',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'remote' => [
- 'title' => '拉取代码时所需的仓库信息',
- 'description' => '拉取代码时所需的仓库信息',
- 'type' => 'string',
- 'example' => 'https:/your_token/@github.com/buptwzj/test-initRepo4.git',
- ],
- 'ref' => [
- 'title' => '拉取代码时所需的版本信息',
- 'description' => '拉取代码时所需的版本信息',
- 'type' => 'string',
- 'example' => '+001691d0768ca49e9550beeb59fbc163f33b7e88:refs/remotes/origin/master',
- ],
+ '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'],
],
],
- 'CodeVersionReference' => [
- 'title' => '代码版本引用',
- 'description' => '代码版本引用',
- 'type' => 'object',
- 'properties' => [
- 'branch' => [
- 'title' => '仓库分支名称',
- 'type' => 'string',
- 'example' => 'main',
- ],
- 'commitID' => [
- 'title' => '仓库分支中某个commit的SHA值，为空时使用当前分支中最新的commit',
- 'type' => 'string',
- 'example' => '12721ec262d03a93809ba2bbc717963cb298ceca',
- ],
+ 'CodeupEventPayload' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Code流水线触发事件消息体',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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' => [
- 'type' => 'string',
- ],
- 'kind' => [
- 'type' => 'string',
- ],
- 'uid' => [
- 'type' => 'string',
- ],
- 'createdTime' => [
- 'type' => 'string',
- ],
- 'description' => [
- 'type' => 'string',
- ],
- 'spec' => [
- '$ref' => '#/components/schemas/ComfyUIWorkflowTemplateSpec',
- ],
+ 'name' => ['type' => 'string'],
+ 'kind' => ['type' => 'string'],
+ 'uid' => ['type' => 'string'],
+ 'createdTime' => ['type' => 'string'],
+ 'description' => ['type' => 'string'],
+ 'spec' => ['$ref' => '#/components/schemas/ComfyUIWorkflowTemplateSpec'],
+ 'installCount' => ['type' => 'integer', 'format' => 'int32'],
+ 'viewerUids' => ['type' => 'string'],
'labels' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'installCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
'ComfyUIWorkflowTemplateSpec' => [
'type' => 'object',
'properties' => [
- 'displayName' => [
- 'type' => 'string',
- ],
+ 'displayName' => ['type' => 'string'],
'author' => [
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
- 'type' => [
- 'type' => 'string',
- ],
- 'avatarUrl' => [
- 'type' => 'string',
- ],
+ 'name' => ['type' => 'string'],
+ 'type' => ['type' => 'string'],
+ 'avatarUrl' => ['type' => 'string'],
],
],
'coverUrls' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string'],
],
'versions' => [
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
- 'snapshotName' => [
- 'type' => 'string',
- ],
+ 'snapshotName' => ['type' => 'string'],
'flows' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
+ 'name' => ['type' => 'string'],
],
],
],
@@ -527,31 +185,19 @@
'items' => [
'type' => 'object',
'properties' => [
- 'path' => [
- 'type' => 'string',
- ],
- 'name' => [
- 'type' => 'string',
- ],
- 'size' => [
- 'type' => 'string',
- ],
+ 'path' => ['type' => 'string'],
+ 'name' => ['type' => 'string'],
+ 'size' => ['type' => 'string'],
'source' => [
'type' => 'object',
'properties' => [
- 'type' => [
- 'type' => 'string',
- ],
- 'webUrl' => [
- 'type' => 'string',
- ],
+ 'type' => ['type' => 'string'],
+ 'webUrl' => ['type' => 'string'],
],
],
'downloadUrls' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -561,32 +207,20 @@
'items' => [
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
+ 'name' => ['type' => 'string'],
'version' => [
'type' => 'object',
'properties' => [
- 'type' => [
- 'type' => 'string',
- ],
- 'value' => [
- 'type' => 'string',
- ],
+ 'type' => ['type' => 'string'],
+ 'value' => ['type' => 'string'],
],
],
'source' => [
'type' => 'object',
'properties' => [
- 'type' => [
- 'type' => 'string',
- ],
- 'webUrl' => [
- 'type' => 'string',
- ],
- 'cloneUrl' => [
- 'type' => 'string',
- ],
+ 'type' => ['type' => 'string'],
+ 'webUrl' => ['type' => 'string'],
+ 'cloneUrl' => ['type' => 'string'],
],
],
],
@@ -597,174 +231,41 @@
],
'publishedVersions' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'ComfyUIWorkflowTemplateTask' => [
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
- 'kind' => [
- 'type' => 'string',
- ],
- 'uid' => [
- 'type' => 'string',
- ],
- 'createdTime' => [
- 'type' => 'string',
- ],
- 'description' => [
- 'type' => 'string',
- ],
- 'spec' => [
- '$ref' => '#/components/schemas/ComfyUIWorkflowTemplateTaskSpec',
- ],
- 'status' => [
- '$ref' => '#/components/schemas/ComfyUIWorkflowTemplateTaskStatus',
- ],
- 'labels' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'ComfyUIWorkflowTemplateTaskSpec' => [
- 'type' => 'object',
- 'properties' => [
- 'templateName' => [
- 'type' => 'string',
- ],
- 'region' => [
- 'type' => 'string',
- ],
- 'projectName' => [
- 'type' => 'string',
- ],
- 'devFunctionName' => [
- 'type' => 'string',
- ],
- 'installConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'version' => [
- 'type' => 'string',
- ],
- 'autoInstall' => [
- 'type' => 'boolean',
- ],
- 'template' => [
- '$ref' => '#/components/schemas/ComfyUIWorkflowTemplateSpec',
- ],
- ],
- ],
- ],
- ],
- 'ComfyUIWorkflowTemplateTaskStatus' => [
- 'type' => 'object',
- 'properties' => [
- 'install' => [
- 'type' => 'object',
- 'properties' => [
- 'phase' => [
- 'type' => 'string',
- ],
- 'invocationID' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'startTime' => [
- 'type' => 'string',
- ],
- 'finishedTime' => [
- 'type' => 'string',
- ],
- ],
+ 'items' => ['type' => 'string'],
],
],
],
'Condition' => [
'title' => '执行条件',
'description' => '执行条件',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'expression' => [
- 'title' => '返回值为bool类型的表达式',
- 'description' => '返回值为bool类型的表达式',
- 'type' => 'string',
- 'example' => 'enable == true'."\n"
- .'-- 表示ctx.data.enable的值为true时为真',
- ],
+ 'expression' => ['title' => '返回值为bool类型的表达式', 'description' => '返回值为bool类型的表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => 'enable == true'."\n"
+ .'-- 表示ctx.data.enable的值为true时为真', 'backendName' => 'expression'],
],
],
'Connection' => [
'title' => '身份绑定',
'description' => '项目',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Connection',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-connection',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
- 'spec' => [
- 'title' => '身份绑定配置',
- 'description' => '身份绑定配置',
- 'required' => true,
- '$ref' => '#/components/schemas/ConnectionSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- ],
- 'description' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
- ],
- 'status' => [
- 'title' => '当前资源的状态信息，只读',
- 'description' => '当前资源的状态信息，只读',
- '$ref' => '#/components/schemas/ConnectionStatus',
+ 'additionalProperties' => ['visibility' => 'Public', 'type' => 'string', 'example' => 'key=value'],
+ 'backendName' => 'labels',
],
+ 'description' => ['title' => '描述信息', 'description' => '描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test-description', 'backendName' => 'description'],
+ 'status' => ['title' => '当前资源的状态信息，只读', 'description' => '当前资源的状态信息，只读', 'visibility' => 'Public', 'backendName' => 'status', '$ref' => '#/components/schemas/ConnectionStatus'],
],
],
'ConnectionSpec' => [
@@ -772,3590 +273,96 @@
'description' => '仓库配置',
'type' => 'object',
'properties' => [
- 'platform' => [
- 'title' => '第三方代码托管平台类型，目前支持：github/gitee/gitlab/codeup',
- 'description' => '第三方代码托管平台类型，目前支持：github/gitee/gitlab/codeup',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'github',
- ],
- 'account' => [
- 'title' => '代码托管平台账号相关的信息',
- 'description' => '代码托管平台账号相关的信息',
- '$ref' => '#/components/schemas/GitAccount',
- ],
- 'gitlabConfig' => [
- 'title' => '连接GitLab代码托管平台所需配置',
- 'description' => '连接GitLab代码托管平台所需配置',
- '$ref' => '#/components/schemas/GitLabConfig',
- ],
+ 'platform' => ['title' => '第三方代码托管平台类型，目前支持：github/gitee/gitlab/codeup', 'description' => '第三方代码托管平台类型，目前支持：github/gitee/gitlab/codeup', 'type' => 'string', 'required' => true, 'example' => 'github'],
+ 'account' => ['title' => '代码托管平台账号相关的信息', 'description' => '代码托管平台账号相关的信息', '$ref' => '#/components/schemas/GitAccount'],
+ 'gitlabConfig' => ['title' => '连接GitLab代码托管平台所需配置', 'description' => '连接GitLab代码托管平台所需配置', '$ref' => '#/components/schemas/GitLabConfig'],
],
],
'ConnectionStatus' => [
'title' => '身份绑定状态',
'description' => '身份绑定的状态',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'installation' => [
- 'title' => '身份绑定流程的当前状态',
- 'description' => '身份绑定流程的当前状态',
- '$ref' => '#/components/schemas/Installation',
- ],
+ 'installation' => ['title' => '身份绑定流程的当前状态', 'description' => '身份绑定流程的当前状态', 'visibility' => 'Public', 'backendName' => 'installation', '$ref' => '#/components/schemas/Installation'],
],
],
'Context' => [
'title' => 'A short description of struct',
'description' => 'json字符串，存储执行上下文',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'data' => [
- 'title' => 'data是一个JSON结构的数据，描述执行的上下文数据',
- 'description' => 'data是一个JSON结构的数据，描述执行的上下文数据',
- 'type' => 'object',
- ],
- ],
- ],
- 'ContextSchema' => [
- 'title' => 'Schema for context input.',
- 'type' => 'object',
- 'properties' => [
- 'type' => [
- 'title' => 'Field type.',
- 'type' => 'string',
- 'example' => 'string',
- ],
- 'description' => [
- 'title' => 'Field description.',
- 'type' => 'string',
- 'example' => '[git](https://git-scm.com/) address for [git clone](https://git-scm.com/docs/git-clone).',
- ],
- 'required' => [
- 'title' => 'Field is required or not.',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'hint' => [
- 'title' => 'Field example.',
- 'type' => 'string',
- 'example' => 'git@gitlab.alibaba-inc.com:serverless/lambda.git',
- ],
- 'name' => [
- 'title' => 'Field name.',
- 'type' => 'string',
- 'example' => 'gitRepoUrl',
- ],
- ],
- ],
- 'DefaultBuilderConfig' => [
- 'title' => '描述一个服务的代码应该如何被构建',
- 'description' => '构架配置',
- 'type' => 'object',
- 'properties' => [
- 'cache' => [
- 'title' => '缓存配置',
- '$ref' => '#/components/schemas/BuildCacheConfig',
- ],
- 'languages' => [
- 'title' => '执行环境需要设置的语言，例如Java11，Python3.9等',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'Python3.9',
- ],
- ],
- 'rootPath' => [
- 'title' => '构建时使用的源码根目录，默认为代码仓库的根目录。构建时，会在源码根目录下执行所有构建步骤，并且将源码根目录进行打包。如果需要在打包时过滤指定文件，可以在源码根目录下增加.signore文件指定要打包时排除的文件',
- 'type' => 'string',
- 'example' => './src',
- ],
- 'steps' => [
- 'title' => '组件构建的步骤，步骤将被顺序执行。步骤的类型可以是命令类型(ServiceCommandStep)，插件类型(ServicePluginStep)以\\ 及组件类型(ServiceComponentStep)',
- 'type' => 'array',
- 'items' => [
- 'type' => 'any',
- 'example' => '{"run": "npm build"}',
- ],
- ],
- ],
- ],
- 'DeleteModelOutput' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求id',
- 'type' => 'string',
- ],
- 'success' => [
- 'title' => '是否请求成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployCustomContainerAsyncOutput' => [
- 'title' => '部署自定义容器异步输出',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployCustomContainerInput' => [
- 'title' => '部署 custom container 请求对象',
- 'type' => 'object',
- 'properties' => [
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
- 'type' => 'object',
- 'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
- 'type' => 'object',
- 'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'environmentVariables' => [
- 'title' => '环境变量',
- 'type' => 'object',
- ],
- 'customContainerConfig' => [
- 'title' => '自定义容器配置',
- 'type' => 'object',
- 'properties' => [
- 'image' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'role' => [
- 'type' => 'string',
- ],
- 'port' => [
- 'title' => '端口',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'instanceLifecycleConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'preStop' => [
- 'type' => 'object',
- 'properties' => [
- 'handler' => [
- 'type' => 'string',
- ],
- 'timeout' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'initializer' => [
- 'type' => 'object',
- 'properties' => [
- 'handler' => [
- 'type' => 'string',
- ],
- 'timeout' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'entrypoint' => [
- 'title' => '接入点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'command' => [
- 'title' => '命令',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'instanceConcurrency' => [
- 'title' => '并发度',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'healthCheckConfig' => [
- 'title' => '健康检查配置',
- 'type' => 'object',
- 'properties' => [
- 'failureThreshold' => [
- 'title' => 'failureThreshold',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'httpGetUrl' => [
- 'title' => 'url',
- 'type' => 'string',
- ],
- 'periodSeconds' => [
- 'title' => 'periodSeconds',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'timeoutSeconds' => [
- 'title' => 'timeoutSeconds',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'successThreshold' => [
- 'title' => 'successThreshold',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'initialDelaySeconds' => [
- 'title' => 'initialDelaySeconds',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'workingDir' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'withPPU' => [
- 'type' => 'boolean',
- ],
- 'skipDownload' => [
- 'type' => 'boolean',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'ossMountConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'mountPoints' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'bucketName' => [
- 'type' => 'string',
- ],
- 'endpoint' => [
- 'type' => 'string',
- ],
- 'bucketPath' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- 'readOnly' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- ],
- 'asyncInvokeConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'asyncTask' => [
- 'type' => 'boolean',
- ],
- 'maxAsyncEventAgeInSeconds' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'destinationConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'onFailure' => [
- 'type' => 'object',
- 'properties' => [
- 'destination' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'onSuccess' => [
- 'type' => 'object',
- 'properties' => [
- 'destination' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- 'maxAsyncRetryAttempts' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'featureGates' => [
- 'type' => 'object',
- 'properties' => [
- 'asyncProvisionCheck' => [
- 'type' => 'boolean',
- ],
- 'disableRollbackOnProvisionFailure' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- 'DeployCustomContainerOutput' => [
- 'title' => '部署自定义容器输出',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'vpcConfigStr' => [
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'nasConfigStr' => [
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployEnvironmentOptions' => [
- 'title' => 'A short description of struct',
- 'description' => '环境部署配置可选项',
- 'type' => 'object',
- 'properties' => [
- 'services' => [
- 'title' => '选择的服务名称列表。指定部分服务进行部署，当服务不存在配置变更时仍会重新部署。null或空列表: 表示部署全部发生配置变更的服务',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => '服务名称',
- ],
- ],
- ],
- ],
- 'DeployHuggingFaceModelAsyncOutput' => [
- 'title' => '部署HuggingFace异步输出',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployHuggingFaceModelInput' => [
- 'title' => '部署 huggingface 请求对象',
- 'type' => 'object',
- 'properties' => [
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'imageName' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'workingDir' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'withPPU' => [
- 'type' => 'boolean',
- ],
- 'fmkHuggingFaceConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'task' => [
- 'type' => 'string',
- ],
- 'framework' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'skipDownload' => [
- 'type' => 'boolean',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
- 'type' => 'object',
- 'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
- 'type' => 'object',
- 'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'instanceConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'environmentVariables' => [
- 'type' => 'object',
- ],
- 'featureGates' => [
- 'type' => 'object',
- 'properties' => [
- 'asyncProvisionCheck' => [
- 'type' => 'boolean',
- ],
- 'disableRollbackOnProvisionFailure' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- 'DeployHuggingFaceModelOutput' => [
- 'title' => '部署 huggingface 返回值',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'taskType' => [
- 'title' => '任务类型',
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployModelScopeModelAsyncOutput' => [
- 'title' => '部署Modelscope异步输出',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployModelScopeModelInput' => [
- 'title' => '部署 modelscope 请求对象',
- 'type' => 'object',
- 'properties' => [
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
- 'type' => 'object',
- 'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
- 'type' => 'object',
- 'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'imageName' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'instanceConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'environmentVariables' => [
- 'type' => 'object',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployModelScopeModelOutput' => [
- 'title' => '部署 modelscope 返回值',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'taskType' => [
- 'title' => '任务类型',
- 'type' => 'string',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- ],
- ],
- 'DeployOllamaModelAsyncOutput' => [
- 'title' => 'DeployOllamaModelAsyncOutput',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployOllamaModelInput' => [
- 'title' => 'DeployOllamaModelInput',
- 'type' => 'object',
- 'properties' => [
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'imageName' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'workingDir' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'withPPU' => [
- 'type' => 'boolean',
- ],
- 'skipDownload' => [
- 'type' => 'boolean',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'fmkOllamaConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'mirostat' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'seed' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'modelfileParams' => [
- 'type' => 'string',
- ],
- 'modelfileFullTextPostfix' => [
- 'type' => 'string',
- ],
- 'singleModelFile' => [
- 'type' => 'string',
- ],
- 'modelfileTemplate' => [
- 'type' => 'string',
- ],
- 'minP' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'tfsZ' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'stream' => [
- 'type' => 'boolean',
- ],
- 'temperature' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'quantize' => [
- 'type' => 'string',
- ],
- 'numCtx' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'repeatPenalty' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'numPredict' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'topK' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mirostatEta' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'modelfileAdditionalFromsString' => [
- 'type' => 'string',
- ],
- 'topP' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'modelName' => [
- 'type' => 'string',
- ],
- 'stop' => [
- 'type' => 'string',
- ],
- 'modelfileAdapter' => [
- 'type' => 'string',
- ],
- 'modelfileSystem' => [
- 'type' => 'string',
- ],
- 'splitedModelStartFile' => [
- 'type' => 'string',
- ],
- 'mirostatTau' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'repeatLastN' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
- 'type' => 'object',
- 'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
- 'type' => 'object',
- 'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'instanceConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'environmentVariables' => [
- 'type' => 'object',
- ],
- 'featureGates' => [
- 'type' => 'object',
- 'properties' => [
- 'asyncProvisionCheck' => [
- 'type' => 'boolean',
- ],
- 'disableRollbackOnProvisionFailure' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- 'DeployOllamaModelOutput' => [
- 'title' => 'DeployOllamaModelOutput',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'modelName' => [
- 'title' => '任务类型',
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeploySGLangModelAsyncOutput' => [
- 'title' => 'DeploySGLangModelAsyncOutput',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeploySGLangModelInput' => [
- 'title' => 'DeploySGLangModelInput',
- 'type' => 'object',
- 'properties' => [
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'fmkSGLangConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'fullTextPostfix' => [
- 'type' => 'string',
- ],
- 'loadFormat' => [
- 'type' => 'string',
- ],
- 'maxRunningRequests' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'servedModelName' => [
- 'type' => 'string',
- ],
- 'memFractionStatic' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'apiKey' => [
- 'type' => 'string',
- ],
- 'chatTemplate' => [
- 'type' => 'string',
- ],
- 'dtype' => [
- 'type' => 'string',
- ],
- 'maxTotalTokens' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'quantization' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'workingDir' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'withPPU' => [
- 'type' => 'boolean',
- ],
- 'skipDownload' => [
- 'type' => 'boolean',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'enableTLS' => [
- 'type' => 'boolean',
- ],
- 'serverAddr' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
- 'type' => 'object',
- 'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
- 'type' => 'object',
- 'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'imageName' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'instanceConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'environmentVariables' => [
- 'type' => 'object',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- 'customContainerConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'role' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'ossMountConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'mountPoints' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'bucketName' => [
- 'type' => 'string',
- ],
- 'endpoint' => [
- 'type' => 'string',
- ],
- 'bucketPath' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- 'readOnly' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- ],
- 'featureGates' => [
- 'type' => 'object',
- 'properties' => [
- 'asyncProvisionCheck' => [
- 'type' => 'boolean',
- ],
- 'disableRollbackOnProvisionFailure' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- 'DeploySGLangModelOutput' => [
- 'title' => 'DeploySGLangModelOutput',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'modelName' => [
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployTensorRtModelAsyncOutput' => [
- 'title' => '部署 tensorrt异步输出',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
+ 'data' => ['title' => 'data是一个JSON结构的数据，描述执行的上下文数据', 'description' => 'data是一个JSON结构的数据，描述执行的上下文数据', 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'data'],
],
],
- 'DeployTensorRtModelInput' => [
- 'title' => '部署 tensorrt 请求对象',
+ 'DifyPluginInstallationConfig' => [
'type' => 'object',
'properties' => [
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'enableTLS' => [
- 'type' => 'boolean',
- ],
- 'serverAddr' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
+ 'provider' => ['title' => '插件供应商', 'type' => 'string'],
+ 'source' => [
+ 'title' => '插件来源',
'type' => 'object',
'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
+ 'marketplace' => [
+ 'title' => 'Dify插件市场配置',
'type' => 'object',
'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'imageName' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'instanceConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
+ 'pluginId' => ['title' => '插件市场中的插件ID', 'type' => 'string'],
+ 'version' => ['title' => '插件版本', 'type' => 'string'],
+ 'uniqueIdentifier' => ['title' => '插件唯一定位符', 'type' => 'string'],
],
],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'environmentVariables' => [
- 'type' => 'object',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployTensorRtModelOutput' => [
- 'title' => '部署 tensorrt 返回值',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployVllmModelAsyncOutput' => [
- 'title' => 'DeployOllamaModelAsyncOutput',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'string',
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DeployVllmModelInput' => [
- 'title' => 'DeployOllamaModelInput',
- 'type' => 'object',
- 'properties' => [
- 'role' => [
- 'title' => '角色',
- 'type' => 'string',
- 'required' => true,
- ],
- 'modelConfig' => [
- 'title' => '模型配置',
- 'type' => 'object',
- 'properties' => [
- 'srcModelScopeModelID' => [
- 'title' => 'ms id',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'workingDir' => [
- 'type' => 'string',
- ],
- 'srcOssBucket' => [
- 'title' => 'oss 桶',
- 'type' => 'string',
- ],
- 'withPPU' => [
- 'type' => 'boolean',
- ],
- 'skipDownload' => [
- 'type' => 'boolean',
- ],
- 'srcModelScopeModelRevision' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '框架',
- 'type' => 'string',
- ],
- 'sourceType' => [
- 'title' => '来源',
- 'type' => 'string',
- ],
- 'srcOssRegion' => [
- 'title' => 'oss 地域',
- 'type' => 'string',
- ],
- 'fmkVllmConfig' => [
+ 'github' => [
+ 'title' => 'Github仓库配置',
'type' => 'object',
'properties' => [
- 'fullTextPostfix' => [
- 'type' => 'string',
- ],
- 'loadFormat' => [
- 'type' => 'string',
- ],
- 'servedModelName' => [
- 'type' => 'string',
- ],
- 'gpuMemoryUtilization' => [
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'apiKey' => [
- 'type' => 'string',
- ],
- 'chatTemplate' => [
- 'type' => 'string',
- ],
- 'dtype' => [
- 'type' => 'string',
- ],
- 'swapSpace' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'maxModelLen' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'maxParallelLoadingWorkers' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'blockSize' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'quantization' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'srcModelScopeToken' => [
- 'title' => 'token',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'syncStrategy' => [
- 'type' => 'string',
- ],
- 'srcOssPath' => [
- 'title' => 'oss 路径',
- 'type' => 'string',
- ],
- ],
- ],
- 'nasConfig' => [
- 'title' => 'nas 配置',
- 'type' => 'object',
- 'properties' => [
- 'groupId' => [
- 'title' => '分组 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'mountPoints' => [
- 'title' => '挂载点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'enableTLS' => [
- 'type' => 'boolean',
- ],
- 'serverAddr' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- ],
+ 'repository' => ['title' => '仓库名称', 'type' => 'string'],
+ 'version' => ['title' => '仓库release版本', 'type' => 'string'],
+ 'package' => ['title' => '插件安装包名', 'type' => 'string'],
],
],
- 'userId' => [
- 'title' => '用户 id',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'description' => [
- 'title' => '描述',
- 'type' => 'string',
- ],
- 'concurrencyConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'reservedConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'timeout' => [
- 'title' => '超市',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'originalName' => [
- 'title' => '原始名称',
- 'type' => 'string',
- ],
- 'accountID' => [
- 'title' => '账户 id',
- 'type' => 'string',
- ],
- 'httpTrigger' => [
- 'title' => 'http 触发器',
- 'type' => 'object',
- 'properties' => [
- 'triggerConfig' => [
- 'title' => '触发器配置',
+ 'downloadUrl' => ['title' => '自定义下载地址', 'type' => 'string'],
+ 'oss' => [
+ 'title' => 'OSS对象存储配置',
'type' => 'object',
'properties' => [
- 'authConfig' => [
- 'type' => 'string',
- ],
- 'methods' => [
- 'title' => '方法列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'authType' => [
- 'title' => '认证类型',
- 'type' => 'string',
- ],
- 'dsableURLInternet' => [
- 'title' => '公网访问',
- 'type' => 'boolean',
- ],
- 'disableURLInternet' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- 'qualifier' => [
- 'title' => '版本',
- 'type' => 'string',
- ],
- ],
- ],
- 'diskSize' => [
- 'title' => '磁盘',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'traceId' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'logConfig' => [
- 'title' => '日志配置',
- 'type' => 'object',
- 'properties' => [
- 'enableRequestMetrics' => [
- 'title' => '请求 metrics',
- 'type' => 'boolean',
- ],
- 'enableInstanceMetrics' => [
- 'title' => '实例 metrics',
- 'type' => 'boolean',
- ],
- 'logBeginRule' => [
- 'title' => '起始规则',
- 'type' => 'string',
- ],
- 'project' => [
- 'title' => '工程',
- 'type' => 'string',
- ],
- 'logstore' => [
- 'title' => '存储',
- 'type' => 'string',
- ],
- ],
- ],
- 'imageName' => [
- 'title' => '镜像',
- 'type' => 'string',
- ],
- 'gpuConfig' => [
- 'title' => 'gpu 配置',
- 'type' => 'object',
- 'properties' => [
- 'gpuMemorySize' => [
- 'title' => '显存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'gpuType' => [
- 'title' => 'gpu 类型',
- 'type' => 'string',
- ],
- ],
- ],
- 'cpu' => [
- 'title' => 'cpu',
- 'type' => 'number',
- 'format' => 'float',
- ],
- 'instanceConcurrency' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'reportStatusURL' => [
- 'title' => '回告地址',
- 'type' => 'string',
- ],
- 'provisionConfig' => [
- 'title' => '预留配置',
- 'type' => 'object',
- 'properties' => [
- 'scheduledActions' => [
- 'title' => '策略',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'scheduleExpression' => [
- 'title' => '表达式',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '名称',
- 'type' => 'string',
- ],
- 'timeZone' => [
- 'title' => '时区',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- ],
- 'endTime' => [
- 'title' => '休止时间',
- 'type' => 'string',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'alwaysAllocateGPU' => [
- 'title' => '闲置',
- 'type' => 'boolean',
- ],
- 'target' => [
- 'title' => '目标值',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'memorySize' => [
- 'title' => '内存',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'envName' => [
- 'title' => '环境名称',
- 'type' => 'string',
- ],
- 'environmentVariables' => [
- 'type' => 'object',
- ],
- 'vpcConfig' => [
- 'title' => 'vpc 配置',
- 'type' => 'object',
- 'properties' => [
- 'securityGroupId' => [
- 'title' => '安全组',
- 'type' => 'string',
- ],
- 'vSwitchIds' => [
- 'title' => '交换机',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'vpcId' => [
- 'title' => 'vpc id',
- 'type' => 'string',
- ],
- ],
- ],
- 'name' => [
- 'title' => '实例名称',
- 'type' => 'string',
- 'required' => true,
- ],
- 'projectName' => [
- 'title' => '项目名',
- 'type' => 'string',
- ],
- 'region' => [
- 'title' => '地域',
- 'type' => 'string',
- ],
- 'customContainerConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'role' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'ossMountConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'mountPoints' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'bucketName' => [
- 'type' => 'string',
- ],
- 'endpoint' => [
- 'type' => 'string',
- ],
- 'bucketPath' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- 'readOnly' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- ],
- 'featureGates' => [
- 'type' => 'object',
- 'properties' => [
- 'asyncProvisionCheck' => [
- 'type' => 'boolean',
- ],
- 'disableRollbackOnProvisionFailure' => [
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- ],
- 'DeployVllmModelOutput' => [
- 'title' => 'DeployOllamaModelOutput',
- 'type' => 'object',
- 'properties' => [
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'traceID' => [
- 'title' => '追踪 id',
- 'type' => 'string',
- ],
- 'modelName' => [
- 'title' => '任务类型',
- 'type' => 'string',
- ],
- 'urlInternet' => [
- 'title' => '外网地址',
- 'type' => 'string',
- ],
- 'deploymentTaskID' => [
- 'title' => '任务 id',
- 'type' => 'string',
- ],
- 'errorMessage' => [
- 'title' => '完结错误信息',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完结',
- 'type' => 'boolean',
- ],
- 'serviceName' => [
- 'title' => 'instance name',
- 'type' => 'string',
- ],
- 'urlIntranet' => [
- 'title' => '内网地址',
- 'type' => 'string',
- ],
- ],
- ],
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'DescribeRegionsOutput' => [
- 'type' => 'object',
- 'properties' => [
- 'regions' => [
- 'type' => 'object',
- 'properties' => [
- 'region' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'localName' => [
- 'type' => 'string',
- ],
- 'regionId' => [
- 'type' => 'string',
- ],
- ],
+ 'bucket' => ['title' => '存储桶名称', 'type' => 'string'],
+ 'object' => ['title' => '对象名称', 'type' => 'string'],
+ 'endpoint' => ['title' => 'oss服务端点', 'type' => 'string'],
],
],
],
],
],
],
- 'DownloadModelOutput' => [
- 'title' => '下载模型返回值',
+ 'DifyToolSchema' => [
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求 id',
- 'type' => 'string',
- 'required' => true,
- ],
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'taskType' => [
- 'title' => '任务类型',
- 'type' => 'string',
- ],
- 'modelPath' => [
- 'title' => '模型目录',
- 'type' => 'string',
- ],
- ],
- ],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
+ 'name' => ['title' => '工具名称', 'type' => 'string'],
+ 'description' => ['title' => '工具描述', 'type' => 'string'],
+ 'inputSchema' => ['title' => '输入schema', 'type' => 'object'],
+ 'outputSchema' => ['title' => '自定义输出schema', 'type' => 'object'],
],
],
'EfmModel' => [
'title' => '部署单元模型服务',
'type' => 'object',
'properties' => [
- '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',
- ],
+ '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' => '模型服务部署单元的标签',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -4363,723 +370,270 @@
'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,
- ],
+ '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',
- ],
+ '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' => '环境可以与用于开发迭代的特定分支相关联，也可以与基础结构堆栈相关联，以便将服务部署到指定的环境。',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '环境名称，项目下唯一，不可修改',
- 'description' => '环境名称，项目下唯一，不可修改',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
- 'kind' => [
- 'title' => '当前资源的类型，只读',
- 'description' => '当前资源的类型，只读',
- 'type' => 'string',
- 'example' => 'Environment',
- ],
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'createdTime' => [
- 'title' => '创建此对象时服务器的时间，只读',
- 'description' => '创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'description' => [
- 'title' => '资源描述',
- 'description' => '资源描述',
- 'type' => 'string',
- 'example' => 'test env',
- ],
- 'spec' => [
- 'title' => '环境配置',
- 'description' => '环境配置',
- 'required' => true,
- '$ref' => '#/components/schemas/EnvironmentSpec',
- ],
+ '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' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'status' => [
- 'title' => '当前环境的状态',
- 'description' => '当前环境的状态',
- '$ref' => '#/components/schemas/EnvironmentStatus',
- ],
- 'projectName' => [
- 'title' => '环境所属的项目名称，只读',
- 'description' => '环境所属的项目名称，只读',
- 'type' => 'string',
- 'example' => 'demo-project',
- ],
- 'generation' => [
- 'title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致',
- 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'EnvironmentBaseline' => [
- 'title' => '环境基线',
- 'description' => '环境基线',
- 'type' => 'object',
- 'properties' => [
- 'variables' => [
- 'title' => '环境的变量配置信息',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/Variable',
- ],
- ],
- 'servicesInstances' => [
- 'title' => '项目下的服务使用当前环境中的配置进行部署后产生的服务实例',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/ServiceInstance',
- ],
- ],
- ],
- ],
- 'EnvironmentChanges' => [
- 'title' => '环境中的配置变化，只读',
- 'description' => '环境配置的变化',
- 'type' => 'object',
- 'properties' => [
- 'services' => [
- 'title' => '环境中服务的配置变化，只读。是经过变量解析后的ServicesConfigs的JSON Merge Patch对象',
- 'type' => 'object',
- ],
- ],
- ],
- 'EnvironmentDeployment' => [
- 'title' => '环境部署。描述一次环境的部署，每次环境的部署会产生并编排若干个服务的部署并执行',
- 'description' => '环境部署。描述一次环境的部署，每次环境的部署会产生并编排服务的部署并执行',
- 'type' => 'object',
- 'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'description' => [
- 'title' => '资源的描述信息',
- 'type' => 'string',
- 'example' => 'commit by xxx.',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Deployment',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。在项目中，它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-deployment',
- 'maxLength' => 63,
- 'minLength' => 1,
- 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$',
- ],
- 'status' => [
- 'title' => '资源的状态',
- '$ref' => '#/components/schemas/EnvironmentDeploymentStatus',
- ],
- 'labels' => [
- 'title' => '资源的标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'spec' => [
- 'title' => '资源的配置',
- '$ref' => '#/components/schemas/EnvironmentDeploymentSpec',
- ],
- ],
- ],
- 'EnvironmentDeploymentSpec' => [
- 'title' => '环境部署配置',
- 'description' => '环境部署的配置信息',
- 'type' => 'object',
- 'properties' => [
- 'changes' => [
- 'title' => '环境配置的变化内容',
- '$ref' => '#/components/schemas/EnvironmentChanges',
- ],
- 'baseline' => [
- 'title' => '环境配置基线',
- '$ref' => '#/components/schemas/EnvironmentSnapshot',
- ],
- 'target' => [
- 'title' => '本次环境部署计划达到的配置目标',
- '$ref' => '#/components/schemas/EnvironmentStagedConfigs',
- ],
- 'skipRemoveResources' => [
- 'title' => '删除时，是否要跳过清理资源。默认为false，对资源进行清理',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'webhookCodeContext' => [
- 'title' => 'webhook触发的上下文',
- '$ref' => '#/components/schemas/WebhookCodeContext',
- ],
- ],
- ],
- 'EnvironmentDeploymentStatus' => [
- 'title' => '环境部署的状态信息',
- 'type' => 'object',
- 'properties' => [
- 'phase' => [
- 'title' => '本次环境部署的执行状态，包括：Initializing: 初始化中、InitFailed: 初始化失败、Running: 执行中、HangUp: 挂起等待审批中、Finished: 执行完成、Failed: 部署失败、Canceled: 已取消',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'pipelineName' => [
- 'title' => '完成本次环境部署所使用的流水线名称',
- 'type' => 'string',
- 'example' => 'my-pipeline',
- ],
- 'finishedTime' => [
- 'title' => '部署完成时间',
- 'type' => 'string',
- ],
- 'serviceDeployments' => [
- 'title' => '服务名称对应的部署。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '服务部署名称',
- ],
- ],
- ],
- ],
- 'EnvironmentSnapshot' => [
- 'title' => '环境中当前已部署的服务的快照。包含已部署的服务的配置、状态、变量等信息',
- 'description' => '环境中当前已部署的服务的快照。包含已部署的服务的配置、状态、变量等信息',
- 'type' => 'object',
- 'properties' => [
- 'services' => [
- 'title' => '环境中已部署的服务',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/ServiceInstance',
- ],
+ 'additionalProperties' => ['visibility' => 'Public', 'type' => 'string', 'example' => 'value to the label key.'],
+ 'backendName' => 'labels',
],
+ 'status' => ['title' => '当前环境的状态', 'description' => '当前环境的状态', 'visibility' => 'Public', 'backendName' => 'status', '$ref' => '#/components/schemas/EnvironmentStatus'],
+ 'projectName' => ['title' => '环境所属的项目名称，只读', 'description' => '环境所属的项目名称，只读', 'visibility' => 'Public', 'type' => 'string', 'example' => 'demo-project', 'backendName' => 'projectName'],
+ 'generation' => ['title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致', 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'generation'],
],
],
'EnvironmentSpec' => [
'title' => '环境配置描述',
'description' => '环境配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
'type' => [
'title' => '环境类型，只能在testing、staging、production中选择',
'description' => '环境类型，只能在testing、staging、production中选择',
+ 'visibility' => 'Public',
'type' => 'string',
'example' => 'Testing',
+ 'backendName' => 'type',
'default' => 'Production',
- 'enum' => [
- 'Testing',
- 'Staging',
- 'Production',
- ],
- ],
- 'roleArn' => [
- 'title' => '环境角色',
- 'description' => '环境角色',
- 'type' => 'string',
- 'example' => 'acs:ram::*******:role/aliyundevsdefaultrole',
- ],
- 'stagedConfigs' => [
- 'title' => '环境下保存的配置，可以通过部署达到该配置状态',
- 'description' => '环境下保存的配置，可以通过部署达到该配置状态',
- '$ref' => '#/components/schemas/EnvironmentStagedConfigs',
- ],
- ],
- ],
- 'EnvironmentStagedConfigs' => [
- 'title' => '环境中的一套可被部署的配置',
- 'description' => '环境配置的变化',
- 'type' => 'object',
- 'properties' => [
- 'services' => [
- 'title' => '环境中服务的配置',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/ServiceConfig',
- ],
- ],
- 'variables' => [
- 'title' => '环境中共享变量的配置',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/Variable',
- ],
+ 'enum' => ['Testing', 'Staging', 'Production'],
],
+ 'roleArn' => ['title' => '环境角色', 'description' => '环境角色', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::*******:role/aliyundevsdefaultrole', 'backendName' => 'roleArn'],
+ 'stagedConfigs' => ['title' => '环境下保存的配置，可以通过部署达到该配置状态', 'description' => '环境下保存的配置，可以通过部署达到该配置状态', 'visibility' => 'Public', 'backendName' => 'stagedConfigs', '$ref' => '#/components/schemas/EnvironmentStagedConfigs'],
],
],
'EnvironmentStatus' => [
'title' => '环境状态',
'description' => '环境状态',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
'servicesInstances' => [
'title' => '项目下的服务使用当前环境中的配置进行部署后产生的服务实例',
'description' => '项目下的服务使用当前环境中的配置进行部署后产生的服务实例',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/ServiceInstance',
- ],
- ],
- 'latestEnvironmentDeploymentName' => [
- 'title' => '最近一次部署计划的名称。每次环境部署都会产生一个部署计划，涉及若干个服务的部署',
- 'description' => '最近一次部署计划的名称。每次环境部署都会产生一个部署计划，涉及若干个服务的部署',
- 'type' => 'string',
+ 'additionalProperties' => ['visibility' => 'Public', '$ref' => '#/components/schemas/ServiceInstance'],
+ 'backendName' => 'servicesInstances',
],
+ 'latestEnvironmentDeploymentName' => ['title' => '最近一次部署计划的名称。每次环境部署都会产生一个部署计划，涉及若干个服务的部署', 'description' => '最近一次部署计划的名称。每次环境部署都会产生一个部署计划，涉及若干个服务的部署', 'visibility' => 'Public', 'type' => 'string', 'backendName' => 'latestEnvironmentDeploymentName'],
'servicesWithPendingChanges' => [
'title' => '存在未部署的变更的服务名称列表',
'description' => '存在未部署的变更的服务名称列表',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => '服务名称',
- ],
- ],
- 'observedGeneration' => [
- 'title' => '资源最近的一次状态更新时的资源generation',
- 'description' => '系统最新观测到的资源generation',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'observedTime' => [
- 'title' => '资源最近的一次状态更新时间',
- 'description' => '资源最近的一次状态更新时间',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
+ 'items' => ['visibility' => 'Public', 'type' => 'string', 'example' => '服务名称', 'extendType' => 'true'],
+ 'backendName' => 'servicesWithPendingChanges',
],
+ 'observedGeneration' => ['title' => '资源最近的一次状态更新时的资源generation', 'description' => '系统最新观测到的资源generation', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'observedGeneration'],
+ 'observedTime' => ['title' => '资源最近的一次状态更新时间', 'description' => '资源最近的一次状态更新时间', 'visibility' => 'Public', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z', 'backendName' => 'observedTime'],
],
],
'EventFilterConfig' => [
'title' => '事件过滤配置',
'description' => '事件过滤配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'branch' => [
- 'title' => '分支发生变更事件',
- 'description' => '分支发生变更事件',
- '$ref' => '#/components/schemas/BranchFilter',
- ],
+ 'branch' => ['title' => '分支发生变更事件', 'description' => '分支发生变更事件', 'visibility' => 'Public', 'backendName' => 'branch', '$ref' => '#/components/schemas/BranchFilter'],
],
],
- 'FileManagerMountConfig' => [
+ 'EventPayload' => [
+ 'title' => 'A short description of struct',
+ 'description' => '流水线触发事件消息体',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
- 'role' => [
- 'type' => 'string',
- ],
- 'region' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'vpcConfig' => [
- '$ref' => '#/components/schemas/VpcConfig',
- ],
- 'ossMountPoints' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/OSSMountPoint',
- ],
- ],
- 'nasMountPoints' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/NasMountConfig',
- ],
- ],
- 'timeoutInSecond' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'mutex' => [
- 'type' => 'boolean',
- ],
+ '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',
- ],
+ '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',
- ],
+ 'currentBytes' => ['type' => 'integer', 'format' => 'int64'],
+ 'totalBytes' => ['type' => 'integer', 'format' => 'int64'],
],
],
- 'result' => [
- 'type' => 'any',
- ],
- 'errorCode' => [
- 'type' => 'string',
- ],
+ 'result' => ['type' => 'any'],
+ 'errorCode' => ['type' => 'string'],
],
],
- 'FinalizeConfig' => [
- 'title' => '服务删除后的执行配置',
- 'description' => '服务被删除后，需要按照配置进行善后处理',
+ 'GitAccount' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'OAuth凭证',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'steps' => [
- 'title' => '善后执行步骤，步骤将被顺序执行。步骤的类型可以是命令类型(ServiceCommandStep)，插件类型(ServicePluginStep)以\\ 及组件类型(ServiceComponentStep)',
- 'type' => 'array',
- 'items' => [
- 'type' => 'any',
- 'example' => '{"run": "echo \'deleted\'"}',
- ],
- ],
+ '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' => '代码托管平台账号的ID，在每种代码托管平台下唯一', 'description' => '代码托管平台账号的ID，在每种代码托管平台下唯一', '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' => '代码托管平台的地址，仅在自建GitLab时使用', 'description' => '代码托管平台的地址，仅在自建GitLab时使用', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'https://gitlab.com', 'backendName' => 'uri'],
],
],
- 'GetModelStatusOutput' => [
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求id',
- 'type' => 'string',
- ],
- 'data' => [
- 'title' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'fileSize' => [
- 'title' => '文件大小',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'finished' => [
- 'title' => '是否完成（包含成功和失败）',
- 'type' => 'boolean',
- ],
- 'finishedTime' => [
- 'title' => '完成时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'total' => [
- 'title' => '文件总数',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'errMessage' => [
- 'title' => '错误日志',
- 'type' => 'string',
- ],
- 'speed' => [
- 'title' => '当前下载速率',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'currentBytes' => [
- 'title' => '当前已下载的文件大小',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'success' => [
- 'title' => '是否请求成功',
- 'type' => 'boolean',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- ],
- ],
- 'GitAccount' => [
+ 'GiteeEventPayload' => [
'title' => 'A short description of struct',
- 'description' => 'OAuth凭证',
+ 'description' => 'Gitee流水线触发事件消息体',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '代码托管平台的登录账号名，在每种代码托管平台下唯一',
- 'description' => '代码托管平台的登录账号名，在每种代码托管平台下唯一',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'your_username',
- ],
- 'displayName' => [
- 'title' => '代码托管平台中的昵称，可以为空且不唯一',
- 'description' => '代码托管平台中的昵称，可以为空且不唯一',
- 'type' => 'string',
- 'example' => 'your_displayname',
- ],
- 'id' => [
- 'title' => '代码托管平台账号的ID，在每种代码托管平台下唯一',
- 'description' => '代码托管平台账号的ID，在每种代码托管平台下唯一',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'avatar' => [
- 'title' => '代码托管平台账号的头像链接',
- 'description' => '代码托管平台账号的头像链接',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://gitee.com/assets/no_portrait.png',
- ],
- 'uri' => [
- 'title' => '代码托管平台的地址，仅在自建GitLab时使用',
- 'description' => '代码托管平台的地址，仅在自建GitLab时使用',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://gitlab.com',
- ],
+ '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' => 'Git提交事件快照',
'description' => 'Git事件快照',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'branch' => [
- 'title' => '本次发布关联的分支，如果是PR或MR事件，为源分支',
- 'description' => '本次发布关联的分支，如果是PR或MR事件，为源分支',
- 'type' => 'string',
- 'example' => 'main',
- ],
- 'commitID' => [
- 'title' => '本次发布关联的commitID',
- 'description' => '本次发布关联的commitID',
- 'type' => 'string',
- 'example' => '12721ec262d03a93809ba2bbc717963cb298ceca',
- ],
- 'tag' => [
- 'title' => '本次发布关联的tag',
- 'description' => '本次发布关联的tag',
- 'type' => 'string',
- 'example' => '1.0',
- ],
+ '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' => 'Github流水线触发事件消息体',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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' => '描述连接GitLab代码托管平台所需的信息',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'isFixedIP' => [
- 'title' => '是否固定公网IP访问Gitlab',
- 'description' => '是否固定公网IP访问Gitlab',
- 'type' => 'boolean',
- ],
- 'uri' => [
- 'title' => 'GitLab的域名，默认为https://gitlab.com；当您使用自建GitLab时需要指定',
- 'description' => 'GitLab的域名，默认为https://gitlab.com；当您使用自建GitLab时需要指定',
- 'type' => 'string',
- 'example' => 'http://gitlab.c16194660f14898a0810408171302ac.cn-shanghai.alicontainer.com/',
- ],
- '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',
- 'type' => 'string',
- 'example' => 'your-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'],
],
],
- 'ImageEvent' => [
- 'type' => 'object',
- 'properties' => [
- 'type' => [
- 'type' => 'string',
- ],
- 'time' => [
- 'type' => 'string',
- ],
- 'message' => [
- 'type' => 'string',
- ],
- 'details' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
+ 'GitlabEventPayload' => [
+ 'title' => 'A short description of struct',
+ 'description' => 'Gitlab流水线触发事件消息体',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
],
],
- 'InitializeConfig' => [
- 'title' => '服务的初始化配置',
- 'description' => '初始化配置',
+ 'Installation' => [
+ 'title' => '账号绑定流程',
+ 'description' => '指导用户完成OAuth授权流程',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'steps' => [
- 'title' => '初始化步骤，步骤将被顺序执行。步骤的类型可以是命令类型(ServiceCommandStep)，插件类型(ServicePluginStep)以\\ 及组件类型(ServiceComponentStep)',
- 'type' => 'array',
- 'items' => [
- 'type' => 'any',
- 'example' => '{"run": "npm build"}',
- ],
- ],
+ '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'],
],
],
- 'Installation' => [
- 'title' => '账号绑定流程',
- 'description' => '指导用户完成OAuth授权流程',
+ 'ManualEventPayload' => [
+ 'title' => 'A short description of struct',
+ 'description' => '手动触发流水线事件消息体',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'stage' => [
- 'title' => '账号绑定流程的当前阶段，包括：pending、finished、invalid',
- 'description' => '账号绑定流程的当前阶段，包括：pending、finished、invalid',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'message' => [
- 'title' => '账号绑定流程的指导信息，提示您如何完成账号绑定',
- 'description' => '账号绑定流程的指导信息，提示您如何完成账号绑定',
- 'type' => 'string',
- 'example' => 'Please click \'actionUri\' to complete the OAuth authorization process',
- ],
- 'actionUri' => [
- 'title' => '完成账号绑定流程的当前步骤所需的链接',
- 'description' => '完成账号绑定流程的当前步骤所需的链接',
- 'type' => 'string',
- 'example' => 'https://github.com/login/oauth/authorize?client_id=86059a1b2bb20d3e5fc3&scope=repo,repo:status,delete_repo',
- ],
+ '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'],
],
],
'MCPGatewayConfig' => [
@@ -5101,47 +655,27 @@
'name' => [
'title' => '后端名称',
'type' => 'string',
- 'enum' => [
- 'MCP',
- 'OpenAPI',
- 'Toolset',
- ],
+ 'enum' => ['MCP', 'OpenAPI', 'Toolset'],
],
'type' => [
'title' => '后端类型',
'type' => 'string',
- 'enum' => [
- 'OpenAPI',
- 'MCP',
- 'Toolset',
- ],
+ 'enum' => ['OpenAPI', 'MCP', 'Toolset'],
],
'details' => [
'title' => '后端配置详情',
'type' => 'object',
'properties' => [
- 'mcpInstallation' => [
- 'title' => 'MCP服务器安装配置',
- '$ref' => '#/components/schemas/MCPServerInstallationConfig',
- ],
+ 'mcpInstallation' => ['title' => 'MCP服务器安装配置', '$ref' => '#/components/schemas/MCPServerInstallationConfig'],
'toolsetSelector' => [
'title' => '工具集选择器',
'type' => 'object',
'properties' => [
- 'toolsetName' => [
- 'title' => '工具集名称',
- 'type' => 'string',
- ],
- 'toolName' => [
- 'title' => '工具名称',
- 'type' => 'string',
- ],
+ 'toolsetName' => ['title' => '工具集名称', 'type' => 'string'],
+ 'toolName' => ['title' => '工具名称', 'type' => 'string'],
],
],
- 'openAPISchema' => [
- 'title' => 'OpenAPI schema配置',
- 'type' => 'string',
- ],
+ 'openAPISchema' => ['title' => 'OpenAPI schema配置', 'type' => 'string'],
],
],
],
@@ -5151,10 +685,7 @@
'title' => '策略配置',
'type' => 'object',
'properties' => [
- 'authorization' => [
- 'title' => '第三方鉴权配置',
- '$ref' => '#/components/schemas/Authorization',
- ],
+ 'authorization' => ['title' => '第三方鉴权配置', '$ref' => '#/components/schemas/Authorization'],
],
],
],
@@ -5166,42 +697,24 @@
'title' => 'MCP安装配置',
'type' => 'object',
'properties' => [
- 'mcpServers' => [
- 'title' => 'MCP server配置',
- '$ref' => '#/components/schemas/MCPServerInstallationConfig',
- ],
+ 'mcpServers' => ['title' => 'MCP server配置', '$ref' => '#/components/schemas/MCPServerInstallationConfig'],
],
],
'MCPServerInstallationConfig' => [
'title' => 'MCP server安装配置',
'type' => 'object',
'properties' => [
- 'args' => [
- 'title' => 'MCP server启动参数，仅对stdio传输类型生效。',
- 'type' => 'string',
- ],
'transportType' => [
'title' => '传输类型',
'type' => 'string',
- 'enum' => [
- 'stdio',
- 'sse',
- 'streamableHttp',
- ],
+ 'enum' => ['stdio', 'sse', 'streamableHttp'],
],
+ 'url' => ['title' => 'MCP server地址。仅对sse以及streamableHttp传输类型有效', 'type' => 'string'],
+ 'command' => ['title' => 'MCP server启动命令，仅对stdio传输类型生效。仅支持uvx、npx', 'type' => 'string'],
+ 'args' => ['title' => 'MCP server启动参数，仅对stdio传输类型生效。', 'type' => 'string'],
'env' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'url' => [
- 'title' => 'MCP server地址。仅对sse以及streamableHttp传输类型有效',
- 'type' => 'string',
- ],
- 'command' => [
- 'title' => 'MCP server启动命令，仅对stdio传输类型生效。仅支持uvx、npx',
- 'type' => 'string',
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -5209,263 +722,9 @@
'title' => 'MCP类型的工具元信息',
'type' => 'object',
'properties' => [
- 'inputSchema' => [
- 'type' => 'object',
- ],
- 'name' => [
- 'title' => '工具名称',
- 'type' => 'string',
- 'example' => 'demo-tool',
- ],
- 'description' => [
- 'title' => '工具描述',
- 'type' => 'string',
- 'example' => 'Here is an example',
- ],
- ],
- ],
- 'ModelAsyncTask' => [
- 'title' => 'A short description of struct',
- 'type' => 'object',
- 'properties' => [
- 'startTime' => [
- 'title' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'updateTime' => [
- 'title' => '更新时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'taskType' => [
- 'title' => '任务类型',
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '任务完成（包含成功或失败）',
- 'type' => 'boolean',
- ],
- 'finishedTime' => [
- 'title' => '完成时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'result' => [
- 'title' => '结果',
- 'type' => 'any',
- ],
- 'errMsg' => [
- 'title' => '错误信息',
- 'type' => 'string',
- ],
- 'errCode' => [
- 'title' => '错误码',
- 'type' => 'string',
- ],
- ],
- ],
- 'ModelConfig' => [
- 'title' => 'A short description of struct',
- 'type' => 'object',
- 'properties' => [
- 'reversion' => [
- 'title' => '模型版本',
- 'type' => 'string',
- ],
- 'bucket' => [
- 'title' => 'OSS Bucket 名称',
- 'type' => 'string',
- ],
- 'path' => [
- 'title' => 'OSS Object 路径',
- 'type' => 'string',
- ],
- 'framework' => [
- 'title' => '引导模型的框架引擎',
- 'type' => 'string',
- ],
- 'prefix' => [
- 'type' => 'string',
- ],
- 'model' => [
- 'title' => '模型 ID',
- 'type' => 'string',
- ],
- 'multiModelConfig' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelConfig',
- ],
- ],
- 'type' => [
- 'title' => '模型类别',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'modelscope',
- ],
- 'region' => [
- 'title' => 'OSS 地域',
- 'type' => 'string',
- ],
- 'token' => [
- 'title' => '模型平台 token',
- 'type' => 'string',
- ],
- ],
- ],
- 'ModelFile' => [
- 'title' => 'A short description of struct',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '文件名',
- 'type' => 'string',
- ],
- 'path' => [
- 'title' => '路径',
- 'type' => 'string',
- ],
- 'isDir' => [
- 'title' => '是否为目录',
- 'type' => 'boolean',
- ],
- 'size' => [
- 'title' => '文件大小',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'modeTime' => [
- 'title' => '修改时间',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'ModelFilePreview' => [
- 'title' => 'A short description of struct',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '文件名',
- 'type' => 'string',
- ],
- 'path' => [
- 'title' => '文件路径',
- 'type' => 'string',
- ],
- 'isDir' => [
- 'title' => '是否为文件夹',
- 'type' => 'boolean',
- ],
- 'size' => [
- 'title' => '文件大小',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'hash' => [
- 'title' => '哈希',
- 'type' => 'string',
- ],
- 'content' => [
- 'title' => '文件内容 base64',
- 'type' => 'string',
- ],
- 'isCompressedImage' => [
- 'title' => '是否为压缩图片',
- 'type' => 'boolean',
- ],
- 'unpreviewable' => [
- 'title' => '不可预览',
- 'type' => 'boolean',
- ],
- ],
- ],
- 'ModelProvider' => [
- 'title' => '模型提供商',
- 'description' => '工具集',
- 'type' => 'object',
- 'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Toolset',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-toolset',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'description' => [
- 'title' => '模型提供商的描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
- ],
- 'labels' => [
- 'title' => '资源的标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- ],
- ],
- ],
- 'ModelProviderAuthorization' => [
- 'title' => '模型提供商鉴权信息',
- 'type' => 'object',
- 'properties' => [
- 'authConfig' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'type' => [
- 'title' => '模型提供商鉴权类型',
- 'type' => 'string',
- 'example' => 'apiKey',
- ],
- ],
- ],
- 'ModelProviderSchema' => [
- 'title' => '工具集鉴权信息',
- 'type' => 'object',
- 'properties' => [
- 'detail' => [
- 'title' => '工具集 Schema 详情',
- 'type' => 'string',
- 'example' => '',
- ],
- 'type' => [
- 'title' => '工具集 Schema 类型',
- 'type' => 'string',
- 'example' => 'OpenAPI',
- ],
- ],
- ],
- 'ModelProviderSpec' => [
- 'title' => '模型提供商配置',
- 'type' => 'object',
- 'properties' => [
- 'authorization' => [
- '$ref' => '#/components/schemas/ModelProviderAuthorization',
- ],
- 'schema' => [
- '$ref' => '#/components/schemas/ModelProviderSchema',
- ],
+ 'name' => ['title' => '工具名称', 'type' => 'string', 'example' => 'demo-tool'],
+ 'description' => ['title' => '工具描述', 'type' => 'string', 'example' => 'Here is an example'],
+ 'inputSchema' => ['type' => 'object'],
],
],
'ModelSet' => [
@@ -5473,47 +732,16 @@
'description' => '模型集',
'type' => 'object',
'properties' => [
- 'generation' => [
- 'title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的类型，只读',
- 'type' => 'string',
- 'example' => 'ModelProvider',
- ],
- 'name' => [
- 'title' => '模型集的名称，账号内唯一，不可修改',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-modelset',
- ],
- 'createdTime' => [
- 'title' => '模型集创建时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'description' => [
- 'title' => '模型集的描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
- ],
- 'status' => [
- '$ref' => '#/components/schemas/ModelSetStatus',
- ],
+ 'generation' => ['title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致', 'type' => 'integer', 'format' => 'int64'],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'type' => 'string', 'required' => false, 'example' => '1455541096***548'],
+ 'kind' => ['title' => '当前资源的类型，只读', 'type' => 'string', 'example' => 'ModelProvider'],
+ 'name' => ['title' => '模型集的名称，账号内唯一，不可修改', 'type' => 'string', 'required' => true, 'example' => 'my-modelset'],
+ 'createdTime' => ['title' => '模型集创建时间，只读', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z'],
+ 'description' => ['title' => '模型集的描述信息', 'type' => 'string', 'example' => 'test-description'],
+ 'status' => ['$ref' => '#/components/schemas/ModelSetStatus'],
'labels' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key=value',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'key=value'],
'example' => 'key=value',
],
],
@@ -5526,96 +754,41 @@
'title' => '模型来源类型。predefined：预定义模型，customized：自定义模型',
'type' => 'string',
'example' => 'predefined',
- 'enum' => [
- 'customized',
- 'predefined',
- ],
- ],
- 'displayName' => [
- 'title' => '模型展示名称',
- 'type' => 'string',
- 'example' => '通义千问-Turbo-Latest',
- ],
- 'name' => [
- 'title' => '模型名称，API调用时指定',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'qwen-turbo-latest',
- ],
- 'description' => [
- 'title' => '模型描述',
- 'type' => 'string',
- 'example' => '通义千问系列速度最快、成本很低的模型，适合简单任务。本模型是动态更新版本，模型更新不会提前通知，模型中英文综合能力显著提升，模型人类偏好显著提升，模型推理能力和复杂指令理解能力显著增强，困难任务上的表现更优，数学、代码能力显著提升。',
- ],
- 'enabled' => [
- 'title' => '是否启用',
- 'type' => 'boolean',
+ 'enum' => ['customized', 'predefined'],
],
+ 'displayName' => ['title' => '模型展示名称', 'type' => 'string', 'example' => '通义千问-Turbo-Latest'],
+ 'name' => ['title' => '模型名称，API调用时指定', 'type' => 'string', 'required' => true, 'example' => 'qwen-turbo-latest'],
+ 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问系列速度最快、成本很低的模型，适合简单任务。本模型是动态更新版本，模型更新不会提前通知，模型中英文综合能力显著提升，模型人类偏好显著提升，模型推理能力和复杂指令理解能力显著增强，困难任务上的表现更优，数学、代码能力显著提升。'],
'props' => [
'title' => '模型属性',
'type' => 'object',
'properties' => [
- 'llmMode' => [
- 'title' => 'LLM模型模式，仅模型类型为llm可用。completion：文本补全；chat：对话',
- 'type' => 'string',
- ],
- 'contextSize' => [
- 'title' => '模型上下文窗口大小，模型支持的最大 Token 数。 仅模型类型为llm以及text-embedding 可用',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'llmMode' => ['title' => 'LLM模型模式，仅模型类型为llm可用。completion：文本补全；chat：对话', 'type' => 'string'],
+ 'contextSize' => ['title' => '模型上下文窗口大小，模型支持的最大 Token 数。 仅模型类型为llm以及text-embedding 可用', 'type' => 'integer', 'format' => 'int64'],
],
],
+ 'enabled' => ['title' => '是否启用', 'type' => 'boolean'],
],
],
'ModelSetSpec' => [
'title' => '模型集配置',
'type' => 'object',
'properties' => [
- 'features' => [
- 'title' => '模型能力特征',
- 'type' => 'object',
- 'properties' => [
- 'toolCall' => [
- 'title' => '是否支持ToolCall',
- 'type' => 'boolean',
- ],
- 'vision' => [
- 'title' => '是否支持视觉',
- 'type' => 'boolean',
- ],
- 'agentThought' => [
- 'title' => '是否支持Agent 推理',
- 'type' => 'boolean',
- ],
- ],
- ],
- 'models' => [
- 'title' => '模型列表',
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ModelSetModelProfile',
- ],
- 'required' => true,
- ],
- 'baseUrl' => [
- 'title' => '模型集服务地址，用于调用具体的模型',
- 'type' => 'string',
- ],
- 'authConfig' => [
- 'title' => '鉴权配置',
- '$ref' => '#/components/schemas/Authorization',
- ],
+ 'authConfig' => ['title' => '鉴权配置', '$ref' => '#/components/schemas/Authorization'],
'provider' => [
'title' => '模型提供商',
'type' => 'string',
'example' => 'FunctionAI',
- 'enum' => [
- 'OpenAI',
- 'FunctionAI',
- 'Tongyi',
- 'Anthropic',
- 'OpenAICompatible',
+ 'enum' => ['OpenAI', 'FunctionAI', 'Tongyi', 'Anthropic', 'OpenAICompatible'],
+ ],
+ 'baseUrl' => ['title' => '模型集服务地址，用于调用具体的模型', 'type' => 'string'],
+ 'features' => [
+ 'title' => '模型能力特征',
+ 'type' => 'object',
+ 'properties' => [
+ 'toolCall' => ['title' => '是否支持ToolCall', 'type' => 'boolean'],
+ 'vision' => ['title' => '是否支持视觉', 'type' => 'boolean'],
+ 'agentThought' => ['title' => '是否支持Agent 推理', 'type' => 'boolean'],
],
],
'modelType' => [
@@ -5629,25 +802,19 @@
'type' => 'string',
'required' => true,
'example' => 'llm',
- 'enum' => [
- 'llm',
- 'text-embedding',
- 'tts',
- 'rerank',
- 'speech2text',
- 'moderation',
- ],
+ 'enum' => ['llm', 'text-embedding', 'tts', 'rerank', 'speech2text', 'moderation'],
],
'apiInvokeType' => [
'title' => 'API调用方式。OpenAI(openai)、Anthropic(anthropic)，Ollama(ollama)',
'type' => 'string',
'example' => 'openai',
- 'enum' => [
- 'openai',
- 'ollama',
- 'anthropic',
- 'dashscope',
- ],
+ 'enum' => ['openai', 'ollama', 'anthropic', 'dashscope'],
+ ],
+ 'models' => [
+ 'title' => '模型列表',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/ModelSetModelProfile'],
+ 'required' => true,
],
],
],
@@ -5655,623 +822,318 @@
'title' => '模型供应商状态',
'type' => 'object',
'properties' => [
- 'phase' => [
- 'title' => '模型供应商当前状态',
- 'type' => 'string',
- ],
- 'observedTime' => [
- 'title' => '资源最近的一次状态更新时间',
- 'type' => 'string',
- ],
- 'observedGeneration' => [
- 'title' => '资源最近的一次状态更新时的资源generation',
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- 'ModelTask' => [
- 'title' => 'A short description of struct',
- 'type' => 'object',
- 'properties' => [
- 'finishTime' => [
- 'type' => 'number',
- 'format' => 'double',
- 'deprecated' => true,
- ],
- 'currentBytes' => [
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'type' => 'string',
- ],
- 'finished' => [
- 'title' => '是否完成',
- 'type' => 'boolean',
- ],
- 'updateTime' => [
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'params' => [
- 'type' => 'string',
- ],
- 'speed' => [
- 'type' => 'string',
- ],
- 'result' => [
- 'type' => 'any',
- ],
- 'taskType' => [
- 'type' => 'string',
- ],
- 'total' => [
- 'type' => 'number',
- 'format' => 'float',
- 'deprecated' => true,
- ],
- 'fileSize' => [
- 'type' => 'number',
- 'format' => 'double',
- 'deprecated' => true,
- ],
- 'errCode' => [
- 'type' => 'string',
- ],
- 'extra' => [
- 'type' => 'any',
- ],
- 'finishedTime' => [
- 'title' => '结束下载时间',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'totalBytes' => [
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '开始下载时间',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'id' => [
- 'title' => '任务 ID',
- 'type' => 'string',
- ],
- 'taskId' => [
- 'type' => 'string',
- ],
- 'status' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'NasMountConfig' => [
- 'type' => 'object',
- 'properties' => [
- 'enableTLS' => [
- 'type' => 'boolean',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- 'serverAddr' => [
- 'type' => 'string',
- ],
+ 'phase' => ['title' => '模型供应商当前状态', 'type' => 'string'],
+ 'observedTime' => ['title' => '资源最近的一次状态更新时间', 'type' => 'string'],
+ 'observedGeneration' => ['title' => '资源最近的一次状态更新时的资源generation', 'type' => 'integer', 'format' => 'int64'],
],
],
'OAuthCredential' => [
'title' => '身份绑定凭证',
'description' => 'OAuth凭证',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'token' => [
- 'title' => '代码托管平台访问凭证，开发平台使用该凭证访问第三方代码托管平台',
- 'description' => '代码托管平台访问凭证，开发平台使用该凭证访问第三方代码托管平台',
- 'type' => 'string',
- 'required' => true,
- 'example' => '4e84246b6b3962cd3d207aad1ea2f911',
- ],
- 'type' => [
- 'title' => '凭证的类型',
- 'description' => '凭证的类型',
- 'type' => 'string',
- 'example' => 'bearer',
- ],
- 'scope' => [
- 'title' => '凭证包含的权限范围',
- 'description' => '凭证包含的权限范围',
- 'type' => 'string',
- 'example' => 'user_info projects pull_requests hook gists emails',
- ],
- 'expiration' => [
- 'title' => '凭证到期时间，时间戳形式，-1表示永久有效',
- 'description' => '凭证到期时间，时间戳形式，-1表示永久有效',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1716263324603',
- ],
- 'createdTime' => [
- 'title' => '凭证生成时间，时间戳形式',
- 'description' => '凭证生成时间，时间戳形式',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1716176924603',
- ],
- 'refreshToken' => [
- 'title' => '刷新凭证时所需的信息',
- 'description' => '刷新凭证时所需的信息',
- 'type' => 'string',
- 'example' => '4d77bfae284770d94ebeed6b0199ebfd65e3943ba4f1e44dc36d792a93ba0d13',
- ],
- ],
- ],
- 'OSSMountPoint' => [
- 'type' => 'object',
- 'properties' => [
- 'bucketName' => [
- 'type' => 'string',
- ],
- 'bucketPath' => [
- 'type' => 'string',
- ],
- 'endpoint' => [
- 'type' => 'string',
- ],
- 'mountDir' => [
- 'type' => 'string',
- ],
- 'readOnly' => [
- 'type' => 'boolean',
- ],
+ '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' => '凭证到期时间，时间戳形式，-1表示永久有效', 'description' => '凭证到期时间，时间戳形式，-1表示永久有效', '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'],
],
],
'OpenAPIToolMeta' => [
'title' => 'OpenAPI类型的工具元信息',
'type' => 'object',
'properties' => [
- 'toolId' => [
- 'title' => '工具ID',
- 'type' => 'string',
- ],
- 'path' => [
- 'title' => '工具在OpenAPI中对应的路径',
- 'type' => 'string',
- ],
- 'method' => [
- 'title' => '工具在OpenAPI中对应的方法',
- 'type' => 'string',
- ],
- 'toolName' => [
- 'title' => '工具名称',
- 'type' => 'string',
- ],
- ],
- ],
- 'OperationModelFileAction' => [
- 'title' => 'A short description of struct',
- 'type' => 'object',
- 'properties' => [
- 'action' => [
- 'title' => '行为（move，copy，remove）',
- 'type' => 'string',
- 'required' => true,
- ],
- 'source' => [
- 'title' => '源文件（复制、移动）',
- 'type' => 'string',
- 'required' => false,
- ],
- 'destination' => [
- 'title' => '目的文件（复制、移动）',
- 'type' => 'string',
- 'required' => false,
- ],
- 'target' => [
- 'title' => '目标文件（删除）',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'toolName' => ['title' => '工具名称', 'type' => 'string'],
+ 'toolId' => ['title' => '工具ID', 'type' => 'string'],
+ 'path' => ['title' => '工具在OpenAPI中对应的路径', 'type' => 'string'],
+ 'method' => ['title' => '工具在OpenAPI中对应的方法', 'type' => 'string'],
],
],
- 'OssSourceConfig' => [
- 'title' => 'OSS代码源对象',
+ 'OSSMountPoint' => [
'type' => 'object',
'properties' => [
- 'bucket' => [
- 'title' => 'OSS bucket名称',
- 'type' => 'string',
- 'example' => 'demo-bucket',
- ],
- 'object' => [
- 'title' => 'OSS 对象名称',
- 'type' => 'string',
- 'example' => 'demo-object',
- ],
+ 'bucketName' => ['type' => 'string'],
+ 'bucketPath' => ['type' => 'string'],
+ 'endpoint' => ['type' => 'string'],
+ 'mountDir' => ['type' => 'string'],
+ 'readOnly' => ['type' => 'boolean'],
],
],
'Pipeline' => [
'title' => 'A short description of struct',
'description' => '流水线运行',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'spec' => [
- 'description' => '流水线配置',
- '$ref' => '#/components/schemas/PipelineSpec',
- ],
- 'status' => [
- 'description' => '流水线运行状态',
- '$ref' => '#/components/schemas/PipelineStatus',
- ],
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'generation' => [
- 'title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'description' => [
- 'title' => '流水线描述信息',
- 'description' => '流水线描述信息',
- 'type' => 'string',
- 'example' => 'Pipeline example.',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Pipeline',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-pipeline',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
+ 'spec' => ['description' => '流水线配置', 'visibility' => 'Public', 'backendName' => 'spec', '$ref' => '#/components/schemas/PipelineSpec'],
+ 'status' => ['description' => '流水线运行状态', 'visibility' => 'Public', 'backendName' => 'status', '$ref' => '#/components/schemas/PipelineStatus'],
+ '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' => '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'resourceVersion' => [
- 'title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ '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'],
],
],
'PipelineSpec' => [
'title' => 'A short description of struct',
'description' => '流水线配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'templateName' => [
- 'title' => '流水线模板名称',
- 'description' => '流水线模板名称',
- 'type' => 'string',
- 'example' => 'my-pipeline-template',
- ],
- 'context' => [
- 'title' => '流水线的执行上下文',
- 'description' => '流水线的执行上下文',
- '$ref' => '#/components/schemas/Context',
- ],
- 'templateSpec' => [
- 'title' => '流水线执行流程的描述，优先级高于templateName，流水线执行不再需要预先创建PipelineTemplate',
- 'description' => '流水线执行流程的描述，优先级高于templateName，流水线执行不再需要预先创建PipelineTemplate',
- '$ref' => '#/components/schemas/PipelineTemplateSpec',
- ],
+ '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' => '流水线执行流程的描述，优先级高于templateName，流水线执行不再需要预先创建PipelineTemplate', 'description' => '流水线执行流程的描述，优先级高于templateName，流水线执行不再需要预先创建PipelineTemplate', 'visibility' => 'Public', 'backendName' => 'templateSpec', '$ref' => '#/components/schemas/PipelineTemplateSpec'],
],
],
'PipelineStatus' => [
'title' => 'A short description of struct',
'description' => '流水线运行状态',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'phase' => [
- 'title' => '当前流水线执行的阶段',
- 'description' => '当前流水线执行的阶段',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'latestExecError' => [
- 'title' => '流水线出现的最近一次任务异常',
- 'description' => '流水线出现的最近一次任务异常',
- '$ref' => '#/components/schemas/TaskExecError',
- ],
+ 'phase' => ['title' => '当前流水线执行的阶段', 'description' => '当前流水线执行的阶段', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Success', 'backendName' => 'phase'],
+ 'latestExecError' => ['title' => '流水线出现的最近一次任务异常', 'description' => '流水线出现的最近一次任务异常', 'visibility' => 'Public', 'backendName' => 'latestExecError', '$ref' => '#/components/schemas/TaskExecError'],
],
],
'PipelineTemplate' => [
'title' => 'A short description of struct',
'description' => '流水线模板',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'generation' => [
- 'title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'description' => [
- 'title' => '流水线模板描述信息',
- 'description' => '流水线模板描述信息',
- 'type' => 'string',
- 'example' => 'PipelineTemplate example.',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'PipelineTemplate',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-pipeline-template',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
- 'deletionTime' => [
- 'title' => '资源删除时间，只读',
- 'description' => '资源删除时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'spec' => [
- 'description' => '流水线模板配置',
- '$ref' => '#/components/schemas/PipelineTemplateSpec',
- ],
+ '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' => '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'resourceVersion' => [
- 'title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ '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'],
],
],
'PipelineTemplateSpec' => [
'title' => 'A short description of struct',
'description' => '任务模板配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'context' => [
- 'title' => '流水线的执行上下文',
- 'description' => '流水线的执行上下文',
- '$ref' => '#/components/schemas/Context',
- ],
+ 'context' => ['title' => '流水线的执行上下文', 'description' => '流水线的执行上下文', 'visibility' => 'Public', 'backendName' => 'context', '$ref' => '#/components/schemas/Context'],
'tasks' => [
'title' => '任务执行列表',
'description' => '任务执行列表',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '任务执行配置',
- '$ref' => '#/components/schemas/TaskExec',
- ],
+ 'items' => ['description' => '任务执行配置', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TaskExec'],
+ 'backendName' => 'tasks',
+ ],
+ 'contextSchema' => ['title' => '需要的执行上下文的格式描述', 'description' => '需要的执行上下文的格式描述', 'visibility' => 'Private', 'type' => 'object', 'backendName' => 'contextSchema'],
+ ],
+ ],
+ 'PipelineTrigger' => [
+ 'title' => '流水线触发器',
+ 'description' => '描述git事件触发流水线的规则',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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' => '资源的标签',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ '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'],
+ ],
+ ],
+ 'PipelineTriggerEvent' => [
+ 'title' => '流水线触发器触发事件',
+ 'description' => '记录触发器触发事件',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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' => '资源的标签',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ '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'],
+ ],
+ ],
+ 'PipelineTriggerEventSpec' => [
+ 'title' => 'A short description of struct',
+ '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'],
+ ],
+ ],
+ 'PipelineTriggerEventStatus' => [
+ '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'],
+ ],
+ ],
+ 'PipelineTriggerSpec' => [
+ 'title' => '流水线触发器配置',
+ 'description' => '描述触发器的触发规则与运行的流水线',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Project',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-project',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- ],
- 'description' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
- ],
- 'status' => [
- '$ref' => '#/components/schemas/ProjectStatus',
+ 'additionalProperties' => ['visibility' => 'Public', 'type' => 'string', 'example' => 'key=value'],
+ 'backendName' => 'labels',
],
+ 'description' => ['title' => '描述信息', 'description' => '描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test-description', 'backendName' => 'description'],
+ 'spec' => ['visibility' => 'Private', 'backendName' => 'spec', '$ref' => '#/components/schemas/ProjectSpec'],
+ 'status' => ['visibility' => 'Public', 'backendName' => 'status', '$ref' => '#/components/schemas/ProjectStatus'],
],
],
'ProjectSpec' => [
'title' => '项目配置',
'description' => '一键部署配置',
+ 'visibility' => 'Public',
'type' => 'object',
- 'properties' => [],
+ 'properties' => [
+ 'token' => ['title' => '项目身份令牌，用于触发部署时的身份校验，只读', 'description' => '项目身份令牌，用于触发部署时的身份校验，只读', 'visibility' => 'Private', 'type' => 'string', 'example' => '9D72DE01-C732-49C0-8E85-FFD9D695436B', 'backendName' => 'token'],
+ ],
],
'ProjectStatus' => [
'title' => '项目状态',
'description' => '一键部署配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
'services' => [
'title' => '项目下的服务列表',
'description' => '项目下的服务列表',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/ServiceMeta',
- ],
+ 'items' => ['visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ServiceMeta'],
+ 'backendName' => 'services',
],
+ 'isDeleting' => ['title' => '项目是否删除中', 'description' => '项目是否删除中', 'visibility' => 'Private', 'type' => 'boolean', 'backendName' => 'isDeleting'],
],
],
'PublishTask' => [
'type' => 'object',
'properties' => [
- 'name' => [
- 'type' => 'string',
- ],
- 'kind' => [
- 'type' => 'string',
- ],
- 'uid' => [
- 'type' => 'string',
- ],
- 'createdTime' => [
- 'type' => 'string',
- ],
- 'description' => [
- 'type' => 'string',
- ],
- 'spec' => [
- '$ref' => '#/components/schemas/PublishTaskSpec',
- ],
- 'status' => [
- '$ref' => '#/components/schemas/PublishTaskStatus',
- ],
+ 'name' => ['type' => 'string'],
+ 'kind' => ['type' => 'string'],
+ 'uid' => ['type' => 'string'],
+ 'createdTime' => ['type' => 'string'],
+ 'description' => ['type' => 'string'],
+ 'spec' => ['$ref' => '#/components/schemas/PublishTaskSpec'],
+ 'status' => ['$ref' => '#/components/schemas/PublishTaskStatus'],
'labels' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
'PublishTaskSpec' => [
'type' => 'object',
'properties' => [
- 'type' => [
- 'type' => 'string',
- ],
+ 'type' => ['type' => 'string'],
'options' => [
'type' => 'object',
'properties' => [
- 'autoSave' => [
- 'type' => 'boolean',
- ],
+ 'autoSave' => ['type' => 'boolean'],
],
],
'rawResourceConfig' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- ],
+ 'additionalProperties' => ['type' => 'any'],
],
],
],
'PublishTaskStatus' => [
'type' => 'object',
'properties' => [
- 'phase' => [
- 'type' => 'string',
- ],
+ 'phase' => ['type' => 'string'],
'phases' => [
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
- 'attempts' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'status' => [
- 'type' => 'string',
- ],
- 'startTime' => [
- 'type' => 'string',
- ],
- 'finishTime' => [
- 'type' => 'string',
- ],
+ 'attempts' => ['type' => 'integer', 'format' => 'int32'],
+ 'status' => ['type' => 'string'],
+ 'startTime' => ['type' => 'string'],
+ 'finishTime' => ['type' => 'string'],
'details' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- ],
+ 'additionalProperties' => ['type' => 'any'],
],
'error' => [
'type' => 'object',
'properties' => [
- 'message' => [
- 'type' => 'string',
- ],
- 'code' => [
- 'type' => 'string',
- ],
+ 'message' => ['type' => 'string'],
+ 'code' => ['type' => 'string'],
],
],
],
@@ -6282,1327 +1144,410 @@
'PullRequestFilter' => [
'title' => 'PR或MR事件过滤配置',
'description' => 'PR或MR事件过滤配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'sourceBranch' => [
- 'title' => 'PR或MR的来源分支名称正则表达式，不填则表示所有分支',
- 'description' => 'PR或MR的来源分支名称正则表达式，不填则表示所有分支',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'feature-.*',
- ],
- 'targetBranch' => [
- 'title' => 'PR或MR的目标分支名称正则表达式，不填则表示所有分支',
- 'description' => 'PR或MR的目标分支名称正则表达式，不填则表示所有分支',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'master',
- ],
+ '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' => 'PR或MR的类型，为空则表示所有类型。TODO：场景类型',
'description' => 'PR或MR的类型，为空则表示所有类型。',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '可枚举的类型。包括：(opened、closed、merged、reopened、updated）',
- 'type' => 'string',
- 'example' => 'opened',
- ],
+ 'items' => ['description' => '可枚举的类型。包括：(opened、closed、merged、reopened、updated）', 'visibility' => 'Public', 'type' => 'string', 'example' => 'opened', 'extendType' => 'true'],
+ 'backendName' => 'types',
],
],
],
'PushFilter' => [
'title' => '推送事件过滤配置',
'description' => '推送事件过滤配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'branch' => [
- 'title' => '推送的分支名称正则表达式',
- 'description' => '推送的分支名称正则表达式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'master',
- ],
- 'tag' => [
- 'title' => '推送的tag名称正则表达式',
- 'description' => '推送的tag名称正则表达式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'prod-.*',
- ],
+ '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' => '流水线发布结果的详情',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Repository',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-repository',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
- 'spec' => [
- 'title' => '仓库绑定配置',
- 'description' => '仓库绑定配置',
- 'required' => true,
- '$ref' => '#/components/schemas/RepositorySpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- ],
- 'description' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
+ 'additionalProperties' => ['visibility' => 'Public', 'type' => 'string', 'example' => 'key=value'],
+ 'backendName' => 'labels',
],
+ 'description' => ['title' => '描述信息', 'description' => '描述信息', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test-description', 'backendName' => 'description'],
],
],
- 'RepositorySourceConfig' => [
- 'title' => '仓库源码配置，描述一个代码仓库中的一套源码',
- 'description' => '仓库源码配置，描述一个代码仓库中的一套源码',
+ 'RepositoryConfig' => [
+ 'title' => 'A short description of struct',
+ 'description' => '代码仓库配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'repositoryName' => [
- 'title' => '关联的平台中的仓库绑定实体的名称，该实体描述了一个具体的代码仓库',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-repository',
- ],
- 'codeVersion' => [
- 'title' => '代码版本引用，描述了代码仓库中一个具体的代码版本',
- '$ref' => '#/components/schemas/CodeVersionReference',
- ],
- 'filter' => [
- '$ref' => '#/components/schemas/EventFilterConfig',
- ],
+ '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',
'type' => 'object',
'properties' => [
- 'connectionName' => [
- 'title' => '仓库所使用的身份绑定信息。通过关联的Connection可以获取到代码托管平台账号和凭证等信息',
- 'description' => '仓库所使用的身份绑定信息。通过关联的Connection可以获取到代码托管平台账号和凭证等信息',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'awesome-connection',
- ],
- 'cloneUrl' => [
- 'title' => '拉取仓库代码(git clone)所需的链接，支持HTTPS和SSH形式。',
- 'description' => '拉取仓库代码(git clone)所需的链接，支持HTTPS和SSH形式。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://github.com/DDofDD/start-springboot-lfgy.git',
- ],
- 'platform' => [
- 'title' => '只读，仓库所属代码托管平台的类型，支持github、gitee、gitlab、codeup',
- 'description' => '只读，仓库所属代码托管平台的类型，支持github、gitee、gitlab、codeup',
- 'type' => 'string',
- 'example' => 'github',
- ],
- 'id' => [
- 'title' => '只读，代码托管平台中的仓库ID，平台内唯一',
- 'description' => '只读，代码托管平台中的仓库ID，平台内唯一',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '312649',
- ],
- 'owner' => [
- 'title' => '只读，代码托管平台中仓库所属账号名或组织名',
- 'description' => '只读，代码托管平台中仓库所属账号名或组织名',
- 'type' => 'string',
- 'example' => 'my-org-name',
- ],
- 'displayName' => [
- 'title' => '只读，代码托管平台中的仓库名',
- 'description' => '只读，代码托管平台中的仓库名',
- 'type' => 'string',
- 'example' => 'my-repo-name',
- ],
- 'webUrl' => [
- 'title' => '只读，仓库主页链接',
- 'description' => '只读，仓库主页链接',
- 'type' => 'string',
- 'example' => 'https://github.com/my-org-name/my-repo-name',
- ],
- ],
- ],
- 'RunAfter' => [
- 'title' => '任务依赖，必须在依赖结束后执行',
- 'description' => 'Describe dependencies',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '执行依赖的任务代称',
- 'description' => '执行依赖的任务代称',
- 'type' => 'string',
- 'example' => 'task-1',
- ],
- ],
- ],
- 'ServiceBaseline' => [
- 'title' => '服务的基线信息',
- 'description' => '服务的配置基线信息',
- 'type' => 'object',
- 'properties' => [
- 'serviceInstance' => [
- 'title' => '服务的配置与状态',
- '$ref' => '#/components/schemas/ServiceInstance',
- ],
- ],
- ],
- 'ServiceChanges' => [
- 'title' => 'A short description of struct',
- 'description' => '服务变更',
- 'type' => 'object',
- 'properties' => [
- 'merge' => [
- 'title' => '服务的配置变化，是ServiceConfig配置的JSONMerge对象',
- 'type' => 'object',
- 'example' => '{}: 不进行修改',
- ],
- ],
- ],
- 'ServiceCommandStep' => [
- 'title' => '组件初始化命令类型步骤',
- 'description' => '组件初始化命令类型步骤',
- 'type' => 'object',
- 'properties' => [
- 'run' => [
- 'title' => '命令',
- 'type' => 'string',
- 'example' => 's invoke',
- ],
- 'path' => [
- 'title' => '工作路径',
- 'type' => 'string',
- 'example' => './',
- ],
- ],
- ],
- 'ServiceComponentStep' => [
- 'title' => '组件类型步骤',
- 'description' => '服务的组件类型步骤',
- 'type' => 'object',
- 'properties' => [
- 'component' => [
- 'title' => '组件类型命令',
- 'type' => 'string',
- 'example' => 'fc3 invoke',
- ],
- ],
- ],
- 'ServiceConfig' => [
- 'title' => '服务配置',
- 'description' => '服务配置描述',
- 'type' => 'object',
- 'properties' => [
- 'props' => [
- 'title' => '服务属性',
- 'type' => 'object',
- ],
- 'source' => [
- 'title' => '代码源配置',
- '$ref' => '#/components/schemas/SourceConfig',
- ],
- 'build' => [
- '$ref' => '#/components/schemas/BuildConfig',
- ],
- 'variables' => [
- 'title' => '服务变量',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/Variable',
- ],
- ],
- 'type' => [
- 'title' => '服务的类型',
- 'type' => 'string',
- 'example' => 'Function',
- ],
- 'component' => [
- 'title' => '组件名称，符合ServerlessDevs的规范',
- 'type' => 'string',
- 'example' => 'fc3@1.0.0',
- ],
- 'artifact' => [
- 'title' => '交付物配置。配置后部署时会使用指定的交付物',
- '$ref' => '#/components/schemas/ArtifactMeta',
- ],
- ],
- ],
- 'ServiceDeployment' => [
- 'title' => '服务部署',
- 'description' => '描述一次环境的部署中，服务的部署详情',
- 'type' => 'object',
- 'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'description' => [
- 'title' => '资源的描述信息',
- 'type' => 'string',
- 'example' => 'commit by xxx.',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Deployment',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'environmentDeploymentName' => [
- 'title' => '当前服务部署所关联的环境部署，只读。一次环境部署会涉及1~N个服务部署，服务部署之间存在可能存在依赖关系',
- 'type' => 'string',
- 'example' => 'my-environment-deployment',
- ],
- 'name' => [
- 'title' => '当前资源的名称。在项目中，它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-deployment',
- 'maxLength' => 63,
- 'minLength' => 1,
- 'pattern' => '^(?![0-9]+$)(?!-)[a-zA-Z0-9-_]{0,63}(?<!-)$',
- ],
- 'status' => [
- 'title' => '部署的状态',
- '$ref' => '#/components/schemas/ServiceDeploymentStatus',
- ],
- 'labels' => [
- 'title' => '资源的标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- ],
- ],
- 'ServiceDeploymentSpec' => [
- 'title' => 'A short description of struct',
- 'description' => '服务部署的配置信息',
- 'type' => 'object',
- 'properties' => [
- 'changes' => [
- 'title' => '服务配置的修改',
- '$ref' => '#/components/schemas/ServiceChanges',
- ],
- 'baseline' => [
- 'title' => '服务配置的基线信息',
- '$ref' => '#/components/schemas/ServiceBaseline',
- ],
- 'target' => [
- 'title' => '本次部署计划达到的服务配置目标',
- '$ref' => '#/components/schemas/ServiceBaseline',
- ],
- 'skipRemoveResources' => [
- 'title' => '删除时，是否要跳过清理资源。默认为false，对资源进行清理',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'connectionName' => ['title' => '仓库所使用的身份绑定信息。通过关联的Connection可以获取到代码托管平台账号和凭证等信息', 'description' => '仓库所使用的身份绑定信息。通过关联的Connection可以获取到代码托管平台账号和凭证等信息', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'awesome-connection', 'backendName' => 'connectionName'],
+ 'cloneUrl' => ['title' => '拉取仓库代码(git clone)所需的链接，支持HTTPS和SSH形式。', 'description' => '拉取仓库代码(git clone)所需的链接，支持HTTPS和SSH形式。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'https://github.com/DDofDD/start-springboot-lfgy.git', 'backendName' => 'cloneUrl'],
+ 'platform' => ['title' => '只读，仓库所属代码托管平台的类型，支持github、gitee、gitlab、codeup', 'description' => '只读，仓库所属代码托管平台的类型，支持github、gitee、gitlab、codeup', 'visibility' => 'Public', 'type' => 'string', 'example' => 'github', 'backendName' => 'platform'],
+ 'id' => ['title' => '只读，代码托管平台中的仓库ID，平台内唯一', 'description' => '只读，代码托管平台中的仓库ID，平台内唯一', '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'],
],
],
- 'ServiceDeploymentStatus' => [
- 'title' => '服务部署的状态信息',
+ 'ResourceDrift' => [
+ 'title' => '基础设施堆栈资源漂移',
+ 'description' => '资源漂移',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'phase' => [
- 'title' => '本次服务部署的状态，包括：Initializing：初始化中、Running: 部署中、Finished: 已部署、Failed: 部署失败、Canceled: 已取消、HangUp：已挂起',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'pipelineName' => [
- 'title' => '本次服务部署所对应的环境部署使用的流水线名称',
- 'type' => 'string',
- 'example' => 'my-pipeline',
- ],
- 'startTime' => [
- 'title' => '部署开始时间，具体为状态从Initializing转换为Running的时刻的时间',
- 'type' => 'string',
- ],
- 'finishedTime' => [
- 'title' => '部署完成时间',
- 'type' => 'string',
- ],
- 'taskName' => [
- 'title' => '本次服务部署使用的任务名称',
- 'type' => 'string',
- 'example' => 'my-task',
- ],
- ],
- ],
- 'ServiceInstance' => [
- 'title' => 'A short description of struct',
- 'description' => '服务在具体环境中部署所产生的服务实例',
- 'type' => 'object',
- 'properties' => [
- 'config' => [
- 'title' => '服务在当前环境中的配置信息',
- '$ref' => '#/components/schemas/ServiceConfig',
- ],
- 'variables' => [
- 'title' => '服务当前所使用的环境共享变量的快照，在服务每次成功部署时更新',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/Variable',
- ],
- ],
- 'outputs' => [
- 'title' => '服务的输出，可以被引用',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- ],
- 'example' => '{}',
- ],
- 'latestDeployment' => [
- 'title' => '最近一次服务部署的必要元数据信息',
+ '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' => '详细漂移结果',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '服务部署（ServiceDeployment）的名称',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '部署开始时间，具体为状态从Initializing转换为Running的时刻的时间',
- 'type' => 'string',
- ],
- 'finishedTime' => [
- 'title' => '部署完成时间',
- 'type' => 'string',
- ],
- 'phase' => [
- 'title' => '本次服务部署的状态，包括：Initializing：初始化中、Running: 部署中、Finished: 已部署、Failed: 部署失败、Canceled: 已取消、HangUp：已挂起',
- 'type' => 'string',
- 'example' => 'Running',
+ 'actions' => [
+ 'title' => '漂移行为',
+ 'description' => '漂移行为',
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ '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'],
],
+ 'backendName' => 'change',
],
],
],
- 'ServiceMeta' => [
- 'title' => '服务的元数据信息',
- 'description' => '服务元数据',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => '服务名称',
- 'type' => 'string',
- 'example' => 'my-service',
- ],
- 'type' => [
- 'title' => '服务类型',
- 'type' => 'string',
- 'example' => 'fc3',
- ],
- ],
- ],
- 'ServicePluginStep' => [
- 'title' => '插件步骤',
- 'description' => '服务插件步骤',
- 'type' => 'object',
- 'properties' => [
- 'plugin' => [
- 'title' => '插件的名称',
- 'type' => 'string',
- 'example' => 'dingding-robot',
- ],
- 'args' => [
- 'title' => '插件的参数',
- 'type' => 'object',
- 'example' => '{"key":"value"}',
- ],
- ],
- ],
- 'SourceConfig' => [
- 'title' => '源代码配置，Dipper平台会使用该配置定位一套源代码并进行后续的构建和部署',
- 'description' => '代码源配置',
- 'type' => 'object',
- 'properties' => [
- 'template' => [
- 'title' => '模板源码配置，描述Serverless Registry中一个模板代码仓库中的一套源代码',
- '$ref' => '#/components/schemas/TemplateSourceConfig',
- ],
- 'repository' => [
- 'title' => '仓库源码配置，描述了一个代码仓库中的一套源码',
- '$ref' => '#/components/schemas/RepositorySourceConfig',
- ],
- 'oss' => [
- '$ref' => '#/components/schemas/OssSourceConfig',
+ 'RunAfter' => [
+ 'title' => '任务依赖，必须在依赖结束后执行',
+ 'description' => 'Describe dependencies',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '执行依赖的任务代称', 'description' => '执行依赖的任务代称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'task-1', 'backendName' => 'name'],
+ ],
+ ],
+ 'RunPipelineConfig' => [
+ 'title' => '触发后运行流水线配置',
+ 'description' => '触发后运行流水线配置',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ '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' => '流水线环境变量，可以在流水线执行时引用',
+ 'visibility' => 'Public',
+ 'type' => 'array',
+ 'items' => ['description' => '变量', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/Variable'],
+ 'backendName' => 'variables',
],
],
],
'Task' => [
'title' => 'A short description of struct',
'description' => '任务运行',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'spec' => [
- 'description' => '任务运行配置',
- '$ref' => '#/components/schemas/TaskSpec',
- ],
- 'status' => [
- 'description' => '任务运行状态',
- '$ref' => '#/components/schemas/TaskStatus',
- ],
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'generation' => [
- 'title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'description' => [
- 'title' => '任务描述信息',
- 'description' => '任务描述信息',
- 'type' => 'string',
- 'example' => 'Task example.',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Task',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-task',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
+ 'spec' => ['description' => '任务运行配置', 'visibility' => 'Public', 'backendName' => 'spec', '$ref' => '#/components/schemas/TaskSpec'],
+ 'status' => ['description' => '任务运行状态', 'visibility' => 'Public', 'backendName' => 'status', '$ref' => '#/components/schemas/TaskStatus'],
+ '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' => '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'resourceVersion' => [
- 'title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ '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'],
],
],
'TaskExec' => [
'title' => 'A short description of struct',
'description' => '任务执行',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '当前任务代称',
- 'description' => '当前任务代称',
- 'type' => 'string',
- 'example' => 'task-1',
- ],
- 'context' => [
- 'title' => '执行上下文',
- 'description' => '执行上下文',
- '$ref' => '#/components/schemas/Context',
- ],
- 'taskTemplate' => [
- 'title' => '任务模板名称',
- 'description' => '任务模板名称',
- 'type' => 'string',
- 'example' => 'serverless-runner',
- ],
+ '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'],
'runAfters' => [
'title' => '执行顺序，必须在所有依赖任务执行完毕后才能被执行',
'description' => '执行顺序，必须在所有依赖任务执行完毕后才能被执行',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '执行依赖的任务代称。',
- '$ref' => '#/components/schemas/RunAfter',
- ],
+ 'items' => ['description' => '执行依赖的任务代称。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/RunAfter'],
+ 'backendName' => 'runAfters',
],
],
],
'TaskExecError' => [
'title' => '任务执行出现的异常描述',
'description' => '任务执行异常',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'title' => [
- 'title' => '错误描述',
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => '权限不足错误',
- ],
- 'message' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '部署服务[_appcenter-xxx]失败，权限不足',
- ],
- 'code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'AccessDenied',
- ],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '1-26d1287xxxxx',
- ],
- 'extraInfo' => [
- 'title' => '对解决错误有帮助的额外信息',
- 'description' => '对解决错误有帮助的额外信息',
- 'type' => 'string',
- 'example' => '部署辅助函数权限不足，需要添加额外的权限以解决问题',
- ],
+ 'title' => ['title' => '错误描述', 'description' => '错误描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '权限不足错误', 'backendName' => 'title'],
+ 'message' => ['title' => '错误信息', 'description' => '错误信息', 'visibility' => 'Public', 'type' => 'string', 'example' => '部署服务[_appcenter-xxx]失败，权限不足', 'backendName' => 'message'],
+ 'code' => ['title' => '错误码', 'description' => '错误码', 'visibility' => 'Public', 'type' => 'string', 'example' => 'AccessDenied', 'backendName' => 'code'],
+ 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'visibility' => 'Public', 'type' => 'string', 'example' => '1-26d1287xxxxx', 'backendName' => 'requestId'],
+ 'extraInfo' => ['title' => '对解决错误有帮助的额外信息', 'description' => '对解决错误有帮助的额外信息', 'visibility' => 'Public', 'type' => 'string', 'example' => '部署辅助函数权限不足，需要添加额外的权限以解决问题', 'backendName' => 'extraInfo'],
],
],
'TaskInvocation' => [
'title' => 'A short description of struct',
'description' => '任务调用详情',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'invocationID' => [
- 'title' => '调用ID，任务在函数计算中的调用ID',
- 'description' => '调用ID，任务在函数计算中的调用ID',
- 'type' => 'string',
- 'example' => 'E099843B-10A2-4936-9964-4E0EE263D564',
- ],
- 'requestID' => [
- 'title' => '请求ID，任务在函数计算中的请求ID',
- 'description' => '请求ID，任务在函数计算中的请求ID',
- 'type' => 'string',
- 'example' => '1B3058B1-F1C9-457C-B95C-2C250A4B3118',
- ],
- 'invocationTarget' => [
- 'title' => '调用目标',
- 'description' => '调用目标',
- 'type' => 'string',
- 'example' => 'acs:fc:cn-hangzhou:143xxxx:services/xxx.LATEST/functions/xxx',
- ],
- 'status' => [
- 'title' => '上一次观测到的调用状态。',
- 'description' => '上一次观测到的调用状态。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'output' => [
- 'title' => '调用结果',
- 'description' => '调用结果',
- 'type' => 'string',
- 'example' => '{"key1":"value1","key2":"value2"}',
- ],
- 'instanceID' => [
- 'title' => '调用命中的实例ID',
- 'description' => '调用命中的实例ID',
- 'type' => 'string',
- 'example' => 'c-nkj8shz7xxxx',
- ],
- 'slsProject' => [
- 'title' => '日志投递到SLS产品的Project名称',
- 'description' => '日志投递到SLS产品的Project名称',
- 'type' => 'string',
- 'example' => 'my-sls-project',
- ],
- 'slsLogStore' => [
- 'title' => '日志投递到SLS产品的Logstore名称',
- 'description' => '日志投递到SLS产品的Logstore名称',
- 'type' => 'string',
- 'example' => 'my-sls-logstore',
- ],
+ 'invocationID' => ['title' => '调用ID，任务在函数计算中的调用ID', 'description' => '调用ID，任务在函数计算中的调用ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'E099843B-10A2-4936-9964-4E0EE263D564', 'backendName' => 'invocationID'],
+ 'requestID' => ['title' => '请求ID，任务在函数计算中的请求ID', 'description' => '请求ID，任务在函数计算中的请求ID', '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' => '调用命中的实例ID', 'description' => '调用命中的实例ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'c-nkj8shz7xxxx', 'backendName' => 'instanceID'],
+ 'slsProject' => ['title' => '日志投递到SLS产品的Project名称', 'description' => '日志投递到SLS产品的Project名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my-sls-project', 'backendName' => 'slsProject'],
+ 'slsLogStore' => ['title' => '日志投递到SLS产品的Logstore名称', 'description' => '日志投递到SLS产品的Logstore名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my-sls-logstore', 'backendName' => 'slsLogStore'],
],
],
'TaskSpec' => [
'title' => 'A short description of struct',
'description' => '任务运行配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'templateName' => [
- 'title' => '任务模板名称',
- 'description' => '任务模板名称',
- 'type' => 'string',
- 'example' => 'my-task-template',
- ],
- 'context' => [
- 'title' => '任务的执行上下文',
- 'description' => '任务的执行上下文',
- '$ref' => '#/components/schemas/Context',
- ],
+ 'templateName' => ['title' => '任务模板名称', 'description' => '任务模板名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'my-task-template', 'backendName' => 'templateName'],
+ 'context' => ['title' => '任务的执行上下文', 'description' => '任务的执行上下文', 'visibility' => 'Public', 'backendName' => 'context', '$ref' => '#/components/schemas/Context'],
],
],
'TaskStatus' => [
'title' => 'A short description of struct',
'description' => '任务运行状态',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'statusGeneration' => [
- 'title' => '状态版本号',
- 'description' => '状态版本号',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'phase' => [
- 'title' => '当前执行阶段',
- 'description' => '当前执行阶段',
- 'type' => 'string',
- 'example' => 'Success',
- ],
+ 'statusGeneration' => ['title' => '状态版本号', 'description' => '状态版本号', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'backendName' => 'statusGeneration'],
+ 'phase' => ['title' => '当前执行阶段', 'description' => '当前执行阶段', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Success', 'backendName' => 'phase'],
'executionDetails' => [
'title' => '执行详情',
'description' => '执行详情',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '执行详情',
- 'type' => 'string',
- 'example' => 'step1: start task.',
- ],
+ 'items' => ['description' => '执行详情', 'visibility' => 'Public', 'type' => 'string', 'example' => 'step1: start task.', 'extendType' => 'true'],
+ 'backendName' => 'executionDetails',
],
'invocations' => [
'title' => '执行历史',
'description' => '执行历史',
+ 'visibility' => 'Public',
'type' => 'array',
- 'items' => [
- 'description' => '调用的列表',
- '$ref' => '#/components/schemas/TaskInvocation',
- ],
- ],
- 'latestExecError' => [
- 'title' => '最近一次任务执行错误',
- 'description' => '最近一次任务执行错误',
- '$ref' => '#/components/schemas/TaskExecError',
+ 'items' => ['description' => '调用的列表', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TaskInvocation'],
+ 'backendName' => 'invocations',
],
+ 'latestExecError' => ['title' => '最近一次任务执行错误', 'description' => '最近一次任务执行错误', 'visibility' => 'Public', 'backendName' => 'latestExecError', '$ref' => '#/components/schemas/TaskExecError'],
],
],
'TaskTemplate' => [
'description' => '任务模板',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'generation' => [
- 'title' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'description' => '当前配置的自增的序列号，由系统填充，只读。当spec更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'description' => [
- 'title' => '任务模板描述信息',
- 'description' => '任务模板描述信息',
- 'type' => 'string',
- 'example' => 'TaskTemplate example.',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'TaskTemplate',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-task-template',
- 'maxLength' => 40,
- 'minLength' => 1,
- 'pattern' => '[a-z](?!-)[a-z0-9-]{1,40}(?<!-)',
- ],
- 'deletionTime' => [
- 'title' => '资源删除时间，只读',
- 'description' => '资源删除时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'spec' => [
- 'title' => '资源的配置属性',
- 'description' => '资源的配置属性',
- '$ref' => '#/components/schemas/TaskTemplateSpec',
- ],
+ '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' => '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'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '资源标签的值',
- ],
- ],
- 'resourceVersion' => [
- 'title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'additionalProperties' => ['description' => '标签', 'visibility' => 'Public', 'type' => 'string', 'example' => '资源标签的值'],
+ 'backendName' => 'labels',
],
+ 'resourceVersion' => ['title' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'description' => '当前状态的自增的序列号，由系统填充，只读。当资源更新时递增', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'resourceVersion'],
],
],
'TaskTemplateSpec' => [
'title' => 'A short description of struct',
'description' => '任务模板描述',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'description' => [
- 'title' => '任务执行的描述信息',
- 'description' => '任务执行的描述信息',
- 'type' => 'string',
- 'example' => 'build&deploy.',
- ],
- 'worker' => [
- 'title' => '任务节点的描述',
- 'description' => '任务节点的描述',
- '$ref' => '#/components/schemas/TaskWorker',
- ],
- 'context' => [
- 'title' => '任务的执行上下文',
- 'description' => '任务的执行上下文',
- '$ref' => '#/components/schemas/Context',
- ],
- 'executeCondition' => [
- 'title' => '任务执行的条件',
- 'description' => '任务执行的条件',
- '$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' => '描述任务执行方式',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'presetWorker' => [
- 'title' => '系统预设的任务类型。它会执行预设的逻辑。',
- 'description' => '系统预设的任务类型。它会执行预设的逻辑。',
- 'type' => 'string',
- 'example' => 'serverless-runner',
- ],
- ],
- ],
- 'Template' => [
- 'title' => '服务模板',
- 'description' => '模板',
- 'type' => 'object',
- 'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的类型，只读',
- 'type' => 'string',
- 'example' => 'Template',
- ],
- 'name' => [
- 'title' => '模板名称，账号内唯一',
- 'type' => 'string',
- 'example' => 'demo-template',
- ],
- 'description' => [
- 'title' => '资源描述',
- 'type' => 'string',
- 'example' => 'It is a template',
- ],
- 'createdTime' => [
- 'title' => '创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'spec' => [
- 'title' => '模板的配置',
- '$ref' => '#/components/schemas/TemplateSpec',
- ],
- 'labels' => [
- 'title' => '资源的标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'status' => [
- 'title' => '模板状态',
- '$ref' => '#/components/schemas/TemplateStatus',
- ],
+ 'presetWorker' => ['title' => '系统预设的任务类型。它会执行预设的逻辑。', 'description' => '系统预设的任务类型。它会执行预设的逻辑。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'serverless-runner', 'backendName' => 'presetWorker'],
],
],
'TemplateConfig' => [
'title' => '模板部署服务输入',
'description' => '项目模板配置',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'variableValues' => [
- 'title' => '模板变量',
- 'description' => '模板变量',
- '$ref' => '#/components/schemas/TemplateVariableValueMap',
- ],
- 'templateName' => [
- 'title' => '模板名称',
- 'description' => '模板名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'start-springboot',
- ],
+ 'variableValues' => ['title' => '模板变量', 'description' => '模板变量', 'visibility' => 'Public', 'backendName' => 'variableValues', '$ref' => '#/components/schemas/TemplateVariableValueMap'],
+ 'templateName' => ['title' => '模板名称', 'description' => '模板名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'start-springboot', 'backendName' => 'templateName'],
'parameters' => [
'title' => '模板参数',
'description' => '模板参数',
+ 'visibility' => 'Public',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"region":"cn-hangzhou"}',
- ],
+ 'additionalProperties' => ['visibility' => 'Public', 'type' => 'string', 'example' => '{"region":"cn-hangzhou"}'],
'example' => '{"region":"cn-hangzhou"}',
+ 'backendName' => 'parameters',
],
'serviceNameChanges' => [
'title' => '服务名称变化，key是模板原始服务名，value是需要修改的目标服务名',
'description' => '服务名称变化，key是模板原始服务名，value是需要修改的目标服务名',
+ 'visibility' => 'Public',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"originName": "newName"}',
- ],
+ 'additionalProperties' => ['visibility' => 'Public', 'type' => 'string', 'example' => '{"originName": "newName"}'],
'example' => '{"svc1":"svc2"}',
- ],
- ],
- ],
- 'TemplateParameterSchema' => [
- 'title' => '模板参数定义',
- 'description' => '模板参数定义',
- 'type' => 'object',
- 'properties' => [
- 'default' => [
- 'title' => '默认值',
- 'type' => 'any',
- 'example' => 'defaultValue',
- ],
- 'pattern' => [
- 'title' => '正则校验规则',
- 'type' => 'string',
- 'example' => '"^[a-zA-Z._-]+$"',
- ],
- 'description' => [
- 'title' => '参数描述',
- 'type' => 'string',
- 'example' => 'Parameters for testing',
- ],
- 'roleExtension' => [
- 'title' => 'RAM角色类的参数扩展',
- 'type' => 'object',
- 'properties' => [
- 'service' => [
- 'title' => '授权云服务',
- 'type' => 'string',
- ],
- 'name' => [
- 'title' => '授权角色名',
- 'type' => 'string',
- ],
- 'authorities' => [
- 'title' => '系统权限策略列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'sensitive' => [
- 'title' => '是否敏感信息',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'title' => [
- 'title' => '参数标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo',
- ],
- 'type' => [
- 'title' => '参数类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'string',
- 'enum' => [
- 'string',
- 'number',
- 'integer',
- 'boolean',
- ],
- ],
- 'required' => [
- 'title' => '是否必填',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'enum' => [
- 'title' => '参数枚举',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'abc',
- ],
- ],
- ],
- ],
- 'TemplateRevision' => [
- 'title' => '模板快照',
- 'description' => '模板快照',
- 'type' => 'object',
- 'properties' => [
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'templateName' => [
- 'title' => '快照的模板名称，只读',
- 'type' => 'string',
- 'example' => 'demo-template',
- ],
- 'kind' => [
- 'title' => '当前资源的类型，只读',
- 'type' => 'string',
- 'example' => 'TemplateRevision',
- ],
- 'name' => [
- 'title' => '版本名称，自动生成，只读',
- 'type' => 'string',
- 'example' => 'demo-template',
- ],
- 'description' => [
- 'title' => '资源描述',
- 'type' => 'string',
- 'example' => 'It is a template revision',
- ],
- 'createdTime' => [
- 'title' => '创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'spec' => [
- 'title' => '模板的配置',
- '$ref' => '#/components/schemas/TemplateSpec',
- ],
- 'labels' => [
- 'title' => '资源的标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value to the label key.',
- ],
- ],
- 'status' => [
- 'type' => 'object',
- 'properties' => [
- 'phase' => [
- 'title' => '版本发布状态',
- 'type' => 'string',
- 'example' => 'Published',
- ],
- 'pipelineName' => [
- 'title' => '版本发布执行的流水线名称',
- 'type' => 'string',
- 'example' => 'p-default',
- ],
- 'packageUrl' => [
- 'title' => '模版包地址',
- 'type' => 'string',
- 'example' => 'https://registry.serverless-devs.com/details.html?name=template-test&package_type=v3',
- ],
- 'templateUrl' => [
- 'title' => '模版地址',
- 'type' => 'string',
- 'example' => 'https://cap.console.aliyun.com/template-detail?template=adasdasdaewe-adadqwe',
- ],
- ],
- ],
- ],
- ],
- 'TemplateServiceConfig' => [
- 'title' => '模板服务配置',
- 'description' => '模板服务配置',
- 'type' => 'object',
- 'properties' => [
- 'artifact' => [
- 'title' => '制品配置',
- '$ref' => '#/components/schemas/ArtifactMeta',
- ],
- 'variables' => [
- 'title' => '服务变量',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/TemplateParameterSchema',
- ],
- ],
- 'component' => [
- 'title' => '组件名称，符合ServerlessDevs的规范',
- 'type' => 'string',
- 'example' => 'fc3@1.0.0',
- ],
- 'build' => [
- '$ref' => '#/components/schemas/BuildConfig',
- ],
- 'source' => [
- 'title' => '源码配置',
- '$ref' => '#/components/schemas/SourceConfig',
- ],
- 'type' => [
- 'title' => '服务类型',
- 'type' => 'string',
- 'example' => 'Function',
- ],
- 'props' => [
- 'title' => '服务属性',
- 'type' => 'object',
- ],
- ],
- ],
- 'TemplateSourceConfig' => [
- 'title' => '模板源码配置，描述Serverless Registry中一个模板代码仓库中的一套源代码',
- 'description' => '模板源码配置，描述Serverless Registry中一个模板代码仓库中的一套源代码',
- 'type' => 'object',
- 'properties' => [
- 'downloadUrl' => [
- 'title' => 'Serverless Registry中模板下载地址',
- 'type' => 'string',
- 'example' => 'https://api.devsapp.cn/v3/packages/start-modelscope-v3/zipball/0.1.6',
- ],
- 'name' => [
- 'title' => '模板名称',
- 'type' => 'string',
- 'example' => 'start-springboot-cap',
- ],
- ],
- ],
- 'TemplateSpec' => [
- 'title' => '模版配置',
- 'description' => '模版配置',
- 'type' => 'object',
- 'properties' => [
- 'license' => [
- 'title' => '模板使用许可证的标识符，可以从 https://spdx.org/licenses 中查询',
- 'type' => 'string',
- 'example' => 'Apache-1.0',
- ],
- 'registryToken' => [
- 'title' => 'Serverless Registry的token',
- 'type' => 'string',
- ],
- 'variables' => [
- 'title' => '共享变量',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/TemplateParameterSchema',
- ],
- ],
- 'author' => [
- 'title' => '模板作者',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'CAP',
- ],
- 'readme' => [
- 'title' => '模板详细描述',
- 'type' => 'string',
- 'required' => true,
- ],
- 'source' => [
- 'title' => '模板工程的源码。如果指定，则发直接使用源码进行模版发布',
- 'type' => 'object',
- 'properties' => [
- 'repository' => [
- 'title' => '代码仓库引用',
- '$ref' => '#/components/schemas/RepositorySourceConfig',
- ],
- ],
- 'required' => false,
- ],
- 'services' => [
- 'title' => '模板服务配置',
- 'type' => 'object',
- 'additionalProperties' => [
- '$ref' => '#/components/schemas/TemplateServiceConfig',
- ],
- ],
- 'packageName' => [
- 'title' => '发布到registry的包名称',
- 'type' => 'string',
- 'example' => 'demo-package',
- ],
- 'category' => [
- 'title' => '模版类别',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AI',
- ],
- 'version' => [
- 'title' => '发布到registry使用的版本名',
- 'type' => 'string',
- ],
- ],
- ],
- 'TemplateStatus' => [
- 'title' => '模板状态',
- 'description' => '模板源码',
- 'type' => 'object',
- 'properties' => [
- 'phase' => [
- 'title' => '模板当前状态。Published：已发布、PublishFailed：发布失败、Publishing：发布中',
- 'type' => 'string',
- 'example' => 'Published',
- ],
- 'latestDeployment' => [
- 'title' => '最近部署详情',
- 'type' => 'object',
- 'properties' => [
- 'phase' => [
- 'title' => '部署状态。包括Published：已发布、PublishFailed：发布失败、Building：构建中、BuildFailed：构建失败、Ready：已就绪，可执行构建或者发布',
- 'type' => 'string',
- 'example' => 'BuildFinished',
- ],
- 'pipelineName' => [
- 'title' => '流水线名称',
- 'type' => 'string',
- ],
- 'finishedTime' => [
- 'title' => '部署完成时间',
- 'type' => 'string',
- ],
- 'startTime' => [
- 'title' => '部署开始时间',
- 'type' => 'string',
- ],
- ],
- ],
- 'latestVersion' => [
- 'title' => '最近发布的版本',
- 'type' => 'string',
- 'example' => '1.0.0',
- ],
- 'packageUrl' => [
- 'title' => '模版包地址',
- 'type' => 'string',
- 'example' => 'https://registry.serverless-devs.com/details.html?name=template-test&package_type=v3',
- ],
- 'templateUrl' => [
- 'title' => '模板详情地址',
- 'type' => 'string',
- 'example' => 'https://cap.console.aliyun.com/template-detail?template=adasdasdaewe-adadqwe',
- ],
- ],
- ],
- 'TemplateVariableValueMap' => [
- 'title' => 'A short description of struct',
- 'description' => '模板变量',
- 'type' => 'object',
- 'properties' => [
- 'shared' => [
- 'title' => '共享变量',
- 'type' => 'object',
- 'example' => '{"TEST_KEY":"new_value"}',
- ],
- 'services' => [
- 'title' => '服务变量',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{"TEST_SERVICE_KEY":"new_value"}',
- ],
- ],
- ],
- ],
- ],
- 'Tool' => [
- 'type' => 'object',
- 'properties' => [
- 'toolId' => [
- 'type' => 'string',
- ],
- 'path' => [
- 'type' => 'string',
- ],
- 'method' => [
- 'type' => 'string',
- ],
- 'toolName' => [
- 'type' => 'string',
+ 'backendName' => 'serviceNameChanges',
],
],
],
@@ -7611,81 +1556,30 @@
'description' => '工具集',
'type' => 'object',
'properties' => [
- 'generation' => [
- 'title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致',
- 'description' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'uid' => [
- 'title' => '当前阿里云主账号的ID，只读',
- 'description' => '当前阿里云主账号的ID，只读',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1455541096***548',
- ],
- 'kind' => [
- 'title' => '当前资源的名称，只读',
- 'description' => '当前资源的名称，只读',
- 'type' => 'string',
- 'example' => 'Toolset',
- ],
- 'name' => [
- 'title' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'description' => '当前资源的名称。它需要是唯一的，且无法变更',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-toolset',
- ],
- 'createdTime' => [
- 'title' => '表示创建此对象时服务器的时间，只读',
- 'description' => '表示创建此对象时服务器的时间，只读',
- 'type' => 'string',
- 'example' => '2021-11-19T09:34:38Z',
- ],
- 'description' => [
- 'title' => '工具集的描述信息',
- 'description' => '工具集的描述信息',
- 'type' => 'string',
- 'example' => 'test-description',
- ],
- 'spec' => [
- 'title' => '工具集具体配置',
- 'description' => '工具集具体配置',
- '$ref' => '#/components/schemas/ToolsetSpec',
- ],
+ 'uid' => ['title' => '当前阿里云主账号的ID，只读', 'description' => '当前阿里云主账号的ID，只读', 'type' => 'string', 'required' => false, 'example' => '1455541096***548'],
+ 'kind' => ['title' => '当前资源的名称，只读', 'description' => '当前资源的名称，只读', 'type' => 'string', 'example' => 'Toolset'],
+ 'name' => ['title' => '当前资源的名称。它需要是唯一的，且无法变更', 'description' => '当前资源的名称。它需要是唯一的，且无法变更', 'type' => 'string', 'required' => true, 'example' => 'my-toolset'],
+ 'createdTime' => ['title' => '表示创建此对象时服务器的时间，只读', 'description' => '表示创建此对象时服务器的时间，只读', 'type' => 'string', 'example' => '2021-11-19T09:34:38Z'],
+ 'description' => ['title' => '工具集的描述信息', 'description' => '工具集的描述信息', 'type' => 'string', 'example' => 'test-description'],
+ 'spec' => ['title' => '工具集具体配置', 'description' => '工具集具体配置', '$ref' => '#/components/schemas/ToolsetSpec'],
'labels' => [
'title' => '资源的标签',
'description' => '资源的标签',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'key=value',
- ],
- ],
- 'status' => [
- 'title' => '工具集状态',
- 'description' => '工具集状态',
- '$ref' => '#/components/schemas/ToolsetStatus',
+ 'additionalProperties' => ['description' => '标签', 'type' => 'string', 'example' => 'key=value'],
],
+ 'status' => ['title' => '工具集状态', 'description' => '工具集状态', '$ref' => '#/components/schemas/ToolsetStatus'],
+ 'generation' => ['title' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致', 'description' => '当前资源的自增的序列号，由系统填充，只读，当spec、labels、description更新时递增。如果指定，系统会加入并发写校验，generation必须和系统中的状态值一致', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
'ToolsetAuthorization' => [
'title' => '工具集鉴权信息',
'type' => 'object',
'properties' => [
+ 'type' => ['title' => '工具集鉴权类型', 'type' => 'string', 'example' => 'apiKey'],
'authConfig' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'type' => [
- 'title' => '工具集鉴权类型',
- 'type' => 'string',
- 'example' => 'apiKey',
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -7694,73 +1588,51 @@
'description' => '工具集鉴权信息',
'type' => 'object',
'properties' => [
- 'type' => [
- 'title' => '工具集 Schema 类型',
- 'description' => '工具集 Schema 类型',
- 'type' => 'string',
- 'example' => 'OpenAPI',
- ],
- 'detail' => [
- 'title' => '工具集 Schema 详情',
- 'description' => '工具集 Schema 详情',
- 'type' => 'string',
- 'deprecated' => false,
- '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",
- ],
+ 'type' => ['title' => '工具集 Schema 类型', 'description' => '工具集 Schema 类型', 'type' => 'string', 'example' => 'OpenAPI'],
+ 'detail' => ['title' => '工具集 Schema 详情', 'description' => '工具集 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时有效',
- 'description' => 'MCP服务器安装配置，只针对type为MCP时有效',
- '$ref' => '#/components/schemas/MCPInstallationConfig',
- ],
- 'openAPISchema' => [
- 'title' => 'OpenAPI Schema详情，仅针对type为OpenAPI时有效',
- 'description' => 'OpenAPI Schema详情，仅针对type为OpenAPI时有效',
- 'type' => 'string',
- ],
- 'mcpGateway' => [
- 'title' => 'MCP网关配置，仅针对type为MCPGateway时有效',
- 'description' => 'MCP网关配置，仅针对type为MCPGateway时有效',
- '$ref' => '#/components/schemas/MCPGatewayConfig',
- ],
+ 'mcpInstallation' => ['title' => 'MCP服务器安装配置，只针对type为MCP时有效', '$ref' => '#/components/schemas/MCPInstallationConfig'],
+ 'openAPISchema' => ['title' => 'OpenAPI Schema详情，仅针对type为OpenAPI时有效', 'type' => 'string'],
+ 'mcpGateway' => ['title' => 'MCP网关配置，仅针对type为MCPGateway时有效', '$ref' => '#/components/schemas/MCPGatewayConfig'],
+ 'difyPluginInstallation' => ['title' => 'Dify插件安装配置', '$ref' => '#/components/schemas/DifyPluginInstallationConfig'],
],
],
],
@@ -7770,95 +1642,47 @@
'description' => '工具集配置',
'type' => 'object',
'properties' => [
- 'schema' => [
- 'title' => '工具集schema结构',
- 'description' => '工具集schema结构',
- '$ref' => '#/components/schemas/ToolsetSchema',
- ],
- 'authConfig' => [
- 'title' => '鉴权配置',
- 'description' => '鉴权配置',
- '$ref' => '#/components/schemas/Authorization',
- ],
+ 'schema' => ['title' => '工具集schema结构', 'description' => '工具集schema结构', '$ref' => '#/components/schemas/ToolsetSchema'],
'networkConfig' => [
'title' => '工具集网络配置',
- 'description' => '工具集网络配置',
'type' => 'object',
'properties' => [
- 'internetAccess' => [
- 'title' => '是否允许工具集函数访问公网',
- 'description' => '是否允许工具集函数访问公网',
- 'type' => 'boolean',
- ],
+ 'internetAccess' => ['title' => '是否允许工具集函数访问公网', 'type' => 'boolean'],
'vpcConfig' => [
'title' => '工具集vpc配置',
- 'description' => '工具集vpc配置',
'type' => 'object',
'properties' => [
- 'vpcId' => [
- 'title' => 'vpd id',
- 'description' => 'vpd id',
- 'type' => 'string',
- ],
+ 'vpcId' => ['title' => 'vpd id', 'type' => 'string'],
'vSwitchIds' => [
'title' => '交换机列表',
- 'description' => '交换机列表',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'securityGroupId' => [
- 'title' => '安全组id',
- 'description' => '安全组id',
- 'type' => 'string',
+ 'items' => ['type' => 'string'],
],
+ 'securityGroupId' => ['title' => '安全组id', 'type' => 'string'],
],
],
],
],
+ 'authConfig' => ['title' => '鉴权配置', 'description' => '鉴权配置', '$ref' => '#/components/schemas/Authorization'],
],
],
'ToolsetStatus' => [
'description' => '工具集状态',
'type' => 'object',
'properties' => [
- 'phase' => [
- 'title' => '工具集状态。Pending：初始状态；Installing：安装中，只有uvx、npx托管时才进入该状态；Installed：成功状态，表示成功安装；Failed：失败状态，安装失败会进入到该状；Invalid：无效状态，当导入存量的mcp server时，访问该server的url执行listTools失败会进入到该状态',
- 'description' => '工具集状态。Pending：初始状态；Installing：安装中，只有uvx、npx托管时才进入该状态；Installed：成功状态，表示成功安装；Failed：失败状态，安装失败会进入到该状；Invalid：无效状态，当导入存量的mcp server时，访问该server的url执行listTools失败会进入到该状态',
- 'type' => 'string',
- 'example' => 'Installed',
- ],
+ 'phase' => ['title' => '工具集状态。Pending：初始状态；Installing：安装中，只有uvx、npx托管时才进入该状态；Installed：成功状态，表示成功安装；Failed：失败状态，安装失败会进入到该状；Invalid：无效状态，当导入存量的mcp server时，访问该server的url执行listTools失败会进入到该状态', 'description' => '工具集状态。Pending：初始状态；Installing：安装中，只有uvx、npx托管时才进入该状态；Installed：成功状态，表示成功安装；Failed：失败状态，安装失败会进入到该状；Invalid：无效状态，当导入存量的mcp server时，访问该server的url执行listTools失败会进入到该状态', 'type' => 'string', 'example' => 'Installed'],
'outputs' => [
'description' => '工具集输出',
'type' => 'object',
'properties' => [
+ 'functionArn' => ['title' => '函数资源定位符。当工具集托管资源时存在该字段', 'description' => '函数资源定位符。当工具集托管资源时存在该字段', 'type' => 'string', 'example' => 'acs:fc:cn-qingdao:0000:functions/aliyun_merchant_login_egistration'],
'urls' => [
'title' => '工具集访问地址。仅当工具集托管资源时存在该字段',
'description' => '工具集访问地址。仅当工具集托管资源时存在该字段',
'type' => 'object',
'properties' => [
- 'internetUrl' => [
- 'title' => '公网访问地址',
- 'description' => '公网访问地址',
- 'type' => 'string',
- 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse',
- ],
- 'intranetUrl' => [
- 'title' => '内网访问地址',
- 'description' => '内网访问地址',
- 'type' => 'string',
- 'example' => 'https://mock.cn-hangzhou-vpc.fcapp.run/sse',
- ],
- ],
- ],
- 'openApiTools' => [
- 'title' => 'OpenAPI类型的工具集工具列表，仅当OpenAPI类型的工具集存在该字段',
- 'description' => 'OpenAPI类型的工具集工具列表，仅当OpenAPI类型的工具集存在该字段',
- 'type' => 'array',
- 'items' => [
- 'description' => 'OpenAPI工具信息',
- '$ref' => '#/components/schemas/OpenAPIToolMeta',
+ 'internetUrl' => ['title' => '公网访问地址', 'description' => '公网访问地址', 'type' => 'string', 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse'],
+ 'intranetUrl' => ['title' => '内网访问地址', 'description' => '内网访问地址', 'type' => 'string', 'example' => 'https://mock.cn-hangzhou-vpc.fcapp.run/sse'],
],
],
'mcpServerConfig' => [
@@ -7866,59 +1690,36 @@
'description' => 'MCP服务器访问配置。仅当MCP类型的工具集存在该字段',
'type' => 'object',
'properties' => [
+ 'url' => ['title' => 'MCP服务器访问地址', 'description' => 'MCP服务器访问地址', 'type' => 'string', 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse'],
+ 'transportType' => ['title' => 'MCP服务器传输类型。SSE、StreamableHttp', 'description' => 'MCP服务器传输类型。SSE、StreamableHttp', 'type' => 'string', 'example' => 'sse'],
'headers' => [
'description' => '请求头',
'type' => 'object',
- 'additionalProperties' => [
- 'description' => '请求头的值',
- 'type' => 'string',
- 'example' => '{\'Authorization\': Bearer xxxx}',
- ],
- ],
- 'transportType' => [
- 'title' => 'MCP服务器传输类型。SSE、StreamableHttp',
- 'description' => 'MCP服务器传输类型。SSE、StreamableHttp',
- 'type' => 'string',
- 'example' => 'sse',
- ],
- 'url' => [
- 'title' => 'MCP服务器访问地址',
- 'description' => 'MCP服务器访问地址',
- 'type' => 'string',
- 'example' => 'https://mock.cn-hangzhou.fcapp.run/sse',
+ 'additionalProperties' => ['description' => '请求头的值', 'type' => 'string', 'example' => '{\'Authorization\': Bearer xxxx}'],
],
],
],
+ 'openApiTools' => [
+ 'title' => 'OpenAPI类型的工具集工具列表，仅当OpenAPI类型的工具集存在该字段',
+ 'description' => 'OpenAPI类型的工具集工具列表，仅当OpenAPI类型的工具集存在该字段',
+ 'type' => 'array',
+ 'items' => ['description' => 'OpenAPI工具信息', '$ref' => '#/components/schemas/OpenAPIToolMeta'],
+ ],
'tools' => [
'title' => 'MCP类型的工具集工具列表，仅当MCP类型的工具集存在该字段',
'description' => 'MCP类型的工具集工具列表，仅当MCP类型的工具集存在该字段',
'type' => 'array',
- 'items' => [
- 'description' => 'MCP工具信息',
- '$ref' => '#/components/schemas/MCPToolMeta',
- ],
+ 'items' => ['description' => 'MCP工具信息', '$ref' => '#/components/schemas/MCPToolMeta'],
],
- 'functionArn' => [
- 'title' => '函数资源定位符。当工具集托管资源时存在该字段',
- 'description' => '函数资源定位符。当工具集托管资源时存在该字段',
- 'type' => 'string',
- 'example' => 'acs:fc:cn-qingdao:0000:functions/aliyun_merchant_login_egistration',
+ 'difyTools' => [
+ 'title' => 'Dify类型的工具集工具列表，仅当DifyPlugin类型的工具集存在该字段',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/DifyToolSchema'],
],
],
],
- 'observedTime' => [
- 'title' => '资源最近的一次状态更新时间',
- 'description' => '资源最近的一次状态更新时间',
- 'type' => 'string',
- 'example' => '2025-07-28T14:03:19Z',
- ],
- 'observedGeneration' => [
- 'title' => '资源最近的一次状态更新时的资源generation',
- 'description' => '资源最近的一次状态更新时的资源generation',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
+ 'observedGeneration' => ['title' => '资源最近的一次状态更新时的资源generation', 'description' => '资源最近的一次状态更新时的资源generation', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'observedTime' => ['title' => '资源最近的一次状态更新时间', 'description' => '资源最近的一次状态更新时间', 'type' => 'string', 'example' => '2025-07-28T14:03:19Z'],
],
],
'Variable' => [
@@ -7926,1487 +1727,1172 @@
'description' => '变量',
'type' => 'object',
'properties' => [
- 'value' => [
- 'title' => '变量的值',
- 'description' => '变量的值',
- 'type' => 'any',
- 'example' => 'object_value',
- ],
- 'sensitive' => [
- 'title' => '变量是否敏感',
- 'description' => '变量是否敏感',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'encrypted' => [
- 'title' => '变量是否被加密',
- 'description' => '变量是否被加密',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- 'WebhookCodeContext' => [
- 'title' => 'git事件对应的上下文',
- 'type' => 'object',
- 'properties' => [
- 'description' => [
- 'title' => 'Merge Request或Pull Request的描述',
- 'type' => 'string',
- 'example' => 'my PR decscription',
- ],
- 'message' => [
- 'title' => '最新的提交的提交信息',
- 'type' => 'string',
- 'example' => 'commit message',
- ],
- 'eventType' => [
- 'title' => 'Git事件类型。推送类型事件为PUSH，Merge Request或Pull Request的事件为MR',
- 'type' => 'string',
- 'example' => 'PUSH',
- ],
- 'commitID' => [
- 'title' => '最新的提交的ID',
- 'type' => 'string',
- 'example' => 'b1dd9ba168dfef1cb3a1dd608b6054c771a93959',
- ],
- 'branch' => [
- 'title' => '用于checkout的分支。Merge Request或Pull Request的最新的分支，或是推送的目标分支。',
- 'type' => 'string',
- 'example' => 'master',
- ],
- 'sourceBranch' => [
- 'title' => '来源分支。Merge Request或Pull Request的来源分支，推送的来源分支',
- 'type' => 'string',
- 'example' => 'master',
- ],
- 'title' => [
- 'title' => 'Merge Request或Pull Request的标题',
- 'type' => 'string',
- 'example' => '# FIX',
- ],
- 'tag' => [
- 'title' => '推送的标签',
- 'type' => 'string',
- 'example' => 'release-0.0.1',
- ],
- 'prType' => [
- 'title' => 'Merge Request或Pull Request的类型。包括打开（opened）、关闭（closed）、合并（merged）、重新打开（reopened）、更新（updated）和无效（invalid）等类型。',
- 'type' => 'string',
- 'example' => 'merged',
- ],
- 'targetBranch' => [
- 'title' => '来源分支。Merge Request或Pull Request的目标分支，推送的目标分支',
- 'type' => 'string',
- 'example' => 'master',
- ],
- 'repoUrl' => [
- 'title' => '代码仓库的URL',
- 'type' => 'string',
- 'example' => 'https://codeup.aliyun.com/my-namespace/my-repo.git',
- ],
- ],
- ],
- 'open_struct_OssSourceConfig' => [
- 'title' => 'OSS代码源对象',
- 'type' => 'object',
- 'properties' => [
- 'bucket' => [
- 'title' => 'OSS bucket名称',
- 'type' => 'string',
- 'example' => 'demo-bucket',
- ],
- 'object' => [
- 'title' => 'OSS 对象名称',
- 'type' => 'string',
- 'example' => 'demo-object',
- ],
+ 'value' => ['title' => '变量的值', 'description' => '变量的值', 'type' => 'any', 'example' => 'object_value'],
+ 'sensitive' => ['title' => '变量是否敏感', 'description' => '变量是否敏感', 'type' => 'boolean', 'example' => 'false'],
+ 'encrypted' => ['title' => '变量是否被加密', 'description' => '变量是否被加密', 'type' => 'boolean', 'example' => 'false'],
],
- 'deprecated' => true,
],
],
],
'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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
+ ],
+ [
'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' => '激活内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'account' => ['title' => '代码托管平台中的账号信息', 'description' => '代码托管平台中的账号信息', 'required' => false, '$ref' => '#/components/schemas/GitAccount'],
+ 'credential' => ['title' => '完成OAuth授权流程后获取的凭证信息，使用该凭证可以访问代码托管平台相关API', 'description' => '完成OAuth授权流程后获取的凭证信息，使用该凭证可以访问代码托管平台相关API', 'required' => false, '$ref' => '#/components/schemas/OAuthCredential'],
+ ],
'required' => false,
- 'example' => 'my-toolset',
],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '成功更新后的工具集实体',
- 'description' => '成功更新后的工具集实体',
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['title' => '激活后的身份绑定实体', 'description' => '激活后的身份绑定实体', '$ref' => '#/components/schemas/Connection'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '激活身份绑定',
+ 'summary' => '激活一个身份绑定。点击Connection状态中的授权链接完成OAuth授权流程后，开发平台会激活当前身份绑定。 使用OAuth授权的第三方代码托管平台包括：GitHub、Gitee、Codeup。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:ActivateConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '更新工具集',
+ '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' => '取消流水线执行。流水线以及任务将被尽快取消执行。',
+ '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' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始。',
- 'description' => '当前页码，默认为1。页码从1开始。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '每页大小，默认为100。取值范围1~100',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'keyword',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo',
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'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' => ['title' => '流水线执行', 'description' => '流水线执行', '$ref' => '#/components/schemas/Pipeline'],
+ ],
+ ],
+ 'title' => '取消流水线执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '批量查询工具集',
+ '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\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\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' => '取消流水线任务执行。',
+ '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '查询到的工具集实体',
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '取消流水线任务执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '获取工具集',
+ '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' => ['title' => '交付物配置', 'description' => '交付物配置', 'required' => false, '$ref' => '#/components/schemas/Artifact'],
],
],
- 'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [
+ 'schema' => ['title' => '交付物配置', 'description' => '交付物配置', '$ref' => '#/components/schemas/Artifact'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
- 'title' => '删除工具集',
- ],
- 'CreateToolset' => [
- 'summary' => '创建工具集',
- 'path' => '/2023-07-14/toolsets',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建交付物',
+ 'summary' => '创建交付物存储',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateEnvironment' => [
+ 'summary' => '创建项目下的环境，并可选地根据模板自动部署该环境。'."\n"
+ .'服务会部署到指定的环境中，环境可以绑定代码仓库的某个分支或者某个项目模板。环境还可以设置基础设施堆栈，被环境下的所有服务所共享。',
+ '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' => ['title' => '环境实体', 'description' => '环境实体', 'required' => false, '$ref' => '#/components/schemas/Environment'],
+ ],
+ [
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['title' => '项目名', 'description' => '项目名', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '成功创建的工具集实体',
- '$ref' => '#/components/schemas/Toolset',
- ],
+ 'schema' => ['title' => '环境实体', 'description' => '环境实体', '$ref' => '#/components/schemas/Environment'],
],
],
- '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"}]',
- 'title' => '创建工具集',
- ],
- 'RenderServicesByTemplate' => [
- 'summary' => '解析模板中的服务以及变量配置。',
- 'path' => '/2023-07-14/templates/action/renderServices',
- 'methods' => [
- 'post',
+ 'title' => '创建环境',
+ 'description' => '使用注意事项：'."\n"
+ ."\n"
+ .'- 当Environment.Spec.TemplateConfig非空时：创建环境后，开发平台会使用您提供的模板信息异步地为您自动部署该项目（创建PipelineTrigger、PipelineTriggerEvent、Pipeline实体）。'."\n"
+ ."\n"
+ .'- 当Environment.Spec.TemplateConfig为空时：仅创建环境实体，需要您手动调用PipelineTrigger、PipelineTriggerEvent相关API完成部署。'."\n"
+ ."\n"
+ .'<notice>通过模板完成的项目部署流程完全免费，部署后项目模板所涉及的云资源将按照各云产品的计费方式计费></notice>',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-06T06:01:08.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreatePipeline' => [
+ 'summary' => '创建流水线执行。流水线将被异步地执行，并按照配置，产生具体的流水线任务。',
+ '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' => '服务名称变化，key是模板原始服务名，value是需要修改的目标服务名',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'title' => '修改后的目标服务名称',
- 'description' => '修改后的目标服务名称',
- 'type' => 'string',
- 'example' => '{"originName": "newName"}',
- ],
- 'example' => '{"svc1":"svc2"}',
- ],
- 'projectName' => [
- 'title' => '项目名称，用于在已有项目中通过模板新增服务的场景。当指定时，会检测模板中的服务名和指定项目中的服务是否存在命名冲突，如果冲突时会自动生成新的服务名称。',
- 'description' => '项目名称，用于在已有项目中通过模板新增服务的场景。当指定时，会检测模板中的服务名和指定项目中的服务是否存在命名冲突，如果冲突时会自动生成新的服务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my-project',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '创建的流水线执行', 'description' => '创建的流水线执行', 'required' => false, '$ref' => '#/components/schemas/Pipeline'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'services' => [
- 'title' => '解析后的服务集合',
- 'description' => '解析后的服务集合',
- 'type' => 'object',
- 'additionalProperties' => [
- 'title' => '服务配置',
- 'description' => '服务配置',
- '$ref' => '#/components/schemas/ServiceConfig',
- ],
- ],
- 'variables' => [
- 'title' => '解析后的变量集合',
- 'description' => '解析后的变量集合',
- 'type' => 'object',
- 'additionalProperties' => [
- 'title' => '变量配置',
- 'description' => '变量配置',
- '$ref' => '#/components/schemas/Variable',
- ],
- ],
- 'changedServiceNames' => [
- 'title' => '变化后的服务名称。key是新的服务名称，value是原始服务名称。'."\n"
- .'通过这个字段，可以记录模板的原始服务名称，实现部署前的不断修改名称',
- 'description' => '变化后的服务名称。key是新的服务名称，value是原始服务名称。'."\n"
- .'通过这个字段，可以记录模板的原始服务名称，实现部署前的不断修改名称',
- 'type' => 'object',
- 'additionalProperties' => [
- 'title' => '原始服务名称',
- 'description' => '原始服务名称',
- 'type' => 'string',
- 'example' => 'demo-service',
- ],
- ],
+ 'schema' => ['title' => '创建的流水线执行', 'description' => '创建的流水线执行', '$ref' => '#/components/schemas/Pipeline'],
+ ],
+ ],
+ 'title' => '创建流水线执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreatePipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '解析模板中的服务以及变量配置',
+ '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\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\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' => '创建项目，并在指定模板配置时自动部署此项目。',
+ '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' => '计划创建的项目实体', 'required' => false, '$ref' => '#/components/schemas/Project'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '交付物临时下载地址',
- 'description' => '交付物临时下载地址',
- '$ref' => '#/components/schemas/ArtifactCode',
- ],
+ 'schema' => ['description' => '成功创建的项目实体', '$ref' => '#/components/schemas/Project'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"checksum\\": \\"\\",\\n \\"url\\": \\"\\"\\n}","type":"json"}]',
- 'title' => '获取交付物临时下载地址',
- ],
- 'FetchArtifactTempBucketToken' => [
- 'summary' => '获取交付物临时上传的bucket、object和临时sts',
- 'path' => '/2023-07-14/artifacts/action/fetchTempBucketToken',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '创建项目',
+ 'description' => '1. 当`Project.Spec.TemplateConfig`非空时：创建项目后，开发平台会使用您提供的模板信息异步地为您自动部署该项目（创建`Environment`、`PipelineTrigger`、`PipelineTriggerEvent`、`Pipeline`实体）'."\n"
+ .'2. 当`Project.Spec.TemplateConfig`为空时：仅创建项目实体，需要您手动调用`Environment`、`PipelineTrigger`、`PipelineTriggerEvent`相关API完成部署。'."\n"
+ ."\n"
+ .'><notice>通过模板完成的项目部署流程完全免费，部署后项目模板所涉及的云资源将按照各云产品的计费方式计费></notice>',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'security' => [
+ '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' => '全部资源', 'arn' => '*'],
+ ],
],
],
- [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ossObjectName\\": \\"\\",\\n \\"ossBucketName\\": \\"\\",\\n \\"ossRegion\\": \\"\\",\\n \\"credentials\\": {\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"securityToken\\": \\"\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取交付物临时上传令牌',
],
- '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' => ['title' => '流水线任务', 'description' => '流水线任务', 'required' => false, '$ref' => '#/components/schemas/Task'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '交付物配置',
- 'description' => '交付物配置',
- '$ref' => '#/components/schemas/Artifact',
- ],
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
],
],
- '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"}]',
- 'title' => '查询交付物',
- ],
- 'PutArtifact' => [
- 'summary' => '更新交付物',
- 'path' => '/2023-07-14/artifacts/{name}',
- 'methods' => [
- 'put',
+ 'title' => '创建流水线任务执行',
+ 'summary' => '创建流水线任务执行。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '计划创建的工具集实体', 'required' => false, '$ref' => '#/components/schemas/Toolset'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '交付物配置',
- 'description' => '交付物配置',
- '$ref' => '#/components/schemas/Artifact',
- ],
+ 'schema' => ['description' => '成功创建的工具集实体', '$ref' => '#/components/schemas/Toolset'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '创建工具集',
+ 'summary' => '创建工具集',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '更新交付物',
],
'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' => ['title' => '交付物名称', 'description' => '交付物名称', 'type' => 'string', 'required' => false, 'example' => 'demo-artifact'],
],
],
'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除交付物',
- ],
- 'CreateArtifact' => [
- 'summary' => '创建交付物存储',
- 'path' => '/2023-07-14/artifacts',
- 'methods' => [
- 'post',
+ 'summary' => '删除交付物',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ ],
+ 'DeleteConnection' => [
+ 'summary' => '删除一个身份绑定。',
+ '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => ['title' => '若存在其他Repository实体关联了该Connection，则无法直接删除；指定force=true后可以强制删除Connection(但不级联删除Repository)', 'description' => '是否强制删除。若存在仓库绑定实体（Repository）关联了该身份绑定（Connection），则无法直接删除；您能够通过强制删除的方式删除该身份绑定'."\n"
+ ."\n"
+ .'><notice>删除身份绑定（Connection）时，不会级联删除关联的仓库绑定（Repository）></notice>', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '交付物配置',
- 'description' => '交付物配置',
- '$ref' => '#/components/schemas/Artifact',
+ 'title' => 'Schema of Response',
+ 'description' => '返回结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'A5152937-1C8A-5260-90FA-520CEF028D2D'],
+ ],
],
],
],
- '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"}]',
- 'title' => '创建交付物',
- ],
- 'CreateProject' => [
- 'summary' => '创建项目，并在指定模板配置时自动部署此项目。',
- 'path' => '/2023-07-14/projects',
- 'methods' => [
- 'post',
+ 'title' => '删除身份绑定',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5152937-1C8A-5260-90FA-520CEF028D2D\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteEnvironment' => [
+ 'summary' => '删除一个环境，并级联删除项目下的其他实体（包括流水线触发器、流水线触发记录、流水线模板、流水线）。',
+ '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' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '成功创建的项目实体',
- '$ref' => '#/components/schemas/Project',
- ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['title' => '环境名称', 'description' => '环境名称', 'type' => 'string', 'required' => true, 'example' => 'demo-env'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除环境',
+ 'description' => '删除环境目前不支持删除环境下的云资源，您需要手动删除资源。',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-06T06:01:13.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '创建项目',
- 'description' => '1. 当`Project.Spec.TemplateConfig`非空时：创建项目后，开发平台会使用您提供的模板信息异步地为您自动部署该项目（创建`Environment`、`PipelineTrigger`、`PipelineTriggerEvent`、`Pipeline`实体）'."\n"
- .'2. 当`Project.Spec.TemplateConfig`为空时：仅创建项目实体，需要您手动调用`Environment`、`PipelineTrigger`、`PipelineTriggerEvent`相关API完成部署。'."\n"
- ."\n"
- .'><notice>通过模板完成的项目部署流程完全免费，部署后项目模板所涉及的云资源将按照各云产品的计费方式计费></notice>',
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
],
'DeleteProject' => [
'summary' => '删除一个项目，并级联删除项目下的其他实体（包括环境、流水线触发器、流水线触发记录、流水线模板、流水线）。',
'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' => ['title' => '对象名称', 'description' => '项目名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
[
'name' => 'force',
'in' => 'query',
- 'schema' => [
- 'title' => '当项目下不存在任何环境或仅存在一个默认环境时，才允许删除该项目；而force可以强制删除项目并级联删除其下环境',
- 'description' => '是否强制删除。当项目中包含多个环境时，若force为true，则能够强制删除项目，并级联删除所有环境下的其他实体；若force为false，则抛出异常，需要您先删除环境',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '当项目下不存在任何环境或仅存在一个默认环境时，才允许删除该项目；而force可以强制删除项目并级联删除其下环境', 'description' => '是否强制删除。当项目中包含多个环境时，若force为true，则能够强制删除项目，并级联删除所有环境下的其他实体；若force为false，则抛出异常，需要您先删除环境', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除项目',
'description' => '1. 若项目中不存在环境或仅包含一个默认环境：能够删除项目，并级联删除环境下的其他实体（包括流水线触发器、流水线触发记录、流水线模板、流水线）'."\n"
.'2. 若项目中包含多个环境：若`force`为`true`，则能够强制删除项目，并级联删除所有环境下的其他实体；若`force`为`false`，则抛出异常，需要您先删除环境'."\n"
."\n"
.'> 使用OpenAPI删除项目时，暂不支持删除项目下部署的云资源（例如函数、自定义域名等）',
- ],
- 'UpdateProject' => [
- 'summary' => '修改项目，并在模板参数变化时自动部署该项目。',
- 'path' => '/2023-07-14/projects/{name}',
- 'methods' => [
- 'put',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-06T06:01:13.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ ],
+ 'DeleteToolset' => [
+ 'summary' => '删除某个工具集',
+ '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',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['title' => '工具集名称', 'description' => '工具集名称', 'type' => 'string', 'required' => false, 'example' => 'my-toolset'],
+ ],
+ ],
+ 'responses' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除工具集',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
+ ],
+ 'DeployEnvironment' => [
+ 'summary' => '手动触发环境部署。',
+ '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' => ['title' => '所属应用名称', 'description' => '所属项目名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '对象名称', 'description' => '环境名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['title' => '部署环境选项', 'description' => '部署选项', 'required' => false, '$ref' => '#/components/schemas/DeployEnvironmentOptions'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '成功更新后的项目实体',
- 'description' => '成功更新后的项目实体',
- '$ref' => '#/components/schemas/Project',
- ],
+ 'schema' => ['title' => '环境部署信息', 'description' => '环境部署详情', '$ref' => '#/components/schemas/EnvironmentDeployment'],
],
],
- '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' => '修改项目',
- 'description' => '1. 使用修改（Update）相关的接口时，您指定的可写字段将被更新，未指定的字段将保持不变'."\n"
- .'2. 当且仅当模板参数（spec.templateConfig.parameters）发生变化时，才会触发自动部署'."\n"
- .'3. 使用环境（Environment）相关API修改默认环境（Default）配置后，不再支持更新项目',
- ],
- 'ListProjects' => [
- 'summary' => '批量查询满足条件的项目。',
- 'path' => '/2023-07-14/projects',
- 'methods' => [
- 'get',
+ 'title' => '部署环境',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:DeployEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'templateName=spring-boot-v3',
- ],
- 'required' => false,
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['title' => '交付物名称', 'description' => '交付物名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
- [
- 'name' => 'pageNumber',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始。',
- 'description' => '当前页码，默认为1。页码从1开始',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['title' => '交付物临时下载地址', 'description' => '交付物临时下载地址', '$ref' => '#/components/schemas/ArtifactCode'],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取交付物临时下载地址',
+ 'summary' => '获取交付物的zip包临时下载地址url',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '每页大小，默认为100。取值范围1~100',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'FetchArtifactTempBucketToken' => [
+ 'summary' => '获取交付物临时上传的bucket、object和临时sts',
+ 'path' => '/2023-07-14/artifacts/action/fetchTempBucketToken',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'keyword',
- 'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- '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' => '当前页码，默认为1。页码从1开始',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '每页大小，默认为100。取值范围1~100',
- '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' => ['title' => '交付上传临时地址', 'description' => '交付上传临时地址', '$ref' => '#/components/schemas/ArtifactTempBucketToken'],
+ ],
+ [],
+ ],
+ 'title' => '获取交付物临时上传令牌',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactTempBucketToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '批量查询项目',
],
- 'GetProject' => [
- 'summary' => '查询项目',
- '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '查询的项目实体',
- '$ref' => '#/components/schemas/Project',
- ],
+ 'schema' => ['description' => '身份绑定凭证', '$ref' => '#/components/schemas/OAuthCredential'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '获取身份绑定凭证',
+ 'summary' => '获取完成授权流程的身份绑定凭证，开发平台会使用该凭证访问第三方代码托管平台。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchConnectionCredential',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '查询项目',
+ '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' => '查询交付物',
+ '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'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['title' => '交付物名称', 'description' => '交付物名称', 'type' => 'string', 'required' => false, 'example' => 'demo-artifact'],
+ ],
],
- 'produces' => [
- 'application/json',
+ 'responses' => [
+ 200 => [
+ 'schema' => ['title' => '交付物配置', 'description' => '交付物配置', '$ref' => '#/components/schemas/Artifact'],
+ ],
],
- 'operationType' => 'readAndWrite',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询交付物',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetEnvironment' => [
+ 'summary' => '查询一个环境。',
+ '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' => '项目名称', 'description' => '项目名称', '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' => [
- 'title' => '部署环境选项',
- 'description' => '部署选项',
- 'required' => false,
- '$ref' => '#/components/schemas/DeployEnvironmentOptions',
- ],
+ 'schema' => ['title' => '环境名称', 'description' => '环境名称', 'type' => 'string', 'required' => true, 'example' => 'demo-env'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '环境部署信息',
- 'description' => '环境部署详情',
- '$ref' => '#/components/schemas/EnvironmentDeployment',
- ],
+ 'schema' => ['title' => '环境实体', 'description' => '环境实体', '$ref' => '#/components/schemas/Environment'],
],
],
- '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' => '部署环境',
+ 'title' => '查询环境',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-06T06:01:09.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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',
],
@@ -9414,561 +2900,378 @@
[
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境部署名称',
- 'description' => '环境部署名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '环境部署名称', 'description' => '环境部署名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '环境部署详情',
- 'description' => '环境部署详情',
- '$ref' => '#/components/schemas/EnvironmentDeployment',
- ],
+ 'schema' => ['title' => '环境部署详情', 'description' => '环境部署详情', '$ref' => '#/components/schemas/EnvironmentDeployment'],
],
],
'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' => '查询环境部署详情',
- ],
- 'GetServiceDeployment' => [
- 'summary' => '查询服务部署信息',
- 'path' => '/2023-07-14/servicedeployments/{name}',
- 'methods' => [
- 'get',
+ 'summary' => '查询环境部署信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironmentDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '服务部署详情',
- 'description' => '服务部署详情',
- '$ref' => '#/components/schemas/ServiceDeployment',
- ],
+ 'schema' => ['title' => '流水线执行', 'description' => '流水线执行', '$ref' => '#/components/schemas/Pipeline'],
],
],
- '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"}]',
- 'title' => '查询服务部署详情',
- ],
- 'ListServiceDeployments' => [
- 'summary' => '批量查询服务部署信息。',
- 'path' => '/2023-07-14/servicedeployments',
- 'methods' => [
- 'get',
+ 'title' => '查询流水线执行',
+ 'summary' => '查询流水线执行。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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 \\"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\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\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' => '查询项目',
+ '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' => '只返回含有这些label的对象',
- 'type' => 'array',
- 'items' => [
- 'title' => 'label表达式，例如: appName=my-app',
- 'description' => 'label表达式，例如: appName=my-app',
- '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'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' => [
- 'title' => '服务部署详情',
- 'description' => '服务部署详情',
- '$ref' => '#/components/schemas/ServiceDeployment',
- ],
- ],
+ 'schema' => ['description' => '查询的项目实体', '$ref' => '#/components/schemas/Project'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '查询项目',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '批量查询服务部署信息',
],
- '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'description' => '预期环境部署配置',
- '$ref' => '#/components/schemas/EnvironmentDeploymentSpec',
- ],
+ 'schema' => ['description' => '查询的仓库绑定实体', '$ref' => '#/components/schemas/Repository'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '查询仓库绑定',
+ 'summary' => '查询一个仓库绑定实体。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetRepository',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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"}]',
- 'title' => '预览环境变更信息',
+ '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' => '创建项目下的环境，并可选地根据模板自动部署该环境。'."\n"
- .'服务会部署到指定的环境中，环境可以绑定代码仓库的某个分支或者某个项目模板。环境还可以设置基础设施堆栈，被环境下的所有服务所共享。',
- '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' => '项目名',
- 'description' => '项目名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
+ 'schema' => ['title' => '服务部署名称', 'description' => '服务部署名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '环境实体',
- 'description' => '环境实体',
- '$ref' => '#/components/schemas/Environment',
- ],
+ 'schema' => ['title' => '服务部署详情', 'description' => '服务部署详情', '$ref' => '#/components/schemas/ServiceDeployment'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '查询服务部署详情',
+ 'summary' => '查询服务部署信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetServiceDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '创建环境',
- 'description' => '使用注意事项：'."\n"
- ."\n"
- .'- 当Environment.Spec.TemplateConfig非空时：创建环境后，开发平台会使用您提供的模板信息异步地为您自动部署该项目（创建PipelineTrigger、PipelineTriggerEvent、Pipeline实体）。'."\n"
- ."\n"
- .'- 当Environment.Spec.TemplateConfig为空时：仅创建环境实体，需要您手动调用PipelineTrigger、PipelineTriggerEvent相关API完成部署。'."\n"
- ."\n"
- .'<notice>通过模板完成的项目部署流程完全免费，部署后项目模板所涉及的云资源将按照各云产品的计费方式计费></notice>',
],
- 'DeleteEnvironment' => [
- 'summary' => '删除一个环境，并级联删除项目下的其他实体（包括流水线触发器、流水线触发记录、流水线模板、流水线）。',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
- 'methods' => [
- 'delete',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetTask' => [
+ 'summary' => '查询流水线任务执行。',
+ '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' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '环境名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'schema' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
- 'responses' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responses' => [
+ 200 => [
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]',
- 'title' => '删除环境',
- 'description' => '删除环境目前不支持删除环境下的云资源，您需要手动删除资源。',
- ],
- 'UpdateEnvironment' => [
- 'summary' => '修改环境，并在模板参数变化时自动部署该环境。',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
- 'methods' => [
- 'put',
+ 'title' => '查询流水线任务执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '获取某个工具集的信息',
+ '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' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '环境名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'schema' => ['title' => '工具集名称', 'description' => '工具集名称', 'type' => 'string', 'required' => false, 'example' => 'my-toolset'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '环境实体',
- 'description' => '环境实体',
- '$ref' => '#/components/schemas/Environment',
- ],
+ 'schema' => ['description' => '查询到的工具集实体', '$ref' => '#/components/schemas/Toolset'],
],
],
- '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' => '修改环境',
- 'description' => '- 使用修改（Update）的接口时，您指定的可写字段将被更新，未指定的字段将保持不变'."\n"
- ."\n"
- .'- 当且仅当模板参数（spec.templateConfig.parameters）发生变化时，才会触发自动部署',
- ],
- 'ListEnvironments' => [
- 'summary' => '批量查询满足条件的环境。',
- 'path' => '/2023-07-14/projects/{projectName}/environments/',
- 'methods' => [
- 'get',
+ 'title' => '获取工具集',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListConnections' => [
+ 'summary' => '批量查询满足条件的身份绑定。',
+ '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' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-project',
- ],
- ],
- [
'name' => 'labelSelector',
'in' => 'query',
'style' => 'simple',
@@ -9976,51 +3279,24 @@
'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'branch=main',
- ],
+ 'items' => ['title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'type' => 'string', 'required' => false, 'example' => 'platform=github'."\n"],
'required' => false,
- 'example' => 'demo-project',
],
],
[
'name' => 'pageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始',
- 'description' => '当前页码，默认为1。页码从1开始',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '当前页码，默认为1。页码从1开始', 'description' => '当前页码，默认为1。页码从1开始', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'pageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '每页大小，默认为100。取值范围1~100',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '每页大小，默认为100。取值范围1~100', 'description' => '每页大小，默认为100。取值范围1~100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
'name' => 'keyword',
'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dev',
- ],
+ 'schema' => ['title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'type' => 'string', 'required' => false, 'example' => 'auto-'],
],
],
'responses' => [
@@ -10030,231 +3306,219 @@
'description' => '查询的分页结果',
'type' => 'object',
'properties' => [
- 'pageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码，默认为1。页码从1开始',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '每页大小，默认为100。取值范围1~100',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'totalCount' => [
- 'title' => '查询到的结果数量',
- 'description' => '查询到的结果数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
+ 'pageNumber' => ['title' => '当前页码', 'description' => '当前页码，默认为1。页码从1开始', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'pageSize' => ['title' => '每页大小', 'description' => '每页大小，默认为100。取值范围1~100', '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/Environment',
- ],
+ 'items' => ['title' => '查询的一个满足条件的身份绑定实体', 'description' => '查询的一个满足条件的身份绑定实体', '$ref' => '#/components/schemas/Connection'],
],
],
],
],
],
- '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' => '批量查询环境',
- ],
- 'GetEnvironment' => [
- 'summary' => '查询一个环境。',
- 'path' => '/2023-07-14/projects/{projectName}/environments/{name}',
- 'methods' => [
- 'get',
+ 'title' => '批量查询身份绑定',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListConnections',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
+ ],
+ [
+ 'name' => 'labelSelector',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => true,
+ 'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
+ 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
+ 'type' => 'array',
+ 'items' => ['title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'type' => 'string', 'required' => false, 'example' => 'branch=main'],
+ 'required' => false,
'example' => 'demo-project',
],
],
[
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '环境名称',
- 'description' => '环境名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'demo-env',
- ],
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页码，默认为1。页码从1开始', 'description' => '当前页码，默认为1。页码从1开始', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小，默认为100。取值范围1~100', 'description' => '每页大小，默认为100。取值范围1~100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'type' => 'string', 'required' => false, 'example' => 'dev'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '环境实体',
- 'description' => '环境实体',
- '$ref' => '#/components/schemas/Environment',
+ 'title' => '查询的分页结果',
+ 'description' => '查询的分页结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'pageNumber' => ['title' => '当前页码', 'description' => '当前页码，默认为1。页码从1开始', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'pageSize' => ['title' => '每页大小', 'description' => '每页大小，默认为100。取值范围1~100', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'totalCount' => ['title' => '查询到的结果数量', 'description' => '查询到的结果数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'data' => [
+ 'title' => '查询的资源实体列表',
+ 'description' => '查询的资源实体列表',
+ 'type' => 'array',
+ 'items' => ['title' => '查询的一个满足条件的环境实体', 'description' => '查询的一个满足条件的环境实体', '$ref' => '#/components/schemas/Environment'],
+ ],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量查询环境',
+ 'summary' => '批量查询满足条件的环境。',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-06T06:01:12.000Z', 'description' => '请求参数发生变更'],
],
- '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' => '查询环境',
- ],
- 'DeleteConnection' => [
- 'summary' => '删除一个身份绑定。',
- 'path' => '/2023-07-14/connections/{name}',
- 'methods' => [
- 'delete',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListEnvironments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ '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' => '是否强制删除。若存在仓库绑定实体（Repository）关联了该身份绑定（Connection），则无法直接删除；您能够通过强制删除的方式删除该身份绑定'."\n"
- ."\n"
- .'><notice>删除身份绑定（Connection）时，不会级联删除关联的仓库绑定（Repository）></notice>',
- 'type' => 'boolean',
+ 'title' => '只返回含有这些label的对象',
+ 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
+ 'type' => 'array',
+ 'items' => ['title' => 'label表达式，例如: appName=my-app', 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系', 'type' => 'string', 'required' => false, 'example' => 'label_key1=value1'],
'required' => false,
- 'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'A5152937-1C8A-5260-90FA-520CEF028D2D',
- ],
- ],
+ 'title' => '流水线执行列表',
+ 'description' => '流水线执行列表',
+ 'type' => 'array',
+ 'items' => ['title' => '流水线执行', 'description' => '流水线执行', '$ref' => '#/components/schemas/Pipeline'],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"A5152937-1C8A-5260-90FA-520CEF028D2D\\"\\n}","type":"json"}]',
- 'title' => '删除身份绑定',
- ],
- 'ListConnections' => [
- 'summary' => '批量查询满足条件的身份绑定。',
- 'path' => '/2023-07-14/connections',
- 'methods' => [
- 'get',
+ 'title' => '批量查询流水线执行',
+ 'summary' => '批量查询流水线执行。请尽可能提供更多的查询条件以缩小查询范围。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListPipelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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 \\"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\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\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' => '批量查询满足条件的项目。',
+ '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' => [
@@ -10266,50 +3530,24 @@
'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
'type' => 'array',
- 'items' => [
- 'title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'platform=github'."\n",
- ],
+ 'items' => ['title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'type' => 'string', 'required' => false, 'example' => 'templateName=spring-boot-v3'],
'required' => false,
],
],
[
'name' => 'pageNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码，默认为1。页码从1开始',
- 'description' => '当前页码，默认为1。页码从1开始',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '当前页码，默认为1。页码从1开始。', 'description' => '当前页码，默认为1。页码从1开始', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'pageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小，默认为100。取值范围1~100',
- 'description' => '每页大小，默认为100。取值范围1~100',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['title' => '每页大小，默认为100。取值范围1~100', 'description' => '每页大小，默认为100。取值范围1~100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
'name' => 'keyword',
'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'auto-',
- ],
+ 'schema' => ['title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'type' => 'string', 'required' => false, 'example' => 'spring-boot'],
],
],
'responses' => [
@@ -10319,178 +3557,215 @@
'description' => '查询的分页结果',
'type' => 'object',
'properties' => [
- 'pageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码，默认为1。页码从1开始',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'pageSize' => [
- 'title' => '每页大小',
- 'description' => '每页大小，默认为100。取值范围1~100',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'totalCount' => [
- 'title' => '查询到的结果数量',
- 'description' => '查询到的结果数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'pageNumber' => ['title' => '当前页码', 'description' => '当前页码，默认为1。页码从1开始', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'pageSize' => ['title' => '每页大小', 'description' => '每页大小，默认为100。取值范围1~100', '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/Connection',
- ],
+ 'items' => ['title' => '查询的一个满足条件的项目实体', 'description' => '查询的一个满足条件的项目实体', '$ref' => '#/components/schemas/Project'],
],
],
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
- ],
- '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' => '批量查询身份绑定',
- ],
- 'GetRepository' => [
- 'summary' => '查询一个仓库绑定实体。',
- 'path' => '/2023-07-14/repositories/{name}',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量查询项目',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListProjects',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListServiceDeployments' => [
+ 'summary' => '批量查询服务部署信息。',
+ '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' => '只返回含有这些label的对象',
+ 'description' => '只返回含有这些label的对象',
+ 'type' => 'array',
+ 'items' => ['title' => 'label表达式，例如: appName=my-app', 'description' => 'label表达式，例如: appName=my-app', 'type' => 'string', 'required' => false, 'example' => 'label_key1=value1'],
'required' => false,
- 'example' => 'demo-name',
],
],
+ [
+ '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'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '查询的仓库绑定实体',
- '$ref' => '#/components/schemas/Repository',
+ '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' => ['title' => '服务部署详情', 'description' => '服务部署详情', '$ref' => '#/components/schemas/ServiceDeployment'],
+ ],
+ ],
],
],
],
- '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' => '查询仓库绑定',
- ],
- 'CreatePipeline' => [
- 'summary' => '创建流水线执行。流水线将被异步地执行，并按照配置，产生具体的流水线任务。',
- 'path' => '/2023-07-14/pipelines',
- 'methods' => [
- 'post',
+ 'title' => '批量查询服务部署信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListServiceDeployments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTasks' => [
+ 'summary' => '批量查询流水线任务执行。',
+ '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' => '只返回含有这些label的对象',
+ 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
+ 'type' => 'array',
+ 'items' => ['title' => 'label表达式，例如: appName=my-app', 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系', 'type' => 'string', 'required' => false, 'example' => 'label_key1=value1'],
'required' => false,
- '$ref' => '#/components/schemas/Pipeline',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '创建的流水线执行',
- 'description' => '创建的流水线执行',
- '$ref' => '#/components/schemas/Pipeline',
+ 'title' => '流水线任务列表',
+ 'description' => '流水线任务列表',
+ 'type' => 'array',
+ 'items' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
],
],
],
- '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' => '创建流水线执行',
- ],
- 'ListPipelines' => [
- 'summary' => '批量查询流水线执行。请尽可能提供更多的查询条件以缩小查询范围。',
- 'path' => '/2023-07-14/pipelines',
- 'methods' => [
- 'get',
+ 'title' => '批量查询流水线任务执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '批量查询工具集',
+ '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' => [
[
@@ -10498,293 +3773,331 @@
'in' => 'query',
'style' => 'simple',
'schema' => [
- 'title' => '只返回含有这些label的对象',
+ 'title' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
'type' => 'array',
- 'items' => [
- 'title' => 'label表达式，例如: appName=my-app',
- 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
+ 'items' => ['title' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'description' => 'labelSelector中的一条筛选条件，格式为${key}=${value}', 'type' => 'string', 'required' => false, 'example' => 'label_key1=value1'],
'required' => false,
],
],
+ [
+ 'name' => 'pageNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页码，默认为1。页码从1开始。', 'description' => '当前页码，默认为1。页码从1开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小，默认为100。取值范围1~100', 'description' => '每页大小，默认为100。取值范围1~100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['title' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'description' => '模糊搜索关键词。仅支持实体的name字段，且大小写不敏感', 'type' => 'string', 'required' => false, 'example' => 'demo'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '流水线执行列表',
- 'description' => '流水线执行列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '流水线执行',
- 'description' => '流水线执行',
- '$ref' => '#/components/schemas/Pipeline',
+ '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'],
+ ],
],
],
],
],
- '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' => '批量查询流水线执行',
- ],
- 'GetPipeline' => [
- 'summary' => '查询流水线执行。',
- 'path' => '/2023-07-14/pipelines/{name}',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '批量查询工具集',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListToolsets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PreviewEnvironment' => [
+ 'summary' => '预览环境变更信息',
+ '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' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '环境名称', 'description' => '环境名称', 'type' => 'string', 'required' => true, 'example' => 'demo-env'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '流水线执行',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['description' => '预期环境部署配置', '$ref' => '#/components/schemas/EnvironmentDeploymentSpec'],
],
],
- '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' => [
- 'summary' => '启动流水线执行。',
- 'path' => '/2023-07-14/pipelines/{name}/start',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '预览环境变更信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:PreviewEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PutArtifact' => [
+ 'summary' => '更新交付物',
+ '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' => ['title' => '交付物配置', 'description' => '交付物配置', 'required' => false, '$ref' => '#/components/schemas/Artifact'],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '交付物名称', 'description' => '交付物名称', 'type' => 'string', 'required' => false, 'example' => 'demo-artifact'],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => ['title' => '强制更新', 'description' => '强制更新', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '流水线执行',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['title' => '交付物配置', 'description' => '交付物配置', '$ref' => '#/components/schemas/Artifact'],
],
],
- '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' => [
- 'summary' => '取消流水线执行。流水线以及任务将被尽快取消执行。',
- 'path' => '/2023-07-14/pipelines/{name}/cancel',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新交付物',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:PutArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => ['title' => '流水线执行', 'description' => '流水线执行', 'required' => false, '$ref' => '#/components/schemas/Pipeline'],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => ['title' => '强制更新', 'description' => '强制更新', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '流水线执行',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['title' => '流水线执行', 'description' => '流水线执行', '$ref' => '#/components/schemas/Pipeline'],
],
],
- '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' => [
+ 'title' => '替换流水线执行状态',
'summary' => '替换流水线执行状态。',
- 'path' => '/2023-07-14/pipelines/{name}/status',
- 'methods' => [
- 'put',
+ 'description' => 'API提供了乐观锁机制，在不设置强制更新的场景下，需要基于最新的流水线触发器配置修改后提交，否则将触发提交冲突异常。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutPipelineStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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 \\"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\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\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' => '替换流水线任务执行状态。',
+ '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
[
'name' => 'body',
'in' => 'body',
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '流水线执行',
- 'required' => false,
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', 'required' => false, '$ref' => '#/components/schemas/Task'],
],
[
'name' => 'force',
'in' => 'query',
- 'schema' => [
- 'title' => '强制更新',
- 'description' => '强制更新',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '强制更新', 'description' => '强制更新', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线执行',
- 'description' => '流水线执行',
- '$ref' => '#/components/schemas/Pipeline',
- ],
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
],
],
- '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' => '替换流水线执行状态',
+ 'title' => '替换流水线任务执行状态',
'description' => 'API提供了乐观锁机制，在不设置强制更新的场景下，需要基于最新的流水线触发器配置修改后提交，否则将触发提交冲突异常。',
- ],
- 'CreateTask' => [
- 'summary' => '创建流水线任务执行。',
- 'path' => '/2023-07-14/tasks',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutTaskStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '解析模板中的服务以及变量配置。',
+ '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' => [
@@ -10793,597 +4106,1131 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
+ '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' => '服务名称变化，key是模板原始服务名，value是需要修改的目标服务名',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['title' => '修改后的目标服务名称', 'description' => '修改后的目标服务名称', 'type' => 'string', 'example' => '{"originName": "newName"}'],
+ 'example' => '{"svc1":"svc2"}',
+ ],
+ 'projectName' => ['title' => '项目名称，用于在已有项目中通过模板新增服务的场景。当指定时，会检测模板中的服务名和指定项目中的服务是否存在命名冲突，如果冲突时会自动生成新的服务名称。', 'description' => '项目名称，用于在已有项目中通过模板新增服务的场景。当指定时，会检测模板中的服务名和指定项目中的服务是否存在命名冲突，如果冲突时会自动生成新的服务名称。', 'type' => 'string', 'required' => false, 'example' => 'my-project'],
+ ],
'required' => false,
- '$ref' => '#/components/schemas/Task',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
+ 'type' => 'object',
+ 'properties' => [
+ 'services' => [
+ 'title' => '解析后的服务集合',
+ 'description' => '解析后的服务集合',
+ 'type' => 'object',
+ 'additionalProperties' => ['title' => '服务配置', 'description' => '服务配置', '$ref' => '#/components/schemas/ServiceConfig'],
+ ],
+ 'variables' => [
+ 'title' => '解析后的变量集合',
+ 'description' => '解析后的变量集合',
+ 'type' => 'object',
+ 'additionalProperties' => ['title' => '变量配置', 'description' => '变量配置', '$ref' => '#/components/schemas/Variable'],
+ ],
+ 'changedServiceNames' => [
+ 'title' => '变化后的服务名称。key是新的服务名称，value是原始服务名称。'."\n"
+ .'通过这个字段，可以记录模板的原始服务名称，实现部署前的不断修改名称',
+ 'description' => '变化后的服务名称。key是新的服务名称，value是原始服务名称。'."\n"
+ .'通过这个字段，可以记录模板的原始服务名称，实现部署前的不断修改名称',
+ 'type' => 'object',
+ 'additionalProperties' => ['title' => '原始服务名称', 'description' => '原始服务名称', 'type' => 'string', 'example' => 'demo-service'],
+ ],
+ ],
+ 'description' => '',
],
],
],
- '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' => '创建流水线任务执行',
- ],
- 'ListTasks' => [
- 'summary' => '批量查询流水线任务执行。',
- 'path' => '/2023-07-14/tasks',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '解析模板中的服务以及变量配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:RenderServicesByTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'type' => 'array',
- 'items' => [
- 'title' => 'label表达式，例如: appName=my-app',
- 'description' => '利用实体的labels字段进行筛选。精确匹配labelSelector数组中的所有条件，不同条件之间是“且”的关系',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'label_key1=value1',
- ],
- 'required' => false,
- ],
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务列表',
- 'description' => '流水线任务列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
+ ],
+ ],
+ 'title' => '恢复流水线任务执行',
+ 'summary' => '恢复流水线任务执行。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:ResumeTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '批量查询流水线任务执行',
+ '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' => '查询流水线任务执行。',
- 'path' => '/2023-07-14/tasks/{name}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RetryTask' => [
+ 'summary' => '重试流水线任务执行。',
+ '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
+ ],
+ ],
+ 'title' => '重试流水线任务执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:RetryTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '启动流水线执行。',
+ '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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
+ ],
+ ],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
+ 'schema' => ['title' => '流水线执行', 'description' => '流水线执行', '$ref' => '#/components/schemas/Pipeline'],
+ ],
+ ],
+ 'title' => '启动流水线执行',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '查询流水线任务执行',
+ '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\\": \\"部署辅助函数权限不足，需要添加额外的权限以解决问题\\"\\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' => '启动流水线任务执行。',
'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' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
- ],
+ 'schema' => ['title' => '流水线任务', 'description' => '流水线任务', '$ref' => '#/components/schemas/Task'],
],
],
- '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' => [
- 'summary' => '重试流水线任务执行。',
- 'path' => '/2023-07-14/tasks/{name}/retry',
- 'methods' => [
- 'put',
+ 'summary' => '启动流水线任务执行。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '修改环境，并在模板参数变化时自动部署该环境。',
+ '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' => ['title' => '环境实体。您指定的可写字段将被更新，未指定的字段将保持不变', 'description' => '环境实体。您指定的可写字段将被更新，未指定的字段将保持不变', 'required' => false, '$ref' => '#/components/schemas/Environment'],
+ ],
+ [
+ 'name' => 'projectName',
+ 'in' => 'path',
+ 'schema' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => true, 'example' => 'demo-project'],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '环境名称', 'description' => '环境名称', 'type' => 'string', 'required' => true, 'example' => 'demo-env'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
- ],
+ 'schema' => ['title' => '环境实体', 'description' => '环境实体', '$ref' => '#/components/schemas/Environment'],
],
],
- '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' => [
- 'summary' => '恢复流水线任务执行。',
- 'path' => '/2023-07-14/tasks/{name}/resume',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '修改环境',
+ 'description' => '- 使用修改（Update）的接口时，您指定的可写字段将被更新，未指定的字段将保持不变'."\n"
+ ."\n"
+ .'- 当且仅当模板参数（spec.templateConfig.parameters）发生变化时，才会触发自动部署',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-06T06:01:12.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateProject' => [
+ 'summary' => '修改项目，并在模板参数变化时自动部署该项目。',
+ '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' => ['title' => '计划更新的项目实体内容。您指定的可写字段将被更新，未指定的字段将保持不变', 'description' => '计划更新的项目实体内容。您指定的可写字段将被更新，未指定的字段将保持不变', 'required' => false, '$ref' => '#/components/schemas/Project'],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '对象名称', 'description' => '对象名称', 'type' => 'string', 'required' => false, 'example' => 'demo-name'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
- ],
+ 'schema' => ['title' => '成功更新后的项目实体', 'description' => '成功更新后的项目实体', '$ref' => '#/components/schemas/Project'],
],
],
- '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' => [
- 'summary' => '取消流水线任务执行。',
- 'path' => '/2023-07-14/tasks/{name}/cancel',
- 'methods' => [
- 'put',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '修改项目',
+ 'description' => '1. 使用修改（Update）相关的接口时，您指定的可写字段将被更新，未指定的字段将保持不变'."\n"
+ .'2. 当且仅当模板参数（spec.templateConfig.parameters）发生变化时，才会触发自动部署'."\n"
+ .'3. 使用环境（Environment）相关API修改默认环境（Default）配置后，不再支持更新项目',
+ 'changeSet' => [
+ ['createdAt' => '2024-06-24T02:30:45.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ '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' => '更新工具集信息',
+ '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' => ['title' => '计划更新的工具集实体。您指定的可写字段将被更新，未指定的字段将保持不变', 'description' => '计划更新的工具集实体。您指定的可写字段将被更新，未指定的字段将保持不变', 'required' => false, '$ref' => '#/components/schemas/Toolset'],
+ ],
+ [
'name' => 'name',
'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
- ],
+ 'schema' => ['title' => '工具集名称', 'description' => '工具集名称', 'type' => 'string', 'required' => false, 'example' => 'my-toolset'],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
+ 'schema' => ['title' => '成功更新后的工具集实体', 'description' => '成功更新后的工具集实体', '$ref' => '#/components/schemas/Toolset'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'title' => '更新工具集',
+ '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' => '取消流水线任务执行',
],
- 'PutTaskStatus' => [
- 'summary' => '替换流水线任务执行状态。',
- 'path' => '/2023-07-14/tasks/{name}/status',
- 'methods' => [
- 'put',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'devs.cn-shenzhen.aliyuncs.com', 'endpoint' => 'devs.cn-shenzhen.aliyuncs.com', 'vpc' => 'devs-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'devs.cn-beijing.aliyuncs.com', 'endpoint' => 'devs.cn-beijing.aliyuncs.com', 'vpc' => 'devs-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'devs.cn-shanghai.aliyuncs.com', 'endpoint' => 'devs.cn-shanghai.aliyuncs.com', 'vpc' => 'devs-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'devs.cn-hangzhou.aliyuncs.com', 'endpoint' => 'devs.cn-hangzhou.aliyuncs.com', 'vpc' => 'devs-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'devs.us-west-1.aliyuncs.com', 'endpoint' => 'devs.us-west-1.aliyuncs.com', 'vpc' => 'devs-vpc.us-west-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateEnvironment'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteEnvironment'],
+ ['description' => '响应参数发生变更', 'api' => 'DeleteProject'],
+ ['description' => '请求参数发生变更', 'api' => 'GetEnvironment'],
+ ['description' => '请求参数发生变更', 'api' => 'ListEnvironments'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateEnvironment'],
+ ],
+ 'createdAt' => '2024-09-06T06:01:33.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'UpdateProject'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'createdAt' => '2024-06-24T02:31:04.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ram' => [
+ 'productCode' => 'Devs',
+ 'productName' => '云原生应用开发平台 CAP',
+ 'ramCodes' => ['devs'],
+ 'ramLevel' => '资源级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'PutArtifact',
+ 'description' => '更新交付物',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:PutArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CancelPipeline',
+ 'description' => '取消流水线执行',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'CreatePipeline',
+ 'description' => '创建流水线执行',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreatePipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'DeleteConnection',
+ 'description' => '删除身份绑定',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteConnection',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'PutTaskStatus',
+ 'description' => '替换流水线任务执行状态',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
+ 'ramAction' => [
+ 'action' => 'devs:PutTaskStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'name',
- 'in' => 'path',
- 'schema' => [
- 'title' => '对象名称',
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'demo-name',
+ [
+ 'apiName' => 'ListToolsets',
+ 'description' => '批量查询工具集',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListToolsets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'body',
- 'in' => 'body',
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- 'required' => false,
- '$ref' => '#/components/schemas/Task',
+ ],
+ [
+ 'apiName' => 'DeleteToolset',
+ 'description' => '删除工具集',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'force',
- 'in' => 'query',
- 'schema' => [
- 'title' => '强制更新',
- 'description' => '强制更新',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ ],
+ [
+ 'apiName' => 'UpdateProject',
+ 'description' => '修改项目',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => 'Project', 'arn' => 'acs:devs:{#regionId}:{#accountId}:project/{#name}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '流水线任务',
- 'description' => '流水线任务',
- '$ref' => '#/components/schemas/Task',
+ [
+ 'apiName' => 'CreateProject',
+ 'description' => '创建项目',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '替换流水线任务执行状态',
- 'description' => 'API提供了乐观锁机制，在不设置强制更新的场景下，需要基于最新的流水线触发器配置修改后提交，否则将触发提交冲突异常。',
- ],
- 'ActivateConnection' => [
- 'summary' => '激活一个身份绑定。点击Connection状态中的授权链接完成OAuth授权流程后，开发平台会激活当前身份绑定。 使用OAuth授权的第三方代码托管平台包括：GitHub、Gitee、Codeup。',
- 'path' => '/2023-07-14/connections/{name}/activate',
- 'methods' => [
- 'patch',
+ [
+ 'apiName' => 'ListProjects',
+ 'description' => '批量查询项目',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListProjects',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListConnections',
+ 'description' => '批量查询身份绑定',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListConnections',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'RetryTask',
+ 'description' => '重试流水线任务执行',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:RetryTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ '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}'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'ListPipelines',
+ 'description' => '批量查询流水线执行',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListPipelines',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'PreviewEnvironment',
+ 'description' => '预览环境变更信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:PreviewEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPipeline',
+ 'description' => '查询流水线执行',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetToolset',
+ 'description' => '获取工具集',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetToolset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteProject',
+ 'description' => '删除项目',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchArtifactTempBucketToken',
+ 'description' => '获取交付物临时上传令牌',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactTempBucketToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEnvironment',
+ 'description' => '删除环境',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteArtifact',
+ 'description' => '删除交付物',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'devs:DeleteArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '全部资源', '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' => '完成OAuth授权流程后获取的凭证信息，使用该凭证可以访问代码托管平台相关API',
- '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' => '全部资源', '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' => '全部资源', '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' => '激活身份绑定',
- ],
- 'FetchConnectionCredential' => [
- 'summary' => '获取完成授权流程的身份绑定凭证，开发平台会使用该凭证访问第三方代码托管平台。',
- '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'ListServiceDeployments',
+ 'description' => '批量查询服务部署信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListServiceDeployments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetEnvironment',
+ 'description' => '查询环境',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTasks',
+ 'description' => '批量查询流水线任务执行',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:ListTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'CreateArtifact',
+ 'description' => '创建交付物',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'StartPipeline',
+ 'description' => '启动流水线执行',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartPipeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'GetRepository',
+ 'description' => '查询仓库绑定',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREdevsJWJ2XN',
+ 'ramAction' => [
+ 'action' => 'devs:GetRepository',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '全部资源', '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEnvironmentDeployment',
+ 'description' => '查询环境部署详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetEnvironmentDeployment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchConnectionCredential',
+ 'description' => '获取身份绑定凭证',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchConnectionCredential',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartTask',
+ 'description' => '启动流水线任务执行',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:StartTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchArtifactDownloadUrl',
+ 'description' => '获取交付物临时下载地址',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:FetchArtifactDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RenderServicesByTemplate',
+ 'description' => '解析模板中的服务以及变量配置',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'devs:RenderServicesByTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateEnvironment',
+ 'description' => '修改环境',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:UpdateEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PutPipelineStatus',
+ 'description' => '替换流水线执行状态',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:PutPipelineStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTask',
+ 'description' => '创建流水线任务执行',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'devs:CreateTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetArtifact',
+ 'description' => '查询交付物',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'devs:GetArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelTask',
+ 'description' => '取消流水线任务执行',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:CancelTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeployEnvironment',
+ 'description' => '部署环境',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'devs:DeployEnvironment',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEnvironments',
+ 'description' => '批量查询环境',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'devs:ListEnvironments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Devs', 'resourceType' => '全部资源', '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' => '获取身份绑定凭证',
],
- ],
- '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:53:10 +0000