diff options
Diffstat (limited to 'data/zh_cn/iacservice/2021-08-06')
| -rw-r--r-- | data/zh_cn/iacservice/2021-08-06/api-docs.php | 11189 |
1 files changed, 11189 insertions, 0 deletions
diff --git a/data/zh_cn/iacservice/2021-08-06/api-docs.php b/data/zh_cn/iacservice/2021-08-06/api-docs.php new file mode 100644 index 0000000..8b7e6fa --- /dev/null +++ b/data/zh_cn/iacservice/2021-08-06/api-docs.php @@ -0,0 +1,11189 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'IaCService', + 'version' => '2021-08-06', + ], + 'directories' => [ + [ + 'id' => 171780, + 'title' => '模板', + 'type' => 'directory', + 'children' => [ + 'CreateModule', + 'UpdateModuleAttribute', + 'ListModules', + 'GetModule', + 'DeleteModule', + ], + ], + [ + 'id' => 172110, + 'title' => '模板版本', + 'type' => 'directory', + 'children' => [ + 'CreateModuleVersion', + 'GetModuleVersion', + 'ListModuleVersion', + ], + ], + [ + 'id' => 171831, + 'title' => '任务', + 'type' => 'directory', + 'children' => [ + 'CreateTask', + 'UpdateTaskAttribute', + 'ListTasks', + 'GetTask', + 'DeleteTask', + ], + ], + [ + 'id' => 171775, + 'title' => '作业', + 'type' => 'directory', + 'children' => [ + 'CreateJob', + 'OperateJob', + 'ListJobs', + 'GetJob', + ], + ], + [ + 'id' => 171820, + 'title' => '资源导出任务', + 'type' => 'directory', + 'children' => [ + 'CreateResourceExportTask', + 'UpdateResourceExportTaskAttribute', + 'ListResourceExportTasks', + 'GetResourceExportTask', + 'CancelResourceExportTask', + 'ExecuteResourceExportTask', + 'DeleteResourceExportTask', + 'ListResourceExportTaskVersions', + ], + ], + [ + 'id' => 205402, + 'title' => '工作空间', + 'type' => 'directory', + 'children' => [ + 'CreateRegistryNamespace', + 'UpdateRegistryNamespaceAttribute', + 'ListRegistryNamespaces', + 'GetRegistryNamespace', + 'DeleteRegistryNamespace', + 'AddSharedAccounts', + 'RemoveSharedAccounts', + ], + ], + [ + 'id' => 205400, + 'title' => 'Registry模版', + 'type' => 'directory', + 'children' => [ + 'CreateRegistryModule', + 'UpdateRegistryModuleAttribute', + 'ListRegistryModules', + 'GetRegistryModule', + 'DeleteRegistryModule', + 'PublishRegistryModuleVersion', + 'ListRegistryModuleVersions', + 'GetRegistryModuleVersion', + 'DeleteRegistryModuleVersion', + ], + ], + [ + 'id' => 172263, + 'title' => '元数据', + 'type' => 'directory', + 'children' => [ + 'ListTerraformProviderVersions', + 'ListProducts', + 'ListResourceTypes', + 'GetResourceType', + ], + ], + [ + 'id' => 205406, + 'title' => 'Explorer模板', + 'type' => 'directory', + 'children' => [ + 'UpdateExplorerModuleAttribute', + ], + ], + [ + 'id' => 244873, + 'title' => 'Terraform执行', + 'type' => 'directory', + 'children' => [ + 'ValidateModule', + 'ExecuteTerraformApply', + 'ExecuteTerraformDestroy', + 'GetExecuteState', + 'ExecuteTerraformPlan', + ], + ], + [ + 'id' => 245334, + 'title' => '官方RegistryModule', + 'type' => 'directory', + 'children' => [ + 'ExecuteRegistryModule', + 'ListExplorerRegistryModuleVersions', + 'ListExplorerRegistryModules', + 'ListExplorerRegistryModuleExamples', + ], + ], + [ + 'id' => 171803, + 'title' => '项目', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'UpdateProject', + 'ListProject', + 'GetProject', + 'DeleteProject', + ], + ], + [ + 'id' => 171885, + 'title' => '分组', + 'type' => 'directory', + 'children' => [ + 'CreateGroup', + 'UpdateGroup', + 'GetGroup', + 'ListGroup', + 'DeleteGroup', + 'AssociateGroup', + 'DissociateGroup', + ], + ], + [ + 'id' => 371929, + 'title' => '状态管理', + 'type' => 'directory', + 'children' => [ + 'ManageTerraformState', + ], + ], + [ + 'id' => 171857, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'GenerateModule', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateModule' => [ + 'summary' => '创建一个模板。', + 'path' => '/modules', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等串，建议使用uuid。', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '模板描述，长度不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description', + ], + 'groupInfo' => [ + 'description' => '分组信息', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'g-5fd38c9b92d541a7083a86432e2', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead75605713865c386cb9d', + ], + ], + 'required' => false, + ], + 'name' => [ + 'description' => '模板名称，需满足下述要求：'."\n" + .'- 长度为 2~128 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" + .'- 名称在当前账号的模板资源下唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName'."\n", + ], + 'source' => [ + 'description' => '创建来源，取值'."\n" + .'- OSS ：OSS导入'."\n" + .'- Registry : 使用模板中心的模板来创建'."\n" + .'- ExportTask：引用资源导出任务导出的模板', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ExportTask' => 'ExportTask', + 'Registry' => 'Registry', + 'OSS' => 'OSS', + ], + 'example' => 'OSS', + ], + 'sourcePath' => [ + 'description' => '模板来源的路径值'."\n" + .'- 来源为Registry时，取值 \\<工作空间名称>/\\<模块名称>:\\<模块版本>, 例如 terraform-alicloud-modules/rds:1.0.0'."\n" + .'- 来源为OSS时，取值为oss::<文件链接>，必须为zip文件，例如oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为ExportTask时，取值为 \\<导出任务ID>:\\<导出的版本>,例如 ex-3b6cb9fa4751afff298da723c24ac:v1', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip', + ], + 'statePath' => [ + 'description' => '模板对应的State文件的路径值，目前只针对OSS路径。'."\n" + .'取值 oss::\\<文件OSS路径>/terraform.tfstate', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate', + ], + 'versionStrategy' => [ + 'description' => '版本生成策略,取值'."\n" + ."\n" + .'- Manual :手动生成版本(默认)'."\n" + .'- SourcePathUpdated ：'."\n" + .' 修改sourcePath触发生成新版本', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Manual' => 'Manual', + 'SourcePathUpdated' => 'SourcePathUpdated', + ], + 'example' => 'Manual', + ], + 'tags' => [ + 'description' => '模板的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '模板的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '模板的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-518855d9a058cfffcc446d8fe3c99', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0D797DC3-FF04-5C21-81EB-92C7799512E3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"moduleId\\": \\"mod-518855d9a058cfffcc446d8fe3c99\\",\\n \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-92C7799512E3\\"\\n}","type":"json"}]', + 'title' => '创建模板', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'UpdateModuleAttribute' => [ + 'summary' => '修改模板的属性。', + 'path' => '/modules/{moduleId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '模板描述，长度不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description'."\n", + ], + 'name' => [ + 'description' => '模板名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 2~128 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" + .'- 名称在当前账号的模板资源下唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'ModuleName', + ], + 'sourcePath' => [ + 'description' => '模板来源的路径值'."\n" + ."\n" + .'- 来源为Registry时，取值 <工作空间名称>/<模块名称>:<模块版本>, 例如 terraform-alicloud-modules/rds:1.0.0'."\n" + .'- 来源为OSS时，取值为oss::<文件链接>，必须为zip文件，例如oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为ExportTask时，取值为 <导出任务ID>:<导出的版本>,例如 ex-3b6cb9fa4751afff298da723c24ac:v1', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip', + ], + 'statePath' => [ + 'description' => '模板对应的State文件的路径值，目前只针对OSS路径。 取值 oss::<文件OSS路径>/terraform.tfstate', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate', + ], + 'versionStrategy' => [ + 'description' => '版本生成策略,取值'."\n" + ."\n" + .'- Manual :手动生成版本(默认)'."\n" + .'- SourcePathUpdated ：'."\n" + .' 修改sourcePath触发生成新版本', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Manual' => 'Manual', + 'SourcePathUpdated' => 'SourcePathUpdated', + ], + 'example' => 'Manual', + ], + 'groupInfo' => [ + 'description' => '项目分组信息', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'g-433aead7560571e66e31274ffd3', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead75605713865c386cb9d', + ], + ], + 'required' => false, + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'tags' => [ + 'description' => '模板的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '模板的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '模板的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-62ecaa43022ce189d65f8d4a794', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'CA05185E-6B90-5941-98D4-7212688AECC8', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CA05185E-6B90-5941-98D4-7212688AECC8\\"\\n}","type":"json"}]', + 'title' => '修改模板', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListModules' => [ + 'summary' => '获取模板列表。', + 'path' => '/modules', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '搜索关键词，支持对模板名称的模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-al1c58tb2lu9oej36kclvf', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'g-kw1a50tj8rk7cki2q8bbat', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '模板标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagKey' => [ + 'description' => '模板的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'tagValue' => [ + 'description' => '模板的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'modules' => [ + 'description' => '模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板列表。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-01-30T02:14:16Z', + ], + 'deletionProtection' => [ + 'description' => '是否开启了删除保护。'."\n" + .'关联任务时，会开启保护，禁止删除。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'description' => [ + 'description' => '模板描述', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'groupInfo' => [ + 'description' => '分组信息。', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'example' => 'g-kw1a58tb5m2j7rpsa6j25', + ], + 'groupName' => [ + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'groupName', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-fu1a50tjdaff2lppddqsm', + ], + 'projectName' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'projectName', + ], + ], + ], + 'latestVersion' => [ + 'description' => '最新版本号。', + 'type' => 'string', + 'example' => 'v1', + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-518855d9a058cdbd3fd6951d59', + ], + 'name' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'ModuleName', + ], + 'source' => [ + 'description' => '模板来源，枚举值'."\n" + ."\n" + .'- OSS ：OSS导入'."\n" + .'- Registry : 使用模板中心的模板来创建'."\n" + .'- ExportTask：引用资源导出任务导出的模板'."\n" + .'- Upload：文件上传'."\n" + .'- Shared：共享克隆'."\n" + .'- Editor：在线编辑', + 'type' => 'string', + 'example' => 'OSS', + ], + 'status' => [ + 'description' => '模板状态，有效值：'."\n" + ."\n" + .'- Creating 创建中'."\n" + .'- Created 创建完成'."\n" + .'模板创建完成可以发布版本', + 'type' => 'string', + 'example' => 'Created', + ], + 'tags' => [ + 'description' => '模板标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板标签列表。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '模板的标签键', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'value' => [ + 'description' => '模板的标签值', + 'type' => 'string', + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '模板的标签键', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'tagValue' => [ + 'description' => '模板的标签值', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + ], + 'pageNumber' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C617E03B-3DD2-5F0C-A6CF-3028B499A2D5', + ], + 'totalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2790', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"modules\\": [\\n {\\n \\"createTime\\": \\"2022-01-30T02:14:16Z\\",\\n \\"deletionProtection\\": false,\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"groupInfo\\": {\\n \\"groupId\\": \\"g-kw1a58tb5m2j7rpsa6j25\\",\\n \\"groupName\\": \\"groupName\\",\\n \\"projectId\\": \\"p-fu1a50tjdaff2lppddqsm\\",\\n \\"projectName\\": \\"projectName\\"\\n },\\n \\"latestVersion\\": \\"v1\\",\\n \\"moduleId\\": \\"mod-518855d9a058cdbd3fd6951d59\\",\\n \\"name\\": \\"ModuleName\\",\\n \\"source\\": \\"OSS\\",\\n \\"status\\": \\"Created\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"TestKey\\",\\n \\"value\\": \\"TestValue\\",\\n \\"tagKey\\": \\"TestKey\\",\\n \\"tagValue\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"C617E03B-3DD2-5F0C-A6CF-3028B499A2D5\\",\\n \\"totalCount\\": 2790\\n}","type":"json"}]', + 'title' => '获取模板列表', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'GetModule' => [ + 'summary' => '获取模板详情。', + 'path' => '/modules/{moduleId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-148e7853433574fffe9ca86154d77a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'module' => [ + 'description' => '模板信息', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-09-06T06:11:27Z', + ], + 'description' => [ + 'description' => '模板描述', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'latestVersion' => [ + 'description' => '最新版本号。', + 'type' => 'string', + 'example' => 'v1', + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-4267dcfbf1b6d14625614ddbe15', + ], + 'name' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'ModuleName', + ], + 'outputPath' => [ + 'description' => '模板存储路径', + 'type' => 'string', + 'example' => '/', + ], + 'source' => [ + 'description' => '模板来源，枚举值'."\n" + ."\n" + .'- OSS ：OSS导入'."\n" + .'- Registry : 使用模板中心的模板来创建'."\n" + .'- ExportTask：引用资源导出任务导出的模板'."\n" + .'- Upload：文件上传'."\n" + .'- Shared：共享克隆'."\n" + .'- Editor：在线编辑', + 'type' => 'string', + 'example' => 'OSS', + ], + 'sourcePath' => [ + 'description' => '模板来源的路径值'."\n" + ."\n" + .'- 来源为Registry时，取值 <工作空间名称>/<模块名称>:<模块版本>, 例如 terraform-alicloud-modules/rds:1.0.0'."\n" + .'- 来源为OSS时，取值为oss::<文件链接>，例如oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为ExportTask时，取值为 <导出任务ID>:<导出的版本>,例如 ex-3b6cb9fa4751afff298da723c24ac:v1', + 'type' => 'string', + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip', + ], + 'statePath' => [ + 'description' => '模板对应的State文件的路径值，目前只针对OSS路径。 取值 oss::<文件OSS路径>/terraform.tfstate', + 'type' => 'string', + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate', + ], + 'status' => [ + 'description' => '模板状态，有效值：'."\n" + ."\n" + .'- Creating 创建中'."\n" + .'- Created 创建完成'."\n" + .'模板创建完成可以发布版本', + 'type' => 'string', + 'example' => 'Created', + ], + 'versionStrategy' => [ + 'description' => '版本生成策略,取值'."\n" + ."\n" + .'- Manual :手动生成版本(默认)'."\n" + .'- SourcePathUpdated ：'."\n" + .' 修改sourcePath触发生成新版本', + 'type' => 'string', + 'example' => 'Manual', + ], + 'groupInfo' => [ + 'description' => '分组信息。', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'example' => 'g-fu1a1ol8cob1oni01ekcloi', + ], + 'groupName' => [ + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'groupName'."\n", + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-al1d11jlvlsbvr11lf3pqo', + ], + 'projectName' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => 'projectName', + ], + ], + ], + 'tags' => [ + 'description' => '模板的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '模板的标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '模板的标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + ], + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"module\\": {\\n \\"createTime\\": \\"2022-09-06T06:11:27Z\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"latestVersion\\": \\"v1\\",\\n \\"moduleId\\": \\"mod-4267dcfbf1b6d14625614ddbe15\\",\\n \\"name\\": \\"ModuleName\\",\\n \\"outputPath\\": \\"/\\",\\n \\"source\\": \\"OSS\\",\\n \\"sourcePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip\\",\\n \\"statePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate\\",\\n \\"status\\": \\"Created\\",\\n \\"versionStrategy\\": \\"Manual\\",\\n \\"groupInfo\\": {\\n \\"groupId\\": \\"g-fu1a1ol8cob1oni01ekcloi\\",\\n \\"groupName\\": \\"groupName\\\\n\\",\\n \\"projectId\\": \\"p-al1d11jlvlsbvr11lf3pqo\\",\\n \\"projectName\\": \\"projectName\\"\\n },\\n \\"tags\\": [\\n {\\n \\"tagValue\\": \\"TestValue\\",\\n \\"tagKey\\": \\"TestKey\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3\\"\\n}","type":"json"}]', + 'title' => '获取模板详情', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'DeleteModule' => [ + 'summary' => '删除模板。', + 'path' => '/modules/{moduleId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-14e80de4866bf71ef354cc82d17f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '49DA6457-E545-5095-A930-EB8F0BCD4DAA', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49DA6457-E545-5095-A930-EB8F0BCD4DAA\\"\\n}","type":"json"}]', + 'title' => '删除模板', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'CreateModuleVersion' => [ + 'summary' => '发布模板版本。', + 'path' => '/modules/{moduleId}/versions', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-433aead756057143bd9145a5258', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '版本描述，长度不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description'."\n", + ], + 'name' => [ + 'description' => '模板版本名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 2~128 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。', + 'type' => 'string', + 'required' => true, + 'example' => 'versionName', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'moduleVersion' => [ + 'description' => '模板版本号', + 'type' => 'string', + 'example' => 'v1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"moduleVersion\\": \\"v1\\",\\n \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\"\\n}","type":"json"}]', + 'title' => '发布模板版本', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'GetModuleVersion' => [ + 'summary' => '获取模板版本详情。', + 'path' => '/modules/{moduleId}/versions/{moduleVersion}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => false, + 'example' => 'mod-14e80de4866bf71c92a04fe353b1', + ], + ], + [ + 'name' => 'moduleVersion', + 'in' => 'path', + 'schema' => [ + 'description' => '模板版本', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0D298375-F92F-5B65-82E4-EA68F02521F1', + ], + 'version' => [ + 'description' => '版本详情。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '版本创建时间。', + 'type' => 'string', + 'example' => '2022-09-08T18:07:40Z', + ], + 'description' => [ + 'description' => '版本描述', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-4267dcfbf1b6dfffbc27e218d1b66', + ], + 'moduleVersion' => [ + 'description' => '模板版本号', + 'type' => 'string', + 'example' => 'v1', + ], + 'name' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => 'versionName', + ], + 'source' => [ + 'description' => '版本来源，枚举值'."\n" + ."\n" + .'- OSS ：OSS导入'."\n" + .'- Registry : 使用模板中心的模板来创建'."\n" + .'- ExportTask：引用资源导出任务导出的模板'."\n" + .'- Upload：文件上传'."\n" + .'- Shared：共享克隆'."\n" + .'- Editor：在线编辑', + 'type' => 'string', + 'example' => 'OSS', + ], + 'sourcePath' => [ + 'description' => '版本来源的路径值'."\n" + ."\n" + .'- 来源为Registry时，取值 <工作空间名称>/<模块名称>:<模块版本>, 例如 terraform-alicloud-modules/rds:1.0.0'."\n" + .'- 来源为OSS时，取值为oss::<文件链接>，例如oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为ExportTask时，取值为 <导出任务ID>:<导出的版本>,例如 ex-3b6cb9fa4751afff298da723c24ac:v1', + 'type' => 'string', + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip', + ], + 'statePath' => [ + 'description' => '模板对应的State文件的路径值，目前只针对OSS路径。 取值 oss::<文件OSS路径>/terraform.tfstate', + 'type' => 'string', + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate', + ], + 'terraformContext' => [ + 'description' => 'Terraform内容', + 'type' => 'object', + ], + 'versionStrategy' => [ + 'description' => '版本生成策略,取值'."\n" + ."\n" + .'- Manual :手动生成版本(默认)'."\n" + .'- SourcePathUpdated ：'."\n" + .' 修改sourcePath触发生成新版本', + 'type' => 'string', + 'example' => 'Manual', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D298375-F92F-5B65-82E4-EA68F02521F1\\",\\n \\"version\\": {\\n \\"createTime\\": \\"2022-09-08T18:07:40Z\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"moduleId\\": \\"mod-4267dcfbf1b6dfffbc27e218d1b66\\",\\n \\"moduleVersion\\": \\"v1\\",\\n \\"name\\": \\"versionName\\",\\n \\"source\\": \\"OSS\\",\\n \\"sourcePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip\\",\\n \\"statePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate\\",\\n \\"terraformContext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"versionStrategy\\": \\"Manual\\"\\n }\\n}","type":"json"}]', + 'title' => '获取模板版本详情', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListModuleVersion' => [ + 'summary' => '获取模板版本列表。', + 'path' => '/modules/{moduleId}/versions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-433aead756057fff39b2f7ac8b798', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持对版本名称的模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '792171BB-1A68-5148-8B9B-C7C728E1E98B', + ], + 'totalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'versions' => [ + 'description' => '版本信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '版本信息列表。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '版本创建时间。', + 'type' => 'string', + 'example' => '2022-05-13T02:21:49Z', + ], + 'moduleVersion' => [ + 'description' => '模板版本号', + 'type' => 'string', + 'example' => 'v3', + ], + 'name' => [ + 'description' => '版本名称', + 'type' => 'string', + 'example' => 'versionName', + ], + 'description' => [ + 'description' => '版本描述', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-55f1739d9050fffed3ec3a2c4a5e5', + ], + 'sourcePath' => [ + 'description' => '版本来源的路径值', + 'type' => 'string', + 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"792171BB-1A68-5148-8B9B-C7C728E1E98B\\",\\n \\"totalCount\\": 6,\\n \\"versions\\": [\\n {\\n \\"createTime\\": \\"2022-05-13T02:21:49Z\\",\\n \\"moduleVersion\\": \\"v3\\",\\n \\"name\\": \\"versionName\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"moduleId\\": \\"mod-55f1739d9050fffed3ec3a2c4a5e5\\",\\n \\"sourcePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取模板版本列表', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'CreateTask' => [ + 'summary' => '创建任务。', + 'path' => '/tasks', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'autoApply' => [ + 'description' => '是否自动执行任务，默认值为false。'."\n" + .'- true：指的是预览完成（terraform plan）后，无需人工二次确认，自动执行（terraform apply）。'."\n" + .'- false：指的是预览完成（terraform plan）后，需人工二次确认并开始执行（terraform apply）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'autoDestroy' => [ + 'description' => '是否创建后删除，默认值为false。'."\n" + .'- true：指的是执行完成（terraform apply）后，无需人工二次确认，自动执行销毁操作（terraform destroy）。'."\n" + .'- false：指的是执行完成（terraform apply）后，无任何操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '任务描述', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description'."\n", + ], + 'groupInfo' => [ + 'description' => '项目分组信息。', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-5fd38c9b83a86432e2', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aeade5d9167608', + ], + ], + 'required' => false, + ], + 'initModuleState' => [ + 'description' => '是否使用state文件，默认false，适用于模板为资源导出的来源，限制只能有一个任务使用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-144fff6b316f4eb737e', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'required' => true, + 'example' => 'v1', + ], + 'name' => [ + 'description' => '任务名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 2~128 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" + .'- 名称在当前账号的任务资源下唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'TaskName', + ], + 'protectionStrategy' => [ + 'description' => '资源保护策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源保护策略：'."\n" + ."\n" + .'- PreventDestroy：对应的是删除保护，即不允许删除'."\n" + .'- PreventUpdate：对应的是原地变更保护，即不允许任何变更'."\n" + .'- PreventReplace：对应的是ForceNew，即不允许删除重建', + 'type' => 'string', + 'required' => false, + 'example' => 'PreventDestroy', + ], + 'required' => false, + ], + 'ramRole' => [ + 'description' => 'RAM角色，'."\n" + .'触发新作业时由系统扮演角色来执行模板，'."\n" + .'作业触发方式非手动触发时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'RoleName', + ], + 'skipPropertyValidation' => [ + 'description' => '是否跳过枚举值，默认false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'terraformVersion' => [ + 'description' => 'Terraform版本，通过 **ListAvailableTerraformVersions** API获取支持的版本列表，默认为1.5.7。', + 'type' => 'string', + 'required' => false, + 'example' => '1.5.7', + ], + 'triggerStrategy' => [ + 'description' => '作业触发方式'."\n" + ."\n" + .'- Manual ：手动触发（默认）'."\n" + .'- NewVersion ：模板发布新版本时触发'."\n" + .'- ParameterSetUpdated 参数集自身参数内容变更或参数集绑定关系变更时 触发'."\n" + .'- Auto ：当任务自身属性，如新建任务、执行版本或者作业触发策略（由其他改为Auto时），发生变更时自动触发'."\n" + ."\n" + .'非手动触发时必填**ramRole**参数', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Auto' => 'Auto', + 'NewVersion' => 'NewVersion', + 'ParameterSetUpdated' => 'ParameterSetUpdated', + 'Manual' => 'Manual', + ], + 'example' => 'Manual', + 'default' => 'Manual', + 'enum' => [ + 'Always', + 'NewVersion', + 'Manual', + ], + ], + 'taskBackend' => [ + 'description' => '任务配置，配置此参数后，运行的日志信息将保存到指定的OSS中', + 'type' => 'object', + 'properties' => [ + 'bucketName' => [ + 'description' => 'bucket名称', + 'type' => 'string', + 'required' => false, + 'example' => 'iac-runtime-test', + ], + 'bucketEndpoint' => [ + 'description' => 'Endpoint信息', + 'type' => 'string', + 'required' => false, + 'example' => 'ss-cn-beijing.aliyuncs.com', + ], + 'objectPath' => [ + 'description' => '对象路径', + 'type' => 'string', + 'required' => false, + 'example' => '/log', + ], + ], + 'required' => false, + ], + 'tags' => [ + 'description' => '任务的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '任务的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue'."\n", + ], + 'tagKey' => [ + 'description' => '任务的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'CD478792-6952-5A1C-9F57-78932BF0FAC6', + ], + 'taskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'task-433aead756057fffeaba4828f5195', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD478792-6952-5A1C-9F57-78932BF0FAC6\\",\\n \\"taskId\\": \\"task-433aead756057fffeaba4828f5195\\"\\n}","type":"json"}]', + 'title' => '创建任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'UpdateTaskAttribute' => [ + 'summary' => '更新任务属性。', + 'path' => '/tasks/{taskId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'task-4267dcfbf1b6dfff67fea425525e2', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'autoApply' => [ + 'description' => '是否自动执行任务，默认值为false。'."\n" + .'- true：指的是预览完成（terraform plan）后，无需人工二次确认，自动执行（terraform apply）。'."\n" + .'- false：指的是预览完成（terraform plan）后，需人工二次确认并开始执行（terraform apply）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + 'autoDestroy' => [ + 'description' => '是否创建后删除，默认值为false。'."\n" + .'- true：指的是执行完成（terraform apply）后，无需人工二次确认，自动执行销毁操作（terraform destroy）。'."\n" + .'- false：指的是执行完成（terraform apply）后，无任何操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description'."\n", + ], + 'groupInfo' => [ + 'description' => '项目分组信息。', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-433aead7560571e66e31274ffd3', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead75605713865c386cb9d', + ], + ], + 'required' => false, + ], + 'initModuleState' => [ + 'description' => '是否使用state文件，默认false，适用于模板为资源导出的来源，限制只能有一个任务使用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'name' => [ + 'description' => '任务名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 2~128 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" + .'- 名称在当前账号的任务资源下唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'TaskName', + ], + 'protectionStrategy' => [ + 'description' => '资源保护策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源保护策略：'."\n" + ."\n" + .'- PreventDestroy：对应的是删除保护，即不允许删除'."\n" + .'- PreventUpdate：对应的是原地变更保护，即不允许任何变更'."\n" + .'- PreventReplace：对应的是ForceNew，即不允许删除重建', + 'type' => 'string', + 'required' => false, + 'example' => 'PreventDestroy', + ], + 'required' => false, + ], + 'ramRole' => [ + 'description' => 'RAM角色，'."\n" + .'触发新作业时由系统扮演角色来执行模板，'."\n" + .'作业触发方式非手动触发时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'role', + ], + 'skipPropertyValidation' => [ + 'description' => '是否跳过枚举值，默认false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'terraformVersion' => [ + 'description' => 'Terraform版本，通过 **ListAvailableTerraformVersions** API获取支持的版本列表，默认为1.5.7。', + 'type' => 'string', + 'required' => false, + 'example' => '1.5.7', + ], + 'triggerStrategy' => [ + 'description' => '作业触发方式'."\n" + ."\n" + .'- Manual ：手动触发（默认）'."\n" + .'- NewVersion ：模板发布新版本时触发'."\n" + .'- ParameterSetUpdated 参数集自身参数内容变更或参数集绑定关系变更时 触发'."\n" + .'- Auto ：当任务自身属性，如新建任务、执行版本或者作业触发策略（由其他改为Auto时），发生变更时自动触发'."\n" + ."\n" + .'非手动触发时必填**ramRole**参数', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Auto' => 'Auto', + 'NewVersion' => 'NewVersion', + 'ParameterSetUpdated' => 'ParameterSetUpdated', + 'Manual' => 'Manual', + ], + 'example' => 'Manual', + 'default' => 'Manual', + 'enum' => [ + 'Always', + 'NewVersion', + 'Manual', + 'ParameterSetUpdated', + ], + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'tags' => [ + 'description' => '任务的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '任务的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '任务的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '17793D91-A26F-520D-A948-3452A45D15B1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"17793D91-A26F-520D-A948-3452A45D15B1\\"\\n}","type":"json"}]', + 'title' => '修改任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListTasks' => [ + 'summary' => '获取任务列表。', + 'path' => '/tasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字，按照任务ID或任务名称模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => false, + 'example' => 'task-433aead756057fffeaba4828f5195', + ], + ], + [ + 'name' => 'moduleId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID', + 'type' => 'string', + 'required' => false, + 'example' => 'mod-1525e992f1b62139d1c437d64ae', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead7560572f8d95b25775c', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '作业状态，取值'."\n" + ."\n" + .'- Planning：作业正处于执行Plan阶段'."\n" + .'- Planned：作业完成了Plan的执行'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff，此时作业处于最终状态'."\n" + .'- Applying：作业正处于执行Apply阶段'."\n" + .'- Applied：作业完成Apply的执行'."\n" + .'- Errored：作业的执行有错误，进入最终状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Errored' => 'Errored', + 'PlannedAndFinished' => 'PlannedAndFinished', + 'Planning' => 'Planning', + 'Applying' => 'Applying', + 'Planned' => 'Planned', + 'Applied' => 'Applied', + ], + 'example' => 'Errored', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '任务的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '任务的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '98610149-488B-5E48-B981-8D4CE1AF77CD', + ], + 'tasks' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'autoApply' => [ + 'description' => '是否自动执行任务', + 'type' => 'boolean', + 'example' => 'false', + ], + 'moduleName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'mod-name', + ], + 'deletionProtection' => [ + 'description' => '是否开启了删除保护，包含管理的资源时自动开启保护。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'tags' => [ + 'description' => '任务标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '任务标签列表', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '任务的标签值。', + 'type' => 'string', + 'example' => 'iac-demo'."\n", + ], + 'tagKey' => [ + 'description' => '模板的标签键', + 'type' => 'string', + 'example' => 'name', + ], + 'value' => [ + 'description' => '任务标签值', + 'type' => 'string', + 'example' => 'iac-demo', + ], + 'key' => [ + 'description' => '任务标签键', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + 'latestModuleVersion' => [ + 'description' => '模板的最新版本号', + 'type' => 'string', + 'example' => 'v3', + ], + 'createTime' => [ + 'description' => '任务创建时间', + 'type' => 'string', + 'example' => '2022-07-11T15:09:53Z', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'example' => 'v1', + ], + 'name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'TaskName', + ], + 'currentJobStatus' => [ + 'description' => '当前作业状态', + 'type' => 'string', + 'example' => 'Pending', + ], + 'groupInfo' => [ + 'description' => '任务分组信息', + 'type' => 'object', + 'properties' => [ + 'groupName' => [ + 'description' => '分组名称', + 'type' => 'string', + 'example' => 'abc', + ], + 'groupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'g-4267dcfbf1b6d1e0652bfbbe995', + ], + 'projectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'abc', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-433aead7560571cf1b2bfbbe92b', + ], + ], + ], + 'currentJobId' => [ + 'description' => '当前任务的作业ID', + 'type' => 'string', + 'example' => 'job-123asd', + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-518855d9a058c331e9c60bc0ce', + ], + 'taskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'task-1525e992f1b621b0ca51647876e', + ], + 'status' => [ + 'description' => '任务状态'."\n" + ."\n" + .'- Available：可用状态，没有任何job在运行'."\n" + .'- Running：运行状态，当前job正在运行', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"98610149-488B-5E48-B981-8D4CE1AF77CD\\",\\n \\"tasks\\": [\\n {\\n \\"autoApply\\": false,\\n \\"moduleName\\": \\"mod-name\\",\\n \\"deletionProtection\\": false,\\n \\"tags\\": [\\n {\\n \\"tagValue\\": \\"iac-demo\\\\n\\",\\n \\"tagKey\\": \\"name\\",\\n \\"value\\": \\"iac-demo\\",\\n \\"key\\": \\"name\\"\\n }\\n ],\\n \\"latestModuleVersion\\": \\"v3\\",\\n \\"createTime\\": \\"2022-07-11T15:09:53Z\\",\\n \\"moduleVersion\\": \\"v1\\",\\n \\"name\\": \\"TaskName\\",\\n \\"currentJobStatus\\": \\"Pending\\",\\n \\"groupInfo\\": {\\n \\"groupName\\": \\"abc\\",\\n \\"groupId\\": \\"g-4267dcfbf1b6d1e0652bfbbe995\\",\\n \\"projectName\\": \\"abc\\",\\n \\"projectId\\": \\"p-433aead7560571cf1b2bfbbe92b\\"\\n },\\n \\"currentJobId\\": \\"job-123asd\\",\\n \\"moduleId\\": \\"mod-518855d9a058c331e9c60bc0ce\\",\\n \\"taskId\\": \\"task-1525e992f1b621b0ca51647876e\\",\\n \\"status\\": \\"Running\\"\\n }\\n ],\\n \\"totalCount\\": 55\\n}","type":"json"}]', + 'title' => '获取任务列表', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'GetTask' => [ + 'summary' => '获取任务详情。', + 'path' => '/tasks/{taskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'task-433aead7560571f8c2e176e7325', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C24C498A-09CF-54D3-8972-8DC074CF8614', + ], + 'task' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'autoApply' => [ + 'description' => '是否自动执行任务', + 'type' => 'boolean', + 'example' => 'true', + ], + 'autoDestroy' => [ + 'description' => '是否自动删除，当任务执行完成自动销毁资源。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'createTime' => [ + 'description' => '任务创建时间', + 'type' => 'string', + 'example' => '2022-06-15T02:44:37Z', + ], + 'currentJobId' => [ + 'description' => '当前任务的作业ID', + 'type' => 'string', + 'example' => 'job-absdf', + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'groupInfo' => [ + 'description' => '分组信息', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', + ], + 'groupName' => [ + 'description' => '分组名称', + 'type' => 'string', + 'example' => 'abc', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-433aead756057fff47ecbfd94d76', + ], + 'projectName' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + 'initModuleState' => [ + 'description' => '是否使用state文件，默认false，适用于模板为资源导出的来源，限制只能有一个任务使用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'moduleId' => [ + 'description' => '模板ID', + 'type' => 'string', + 'example' => 'mod-4267dcfbf1b6d14625614ddbe15', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'example' => 'v2', + ], + 'name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'TaskName', + ], + 'protectionStrategy' => [ + 'description' => '资源保护策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源保护策略：'."\n" + ."\n" + .'- PreventDestroy：删除保护，即不允许删除'."\n" + .'- PreventUpdate：原地变更保护，即不允许任何变更'."\n" + .'- PreventReplace：ForceNew，即不允许删除重建', + 'type' => 'string', + 'example' => 'PreventDestroy', + ], + ], + 'ramRole' => [ + 'description' => 'RAM角色', + 'type' => 'string', + 'example' => 'role', + ], + 'skipPropertyValidation' => [ + 'description' => '是否跳过枚举值，默认false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'status' => [ + 'description' => '任务状态'."\n" + ."\n" + .'- Available：可用状态，没有任何job在运行'."\n" + .'- Running：运行状态，当前job正在运行', + 'type' => 'string', + 'example' => 'Running', + ], + 'taskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'task-433aead756057154bda7f1c2e98', + ], + 'taskOutputPath' => [ + 'description' => '任务输出路径', + 'type' => 'string', + 'example' => '/', + ], + 'terraformVersion' => [ + 'description' => 'Terraform版本', + 'type' => 'string', + 'example' => '1.5.7', + ], + 'triggerStrategy' => [ + 'description' => '作业触发方式'."\n" + ."\n" + .'- Manual ：手动触发（默认）'."\n" + .'- NewVersion ：模板发布新版本时触发'."\n" + .'- ParameterSetUpdated 参数集自身参数内容变更或参数集绑定关系变更时 触发'."\n" + .'- Auto ：当任务自身属性，如新建任务、执行版本或者作业触发策略（由其他改为Auto时），发生变更时自动触发', + 'type' => 'string', + 'example' => 'Manual', + ], + 'moduleName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'moduleName', + ], + 'taskBackend' => [ + 'description' => '任务配置，配置此参数后，运行的日志信息将保存到指定的OSS中', + 'type' => 'object', + 'properties' => [ + 'bucketName' => [ + 'description' => 'bucket名称', + 'type' => 'string', + 'example' => 'iac-runtime-test'."\n", + ], + 'bucketEndpoint' => [ + 'description' => 'Endpoint信息', + 'type' => 'string', + 'example' => 'ss-cn-beijing.aliyuncs.com'."\n", + ], + 'objectPath' => [ + 'description' => '对象路径', + 'type' => 'string', + 'example' => '/log'."\n", + ], + ], + ], + 'latestModuleVersion' => [ + 'description' => '模板的最新版本号', + 'type' => 'string', + 'example' => 'v3', + ], + 'deletionProtection' => [ + 'description' => '是否开启删除保护', + 'type' => 'boolean', + 'example' => 'true', + ], + 'currentJobStatus' => [ + 'description' => '当前作业状态', + 'type' => 'string', + 'example' => 'Planned', + ], + 'tags' => [ + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => [ + 'description' => '任务的标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + 'tagKey' => [ + 'description' => '任务的标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C24C498A-09CF-54D3-8972-8DC074CF8614\\",\\n \\"task\\": {\\n \\"autoApply\\": true,\\n \\"autoDestroy\\": false,\\n \\"createTime\\": \\"2022-06-15T02:44:37Z\\",\\n \\"currentJobId\\": \\"job-absdf\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"groupInfo\\": {\\n \\"groupId\\": \\"g-59d8d22e78792ffe3d3eb6154d727\\",\\n \\"groupName\\": \\"abc\\",\\n \\"projectId\\": \\"p-433aead756057fff47ecbfd94d76\\",\\n \\"projectName\\": \\"abc\\"\\n },\\n \\"initModuleState\\": false,\\n \\"moduleId\\": \\"mod-4267dcfbf1b6d14625614ddbe15\\",\\n \\"moduleVersion\\": \\"v2\\",\\n \\"name\\": \\"TaskName\\",\\n \\"protectionStrategy\\": [\\n \\"PreventDestroy\\"\\n ],\\n \\"ramRole\\": \\"role\\",\\n \\"skipPropertyValidation\\": false,\\n \\"status\\": \\"Running\\",\\n \\"taskId\\": \\"task-433aead756057154bda7f1c2e98\\",\\n \\"taskOutputPath\\": \\"/\\",\\n \\"terraformVersion\\": \\"1.5.7\\",\\n \\"triggerStrategy\\": \\"Manual\\",\\n \\"moduleName\\": \\"moduleName\\",\\n \\"taskBackend\\": {\\n \\"bucketName\\": \\"iac-runtime-test\\\\n\\",\\n \\"bucketEndpoint\\": \\"ss-cn-beijing.aliyuncs.com\\\\n\\",\\n \\"objectPath\\": \\"/log\\\\n\\"\\n },\\n \\"latestModuleVersion\\": \\"v3\\",\\n \\"deletionProtection\\": true,\\n \\"currentJobStatus\\": \\"Planned\\",\\n \\"tags\\": [\\n {\\n \\"tagValue\\": \\"TestValue\\",\\n \\"tagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取任务详情', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'DeleteTask' => [ + 'summary' => '删除任务。', + 'path' => '/tasks/{taskId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => false, + 'example' => 'task-123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '73B38F77-62BA-5878-8952-530DFE21C93B', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"73B38F77-62BA-5878-8952-530DFE21C93B\\"\\n}","type":"json"}]', + 'title' => '删除任务', + 'description' => '单用户调用频率：100 次/秒。'."\n" + ."\n\n" + .'删除任务，如果任务存在未销毁资源，不允许删除。', + ], + 'CreateJob' => [ + 'summary' => '创建作业并运行任务。', + 'path' => '/tasks/{taskId}/jobs', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => '2daf4227f747cbf11a5501f18cc5e004', + ], + 'description' => [ + 'description' => '作业描述，'."\n" + .'长度（1-64）', + 'type' => 'string', + 'required' => true, + 'example' => 'description', + ], + 'subCommand' => [ + 'description' => '指定操作命令'."\n" + .'取值：'."\n" + ."\n" + .'- plan： 执行预览（默认值）'."\n" + .'- refresh ：刷新资源状态'."\n" + .'- destroy： 销毁资源', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'refresh' => 'refresh', + 'destroy' => 'destroy', + 'plan' => 'plan', + ], + 'example' => 'refresh', + 'default' => 'false', + ], + 'taskType' => [ + 'description' => '任务类型'."\n" + ."\n" + .'Task：常规任务（默认）'."\n" + ."\n" + .'SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SceneTestingTask' => 'SceneTestingTask', + 'Task' => 'Task', + ], + 'example' => 'Task', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'task-433aead756057fffeaba4828f5195', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'jobId' => [ + 'description' => '作业ID', + 'type' => 'string', + 'example' => 'job-518855d98c319561f', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobId\\": \\"job-518855d98c319561f\\",\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '创建作业并运行', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'OperateJob' => [ + 'summary' => '创建作业后，在运行过程中 【取消】操作可以终止作业的运行。'."\n" + .'作业在到达等待确认状态后，【放弃】操作可以终止作业的继续运行，【执行】操作则继续完成作业的执行操作。', + 'path' => '/tasks/{taskId}/jobs/{jobId}/operation/{operationType}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'task-518855d9a058cfffe0e0a92745bbc', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业ID', + 'type' => 'string', + 'required' => true, + 'example' => 'job-5fd38c9b92d54fff865d936f22a39', + ], + ], + [ + 'name' => 'operationType', + 'in' => 'path', + 'schema' => [ + 'description' => '操作类型，'."\n" + .'取值范围：'."\n" + .'- execute 执行'."\n" + .'- abolish 放弃'."\n" + .'- cancel 取消', + 'type' => 'string', + 'required' => false, + 'example' => 'execute', + 'enum' => [ + 'execute', + 'abolish', + 'cancel', + ], + ], + ], + [ + 'name' => 'comment', + 'in' => 'query', + 'schema' => [ + 'description' => '描述，长度（0-128）', + 'type' => 'string', + 'required' => true, + 'example' => 'dasd', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型'."\n" + ."\n" + .'Task：常规任务（默认）'."\n" + ."\n" + .'SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体参数', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E602681C-A811-5787-9DC3-48BED7537071', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E602681C-A811-5787-9DC3-48BED7537071\\"\\n}","type":"json"}]', + 'title' => '操作作业', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListJobs' => [ + 'summary' => '查询作业列表。', + 'path' => '/tasks/{taskId}/jobs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'task-55f1739d9050fff', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '作业状态'."\n" + ."\n" + .'- Pending：Job被创建后的初始状态'."\n" + .'- PlanQueued：Job被创建后，如果没有可用的容器，需要排队等待状态'."\n" + .'- Planning：资源Job正处于执行Plan阶段'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff，此时Job处于最终状态'."\n" + .'- Applying：资源Job正处于执行Apply阶段'."\n" + .'- Applied：资源Job完成Apply的执行'."\n" + .'- Errored：Job的执行有错误，进入最终状态'."\n" + .'- Canceled：Job的执行被取消，进入最终状态', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PlanQueued' => 'PlanQueued', + 'Errored' => 'Errored', + 'Planning' => 'Planning', + 'PlannedAndFinished' => 'PlannedAndFinished', + 'Applying' => 'Applying', + 'Canceled' => 'Canceled', + 'Planned' => 'Planned', + 'Applied' => 'Applied', + 'Pending' => 'Pending', + ], + 'example' => 'Errored', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'exclusiveMaximum' => false, + 'minimum' => '1', + 'exclusiveMinimum' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'exclusiveMaximum' => false, + 'minimum' => '1', + 'exclusiveMinimum' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型'."\n" + ."\n" + .'Task：常规任务（默认）'."\n" + ."\n" + .'SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SceneTestingTask' => 'SceneTestingTask', + 'Task' => 'Task', + ], + 'example' => 'SceneTestingTask', + ], + ], + [ + 'name' => 'jobType', + 'in' => 'query', + 'schema' => [ + 'title' => '作业类型', + 'description' => '作业类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'jobs' => [ + 'description' => '作业信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Job详情。', + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'description' => '作业配置', + 'type' => 'object', + 'properties' => [ + 'isDestroy' => [ + 'description' => '是否为销毁作业', + 'type' => 'boolean', + 'example' => 'true', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'example' => 'v4', + ], + 'resourcesChanged' => [ + 'description' => '资源变更内容', + 'type' => 'string', + 'example' => '+0 ~0 -0', + ], + 'subCommand' => [ + 'description' => '操作命令', + 'type' => 'string', + 'example' => 'destroy', + ], + 'moduleDescription' => [ + 'description' => '模板描述', + 'type' => 'string', + 'example' => 'moduleDescription', + ], + ], + ], + 'createTime' => [ + 'description' => '作业创建时间。', + 'type' => 'string', + 'example' => '2022-07-05T02:13:43Z', + ], + 'description' => [ + 'description' => '作业描述', + 'type' => 'string', + 'example' => 'plan', + ], + 'elapsedTime' => [ + 'description' => '执行耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5m', + ], + 'executeType' => [ + 'description' => '执行类型'."\n" + ."\n" + .'Manual：手动执行（默认）'."\n" + ."\n" + .'Auto：自动执行', + 'type' => 'string', + 'example' => 'Manual', + ], + 'isPassAssertCheck' => [ + 'description' => '断言检查是否通过', + 'type' => 'boolean', + 'example' => 'true', + ], + 'jobId' => [ + 'description' => '作业ID', + 'type' => 'string', + 'example' => 'job-433aff9e4dca57b147c', + ], + 'status' => [ + 'description' => '作业状态'."\n" + ."\n" + .'- Pending：Job被创建后的初始状态'."\n" + .'- PlanQueued：Job被创建后，如果没有可用的容器，需要排队等待状态'."\n" + .'- Planning：资源Job正处于执行Plan阶段'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff，此时Job处于最终状态'."\n" + .'- Applying：资源Job正处于执行Apply阶段'."\n" + .'- Applied：资源Job完成Apply的执行'."\n" + .'- Errored：Job的执行有错误，进入最终状态'."\n" + .'- Canceled：Job的执行被取消，进入最终状态', + 'type' => 'string', + 'example' => 'Errored', + ], + 'statusDetail' => [ + 'description' => '状态详情。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'comment' => [ + 'type' => 'string', + 'example' => 'comment', + 'description' => '备注', + ], + 'jobResult' => [ + 'type' => 'string', + 'example' => 'Apply complete! Resources: 0 added, 0 changed, 0 destroyed.', + 'description' => '作业执行结果', + ], + 'timeStamps' => [ + 'type' => 'string', + 'example' => '2022-06-13 17:11:34', + 'description' => '到达状态时间', + ], + ], + 'description' => '状态详情。', + ], + ], + 'taskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'task-518876866c2c3efb', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本', + 'type' => 'string', + 'example' => '1.240.0', + ], + ], + ], + ], + 'pageNumber' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '882304F9-6DB1-5593-A719-33473D082B9C', + ], + 'totalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobs\\": [\\n {\\n \\"config\\": {\\n \\"isDestroy\\": true,\\n \\"moduleVersion\\": \\"v4\\",\\n \\"resourcesChanged\\": \\"+0 ~0 -0\\",\\n \\"subCommand\\": \\"destroy\\",\\n \\"moduleDescription\\": \\"moduleDescription\\"\\n },\\n \\"createTime\\": \\"2022-07-05T02:13:43Z\\",\\n \\"description\\": \\"plan\\",\\n \\"elapsedTime\\": 0,\\n \\"executeType\\": \\"Manual\\",\\n \\"isPassAssertCheck\\": true,\\n \\"jobId\\": \\"job-433aff9e4dca57b147c\\",\\n \\"status\\": \\"Errored\\",\\n \\"statusDetail\\": {\\n \\"key\\": {\\n \\"comment\\": \\"comment\\",\\n \\"jobResult\\": \\"Apply complete! Resources: 0 added, 0 changed, 0 destroyed.\\",\\n \\"timeStamps\\": \\"2022-06-13 17:11:34\\"\\n }\\n },\\n \\"taskId\\": \\"task-518876866c2c3efb\\",\\n \\"terraformProviderVersion\\": \\"1.240.0\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"882304F9-6DB1-5593-A719-33473D082B9C\\",\\n \\"totalCount\\": 11\\n}","type":"json"}]', + 'title' => '查询作业列表', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'GetJob' => [ + 'summary' => '获取作业信息。', + 'path' => '/tasks/{taskId}/jobs/{jobId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'task-55f1739d9050fffee8fe2a2c4a605', + ], + ], + [ + 'name' => 'jobId', + 'in' => 'path', + 'schema' => [ + 'description' => '作业ID', + 'type' => 'string', + 'required' => true, + 'example' => 'job-433aead756057ffef0028917e6f26', + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型'."\n" + ."\n" + .'Task：常规任务（默认）'."\n" + ."\n" + .'SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SceneTestingTask' => 'SceneTestingTask', + 'Task' => 'Task', + ], + 'example' => 'SceneTestingTask', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'job' => [ + 'description' => '作业详情', + 'type' => 'object', + 'properties' => [ + 'assertCheckDetail' => [ + 'description' => '断言检查列表，适用于 场景化测试任务', + 'type' => 'array', + 'items' => [ + 'description' => '断言检查详情', + 'type' => 'object', + 'properties' => [ + 'comparison' => [ + 'description' => '比较符'."\n" + ."\n" + .'- eq：等于'."\n" + .'- n_eq：不等于'."\n" + .'- ctn：不包含'."\n" + .'- n_ctn：不包含'."\n" + .'- regex：正则匹配', + 'type' => 'string', + 'example' => 'eq', + ], + 'expectedValue' => [ + 'description' => '期望值', + 'type' => 'string', + 'example' => '期望值', + ], + 'isPass' => [ + 'description' => '是否通过', + 'type' => 'boolean', + 'example' => 'true', + ], + 'type' => [ + 'description' => '断言类型'."\n" + ."\n" + .'- state：任务状态'."\n" + .'- result：执行结果结果'."\n" + .'- resourceChange：资源变更', + 'type' => 'string', + 'example' => 'result', + ], + ], + ], + ], + 'config' => [ + 'description' => '作业配置', + 'type' => 'object', + 'properties' => [ + 'autoApply' => [ + 'description' => '是否自动执行任务', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isDestroy' => [ + 'description' => '是否为销毁资源', + 'type' => 'boolean', + 'example' => 'fales', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'example' => 'v1', + ], + 'resourcesChanged' => [ + 'description' => '资源变更内容', + 'type' => 'string', + 'example' => '+0 ~0 -0', + ], + 'subCommand' => [ + 'description' => '操作命令', + 'type' => 'string', + 'example' => 'destroy', + ], + 'hasConfigProactive' => [ + 'type' => 'string', + ], + ], + ], + 'createTime' => [ + 'description' => '作业创建时间。', + 'type' => 'string', + 'example' => '2022-08-31T03:38:40Z', + ], + 'description' => [ + 'description' => '作业描述', + 'type' => 'string', + 'example' => 'description', + ], + 'downloadUrl' => [ + 'description' => '下载地址。', + 'type' => 'object', + 'example' => 'url', + ], + 'elapsedTime' => [ + 'description' => '执行耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3s', + ], + 'executeType' => [ + 'description' => '执行类型'."\n" + ."\n" + .'Manual：手动执行（默认）'."\n" + ."\n" + .'Auto：自动执行', + 'type' => 'string', + 'example' => 'Manual', + ], + 'isPassAssertCheck' => [ + 'description' => '断言检查是否通过', + 'type' => 'boolean', + 'example' => 'true', + ], + 'jobId' => [ + 'description' => '作业ID', + 'type' => 'string', + 'example' => 'job-518855d9a058cfff0dc933e6b5767', + ], + 'output' => [ + 'description' => '作业输出', + 'type' => 'string', + 'example' => '/', + ], + 'parameters' => [ + 'description' => '参数集合', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '参数集合', + 'example' => '{'."\n" + .' "bandwidth":"5",'."\n" + .' "description":"description",'."\n" + .' "address_name":"iac-test-eip",'."\n" + .' "region":"cn-shanghai",'."\n" + .' "tags":"{\\"create\\":\\"iac\\",\\"name \\":\\"test\\"}"'."\n" + .' }', + ], + ], + 'status' => [ + 'description' => '作业状态'."\n" + ."\n" + .'- Pending：Job被创建后的初始状态'."\n" + .'- PlanQueued：Job被创建后，如果没有可用的容器，需要排队等待状态'."\n" + .'- Planning：资源Job正处于执行Plan阶段'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff，此时Job处于最终状态'."\n" + .'- Applying：资源Job正处于执行Apply阶段'."\n" + .'- Applied：资源Job完成Apply的执行'."\n" + .'- Errored：Job的执行有错误，进入最终状态'."\n" + .'- Canceled：Job的执行被取消，进入最终状态', + 'type' => 'string', + 'example' => 'Errored', + ], + 'statusDetail' => [ + 'description' => '作业状态详情。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'comment' => [ + 'type' => 'string', + 'example' => '备注', + 'description' => '备注', + ], + 'jobResult' => [ + 'type' => 'string', + 'example' => 'Apply complete! Resources: 0 added, 0 changed, 0 destroyed.', + 'description' => '执行结果', + ], + 'timeStamps' => [ + 'type' => 'string', + 'example' => '2022-06-13 17:11:34', + 'description' => '到达状态时间', + ], + 'errorMessage' => [ + 'type' => 'string', + ], + ], + 'description' => '作业状态详情。', + ], + ], + 'taskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'task-3b6cb9fa4751a1b9b5f22cbcf4e', + ], + 'taskType' => [ + 'description' => '任务类型'."\n" + ."\n" + .'Task：常规任务（默认）'."\n" + ."\n" + .'SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'example' => 'SceneTestingTask', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本', + 'type' => 'string', + 'example' => '1.230.0', + ], + 'outputJsonPlan' => [ + 'type' => 'any', + ], + 'logFile' => [ + 'description' => '运行日志，当前支持返回以下日志内容（即key的取值）：'."\n" + ."\n" + .'- tf-init.run.error.log'."\n" + .' '."\n" + .'- tf-init.plan.log'."\n" + ."\n" + .'- tf-plan.run.log'."\n" + ."\n" + .'- tf-apply.run.log'."\n" + .' '."\n" + .'- tf-init.apply.log', + 'type' => 'object', + ], + 'jobType' => [ + 'title' => '作业类型', + 'description' => '作业类型', + 'type' => 'string', + 'example' => 'Default', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1435C78A-AED9-53D6-B7A6-E2661D29B1FA', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"job\\": {\\n \\"assertCheckDetail\\": [\\n {\\n \\"comparison\\": \\"eq\\",\\n \\"expectedValue\\": \\"期望值\\",\\n \\"isPass\\": true,\\n \\"type\\": \\"result\\"\\n }\\n ],\\n \\"config\\": {\\n \\"autoApply\\": true,\\n \\"isDestroy\\": true,\\n \\"moduleVersion\\": \\"v1\\",\\n \\"resourcesChanged\\": \\"+0 ~0 -0\\",\\n \\"subCommand\\": \\"destroy\\",\\n \\"hasConfigProactive\\": \\"\\"\\n },\\n \\"createTime\\": \\"2022-08-31T03:38:40Z\\",\\n \\"description\\": \\"description\\",\\n \\"downloadUrl\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"elapsedTime\\": 0,\\n \\"executeType\\": \\"Manual\\",\\n \\"isPassAssertCheck\\": true,\\n \\"jobId\\": \\"job-518855d9a058cfff0dc933e6b5767\\",\\n \\"output\\": \\"/\\",\\n \\"parameters\\": {\\n \\"key\\": \\"{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"bandwidth\\\\\\":\\\\\\"5\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"description\\\\\\":\\\\\\"description\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"address_name\\\\\\":\\\\\\"iac-test-eip\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"tags\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"create\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"iac\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\"}\\\\\\"\\\\n\\\\t\\\\t\\\\t}\\"\\n },\\n \\"status\\": \\"Errored\\",\\n \\"statusDetail\\": {\\n \\"key\\": {\\n \\"comment\\": \\"备注\\",\\n \\"jobResult\\": \\"Apply complete! Resources: 0 added, 0 changed, 0 destroyed.\\",\\n \\"timeStamps\\": \\"2022-06-13 17:11:34\\",\\n \\"errorMessage\\": \\"\\"\\n }\\n },\\n \\"taskId\\": \\"task-3b6cb9fa4751a1b9b5f22cbcf4e\\",\\n \\"taskType\\": \\"SceneTestingTask\\",\\n \\"terraformProviderVersion\\": \\"1.230.0\\",\\n \\"outputJsonPlan\\": \\"\\",\\n \\"logFile\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"jobType\\": \\"Default\\"\\n },\\n \\"requestId\\": \\"1435C78A-AED9-53D6-B7A6-E2661D29B1FA\\"\\n}","type":"json"}]', + 'title' => '获取作业信息', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'CreateResourceExportTask' => [ + 'summary' => '创建资源导出任务。', + 'path' => '/exportTasks', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '资源导出任务描述', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description'."\n", + ], + 'exportToModule' => [ + 'description' => '将导出后的模板保存为Module。'."\n" + .'如果未设置，那么将自动保存在Registry中', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板保存的Module类型。可选值：'."\n" + ."\n" + .'- OSS ：OSS'."\n" + .'- Registry: Terraform Registry', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Registry' => 'Registry', + 'OSS' => 'OSS', + ], + 'example' => 'Registry', + ], + 'sourcePath' => [ + 'description' => '保存模板内容的路径值，source = OSS时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://iac-daily.oss-ap-southeast-1.aliyuncs.com/iacservice/vpc.zip', + ], + 'statePath' => [ + 'description' => '保存模板State文件的路径值，source = OSS时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://iac-daily.oss-ap-southeast-1.aliyuncs.com/default/terraform.tfstate', + ], + ], + 'required' => false, + ], + 'includeRules' => [ + 'description' => '导出资源时使用的包含规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '导出资源时使用的包含规则', + 'type' => 'object', + 'properties' => [ + 'values' => [ + 'description' => '一组资源导出时的包含规则的值列表', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu', + ], + 'required' => false, + ], + 'key' => [ + 'description' => '资源导出时的包含规则名称。可选值如下：'."\n" + ."\n" + .'- ResourceType：必填，资源类型，使用 **ListResourceTypes** 查看支持的资源列表，例如：ALIYUN::VPC::VPC'."\n" + .'- RegionId：必填，资源所属Region，当前只支持一个Region，例如：cn-chengdu'."\n" + .'- \\<ResourceType>:Id：资源ID,例如：ALIYUN::VPC::VPC:Id'."\n" + .'- ResourceGroupId：资源组ID，例如：rg-1234'."\n" + .'- ZoneId：资源所属Zone，目前只支持一个Zone，例如：cn-hangzhou-h'."\n" + ."\n" + .'多个过滤条件之间默认是与的关系，即必须符合所有过滤条件，才视为匹配过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'RegionId', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'name' => [ + 'description' => '资源导出任务名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 3~63 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" + .'- 名称在当前账号的资源导出任务资源下唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'abc', + ], + 'ramRole' => [ + 'description' => 'RAM角色，（1-128）'."\n" + .'触发新作业时由系统扮演角色来执行模版'."\n" + .'作业触发方式非手动触发时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'role-name', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本，使用 **ListTerraformProviderVersions** 查看支持的版本列表，默认为最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.247.0', + ], + 'terraformVersion' => [ + 'description' => 'Terraform版本，使用 **ListAvailableTerraformVersions** 查看支持的版本列表，默认为1.5.7。', + 'type' => 'string', + 'required' => false, + 'example' => '1.5.7', + ], + 'triggerStrategy' => [ + 'description' => '触发策略，有效值：'."\n" + .'- Auto： 当修改规则或触发策略被改为Auto触发'."\n" + .'- Manual：手动触发'."\n" + ."\n" + .'默认值为：Manual', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Auto' => 'Auto', + 'Manual' => 'Manual', + ], + 'example' => 'Auto', + 'default' => 'Manual', + 'enum' => [ + 'Manual', + 'Auto', + ], + ], + 'variables' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'array', + 'items' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'object', + 'properties' => [ + 'properties' => [ + 'description' => '资源类型对应的Terraform资源的属性列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型对应的Terraform资源的属性', + 'type' => 'string', + 'required' => false, + 'example' => 'vswitch_name', + ], + 'required' => false, + ], + 'resourceType' => [ + 'description' => '资源类型，使用 **ListResourceTypes** 查看支持的资源列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN::VPC::VSwitch', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'exportTaskId' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'example' => 'ex-4a1ec8b7003d24528326821be', + ], + 'exportVersion' => [ + 'description' => '资源导出版本', + 'type' => 'string', + 'example' => 'v1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'CFD8C2A8-5BE7-56D2-916D-64039B8E06E3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-4a1ec8b7003d24528326821be\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"CFD8C2A8-5BE7-56D2-916D-64039B8E06E3\\"\\n}","type":"json"}]', + 'title' => '创建资源导出任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'UpdateResourceExportTaskAttribute' => [ + 'summary' => '修改资源导出任务。', + 'path' => '/exportTasks/{exportTaskId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is description'."\n", + ], + 'exportToModule' => [ + 'description' => '将导出后的模板保存为Module。 如果未设置，那么将自动保存在Registry中', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板保存的Module类型。可选值：'."\n" + ."\n" + .'- OSS ：OSS'."\n" + .'- Registry: Terraform Registry', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Registry' => 'Registry', + 'OSS' => 'OSS', + ], + 'example' => 'Registry', + ], + 'sourcePath' => [ + 'description' => '保存模板内容的路径值，source = OSS时设置。 格式：oss::https://<bucket>.oss-<region>.aliyuncs.com/<path>.zip', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://iac-daily.oss-ap-southeast-1.aliyuncs.com/iacservice/vpc.zip', + ], + 'statePath' => [ + 'description' => '保存模板State文件的路径值，source = OSS时设置。 格式：oss::https://<bucket>.oss-<region>.aliyuncs.com/<path>/terraform.tfstate', + 'type' => 'string', + 'required' => false, + 'example' => 'oss::https://iac-daily.oss-ap-southeast-1.aliyuncs.com/default/terraform.tfstate', + ], + ], + 'required' => false, + ], + 'includeRules' => [ + 'description' => '导出资源时使用的包含规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '导出资源时使用的包含规则', + 'type' => 'object', + 'properties' => [ + 'values' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-chengdu', + ], + 'required' => false, + ], + 'key' => [ + 'description' => '资源导出时的包含规则名称。可选值如下：'."\n" + ."\n" + .'- ResourceType：必填，资源类型，使用 **ListResourceTypes** 查看支持的资源列表，例如：ALIYUN::VPC::VPC'."\n" + .'- RegionId：必填，资源所属Region，当前只支持一个Region，例如：cn-chengdu'."\n" + .'- <ResourceType>:Id：资源ID,例如：ALIYUN::VPC::VPC:Id'."\n" + .'- ResourceGroupId：资源组ID，例如：rg-1234'."\n" + .'- ZoneId：资源所属Zone，目前只支持一个Zone，例如：cn-hangzhou-h'."\n" + ."\n" + .'多个过滤条件之间默认是与的关系，即必须符合所有过滤条件，才视为匹配过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'RegionId', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'name' => [ + 'description' => '资源导出任务名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 2~128 个字符。'."\n" + .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" + .'- 名称在当前账号的资源导出任务资源下唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'TaskName', + ], + 'ramRole' => [ + 'description' => 'ram角色.', + 'type' => 'string', + 'required' => false, + 'example' => 'ramName', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本，使用 **ListTerraformProviderVersions** 查看支持的版本列表，默认为最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.183.0', + ], + 'terraformVersion' => [ + 'description' => 'Terraform版本，使用 **ListAvailableTerraformVersions** 查看支持的版本列表，默认为1.5.7。', + 'type' => 'string', + 'required' => false, + 'example' => '1.5.7', + ], + 'triggerStrategy' => [ + 'description' => '触发策略，有效值：'."\n" + .'- Auto： 当修改规则或触发策略被改为Auto触发'."\n" + .'- Manual：手动触发'."\n" + ."\n" + .'默认值为：Manual', + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + 'default' => 'Manual', + 'enum' => [ + 'Always', + 'NewVersion', + 'Manual', + ], + ], + 'variables' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'array', + 'items' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'object', + 'properties' => [ + 'properties' => [ + 'description' => '资源类型对应的Terraform资源的属性列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型对应的Terraform资源的属性', + 'type' => 'string', + 'required' => false, + 'example' => 'vswitch_name'."\n", + ], + 'required' => false, + ], + 'resourceType' => [ + 'description' => '资源类型，使用 **ListResourceTypes** 查看支持的资源列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALIYUN::VPC::VSwitch'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源导出任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ex-al1811jl980g5ffd115nhgt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'exportTaskId' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'example' => 'ex-kw161ol8te1n701e1igt8q8', + ], + 'exportVersion' => [ + 'description' => '导出任务的版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B43F08A7-F2A3-54D3-BDA4-69C9F32A7B9F', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-kw161ol8te1n701e1igt8q8\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"B43F08A7-F2A3-54D3-BDA4-69C9F32A7B9F\\"\\n}","type":"json"}]', + 'title' => '修改资源导出任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListResourceExportTasks' => [ + 'summary' => '查询资源导出任务列表。', + 'path' => '/exportTasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持对任务名称的模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'exportTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源导出任务ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ex-al1c11jl9g2tbte727otp85', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'exportTasks' => [ + 'description' => '导出任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '导出任务列表。', + 'type' => 'object', + 'properties' => [ + 'exportTaskId' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'example' => 'ex-kw1a1ol8c0pngjav17q8eri', + ], + 'exportToModule' => [ + 'description' => '将导出后的模板保存为Module。 如果未设置，那么将自动保存在Registry中', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板保存的Module类型。可选值：'."\n" + ."\n" + .'- OSS ：OSS'."\n" + .'- Registry: Terraform Registry', + 'type' => 'string', + 'example' => 'OSS', + ], + 'sourcePath' => [ + 'description' => '保存模板内容的路径值'."\n" + ."\n" + .'- 当 Source 为 Registry 时，格式为： "cloudregistry::iacservice//"'."\n" + ."\n" + .'- 当 Source 为 OSS 时，格式为："oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip"', + 'type' => 'string', + 'example' => 'oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip', + ], + 'statePath' => [ + 'description' => '保存模板State文件的路径值', + 'type' => 'string', + 'example' => '/', + ], + ], + ], + 'variables' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'array', + 'items' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'object', + 'properties' => [ + 'properties' => [ + 'description' => '资源类型对应的Terraform资源的属性列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型对应的Terraform资源的属性', + 'type' => 'string', + 'example' => 'vswitch_name', + ], + ], + 'resourceType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ALIYUN::VPC::VSwitch'."\n", + ], + ], + ], + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-02-20T02:10:06Z', + ], + 'exportStatus' => [ + 'description' => '导出状态'."\n" + ."\n" + .'- Queue：排队中'."\n" + .'- Pending：准备运行'."\n" + .'- Success：运行成功'."\n" + .'- Errored：运行错误'."\n" + .'- Canceled：被取消', + 'type' => 'string', + 'example' => 'Success', + ], + 'exportVersion' => [ + 'description' => '导出版本。', + 'type' => 'string', + 'example' => 'v2', + ], + 'name' => [ + 'description' => '导出任务名称。', + 'type' => 'string', + 'example' => 'TaskName', + ], + 'description' => [ + 'description' => '导出任务描述', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'includeRules' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'object', + 'properties' => [ + 'values' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'string', + 'example' => 'cn-chengdu', + ], + ], + 'key' => [ + 'description' => '资源导出时的包含规则名称。可选值如下：'."\n" + ."\n" + .'- ResourceType：必填，资源类型，例如：ALIYUN::VPC::VPC'."\n" + .'- RegionId：必填，资源所属Region，当前只支持一个Region，例如：cn-chengdu'."\n" + .'- \\<ResourceType>:Id：资源ID,例如：ALIYUN::VPC::VPC:Id'."\n" + .'- ResourceGroupId：资源组ID，例如：rg-1234'."\n" + .'- ZoneId：资源所属Zone，目前只支持一个Zone，例如：cn-hangzhou-h'."\n" + ."\n" + .'多个过滤条件之间默认是与的关系，即必须符合所有过滤条件，才视为匹配过滤条件。', + 'type' => 'string', + 'example' => 'RegionId', + ], + ], + ], + ], + 'modules' => [ + 'description' => '将资源导出后的Module配置', + 'type' => 'array', + 'items' => [ + 'description' => '将资源导出后的Module配置', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板所在的Module类型，目前有两种格式：CloudRegistry 和OSS。如果客户指定了参数 ExportToModule，那么这两种都将返回，否则只返回 CloudRegistry', + 'type' => 'string', + 'example' => 'OSS', + ], + 'version' => [ + 'description' => '导出后的模板所在的Module的版本', + 'type' => 'string', + 'example' => 'v3', + ], + 'sourcePath' => [ + 'description' => '导出后的模板所在的Module下的下载地址。'."\n" + .' '."\n" + .'- 当 Source 为 CloudRegistry 时，格式为：'."\n" + .'"cloudregistry::iacservice/<exportTaskId>/<Provider Name>"'."\n" + ."\n" + .'- 当 Source 为 OSS 时，格式为："oss::https://<BucketName>.oss-cn-hangzhou.aliyuncs.com/xxx.zip"', + 'type' => 'string', + 'example' => 'oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip', + ], + ], + ], + ], + 'elapsedTime' => [ + 'description' => '执行耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4243', + ], + 'status' => [ + 'description' => '任务状态'."\n" + ."\n" + .'- Available：可用状态'."\n" + .'- Running：运行状态', + 'type' => 'string', + 'example' => 'Available', + ], + ], + ], + ], + 'pageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '65287CB9-AC46-5FE7-B785-0106C159DA42', + ], + 'totalCount' => [ + 'description' => '总条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '330', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTasks\\": [\\n {\\n \\"exportTaskId\\": \\"ex-kw1a1ol8c0pngjav17q8eri\\",\\n \\"exportToModule\\": {\\n \\"source\\": \\"OSS\\",\\n \\"sourcePath\\": \\"oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\",\\n \\"statePath\\": \\"/\\"\\n },\\n \\"variables\\": [\\n {\\n \\"properties\\": [\\n \\"vswitch_name\\"\\n ],\\n \\"resourceType\\": \\"ALIYUN::VPC::VSwitch\\\\n\\"\\n }\\n ],\\n \\"createTime\\": \\"2025-02-20T02:10:06Z\\",\\n \\"exportStatus\\": \\"Success\\",\\n \\"exportVersion\\": \\"v2\\",\\n \\"name\\": \\"TaskName\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"includeRules\\": [\\n {\\n \\"values\\": [\\n \\"cn-chengdu\\"\\n ],\\n \\"key\\": \\"RegionId\\"\\n }\\n ],\\n \\"modules\\": [\\n {\\n \\"source\\": \\"OSS\\",\\n \\"version\\": \\"v3\\",\\n \\"sourcePath\\": \\"oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\"\\n }\\n ],\\n \\"elapsedTime\\": 4243,\\n \\"status\\": \\"Available\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"65287CB9-AC46-5FE7-B785-0106C159DA42\\",\\n \\"totalCount\\": 330\\n}","type":"json"}]', + 'title' => '获取资源导出任务列表', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'GetResourceExportTask' => [ + 'summary' => '查询资源导出任务详情。', + 'path' => '/exportTasks/{exportTaskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源导出任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ex-al171j05rlog5tbri1pmkk', + ], + ], + [ + 'name' => 'exportVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '导出版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'v3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'FC49AA8C-0A19-5556-8929-E7447F18D529', + ], + 'task' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '任务创建时间', + 'type' => 'string', + 'example' => '2022-06-15T02:44:37Z', + ], + 'description' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'elapsedTime' => [ + 'description' => '执行耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4533', + ], + 'exportTaskId' => [ + 'description' => '资源导出任务ID', + 'type' => 'string', + 'example' => 'ex-al1111jlfh53i6mo4o94jj', + ], + 'exportToModule' => [ + 'description' => '将导出后的模板保存为Module。 如果未设置，那么将自动保存在Registry中', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板保存的Module类型。可选值：'."\n" + ."\n" + .'- OSS ：OSS'."\n" + .'- Registry: Terraform Registry', + 'type' => 'string', + 'example' => 'OSS', + ], + 'sourcePath' => [ + 'description' => '保存模板内容的路径值'."\n" + ."\n" + .'- 当 Source 为 Registry 时，格式为： "cloudregistry::iacservice//"'."\n" + ."\n" + .'- 当 Source 为 OSS 时，格式为："oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip"', + 'type' => 'string', + 'example' => 'oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip', + ], + 'statePath' => [ + 'description' => 'Module 对应的State文件的路径值', + 'type' => 'string', + 'example' => '/', + ], + ], + ], + 'exportVersion' => [ + 'description' => '资源导出版本', + 'type' => 'string', + 'example' => 'v2', + ], + 'failedReason' => [ + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'Reason', + ], + 'includeRules' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'object', + 'properties' => [ + 'values' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'string', + 'example' => 'cn-chengdu', + ], + ], + 'key' => [ + 'description' => '资源导出时的包含规则名称。可选值如下：'."\n" + ."\n" + .'- ResourceType：必填，资源类型，例如：ALIYUN::VPC::VPC'."\n" + .'- RegionId：必填，资源所属Region，当前只支持一个Region，例如：cn-chengdu'."\n" + .'- \\<ResourceType>:Id：资源ID,例如：ALIYUN::VPC::VPC:Id'."\n" + .'- ResourceGroupId：资源组ID，例如：rg-1234'."\n" + .'- ZoneId：资源所属Zone，目前只支持一个Zone，例如：cn-hangzhou-h'."\n" + ."\n" + .'多个过滤条件之间默认是与的关系，即必须符合所有过滤条件，才视为匹配过滤条件。', + 'type' => 'string', + 'example' => 'RegionId', + ], + ], + ], + ], + 'name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'vpc_all', + ], + 'ramRole' => [ + 'description' => 'RAM角色', + 'type' => 'string', + 'example' => 'role', + ], + 'status' => [ + 'description' => '任务状态'."\n" + ."\n" + .'- Available：可用状态，没有任何job在运行'."\n" + .'- Running：运行状态，当前job正在运行', + 'type' => 'string', + 'example' => 'Running', + ], + 'taskOutputPath' => [ + 'description' => '任务输出路径', + 'type' => 'string', + 'example' => '/', + ], + 'terraformContext' => [ + 'description' => 'Terraform内容', + 'type' => 'object', + 'example' => '{}', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本', + 'type' => 'string', + 'example' => '1.246.0', + ], + 'terraformVersion' => [ + 'description' => 'Terraform版本', + 'type' => 'string', + 'example' => '1.5.7', + ], + 'triggerStrategy' => [ + 'description' => '触发策略，有效值：'."\n" + .'- Auto： 当修改规则或触发策略被改为Auto触发'."\n" + .'- Manual：手动触发'."\n" + ."\n" + .'默认值为：Manual', + 'type' => 'string', + 'example' => 'Manual', + ], + 'variables' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'array', + 'items' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'object', + 'properties' => [ + 'properties' => [ + 'description' => '资源类型对应的Terraform资源的属性列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型对应的Terraform资源的属性', + 'type' => 'string', + 'example' => 'vswitch_name'."\n", + ], + ], + 'resourceType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'ALIYUN::VPC::VSwitch'."\n", + ], + ], + ], + ], + 'modules' => [ + 'description' => '将资源导出后的Module配置', + 'type' => 'array', + 'items' => [ + 'description' => '将资源导出后的Module配置', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板所在的Module类型，目前有两种格式：CloudRegistry 和OSS。如果客户指定了参数 ExportToModule，那么这两种都将返回，否则只返回 CloudRegistry', + 'type' => 'string', + 'example' => 'OSS', + ], + 'version' => [ + 'description' => '导出后的模板所在的Module的版本', + 'type' => 'string', + 'example' => 'v3', + ], + 'sourcePath' => [ + 'description' => '导出后的模板所在的Module下的下载地址。'."\n" + ."\n" + .'- 当 Source 为 CloudRegistry 时，格式为： "cloudregistry::iacservice//"'."\n" + ."\n\n" + .'- 当 Source 为 OSS 时，格式为："oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip"', + 'type' => 'string', + 'example' => 'oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"FC49AA8C-0A19-5556-8929-E7447F18D529\\",\\n \\"task\\": {\\n \\"createTime\\": \\"2022-06-15T02:44:37Z\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"elapsedTime\\": 4533,\\n \\"exportTaskId\\": \\"ex-al1111jlfh53i6mo4o94jj\\",\\n \\"exportToModule\\": {\\n \\"source\\": \\"OSS\\",\\n \\"sourcePath\\": \\"oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\",\\n \\"statePath\\": \\"/\\"\\n },\\n \\"exportVersion\\": \\"v2\\",\\n \\"failedReason\\": \\"Reason\\",\\n \\"includeRules\\": [\\n {\\n \\"values\\": [\\n \\"cn-chengdu\\"\\n ],\\n \\"key\\": \\"RegionId\\"\\n }\\n ],\\n \\"name\\": \\"vpc_all\\",\\n \\"ramRole\\": \\"role\\",\\n \\"status\\": \\"Running\\",\\n \\"taskOutputPath\\": \\"/\\",\\n \\"terraformContext\\": {},\\n \\"terraformProviderVersion\\": \\"1.246.0\\",\\n \\"terraformVersion\\": \\"1.5.7\\",\\n \\"triggerStrategy\\": \\"Manual\\",\\n \\"variables\\": [\\n {\\n \\"properties\\": [\\n \\"vswitch_name\\\\n\\"\\n ],\\n \\"resourceType\\": \\"ALIYUN::VPC::VSwitch\\\\n\\"\\n }\\n ],\\n \\"modules\\": [\\n {\\n \\"source\\": \\"OSS\\",\\n \\"version\\": \\"v3\\",\\n \\"sourcePath\\": \\"oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取资源导出任务详情', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'CancelResourceExportTask' => [ + 'summary' => '取消执行资源导出任务。', + 'path' => '/exportTasks/cancel/{exportTaskId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ex-445dcb7d0ac661ff08be459a75f', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'exportTaskId' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'example' => 'ex-3b6cb9fa4751a6e5cdc6460282', + ], + 'exportVersion' => [ + 'description' => '导出任务的版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-3b6cb9fa4751a6e5cdc6460282\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '取消资源导出任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ExecuteResourceExportTask' => [ + 'summary' => '执行资源导出任务。', + 'path' => '/exportTasks/execute/{exportTaskId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ex-3b6cb9fa4751a6e645ad8365e6', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'exportTaskId' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'example' => 'ex-3b6cb9fa4751a6e645ad8365e6', + ], + 'exportVersion' => [ + 'description' => '资源导出版本', + 'type' => 'string', + 'example' => 'v1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n" + ."\n", + 'type' => 'string', + 'example' => '0B0A7C19-9077-5975-ACBD-DEE718787992', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-3b6cb9fa4751a6e645ad8365e6\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"0B0A7C19-9077-5975-ACBD-DEE718787992\\"\\n}","type":"json"}]', + 'title' => '执行资源导出任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'DeleteResourceExportTask' => [ + 'summary' => '删除资源导出任务。', + 'path' => '/exportTasks/{exportTaskId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源导出ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ex-3b6cb9fa4751a16b006b03333a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '删除资源导出任务', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListResourceExportTaskVersions' => [ + 'summary' => '获取资源导出任务版本列表。', + 'path' => '/exportTasks/{exportTaskId}/exportVersions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持对导出版本名称的模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源导出任务ID', + 'type' => 'string', + 'required' => true, + 'example' => 'ex-al1f11jlh9llnk8drc4g1c', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '导出状态'."\n" + ."\n" + .'- Queue：排队中'."\n" + .'- Pending：准备运行'."\n" + .'- Success：运行成功'."\n" + .'- Errored：运行错误'."\n" + .'- Canceled：被取消', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Errored' => 'Errored', + 'Canceled' => 'Canceled', + 'Queue' => 'Queue', + 'Pending' => 'Pending', + 'Success' => 'Success', + ], + 'example' => 'Errored', + ], + ], + [ + 'name' => 'exportVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '导出版本号。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'exportTasks' => [ + 'description' => '导出任务版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '导出任务版本列表。', + 'type' => 'object', + 'properties' => [ + 'exportTaskId' => [ + 'description' => '资源导出任务ID', + 'type' => 'string', + 'example' => 'ex-al1711jl6hd8u5crggeq6v', + ], + 'exportToModule' => [ + 'description' => '将导出后的模板保存为Module。 如果未设置，那么将自动保存在Registry中', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板保存的Module类型。可选值：'."\n" + ."\n" + .'- OSS ：OSS'."\n" + .'- Registry: Terraform Registry', + 'type' => 'string', + 'example' => 'OSS', + ], + 'sourcePath' => [ + 'description' => '保存模板内容的路径值'."\n" + ."\n" + .'- 当 Source 为 Registry 时，格式为： "cloudregistry::iacservice//"'."\n" + ."\n" + .'- 当 Source 为 OSS 时，格式为："oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip"', + 'type' => 'string', + 'example' => 'oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip', + ], + 'statePath' => [ + 'description' => 'Module 对应的State文件的路径值', + 'type' => 'string', + 'example' => '/', + ], + ], + ], + 'variables' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'array', + 'items' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', + 'type' => 'object', + 'properties' => [ + 'properties' => [ + 'description' => '资源类型对应的Terraform资源的属性列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源类型对应的Terraform资源的属性', + 'type' => 'string', + 'example' => 'tags', + ], + ], + 'resourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'Vswitch', + ], + ], + ], + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-05-11T02:18:50Z', + ], + 'exportVersion' => [ + 'description' => '资源导出版本', + 'type' => 'string', + 'example' => 'v3', + ], + 'name' => [ + 'description' => '导出任务名称。', + 'type' => 'string', + 'example' => 'TaskName', + ], + 'description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'this is description'."\n", + ], + 'includeRules' => [ + 'description' => '导出资源时使用的包含规则列表', + 'type' => 'array', + 'items' => [ + 'description' => '导出资源时使用的包含规则列表', + 'type' => 'object', + 'properties' => [ + 'values' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'array', + 'items' => [ + 'description' => '一组资源导出时的包含规则的值', + 'type' => 'string', + 'example' => 'cn-chengdu', + ], + ], + 'key' => [ + 'description' => '资源导出时的包含规则名称。可选值如下：'."\n" + ."\n" + .'- ResourceType：必填，资源类型，例如：ALIYUN::VPC::VPC'."\n" + .'- RegionId：必填，资源所属Region，当前只支持一个Region，例如：cn-chengdu'."\n" + .'- \\<ResourceType>:Id：资源ID,例如：ALIYUN::VPC::VPC:Id'."\n" + .'- ResourceGroupId：资源组ID，例如：rg-1234'."\n" + .'- ZoneId：资源所属Zone，目前只支持一个Zone，例如：cn-hangzhou-h'."\n" + ."\n" + .'多个过滤条件之间默认是与的关系，即必须符合所有过滤条件，才视为匹配过滤条件。', + 'type' => 'string', + 'example' => 'RegionId', + ], + ], + ], + ], + 'modules' => [ + 'description' => '将资源导出后的Module配置', + 'type' => 'array', + 'items' => [ + 'description' => '将资源导出后的Module配置', + 'type' => 'object', + 'properties' => [ + 'source' => [ + 'description' => '导出后的模板所在的Module类型，目前有两种格式：CloudRegistry 和OSS。如果客户指定了参数 ExportToModule，那么这两种都将返回，否则只返回 CloudRegistry', + 'type' => 'string', + 'example' => 'OSS', + ], + 'version' => [ + 'description' => '导出后的模板所在的Module的版本', + 'type' => 'string', + 'example' => 'v1', + ], + 'sourcePath' => [ + 'description' => '导出后的模板所在的Module下的下载地址。'."\n" + ."\n" + .'- 当 Source 为 CloudRegistry 时，格式为： "cloudregistry::iacservice//"'."\n" + ."\n" + .'- 当 Source 为 OSS 时，格式为："oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip"', + 'type' => 'string', + 'example' => 'oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip'."\n", + ], + ], + ], + ], + 'elapsedTime' => [ + 'description' => '执行耗时', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4521', + ], + 'failedReason' => [ + 'description' => '导出失败原因。', + 'type' => 'string', + 'example' => 'Reason', + ], + 'status' => [ + 'description' => '版本导出状态。'."\n" + .'- Queue：排队中'."\n" + .'- Pending：准备运行'."\n" + .'- Success：运行成功'."\n" + .'- Errored：运行错误'."\n" + .'- Canceled：被取消', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + 'pageNumber' => [ + 'description' => '页码，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '860FDEEE-1CA3-55F3-97F6-63FC40B7962D', + ], + 'totalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '72', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTasks\\": [\\n {\\n \\"exportTaskId\\": \\"ex-al1711jl6hd8u5crggeq6v\\",\\n \\"exportToModule\\": {\\n \\"source\\": \\"OSS\\",\\n \\"sourcePath\\": \\"oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\",\\n \\"statePath\\": \\"/\\"\\n },\\n \\"variables\\": [\\n {\\n \\"properties\\": [\\n \\"tags\\"\\n ],\\n \\"resourceType\\": \\"Vswitch\\"\\n }\\n ],\\n \\"createTime\\": \\"2025-05-11T02:18:50Z\\",\\n \\"exportVersion\\": \\"v3\\",\\n \\"name\\": \\"TaskName\\",\\n \\"description\\": \\"this is description\\\\n\\",\\n \\"includeRules\\": [\\n {\\n \\"values\\": [\\n \\"cn-chengdu\\"\\n ],\\n \\"key\\": \\"RegionId\\"\\n }\\n ],\\n \\"modules\\": [\\n {\\n \\"source\\": \\"OSS\\",\\n \\"version\\": \\"v1\\",\\n \\"sourcePath\\": \\"oss::https://.oss-cn-hangzhou.aliyuncs.com/xxx.zip\\\\n\\"\\n }\\n ],\\n \\"elapsedTime\\": 4521,\\n \\"failedReason\\": \\"Reason\\",\\n \\"status\\": \\"Running\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"860FDEEE-1CA3-55F3-97F6-63FC40B7962D\\",\\n \\"totalCount\\": 72\\n}","type":"json"}]', + 'title' => '获取资源导出任务版本列表', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'CreateRegistryNamespace' => [ + 'summary' => '创建工作空间。', + 'path' => '/registryNamespace', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限，private：私有的', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'private' => 'private', + ], + 'example' => 'private', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '工作空间描述', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + 'maintainer' => [ + 'description' => '管理员名称', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + 'namespaceName' => [ + 'description' => '工作空间名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 3~63 个字符。'."\n" + .'- 允许大小写字母、数字、短横线（-）、下划线（_），且不能以短横线开头或结尾。'."\n" + .'- 名称在全局工作空间资源下唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B4672AE3-C313-5B7A-BB24-45345570D398', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"requestId\\": \\"B4672AE3-C313-5B7A-BB24-45345570D398\\"\\n}","type":"json"}]', + 'title' => '创建工作空间', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'UpdateRegistryNamespaceAttribute' => [ + 'summary' => '修改工作空间。', + 'path' => '/registryNamespace/{namespaceName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限，private：私有的', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'private' => 'private', + ], + 'example' => 'private', + ], + 'description' => [ + 'description' => '工作空间描述', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => '2da11a5501f18cc5e004', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 3~63 个字符。'."\n" + .'- 允许大小写字母、数字、短横线（-）、下划线（_），且不能以短横线开头或结尾。'."\n" + .'- 名称在全局工作空间资源下唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'CA5C5B39-D1DC-5309-8E97-B9A91DA21094', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"requestId\\": \\"CA5C5B39-D1DC-5309-8E97-B9A91DA21094\\"\\n}","type":"json"}]', + 'title' => '修改工作空间', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListRegistryNamespaces' => [ + 'summary' => '查询工作空间列表。', + 'path' => '/registryNamespace', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持工作空间名称模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间类型。可选值：'."\n" + ."\n" + .'- system：公共工作空间'."\n" + ."\n" + .'- self：自定义工作空间'."\n" + ."\n" + .'- shared：共享工作空间'."\n" + ."\n" + .' - community：社区工作空间'."\n" + ."\n" + .'默认返回所有的', + 'type' => 'string', + 'required' => false, + 'example' => 'self', + 'enum' => [ + 'system', + 'self', + 'shared', + 'community', + ], + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为100。'."\n" + .'默认值：20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'hg7nXVngyM6tQtvCagmtY=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '53', + ], + 'maxResults' => [ + 'description' => '一次获取的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'namespaces' => [ + 'description' => '工作空间列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间信息', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-01-15T02:16:58Z', + ], + 'description' => [ + 'description' => '工作空间描述', + 'type' => 'string', + 'example' => 'description', + ], + 'acl' => [ + 'description' => '权限', + 'type' => 'string', + 'example' => 'private', + ], + 'sharedAccounts' => [ + 'description' => '共享账号列表', + 'type' => 'array', + 'items' => [ + 'description' => '共享账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + 'type' => [ + 'description' => '工作空间类型', + 'type' => 'string', + 'example' => 'shared', + ], + 'maintainer' => [ + 'description' => '管理员名称', + 'type' => 'string', + 'example' => 'admin', + ], + 'modules' => [ + 'description' => '工作空间下Registry模板数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => 'IPTL1XAYFTgtpI04QQpc5dyKpESXBc=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5FFB0033-A016-5A9D-9283-C123AAA7F71D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 53,\\n \\"maxResults\\": 24,\\n \\"namespaces\\": [\\n {\\n \\"createTime\\": \\"2025-01-15T02:16:58Z\\",\\n \\"description\\": \\"description\\",\\n \\"acl\\": \\"private\\",\\n \\"sharedAccounts\\": [\\n 123456\\n ],\\n \\"type\\": \\"shared\\",\\n \\"maintainer\\": \\"admin\\",\\n \\"modules\\": 21,\\n \\"namespaceName\\": \\"NamespaceName\\"\\n }\\n ],\\n \\"nextToken\\": \\"IPTL1XAYFTgtpI04QQpc5dyKpESXBc=\\",\\n \\"requestId\\": \\"5FFB0033-A016-5A9D-9283-C123AAA7F71D\\"\\n}","type":"json"}]', + 'title' => '查询工作空间列表', + 'description' => '单用户调用频率：200 次/秒。', + ], + 'GetRegistryNamespace' => [ + 'summary' => '查询工作空间。', + 'path' => '/registryNamespace/{namespaceName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'terraform-alicloud-modules', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'namespace' => [ + 'description' => '工作空间信息', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限', + 'type' => 'string', + 'example' => 'private', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-20T02:18:29Z', + ], + 'description' => [ + 'description' => '工作空间描述', + 'type' => 'string', + 'example' => 'description', + ], + 'maintainer' => [ + 'description' => '管理员名称', + 'type' => 'string', + 'example' => 'admin', + ], + 'modules' => [ + 'description' => '工作空间下Registry模板数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName', + ], + 'sharedAccounts' => [ + 'description' => '共享账号列表', + 'type' => 'array', + 'items' => [ + 'description' => '共享账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + ], + 'type' => [ + 'description' => '工作空间类型', + 'type' => 'string', + 'example' => 'share', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '26684763-5BAB-58C8-BA4F-9D622AB7AD14', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespace\\": {\\n \\"acl\\": \\"private\\",\\n \\"createTime\\": \\"2025-03-20T02:18:29Z\\",\\n \\"description\\": \\"description\\",\\n \\"maintainer\\": \\"admin\\",\\n \\"modules\\": 21,\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"sharedAccounts\\": [\\n 12345\\n ],\\n \\"type\\": \\"share\\"\\n },\\n \\"requestId\\": \\"26684763-5BAB-58C8-BA4F-9D622AB7AD14\\"\\n}","type":"json"}]', + 'title' => '查询工作空间', + 'description' => '单用户调用频率：200 次/秒。', + ], + 'DeleteRegistryNamespace' => [ + 'summary' => '删除工作空间。', + 'path' => '/registryNamespace/{namespaceName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1D0CD708-E433-5F13-8A42-823C95FC756C', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1D0CD708-E433-5F13-8A42-823C95FC756C\\"\\n}","type":"json"}]', + 'title' => '删除工作空间', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'AddSharedAccounts' => [ + 'summary' => '添加共享账号。', + 'path' => '/sharedAccounts', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'accountIds' => [ + 'description' => '云账号ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '云账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '云账号ID', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 1, + ], + 'resourceId' => [ + 'description' => '共享的资源ID'."\n" + ."\n" + .' - 类型为Namespace时取值工作空间名称 '."\n" + ."\n" + .'- 类型为RegistryModule时取值 \\<namespaceName>/\\<ModuleName>', + 'type' => 'string', + 'required' => false, + 'example' => 'terraform-alicloud-modules/mongodb', + ], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- RegistryModule :Registry模板'."\n" + .'- Namespace：工作空间', + 'type' => 'string', + 'required' => false, + 'example' => 'RegistryModule', + 'enum' => [ + 'RegistryModule', + 'Namespace', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0D797DC3-FF04-5C21-81EB-XXXXXXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-XXXXXXXXX\\"\\n}","type":"json"}]', + 'title' => '添加共享账号', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'RemoveSharedAccounts' => [ + 'summary' => '移除共享账号。', + 'path' => '/sharedAccounts', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '取消共享的资源ID'."\n" + ."\n" + .' - 类型为Namespace时取值工作空间名称 '."\n" + ."\n" + .'- 类型为RegistryModule时取值 \\<namespaceName>/\\<ModuleName>', + 'type' => 'string', + 'required' => true, + 'example' => 'terraform-alicloud-modules/mongodb'."\n", + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- RegistryModule :Registry模板'."\n" + .'- Namespace：工作空间', + 'type' => 'string', + 'required' => true, + 'example' => 'RegistryModule', + 'enum' => [ + 'Namespace', + 'RegistryModule', + ], + ], + ], + [ + 'name' => 'accountIds', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '云账号ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '云账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345678', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8294F4ED-8DBA-5441-B3F2-61C3C5374990', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8294F4ED-8DBA-5441-B3F2-61C3C5374990\\"\\n}","type":"json"}]', + 'title' => '移除共享账号', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'CreateRegistryModule' => [ + 'summary' => '创建Registry模版。', + 'path' => '/registryModule', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限，private：私有的', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => 'Registry模板描述', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + 'moduleName' => [ + 'description' => 'Registry模板名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 3~63 个字符。'."\n" + .'- 允许大小写字母、数字、短横线（-）、下划线（_），且不能以短横线开头或结尾。'."\n" + .'- 名称在工作空间资源下唯一。', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + 'provider' => [ + 'description' => '供应商类型，alicloud：阿里云', + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud', + ], + 'type' => [ + 'description' => '板类型，self：自定义模板', + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C896FE0A-1BEA-5D01-BFF4-B03B82B9CA3D', + ], + 'source' => [ + 'description' => '模板源，由\\<namespaceName>/\\<ModuleName>拼接', + 'type' => 'string', + 'example' => 'namespaceName/ModuleName', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C896FE0A-1BEA-5D01-BFF4-B03B82B9CA3D\\",\\n \\"source\\": \\"namespaceName/ModuleName\\"\\n}","type":"json"}]', + 'title' => '创建Registry模板', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'UpdateRegistryModuleAttribute' => [ + 'summary' => '修改Registry模板。', + 'path' => '/registryModule/{namespaceName}/{moduleName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限，private：私有的', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'private' => 'private', + ], + 'example' => 'private', + ], + 'description' => [ + 'description' => 'Registry模板描述', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Registry模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '127A5B81-D1E7-5E33-8D44-B89507C4B81F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"127A5B81-D1E7-5E33-8D44-B89507C4B81F\\"\\n}","type":"json"}]', + 'title' => '修改Registry模板', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListRegistryModules' => [ + 'summary' => '查询Registry模板列表。', + 'path' => '/registryModules', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'NamespaceName', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间类型。可选值：'."\n" + ."\n" + .'- system：公共Module'."\n" + ."\n" + .'- self：自定义Module'."\n" + ."\n" + .'- shared：共享Module'."\n" + ."\n" + .'- community：社区Module'."\n" + ."\n" + .'默认返回所有的', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + 'enum' => [ + 'system', + 'self', + 'shared', + 'community', + ], + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持对模板名称的模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为100。默认值：20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'NFzbQCa7/yd7rAuSo5xZb54dD+2BRJj42DLT6GrZysw=', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'registryModules' => [ + 'description' => 'Registry模板列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Registry模板', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限，private：私有的', + 'type' => 'string', + 'example' => 'private', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-06-10 16:16:04', + ], + 'description' => [ + 'description' => 'Registry模板描述', + 'type' => 'string', + 'example' => 'description', + ], + 'downloads' => [ + 'description' => '下载次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'moduleName' => [ + 'description' => 'Registry模板名称', + 'type' => 'string', + 'example' => 'ModuleName', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName'."\n", + ], + 'provider' => [ + 'description' => '供应商类型，alicloud：阿里云', + 'type' => 'string', + 'example' => 'alicloud', + ], + 'sharedAccounts' => [ + 'description' => '共享Registry模板账号列表', + 'type' => 'array', + 'items' => [ + 'description' => '共享Registry模板账号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + 'source' => [ + 'description' => '模板源', + 'type' => 'string', + 'example' => 'namespaceName/ModuleName'."\n", + ], + 'sourceUrl' => [ + 'description' => '模板源链接', + 'type' => 'string', + 'example' => 'URL', + ], + 'type' => [ + 'description' => '模板类型', + 'type' => 'string', + 'example' => 'system'."\n", + ], + 'version' => [ + 'description' => '最新版本号', + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + ], + ], + 'count' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173', + ], + 'maxResults' => [ + 'description' => '最大返回数量 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'example' => 'iRdnbADPQp4dD+2BRJj42DLT6GrZysw=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'D25216A9-C0F7-5A3A-A7E4-2B3D4F3A355D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"registryModules\\": [\\n {\\n \\"acl\\": \\"private\\",\\n \\"createTime\\": \\"2025-06-10 16:16:04\\",\\n \\"description\\": \\"description\\",\\n \\"downloads\\": 32,\\n \\"moduleName\\": \\"ModuleName\\",\\n \\"namespaceName\\": \\"NamespaceName\\\\n\\",\\n \\"provider\\": \\"alicloud\\",\\n \\"sharedAccounts\\": [\\n 123456\\n ],\\n \\"source\\": \\"namespaceName/ModuleName\\\\n\\",\\n \\"sourceUrl\\": \\"URL\\",\\n \\"type\\": \\"system\\\\n\\",\\n \\"version\\": \\"1.0.0\\"\\n }\\n ],\\n \\"count\\": 173,\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"iRdnbADPQp4dD+2BRJj42DLT6GrZysw=\\",\\n \\"requestId\\": \\"D25216A9-C0F7-5A3A-A7E4-2B3D4F3A355D\\"\\n}","type":"json"}]', + 'title' => '查询Registry模板列表', + 'description' => '单用户调用频率：200 次/秒。', + ], + 'GetRegistryModule' => [ + 'summary' => '查询Registry模板。', + 'path' => '/registryModule/{namespaceName}/{moduleName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'registryModule' => [ + 'description' => 'Registry模板', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'description' => '权限，private：私有的', + 'type' => 'string', + 'example' => 'private', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-05-28 13:39:05', + ], + 'description' => [ + 'description' => '模板描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'downloads' => [ + 'description' => '下载次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'moduleName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'ecs-cluster'."\n", + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName'."\n", + ], + 'provider' => [ + 'description' => '供应商类型，alicloud：阿里云', + 'type' => 'string', + 'example' => 'alicloud', + ], + 'sharedAccounts' => [ + 'description' => '共享Registry模板账号列表', + 'type' => 'array', + 'items' => [ + 'description' => '共享账号UID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + 'source' => [ + 'description' => '模板源，由<NamespaceName>/<ModuleName>拼接', + 'type' => 'string', + 'example' => 'namespaceName/ModuleName'."\n", + ], + 'sourceUrl' => [ + 'description' => '模板源链接', + 'type' => 'string', + 'example' => 'URL', + ], + 'type' => [ + 'description' => '工作空间类型。'."\n" + ."\n" + .'system：公共Module'."\n" + ."\n" + .'self：自定义Module'."\n" + ."\n" + .'shared：共享Module'."\n" + ."\n" + .'community：社区Module', + 'type' => 'string', + 'example' => 'system', + ], + 'version' => [ + 'description' => '最新版本', + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '5B5AD471-5036-581B-AC9B-7D5EECED877A', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"registryModule\\": {\\n \\"acl\\": \\"private\\",\\n \\"createTime\\": \\"2025-05-28 13:39:05\\",\\n \\"description\\": \\"description\\",\\n \\"downloads\\": 23,\\n \\"moduleName\\": \\"ecs-cluster\\\\n\\",\\n \\"namespaceName\\": \\"NamespaceName\\\\n\\",\\n \\"provider\\": \\"alicloud\\",\\n \\"sharedAccounts\\": [\\n 123456\\n ],\\n \\"source\\": \\"namespaceName/ModuleName\\\\n\\",\\n \\"sourceUrl\\": \\"URL\\",\\n \\"type\\": \\"system\\",\\n \\"version\\": \\"1.0.0\\"\\n },\\n \\"requestId\\": \\"5B5AD471-5036-581B-AC9B-7D5EECED877A\\"\\n}","type":"json"}]', + 'title' => '查询Registry模板', + 'description' => '单用户调用频率：200 次/秒。', + ], + 'DeleteRegistryModule' => [ + 'summary' => '删除Registry模板。', + 'path' => '/registryModule/{namespaceName}/{moduleName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '545995A8-243D-5963-A940-B74FAF6009B5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"545995A8-243D-5963-A940-B74FAF6009B5\\"\\n}","type":"json"}]', + 'title' => '删除Registry模板', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'PublishRegistryModuleVersion' => [ + 'summary' => '发布Registry模板版本。', + 'path' => '/registryModuleVersion', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'moduleName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + 'version' => [ + 'description' => '版本号。必须符合[ semantic version](http://semver.org/)规范。如1.0.1'."\n" + .'起始版本为 1.0.0', + 'type' => 'string', + 'required' => true, + 'example' => '1.2.0', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '36E1679B-4D91-5AF6-B505-B5D4ACDF75BD', + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1.1.1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"36E1679B-4D91-5AF6-B505-B5D4ACDF75BD\\",\\n \\"version\\": \\"1.1.1\\"\\n}","type":"json"}]', + 'title' => '发布Registry模板版本', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListRegistryModuleVersions' => [ + 'summary' => '查询Registry模板版本列表。', + 'path' => '/registryModuleVersion', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'MamespaceName', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Registry模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为100。默认值：20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TRkuCaTw/VsEHrnCZgrBA0ftQSEJU/lzo2ei7MJjplg=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'moduleVersions' => [ + 'description' => '模板版本列表', + 'type' => 'array', + 'items' => [ + 'description' => '模板版本列表', + 'type' => 'object', + 'properties' => [ + 'sourceUrl' => [ + 'description' => '模板源链接', + 'type' => 'string', + 'example' => 'URL', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-05-28 11:15:57', + ], + 'provider' => [ + 'description' => '供应商类型，alicloud：阿里云', + 'type' => 'string', + 'example' => 'alicloud', + ], + 'moduleName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'ModuleName'."\n", + ], + 'source' => [ + 'description' => '模板源，namespaceName/ModuleName', + 'type' => 'string', + 'example' => 'test_namespace/RegistryModule-test0e'."\n", + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'NamespaceName'."\n", + ], + ], + ], + ], + 'count' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21', + ], + 'maxResults' => [ + 'description' => '分页查询时每页行数。最大值为100。默认值：20', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'example' => 'IbuvZ8iOH447bhHWDavGTOMijI2Jep7c=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8606B880-3485-54E2-89E1-43361C468C85', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"moduleVersions\\": [\\n {\\n \\"sourceUrl\\": \\"URL\\",\\n \\"createTime\\": \\"2025-05-28 11:15:57\\",\\n \\"provider\\": \\"alicloud\\",\\n \\"moduleName\\": \\"ModuleName\\\\n\\",\\n \\"source\\": \\"test_namespace/RegistryModule-test0e\\\\n\\",\\n \\"version\\": \\"1.0.0\\",\\n \\"namespaceName\\": \\"NamespaceName\\\\n\\"\\n }\\n ],\\n \\"count\\": 21,\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"IbuvZ8iOH447bhHWDavGTOMijI2Jep7c=\\",\\n \\"requestId\\": \\"8606B880-3485-54E2-89E1-43361C468C85\\"\\n}","type":"json"}]', + 'title' => '查询Registry模板版本列表', + 'description' => '单用户调用频率：200 次/秒。', + ], + 'GetRegistryModuleVersion' => [ + 'summary' => '查询Registry模板版本。', + 'path' => '/registryModuleVersion/{namespaceName}/{moduleName}/{version}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + ], + [ + 'name' => 'version', + 'in' => 'path', + 'schema' => [ + 'description' => '版本号', + 'type' => 'string', + 'required' => true, + 'example' => '1.1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'moduleVersion' => [ + 'description' => '版本信息', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-02-08T02:22:16Z', + ], + 'detailUrl' => [ + 'description' => '详情页地址', + 'type' => 'string', + 'example' => 'URL', + ], + 'downloads' => [ + 'description' => '下载次数', + 'type' => 'string', + 'example' => '24', + ], + 'moduleName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => 'ecs-cluster'."\n", + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'alibabacloud', + ], + 'provider' => [ + 'description' => '供应商类型，alicloud：阿里云', + 'type' => 'string', + 'example' => 'alicloud', + ], + 'source' => [ + 'description' => '模板源', + 'type' => 'string', + 'example' => 'namespaceName/ModuleName'."\n", + ], + 'sourceUrl' => [ + 'description' => '模板源链接', + 'type' => 'string', + 'example' => 'URL', + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1.0.0', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '62DF26B0-53F0-5747-9D7F-FEF444FB4E24', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"moduleVersion\\": {\\n \\"createTime\\": \\"2025-02-08T02:22:16Z\\",\\n \\"detailUrl\\": \\"URL\\",\\n \\"downloads\\": \\"24\\",\\n \\"moduleName\\": \\"ecs-cluster\\\\n\\",\\n \\"namespaceName\\": \\"alibabacloud\\",\\n \\"provider\\": \\"alicloud\\",\\n \\"source\\": \\"namespaceName/ModuleName\\\\n\\",\\n \\"sourceUrl\\": \\"URL\\",\\n \\"version\\": \\"1.0.0\\"\\n },\\n \\"requestId\\": \\"62DF26B0-53F0-5747-9D7F-FEF444FB4E24\\"\\n}","type":"json"}]', + 'title' => '查询Registry模板版本', + 'description' => '单用户调用频率：200 次/秒。', + ], + 'DeleteRegistryModuleVersion' => [ + 'summary' => '删除Registry模板版本。', + 'path' => '/registryModuleVersion/{namespaceName}/{moduleName}/{version}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'NamespaceName ', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ModuleName', + ], + ], + [ + 'name' => 'version', + 'in' => 'path', + 'schema' => [ + 'description' => '版本号', + 'type' => 'string', + 'required' => true, + 'example' => '1.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '491A1E2E-EA1E-5F90-958A-A53EB67780FC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"491A1E2E-EA1E-5F90-958A-A53EB67780FC\\"\\n}","type":"json"}]', + 'title' => '删除Registry模板版本', + 'description' => '单用户调用频率：100 次/秒。', + ], + 'ListTerraformProviderVersions' => [ + 'summary' => '获取TerraformProvider版本列表。', + 'path' => '/version/terraform/provider', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索版本关键词 支持模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + 'readOnly' => false, + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页token，为null表示没有下一页', + 'type' => 'string', + 'required' => false, + 'example' => 'ar9lHbaidqWequN5orMba54dD+2BRJj42DLT6GrZysw=', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '20', + 'readOnly' => false, + ], + ], + [ + 'name' => 'usage', + 'in' => 'query', + 'schema' => [ + 'description' => '用途'."\n" + .'取Explorer展示Meta信息', + 'type' => 'string', + 'required' => false, + 'example' => 'Explorer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'description' => '一次获取的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '分页token，为空表示没有下一页', + 'type' => 'string', + 'example' => 'rnD7wyAII+yDi0UGlV519J4dD+2BRJj42DLT6GrZysw=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '73588ebb-9d40-4660-a59f-764636ae6034', + 'readOnly' => false, + ], + 'totalCount' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + 'readOnly' => false, + ], + 'versions' => [ + 'description' => '版本列表', + 'type' => 'array', + 'items' => [ + 'description' => '版本列表', + 'type' => 'object', + 'properties' => [ + 'version' => [ + 'description' => '版本。', + 'type' => 'string', + 'example' => '1.242.0', + ], + 'publishedTime' => [ + 'description' => '发布时间', + 'type' => 'string', + 'example' => '2025-01-24T05:06:51Z', + ], + 'status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'Available', + ], + ], + ], + 'readOnly' => false, + ], + ], + 'readOnly' => false, + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"rnD7wyAII+yDi0UGlV519J4dD+2BRJj42DLT6GrZysw=\\",\\n \\"requestId\\": \\"73588ebb-9d40-4660-a59f-764636ae6034\\",\\n \\"totalCount\\": 50,\\n \\"versions\\": [\\n {\\n \\"version\\": \\"1.242.0\\",\\n \\"publishedTime\\": \\"2025-01-24T05:06:51Z\\",\\n \\"status\\": \\"Available\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取TerraformProvider版本列表', + ], + 'ListProducts' => [ + 'summary' => '所有产品列表。', + 'path' => '/products', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页nextToken', + 'type' => 'string', + 'required' => false, + 'example' => 'eyJ0b2tlbiI6IjEwMjM0NTY3ODkwIn0=', + ], + ], + [ + 'name' => 'terraformProviderVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'TerraformProvider版本，为空时默认为最新版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.227.0', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数量，取值范围（0-200），默认100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索产品关键词支持模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'supportTerraformer', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持Terraformer', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '状态，Available，Deprecated', + 'type' => 'string', + 'required' => false, + 'example' => 'Available', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式'."\n" + .'- Normal：默认排序（默认值）'."\n" + .'- Top：热门访问排序', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '成功响应的数据结构', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'description' => '分页nextToken', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '每页的最大数量，取值范围（0-200），默认100', + 'type' => 'string', + 'example' => '30BaZ9ekYWXJdqshYecA++coNg7qT1Zbm3RfLyFIZeY=', + ], + 'products' => [ + 'description' => '产品列表', + 'type' => 'array', + 'items' => [ + 'description' => '产品列表', + 'type' => 'object', + 'properties' => [ + 'product' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => 'MSE', + ], + 'subcategory' => [ + 'description' => 'Terraform中对于产品的分类', + 'type' => 'string', + 'example' => 'Microservice_Engine(MSE)', + ], + 'supportTerraformer' => [ + 'description' => '是否支持Terraformer', + 'type' => 'boolean', + 'example' => 'true', + ], + 'terraformProviderVersion' => [ + 'description' => 'TerraformProvider的版本', + 'type' => 'string', + 'example' => '1.229.0', + ], + 'status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'productName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '微服务引擎', + ], + 'productNameEn' => [ + 'description' => '产品英文名称', + 'type' => 'string', + 'example' => 'Microservices Engine', + ], + 'firstCategoryName' => [ + 'description' => '一级分类名称', + 'type' => 'string', + 'example' => '企业应用', + ], + 'firstCategoryNameEn' => [ + 'description' => '一级分类英文名称', + 'type' => 'string', + 'example' => 'Enterprise application', + ], + 'secondCategoryName' => [ + 'description' => '二级分类名称', + 'type' => 'string', + 'example' => '应用服务', + ], + 'secondCategoryNameEn' => [ + 'description' => '二级分类英文名称', + 'type' => 'string', + 'example' => 'Application service', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '9bcaac3c-420d-4303-87ab-7638c07b0a0b', + ], + 'totalCount' => [ + 'description' => '数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '134', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"30BaZ9ekYWXJdqshYecA++coNg7qT1Zbm3RfLyFIZeY=\\",\\n \\"products\\": [\\n {\\n \\"product\\": \\"MSE\\",\\n \\"subcategory\\": \\"Microservice_Engine(MSE)\\",\\n \\"supportTerraformer\\": true,\\n \\"terraformProviderVersion\\": \\"1.229.0\\",\\n \\"status\\": \\"Available\\",\\n \\"productName\\": \\"微服务引擎\\",\\n \\"productNameEn\\": \\"Microservices Engine\\",\\n \\"firstCategoryName\\": \\"企业应用\\",\\n \\"firstCategoryNameEn\\": \\"Enterprise application\\",\\n \\"secondCategoryName\\": \\"应用服务\\",\\n \\"secondCategoryNameEn\\": \\"Application service\\"\\n }\\n ],\\n \\"requestId\\": \\"9bcaac3c-420d-4303-87ab-7638c07b0a0b\\",\\n \\"totalCount\\": 134\\n}","type":"json"}]', + 'title' => '列举产品列表', + 'description' => '## 请求说明'."\n" + ."\n" + .'- **关键词搜索**：通过`keyword`参数进行模糊匹配。'."\n" + .'- **分页查询**：使用`nextToken`进行翻页，通过`maxResults`指定每页返回的最大结果数（默认100，最大200）。'."\n" + .'- **Terraform Provider版本**：可选参数`terraformProviderVersion`用于筛选特定版本的Provider相关产品。'."\n" + .'- **响应结构**包含请求ID、总条目数、当前页数据及分页信息，便于处理查询结果。', + ], + 'ListResourceTypes' => [ + 'summary' => '按条件筛选并获取资源类型列表，支持分页。', + 'path' => '/resourceTypes', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'product', + 'in' => 'query', + 'schema' => [ + 'description' => '产品code，支持模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'terraformProviderVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'TerraformProvider版本，为空时默认为最新版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.227.0', + ], + ], + [ + 'name' => 'subcategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Terraform中的对于产品的分类', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页nextToken', + 'type' => 'string', + 'required' => false, + 'example' => 'tokenForNextPage', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选的状态列表，枚举：Available（可用）, Deprecated（废弃）', + 'type' => 'string', + 'required' => false, + 'example' => 'Available,Deprecated', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数量，取值范围（0-200），默认100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索资源Code或名称关键词支持模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'supportTerraformer', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持Terraformer', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'terraformResourceTypes', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'terraform资源列表', + 'type' => 'array', + 'items' => [ + 'description' => 'terraform资源列表', + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud_route_table', + ], + 'required' => false, + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型返回的顺序。可选值：'."\n" + .'- Normal（默认）：正常排序返回'."\n" + .'- Top：按热门访问排序返回', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'acceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '根据汉语、英语返回结果。取值范围：'."\n" + .'- zh-CN：中文。'."\n" + .'- en-US：英文。'."\n" + ."\n" + .'默认值：zh-CN。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'description' => '每页的最大数量，取值范围（0-200），默认100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '分页nextToken', + 'type' => 'string', + 'example' => 'LC4NJL3Ru2bIiRdnbADPQp4dD+2BRJj42DLT6GrZysw=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '9bcaac3c-420d-4303-87ab-7638c07b0a0b', + ], + 'resourceTypes' => [ + 'description' => '资源列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源详细信息', + 'type' => 'object', + 'properties' => [ + 'product' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => 'VPC', + ], + 'status' => [ + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'statusStartVersion' => [ + 'description' => '资源状态开始生效的版本', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'subcategory' => [ + 'description' => 'Terraform中对于产品的分类', + 'type' => 'string', + 'example' => 'VPC', + ], + 'supportTerraformer' => [ + 'description' => '是否支持Terraformer', + 'type' => 'string', + 'example' => 'true', + ], + 'terraformProviderVersion' => [ + 'description' => 'Terraform Provider的版本', + 'type' => 'string', + 'example' => '1.248.0', + ], + 'terraformResourceType' => [ + 'description' => 'Terraform中的资源类型', + 'type' => 'string', + 'example' => 'alicloud_route_table', + ], + 'productName' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => '专有网络VPC', + ], + 'title' => [ + 'description' => '标题', + 'type' => 'string', + 'example' => '路由表', + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => '路由表', + ], + 'resourceListPageUrl' => [ + 'description' => '资源列表页链接', + 'type' => 'string', + 'example' => 'https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables', + ], + 'resourceDetailPageUrl' => [ + 'description' => '资源详情页链接', + 'type' => 'string', + 'example' => 'https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables/${RouteTableId}', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '93', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"LC4NJL3Ru2bIiRdnbADPQp4dD+2BRJj42DLT6GrZysw=\\",\\n \\"requestId\\": \\"9bcaac3c-420d-4303-87ab-7638c07b0a0b\\",\\n \\"resourceTypes\\": [\\n {\\n \\"product\\": \\"VPC\\",\\n \\"status\\": \\"Available\\",\\n \\"statusStartVersion\\": \\"1.0.0\\",\\n \\"subcategory\\": \\"VPC\\",\\n \\"supportTerraformer\\": \\"true\\",\\n \\"terraformProviderVersion\\": \\"1.248.0\\",\\n \\"terraformResourceType\\": \\"alicloud_route_table\\",\\n \\"productName\\": \\"专有网络VPC\\",\\n \\"title\\": \\"路由表\\",\\n \\"description\\": \\"路由表\\",\\n \\"resourceListPageUrl\\": \\"https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables\\",\\n \\"resourceDetailPageUrl\\": \\"https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables/${RouteTableId}\\"\\n }\\n ],\\n \\"totalCount\\": 93\\n}","type":"json"}]', + 'title' => '列举资源类型列表', + 'description' => '## 请求说明'."\n" + ."\n" + .'此API允许用户根据产品代码、Terraform Provider版本、子类别、状态、关键词等条件查询资源类型列表。结果包含资源的详细信息，如产品代码、状态、状态生效版本、子类别、Terraform Provider版本及资源类型代码。支持分页返回结果，便于处理大量数据。', + ], + 'GetResourceType' => [ + 'summary' => '获取资源类型信息。', + 'path' => '/resourceType/{resourceType}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'description' => '资源Code，用于获取指定资源类型的详细信息', + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud_vpc', + ], + ], + [ + 'name' => 'terraformProviderVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'TerraformProvider版本，为空时默认为最新版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.227.0', + ], + ], + [ + 'name' => 'filterReadOnly', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持过滤只读属性', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'acceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '根据汉语、英语返回结果。取值范围：'."\n" + .'- zh-CN：中文。'."\n" + .'- en-US：英文。'."\n" + ."\n" + .'默认值：zh-CN。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '成功响应的数据结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '9bcaac3c-420d-4303-87ab-7638c07b0a0b', + ], + 'resourceType' => [ + 'description' => '资源类型详细信息', + 'type' => 'object', + 'properties' => [ + 'operations' => [ + 'description' => '资源关联的API集合', + 'type' => 'array', + 'items' => [ + 'description' => '资源关联的API集合', + 'type' => 'object', + 'properties' => [ + 'apiName' => [ + 'description' => 'API名称', + 'type' => 'string', + 'example' => 'CreateVSwitch', + ], + 'apiVersion' => [ + 'description' => 'API的版本', + 'type' => 'string', + 'example' => '2016-04-28', + ], + 'operationType' => [ + 'description' => '操作类型，枚举：Write、Read', + 'type' => 'string', + 'enumValueTitles' => [ + 'Write' => 'Write', + 'Read' => 'Read', + ], + 'example' => 'Write', + ], + 'serviceCode' => [ + 'description' => 'serviceCode', + 'type' => 'string', + 'example' => 'Vpc', + ], + ], + ], + ], + 'product' => [ + 'description' => '产品Code', + 'type' => 'string', + 'example' => 'ECS', + ], + 'properties' => [ + 'description' => '资源属性', + 'type' => 'object', + 'example' => '{}', + ], + 'status' => [ + 'description' => '资源状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'statusStartVersion' => [ + 'description' => '状态生效版本', + 'type' => 'string', + 'example' => '1.227.0', + ], + 'subcategory' => [ + 'description' => 'Terraform中产品分类', + 'type' => 'string', + 'example' => 'network', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraform provider版本', + 'type' => 'string', + 'example' => '1.227.0', + ], + 'terraformResourceType' => [ + 'description' => 'Terraform中资源Code', + 'type' => 'string', + 'example' => 'alicloud_vpc', + ], + 'productName' => [ + 'description' => '产品名称。', + 'type' => 'string', + 'example' => '专有网络VPC'."\n", + ], + 'title' => [ + 'description' => '标题', + 'type' => 'string', + 'example' => '路由表'."\n", + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'resourceListPageUrl' => [ + 'description' => '资源列表页链接', + 'type' => 'string', + 'example' => 'https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables'."\n", + ], + 'resourceDetailPageUrl' => [ + 'description' => '资源详情页链接', + 'type' => 'string', + 'example' => 'https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables/${RouteTableId}'."\n", + ], + 'productNameEn' => [ + 'description' => '产品英文名称', + 'type' => 'string', + 'example' => 'vpc', + ], + 'supportExported' => [ + 'description' => '支持导出', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9bcaac3c-420d-4303-87ab-7638c07b0a0b\\",\\n \\"resourceType\\": {\\n \\"operations\\": [\\n {\\n \\"apiName\\": \\"CreateVSwitch\\",\\n \\"apiVersion\\": \\"2016-04-28\\",\\n \\"operationType\\": \\"Write\\",\\n \\"serviceCode\\": \\"Vpc\\"\\n }\\n ],\\n \\"product\\": \\"ECS\\",\\n \\"properties\\": {},\\n \\"status\\": \\"Available\\",\\n \\"statusStartVersion\\": \\"1.227.0\\",\\n \\"subcategory\\": \\"network\\",\\n \\"terraformProviderVersion\\": \\"1.227.0\\",\\n \\"terraformResourceType\\": \\"alicloud_vpc\\",\\n \\"productName\\": \\"专有网络VPC\\\\n\\",\\n \\"title\\": \\"路由表\\\\n\\",\\n \\"description\\": \\"test\\",\\n \\"resourceListPageUrl\\": \\"https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables\\\\n\\",\\n \\"resourceDetailPageUrl\\": \\"https://vpc.console.aliyun.com/vpc/${RegionId}/route-tables/${RouteTableId}\\\\n\\",\\n \\"productNameEn\\": \\"vpc\\",\\n \\"supportExported\\": true\\n }\\n}","type":"json"}]', + 'title' => '获取资源类型详情', + 'description' => '## 请求说明', + ], + 'UpdateExplorerModuleAttribute' => [ + 'summary' => '更新Explorer模版。', + 'path' => '/explorerModule/{explorerModuleId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '模版描述，长度（0 - 255）', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'name' => [ + 'description' => '模板名，长度（1-128）,'."\n" + .'名称唯一', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => false, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'explorerModuleId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Explorer模版ID', + 'type' => 'string', + 'required' => true, + 'example' => 'mod-al1611jl2tce3nlh2uvklh0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '25B274BA-E672-58C0-8602-541281B6F758', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"25B274BA-E672-58C0-8602-541281B6F758\\"\\n}","type":"json"}]', + 'title' => '更新Explorer模版', + 'description' => '更新Explorer模版。', + ], + 'ValidateModule' => [ + 'summary' => '模版预检。', + 'path' => '/module/validation', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => false, + 'example' => '2daf4227f747cbf11a5501f18cc5e004', + ], + 'code' => [ + 'description' => 'source==Upload时，直接传入模版文本', + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + 'source' => [ + 'description' => '模版来源，枚举：'."\n" + .'Upload 文本上传', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Upload', + ], + 'sourcePath' => [ + 'description' => '来源路径', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'codeMap' => [ + 'description' => '支持传入多个配置文件', + 'type' => 'object', + 'required' => false, + 'example' => '{"main.tf":"xxx"}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'description' => '校验信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'moduleValidationId' => [ + 'description' => '校验Id', + 'type' => 'string', + 'example' => 'BF72A6FB-B07', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BF72A6FB-B071-5F2E-A036-9D62545B962C', + ], + 'status' => [ + 'description' => '校验结果，枚举：'."\n" + .'- Initializing 初始化中'."\n" + .'- Validating 校验中'."\n" + .'- Validated 校验成功'."\n" + .'- Errored 校验失败', + 'type' => 'string', + 'example' => 'Validating', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to do this action.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"message\\": \\"ok\\",\\n \\"moduleValidationId\\": \\"BF72A6FB-B07\\",\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\",\\n \\"status\\": \\"Validating\\"\\n}","type":"json"}]', + 'title' => '模板预检', + 'description' => '对Terraform配置文件内容进行预检查', + ], + 'ExecuteTerraformApply' => [ + 'summary' => '执行TerraformApply。', + 'path' => '/terraform/execution/apply', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'stateId' => [ + 'description' => '状态文件ID，该字段不为空时，在原有状态文件基础上面继续执行Apply命令', + 'type' => 'string', + 'required' => false, + 'example' => 'task-xxx', + ], + 'code' => [ + 'description' => '需要执行的Terraform代码内容，如果执行内容无变化，可以只传入stateId', + 'type' => 'string', + 'required' => false, + 'example' => 'terraform {'."\n" + .' required_providers {'."\n" + .' alicloud = {'."\n" + .' source = "aliyun/alicloud"'."\n" + .' version = "1.254.0"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'resource "alicloud_vpc" "default" {'."\n" + .' is_default = false'."\n" + .' enable_ipv6 = false'."\n" + .' classic_link_enabled = false'."\n" + .' force_delete = false'."\n" + .' system_route_table_route_propagation_enable = false'."\n" + .' dry_run = false'."\n" + .'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'stateId' => [ + 'description' => '状态文件ID', + 'type' => 'string', + 'example' => 'task-xxxx', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'C896FE0A-1BEA-5D01-BFF4-B03B82B9CA3D', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"stateId\\": \\"task-xxxx\\",\\n \\"requestId\\": \\"C896FE0A-1BEA-5D01-BFF4-B03B82B9CA3D\\"\\n}","type":"json"}]', + 'title' => '执行TerraformApply', + 'description' => '该API主要用于执行Terraform Apply命令，通过提供的Terraform代码来创建或更新云资源，并且能够处理复杂的场景，如依赖于先前状态的操作。'."\n" + ."\n" + .'使用此API前，请确保已正确配置了所有必要的认证信息，并且Terraform代码符合预期的功能需求。', + ], + 'ExecuteTerraformDestroy' => [ + 'summary' => '执行Terraform Destroy', + 'path' => '/terraform/execution/destroy', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'stateId' => [ + 'description' => '状态文件ID', + 'type' => 'string', + 'required' => true, + 'example' => 'task-xxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'stateId' => [ + 'description' => '状态文件ID', + 'type' => 'string', + 'example' => 'task-xxxx', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'BF72A6FB-B071-5F2E-A036-9D62545B962C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"stateId\\": \\"task-xxxx\\",\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\"\\n}","type":"json"}]', + 'title' => '执行Terraform Destroy', + 'description' => '执行Terraform Destroy命令，销毁通过Terraform创建的资源', + ], + 'GetExecuteState' => [ + 'summary' => '获取Terraform运行结果', + 'path' => '/terraform/execution/{stateId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'stateId', + 'in' => 'path', + 'schema' => [ + 'description' => '状态文件ID', + 'type' => 'string', + 'required' => true, + 'example' => 'task-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B4672AE3-C313-5B7A-BB24-45345570D398', + ], + 'status' => [ + 'description' => '状态：'."\n" + ."\n" + .'- Pending：准备就绪'."\n" + .'- PlanQueued：plan任务创建后，如果没有可用的工作流，需要排队等待状态'."\n" + .'- ApplyQueued：apply任务创建后，如果没有可用的工作流，需要排队等待状态'."\n" + .'- Planning：执行Plan阶段'."\n" + .'- Planned：完成Plan的执行'."\n" + .'- Confirmed：执行Plan之后被确认'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff，此时Job处于最终状态'."\n" + .'- Applying：处于执行Apply阶段'."\n" + .'- Applied：完成Apply的执行'."\n" + .'- Discarded：执行任务被丢弃，进入最终状态'."\n" + .'- Errored：执行有错误，进入最终状态'."\n" + .'- Canceled：执行被取消，进入最终状态', + 'type' => 'string', + 'example' => 'Pending', + ], + 'errorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'Your account does not have enough balance to order postpaid product.', + ], + 'state' => [ + 'description' => '状态文件内容', + 'type' => 'string', + 'example' => '{"version": 4, "terraform_version": "1.5.7", "serial": 3, "lineage": "cb71b0b2-1ec2-6483-d409-8cae23186ec6", "outputs": {}, "resources": [], "check_results": null}', + ], + 'logFile' => [ + 'description' => '运行日志', + 'type' => 'object', + 'example' => '{"tf-plan.run.log":"xxx"}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B4672AE3-C313-5B7A-BB24-45345570D398\\",\\n \\"status\\": \\"Pending\\",\\n \\"errorMessage\\": \\"Your account does not have enough balance to order postpaid product.\\",\\n \\"state\\": \\"{\\\\\\"version\\\\\\": 4, \\\\\\"terraform_version\\\\\\": \\\\\\"1.5.7\\\\\\", \\\\\\"serial\\\\\\": 3, \\\\\\"lineage\\\\\\": \\\\\\"cb71b0b2-1ec2-6483-d409-8cae23186ec6\\\\\\", \\\\\\"outputs\\\\\\": {}, \\\\\\"resources\\\\\\": [], \\\\\\"check_results\\\\\\": null}\\",\\n \\"logFile\\": {\\n \\"tf-plan.run.log\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + 'title' => '获取Terraform运行结果', + 'description' => '获取Terraform运行的结果', + ], + 'ExecuteTerraformPlan' => [ + 'summary' => '执行TerraformPlan。', + 'path' => '/terraform/execution/plan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'stateId' => [ + 'description' => '状态文件ID，该字段不为空时，在原有状态文件基础上面继续执行Plan命令', + 'type' => 'string', + 'required' => false, + 'example' => 'task-xxx', + ], + 'code' => [ + 'description' => '需要执行的Terraform代码内容，如果执行内容无变化，可以只传入stateId', + 'type' => 'string', + 'required' => false, + 'example' => 'terraform {'."\n" + .' required_providers {'."\n" + .' alicloud = {'."\n" + .' source = "aliyun/alicloud"'."\n" + .' version = "1.254.0"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'resource "alicloud_vpc" "default" {'."\n" + .' is_default = false'."\n" + .' enable_ipv6 = false'."\n" + .' classic_link_enabled = false'."\n" + .' force_delete = false'."\n" + .' system_route_table_route_propagation_enable = false'."\n" + .' dry_run = false'."\n" + .'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'stateId' => [ + 'description' => '状态文件ID', + 'type' => 'string', + 'example' => 'task-xxxx', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0D298375-F92F-5B65-82E4-EA68F02521F1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"stateId\\": \\"task-xxxx\\",\\n \\"requestId\\": \\"0D298375-F92F-5B65-82E4-EA68F02521F1\\"\\n}","type":"json"}]', + 'title' => '执行Terraform Plan', + 'description' => '该API主要用于执行Terraform Plan命令，通过提供的Terraform代码来创建或更新云资源，并且能够处理复杂的场景，如依赖于先前状态的操作。'."\n" + ."\n" + .'使用此API前，请确保已正确配置了所有必要的认证信息，并且Terraform代码符合预期的功能需求。', + ], + 'ExecuteRegistryModule' => [ + 'summary' => '执行阿里云 Terraform 官方提供的 Module。', + 'path' => '/registryModule/{namespaceName}/{moduleName}/execution', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => [ + 'description' => 'Module所属的工作空间，当前官方RegistryModule的工作空间：alibaba、alibabacloud-automation、aliyun、terraform-alicloud-modules', + 'type' => 'string', + 'required' => true, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => [ + 'description' => '模板名称，可以通过ListExplorerRegistryModules查询', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'parameters' => [ + 'description' => '模板用到的参数集', + 'type' => 'object', + 'required' => false, + 'example' => '{\'region\': \'cn-hangzhou\', \'vpcId\': \'vpc-bp145sc90s26q0qbkfb6i\', \'functionName\': \'filemgr-cn-hangzhou-063fd4aead\', \'mountPointsServerAddr\': \'063fd4aead-dex50.cn-hangzhou.nas.aliyuncs.com\'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'stateId' => [ + 'description' => '状态文件ID', + 'type' => 'string', + 'example' => 'task-xxxx', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '79284133-D4BA-56B3-954C-D538256F7EAA', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"stateId\\": \\"task-xxxx\\",\\n \\"requestId\\": \\"79284133-D4BA-56B3-954C-D538256F7EAA\\"\\n}","type":"json"}]', + 'title' => '执行RegistryModule', + 'description' => '该 API 主要用于执行 TerraformModule 代码，以实现来创建或更新云资源。使用此 API 前，请确保已正确配置了所有必要的认证信息，并且 Module 对应的 Terraform 代码符合预期的功能需求。', + ], + 'ListExplorerRegistryModuleVersions' => [ + 'summary' => '列举阿里云 Terraform 官方提供的 Module版本信息。', + 'path' => '/explorerRegistryModule/version', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 所在的工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 的名称', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'moduleVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 的版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.11.0', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字，支持根据 Module 的名称模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：0~200。'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询返回结果下一页的令牌。'."\n" + ."\n" + .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'lJTuhMWkNH89zZWyYM9GjpAbgRb+bPPPwN0Q3pclzKI=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'explorerRegistryModuleVersions' => [ + 'description' => 'Explorer社区模版版本列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Explorer社区模版版本', + 'type' => 'object', + 'properties' => [ + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'namespace-test', + ], + 'moduleName' => [ + 'description' => '模版名称', + 'type' => 'string', + 'example' => 'eip-slb-ecs-polardb', + ], + 'source' => [ + 'description' => '来源', + 'type' => 'string', + 'example' => 'test_namespace/RegistryModule-test4', + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '1.5.0', + ], + 'properties' => [ + 'description' => '资源属性。', + 'type' => 'object', + 'example' => '{}', + ], + 'moduleDetail' => [ + 'description' => '模版详情', + 'type' => 'object', + 'example' => '{}', + ], + 'moduleFile' => [ + 'description' => '模版文件', + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '数据总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'maxResults' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：0~200。'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '查询返回结果下一页的令牌。'."\n" + ."\n" + .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', + 'type' => 'string', + 'example' => 'oIM6ssGyh00noi5zoDR1hJ4dD+2BRJj42DLT6GrZysw=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F2D40488-3F74-568B-87EC-1C04D098DF8B', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"explorerRegistryModuleVersions\\": [\\n {\\n \\"namespaceName\\": \\"namespace-test\\",\\n \\"moduleName\\": \\"eip-slb-ecs-polardb\\",\\n \\"source\\": \\"test_namespace/RegistryModule-test4\\",\\n \\"version\\": \\"1.5.0\\",\\n \\"properties\\": {},\\n \\"moduleDetail\\": {},\\n \\"moduleFile\\": {}\\n }\\n ],\\n \\"totalCount\\": 22,\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"oIM6ssGyh00noi5zoDR1hJ4dD+2BRJj42DLT6GrZysw=\\",\\n \\"requestId\\": \\"F2D40488-3F74-568B-87EC-1C04D098DF8B\\"\\n}","type":"json"}]', + 'title' => '获取官方RegistryModule版本列表', + 'description' => '本接口支持查询阿里云Terraform官方提供的Module版本信息。'."\n" + ."\n" + .'您可以通过指定`maxResults`参数调整最大返回条目数。'."\n" + .'- 如果返回结果中不存在`nextToken`，则表示没有更多数据。否则，则表示还有更多数据。如果想要查询后续页，需要将ListExplorerRegistryModules 接口的`nextToken`参数设置为上一次返回结果中获取到的`nextToken` 。如果未输入`NextToken`参数，查询时默认返回第一页的数据。'."\n" + .'- 通过设置keyword、namespaceName、moduleName、moduleVersion作为过滤条件，可以精确资源的搜索范围。多个过滤条件之间是逻辑与`AND`的关系，只有同时满足所有过滤条件的资源才会被返回。'."\n" + .' - keyword参数：可选参数，关键词搜索，通过对ModuleName模糊匹配。例如：keyword设置为ecs时，则表示查询module名称包含ecs的module。'."\n" + .' - namespaceName：可选参数，支持筛选特定工作空间的Module。例如：keyword设置为alibaba时，则表示查询module的工作空间为alibaba的module。当输入moduleName时，namespace也必须填入，可以通过接口ListExplorerRegistryModule接口获取namespaceName信息。'."\n" + .' - moduleName：可选参数，支持筛选特定名称的Module。例如：keyword设置为ecs时，则表示查询module名称为ecs的module。'."\n" + .' - moduleVersion：可选参数，支持筛选特定版本的Module。例如：keyword设置为1.0.0时，则表示查询module版本为1.0.0的module。'."\n" + ."\n" + .'响应结构包含请求 ID、总条目数、当前页数据及分页信息，便于处理查询结果。', + ], + 'ListExplorerRegistryModules' => [ + 'summary' => '列举阿里云 Terraform 官方提供的 Module 信息。', + 'path' => '/explorerRegistryModule', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'module名称的搜索关键词，支持根据`moduleName`模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：0~200。'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询返回结果下一页的令牌。'."\n" + ."\n" + .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'DxEkv+3w0EDAQgcRFBp8Ep4dD+2BRJj42DLT6GrZysw=', + ], + ], + [ + 'name' => 'sort', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果的排序。可选值：'."\n" + .'- Normal（默认）：正常排序返回'."\n" + .'- Top：按热门访问排序返回', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 的名称。'."\n" + ."\n" + .'注意：Module 的名称与产品名称、资源名称不一定是一致的。', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应参数对象'."\n", + 'type' => 'object', + 'properties' => [ + 'explorerRegistryModules' => [ + 'description' => 'Explorer社区模版列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Explorer社区模版', + 'type' => 'object', + 'properties' => [ + 'moduleName' => [ + 'description' => '模版名称', + 'type' => 'string', + 'example' => 'terraform-alicloud-modules/mongodb', + ], + 'latestVersion' => [ + 'description' => '最新版本号。', + 'type' => 'string', + 'example' => 'v1', + ], + 'source' => [ + 'description' => '来源', + 'type' => 'string', + 'example' => 'terraform-alicloud-modules/mongodb/alicloud', + ], + 'status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'Default', + ], + 'downloads' => [ + 'description' => '下载次数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'test_namespace', + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'demo', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '170', + ], + 'maxResults' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：0~200。'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '查询返回结果下一页的令牌。'."\n" + ."\n" + .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', + 'type' => 'string', + 'example' => 'DxEkv+3w0EDAQgcRFBp8Ep4dD+2BRJj42DLT6GrZysw=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID'."\n", + 'type' => 'string', + 'example' => '1A662F56-CA76-55F6-869D-7F26293B8E67', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"explorerRegistryModules\\": [\\n {\\n \\"moduleName\\": \\"terraform-alicloud-modules/mongodb\\",\\n \\"latestVersion\\": \\"v1\\",\\n \\"source\\": \\"terraform-alicloud-modules/mongodb/alicloud\\",\\n \\"status\\": \\"Default\\",\\n \\"downloads\\": 34,\\n \\"namespaceName\\": \\"test_namespace\\",\\n \\"description\\": \\"demo\\"\\n }\\n ],\\n \\"totalCount\\": 170,\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"DxEkv+3w0EDAQgcRFBp8Ep4dD+2BRJj42DLT6GrZysw=\\",\\n \\"requestId\\": \\"1A662F56-CA76-55F6-869D-7F26293B8E67\\"\\n}","type":"json"}]', + 'title' => '列举官方RegistryModule', + 'description' => '本接口支持查询阿里云Terraform官方提供的Module信息。'."\n" + ."\n" + .'您可以通过指定`maxResults`参数调整最大返回条目数。'."\n" + .'- 如果返回结果中不存在`nextToken`，则表示没有更多数据。否则，则表示还有更多数据。如果想要查询后续页，需要将ListExplorerRegistryModules 接口的`nextToken`参数设置为上一次返回结果中获取到的`nextToken` 。如果未输入`NextToken`参数，查询时默认返回第一页的数据。'."\n" + .'- 通过设置keyword、moduleName作为过滤条件，可以精确资源的搜索范围。多个过滤条件之间是逻辑与`AND`的关系，只有同时满足所有过滤条件的资源才会被返回。'."\n" + .' - keyword参数：可选参数，关键词搜索，通过对ModuleName模糊匹配。例如：keyword设置为ecs时，则表示查询module名称包含ecs的module。'."\n" + .' - moduleName：可选参数，支持筛选特定名称的Module。例如：keyword设置为ecs时，则表示查询module名称为ecs的module。'."\n" + ."\n" + .'响应结构包含请求 ID、总条目数、当前页数据及分页信息，便于处理查询结果。', + ], + 'ListExplorerRegistryModuleExamples' => [ + 'summary' => '获取官方的 Terraform Module 示例列表。', + 'path' => '/explorerRegistryModule/example', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'namespaceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 所在的工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'alibaba', + ], + ], + [ + 'name' => 'moduleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 的名称', + 'type' => 'string', + 'required' => false, + 'example' => 'sls', + ], + ], + [ + 'name' => 'moduleVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 的版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.11.0', + ], + ], + [ + 'name' => 'exampleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Module 的示例名称', + 'type' => 'string', + 'required' => false, + 'example' => 'complete', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持根据 Module 名称或者 Module 的示例模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：0~200。'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询返回结果下一页的令牌。'."\n" + ."\n" + .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'IbuvZbAXFOiB4nKg8iOH447bhHWDavGTOMijI2Jep7c=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'explorerRegistryModuleExamples' => [ + 'description' => 'Explorer社区模版示例列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Explorer社区模版示例', + 'type' => 'object', + 'properties' => [ + 'moduleName' => [ + 'description' => '模版名称', + 'type' => 'string', + 'example' => 'iactestname1', + ], + 'moduleVersion' => [ + 'description' => '模板版本', + 'type' => 'string', + 'example' => '1.11.0', + ], + 'exampleName' => [ + 'description' => '示例名称', + 'type' => 'string', + 'example' => '201-use-case-create-actiontrail-trail', + ], + 'status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'examplePath' => [ + 'description' => '示例路径', + 'type' => 'string', + 'example' => '/', + ], + 'exampleSchema' => [ + 'description' => '示例结构', + 'type' => 'object', + 'example' => '{}', + ], + 'namespaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'alibaba', + ], + ], + ], + ], + 'totalCount' => [ + 'description' => '总数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'maxResults' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：0~200。'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '查询返回结果下一页的令牌。'."\n" + ."\n" + .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', + 'type' => 'string', + 'example' => 'VSjwD+sJ8OZJ8fNjV89AZs7o2AdSD25ZQLeWZ8REjXA=', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BA8F6459-EED6-556B-8130-D150A3866E56', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"explorerRegistryModuleExamples\\": [\\n {\\n \\"moduleName\\": \\"iactestname1\\",\\n \\"moduleVersion\\": \\"1.11.0\\",\\n \\"exampleName\\": \\"201-use-case-create-actiontrail-trail\\",\\n \\"status\\": \\"Available\\",\\n \\"examplePath\\": \\"/\\",\\n \\"exampleSchema\\": {},\\n \\"namespaceName\\": \\"alibaba\\"\\n }\\n ],\\n \\"totalCount\\": 132,\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"VSjwD+sJ8OZJ8fNjV89AZs7o2AdSD25ZQLeWZ8REjXA=\\",\\n \\"requestId\\": \\"BA8F6459-EED6-556B-8130-D150A3866E56\\"\\n}","type":"json"}]', + 'title' => '获取官方RegistryModule示例列表', + 'description' => '本接口支持查询阿里云官方提供的Terraform Module下的示例信息。'."\n" + ."\n" + .'您可以通过指定`maxResults`参数调整最大返回条目数。'."\n" + .'- 如果返回结果中不存在`nextToken`，则表示没有更多数据。否则，则表示还有更多数据。如果想要查询后续页，需要将ListExplorerRegistryModuleExamples 接口的`nextToken`参数设置为上一次返回结果中获取到的`nextToken` 。如果未输入`NextToken`参数，查询时默认返回第一页的数据。'."\n" + .'- 通过设置keyword、namespaceName、moduleName、moduleVersion、exampleName作为过滤条件，可以精确资源的搜索范围。多个过滤条件之间是逻辑与`AND`的关系，只有同时满足所有过滤条件的资源才会被返回。'."\n" + .' - keyword参数：可选参数，关键词搜索，支持对exampleName模糊匹配。例如：keyword设置为ecs时，则表示查询示例名称包含ecs的module示例。'."\n" + .' - namespaceName：可选参数，支持筛选特定工作空间的Module示例。例如：keyword设置为alibaba时，则表示查询module的工作空间为alibaba的module示例。'."\n" + .' - moduleName：可选参数，支持筛选特定名称的Module示例。例如：keyword设置为ecs时，则表示查询module名称为ecs的module示例。'."\n" + .' - moduleVersion：可选参数，支持筛选特定版本的Module示例。例如：keyword设置为1.0.0时，则表示查询module版本为1.0.0的module示例。'."\n" + .' - exampleName：可选参数，支持筛选特定示例名称的Module示例。例如：keyword设置为ecs时，则表示查询module示例名称为ecs的module示例。'."\n" + ."\n" + .'响应结构包含请求 ID、总条目数、当前页数据及分页信息，便于处理查询结果。', + ], + 'CreateProject' => [ + 'summary' => '创建项目。', + 'path' => '/project', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '项目描述'."\n" + .'长度（0-1024）', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'name' => [ + 'description' => '项目名称，'."\n" + .'长度（1-128）', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-433aead7560572f8d95b25775c', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '3E49127A-BB65-5CCD-AB93-0EC0A43E5446', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"projectId\\": \\"p-433aead7560572f8d95b25775c\\",\\n \\"requestId\\": \\"3E49127A-BB65-5CCD-AB93-0EC0A43E5446\\"\\n}","type":"json"}]', + 'title' => '创建项目', + ], + 'UpdateProject' => [ + 'summary' => '更新项目信息。', + 'path' => '/project/{projectId}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '项目描述'."\n" + .'长度（0-1024）', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'name' => [ + 'description' => '项目名称，'."\n" + .'长度（1-128）', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => 'p-433aead7560572f8d95b25775c', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'C62888F6-254D-5589-BF05-0D9EE698C187', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C62888F6-254D-5589-BF05-0D9EE698C187\\"\\n}","type":"json"}]', + 'title' => '更新项目信息', + ], + 'ListProject' => [ + 'summary' => '查询项目列表。', + 'path' => '/project', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持名称搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-case2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'pageNumber' => [ + 'description' => '当前页', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'projects' => [ + 'description' => '项目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '项目信息', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-05-10T10:08:34Z', + ], + 'description' => [ + 'description' => '项目描述。', + 'type' => 'string', + 'example' => 'abc', + ], + 'name' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'example' => '1234', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-148e7853433574fffe9fec72ed9b72', + ], + 'tags' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'key', + ], + 'value' => [ + 'description' => '标签值', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'taskCnt' => [ + 'description' => '任务数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 3,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"projects\\": [\\n {\\n \\"createTime\\": \\"2022-05-10T10:08:34Z\\",\\n \\"description\\": \\"abc\\",\\n \\"name\\": \\"1234\\",\\n \\"projectId\\": \\"p-148e7853433574fffe9fec72ed9b72\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"test\\"\\n }\\n ],\\n \\"taskCnt\\": 2\\n }\\n ],\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '获取项目列表', + ], + 'GetProject' => [ + 'summary' => '查询项目。', + 'path' => '/project/{projectId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead7560572f8d95b25775c', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'project' => [ + 'description' => '项目详情', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-09-06T06:11:27Z', + ], + 'description' => [ + 'description' => '项目描述'."\n" + .'长度（0-1024）', + 'type' => 'string', + 'example' => 'abc', + ], + 'name' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'abc', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-433aead7560572f8d95b25775c', + ], + 'taskCnt' => [ + 'description' => '任务数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '7FA0FF4A-ABD4-54F6-BEAC-B4273EBA10A2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"project\\": {\\n \\"createTime\\": \\"2022-09-06T06:11:27Z\\",\\n \\"description\\": \\"abc\\",\\n \\"name\\": \\"abc\\",\\n \\"projectId\\": \\"p-433aead7560572f8d95b25775c\\",\\n \\"taskCnt\\": 2\\n },\\n \\"requestId\\": \\"7FA0FF4A-ABD4-54F6-BEAC-B4273EBA10A2\\"\\n}","type":"json"}]', + 'title' => '获取项目详情', + ], + 'DeleteProject' => [ + 'summary' => '删除项目。', + 'path' => '/project/{projectId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-148e7853433574fffe9fec72ed9b72', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'BF72A6FB-B071-5F2E-A036-9D62545B962C', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\"\\n}","type":"json"}]', + 'title' => '删除项目', + ], + 'CreateGroup' => [ + 'summary' => '创建分组。', + 'path' => '/group', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'autoDestroy' => [ + 'description' => '是否创建后删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'autoTrigger' => [ + 'description' => '是否开启自动触发策略。取值如下：-**true**：是-**false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '分组描述', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'forcedSetting' => [ + 'description' => '是否强制使用分组配置', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'name' => [ + 'description' => '分组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'notifyConfig' => [ + 'description' => '通知配置', + 'type' => 'array', + 'items' => [ + 'description' => '通知配置', + 'type' => 'object', + 'properties' => [ + 'notifyPath' => [ + 'description' => '通知的路径配置', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + 'notifyType' => [ + 'description' => '通知类型：'."\n" + .'DingDing', + 'type' => 'string', + 'required' => false, + 'example' => 'DingDing', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'notifyOperationTypes' => [ + 'description' => '通知操作类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '通知操作类型'."\n" + .'- apply：执行'."\n" + .'- refresh：刷新'."\n" + .'- destroy：销毁', + 'type' => 'string', + 'required' => false, + 'example' => 'refresh', + ], + 'required' => false, + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => 'p-433aead7560571a87349d054b4', + ], + 'ramRole' => [ + 'description' => 'RAM角色，（1-128）'."\n" + .'触发新作业时由系统扮演角色来执行模版'."\n" + .'作业触发方式非手动触发时必填', + 'type' => 'string', + 'required' => false, + 'example' => 'ramName', + ], + 'reportExportField' => [ + 'description' => '报表的导出字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报表的导出字段列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'taskName', + ], + 'required' => false, + ], + 'reportExportPath' => [ + 'description' => '运行报告的导出地址，支持oss地址'."\n" + .'https://<Oss bucket地址>/<路径>', + 'type' => 'string', + 'required' => false, + 'example' => 'https://test.oss-cn-hangzhou.aliyuncs.com/test/test', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本'."\n" + .'选择一个Terraform Provider版本，任务上配置的优先级更高。', + 'type' => 'string', + 'required' => false, + 'example' => '1.189.0', + ], + 'triggerConfig' => [ + 'description' => '触发策略'."\n" + .'autoTrigger为true时不能为空', + 'type' => 'array', + 'items' => [ + 'description' => '触发策略'."\n" + .'autoTrigger为true时不能为空', + 'type' => 'object', + 'properties' => [ + 'triggerStrategy' => [ + 'description' => '触发策略，取值：'."\n" + ."\n" + .'- ProviderNewVersion 新Provider版本发布时触发'."\n" + .'- Cron 定时触发', + 'type' => 'string', + 'required' => false, + 'example' => 'Cron', + ], + 'triggerValue' => [ + 'description' => '定时触发时需要维护策略值，cron表达式', + 'type' => 'string', + 'required' => false, + 'example' => '0 0 19 * * ？', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'triggerResourceType' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'array', + 'items' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'E2D0E863-1651-5E58-823F-B451C8C24615', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"groupId\\": \\"g-4267dcfbf1b6d128c87adf0e95f\\",\\n \\"requestId\\": \\"E2D0E863-1651-5E58-823F-B451C8C24615\\"\\n}","type":"json"}]', + 'title' => '创建分组', + ], + 'UpdateGroup' => [ + 'summary' => '修改分组。', + 'path' => '/group/{groupId}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'autoDestroy' => [ + 'description' => '是否自动删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'autoTrigger' => [ + 'description' => '是否开启自动触发策略。取值如下：-**true**：是-**false**：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'description' => [ + 'description' => '群描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'forcedSetting' => [ + 'description' => '是否强制使用分组配置', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'name' => [ + 'description' => '群组名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'notifyConfig' => [ + 'description' => '通知配置', + 'type' => 'array', + 'items' => [ + 'description' => '通知配置', + 'type' => 'object', + 'properties' => [ + 'notifyPath' => [ + 'description' => '通知的路径配置', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + 'notifyType' => [ + 'description' => '通知类型：'."\n" + .'DingDing', + 'type' => 'string', + 'required' => false, + 'example' => 'DingDing', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'notifyOperationTypes' => [ + 'description' => '通知操作类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '通知操作类型'."\n" + ."\n" + .'- apply：执行'."\n" + .'- refresh：刷新'."\n" + .'- destroy：销毁', + 'type' => 'string', + 'required' => false, + 'example' => 'refresh', + ], + 'required' => false, + ], + 'ramRole' => [ + 'description' => 'RAM角色，（1-128）'."\n" + .'触发新作业时由系统扮演角色来执行模版'."\n" + .'作业触发方式非手动触发时必填', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + 'reportExportField' => [ + 'description' => '报表的导出字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报表的导出字段列表', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + 'required' => false, + ], + 'reportExportPath' => [ + 'description' => '运行报告的导出地址，支持oss地址', + 'type' => 'string', + 'required' => false, + 'example' => '/', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本'."\n" + .'选择一个Terraform Provider版本，分组中任务将按照Terraform Provider版本执行计划。任务上配置的优先级更高。', + 'type' => 'string', + 'required' => false, + 'example' => '1.183.0', + ], + 'triggerConfig' => [ + 'description' => '触发策略'."\n" + .'autoTrigger为true时不能为空', + 'type' => 'array', + 'items' => [ + 'description' => '触发策略'."\n" + .'autoTrigger为true时不能为空', + 'type' => 'object', + 'properties' => [ + 'triggerStrategy' => [ + 'description' => '触发策略，取值：'."\n" + ."\n" + .'- ProviderNewVersion 新Provider版本发布时触发'."\n" + .'- Cron 定时触发', + 'type' => 'string', + 'required' => false, + 'example' => 'Cron', + ], + 'triggerValue' => [ + 'description' => '定时触发时需要维护策略值，cron表达式', + 'type' => 'string', + 'required' => false, + 'example' => '0 0 * * * ？', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'triggerResourceType' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'array', + 'items' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'required' => false, + 'example' => 'SceneTestingTask', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => true, + 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4EF5E823-AC0D-5CB5-8F18-1352455A488D', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4EF5E823-AC0D-5CB5-8F18-1352455A488D\\"\\n}","type":"json"}]', + 'title' => '修改指定组信息', + ], + 'GetGroup' => [ + 'summary' => '查询分组。', + 'path' => '/group/{groupId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'description' => '分组。', + 'type' => 'object', + 'properties' => [ + 'autoDestroy' => [ + 'description' => '是否自动删除', + 'type' => 'boolean', + 'example' => 'true', + ], + 'autoTrigger' => [ + 'description' => '是否自动触发', + 'type' => 'boolean', + 'example' => 'true', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-08-21T10:57:11Z', + ], + 'description' => [ + 'description' => '组描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'forcedSetting' => [ + 'description' => '是否强制使用分组配置', + 'type' => 'boolean', + 'example' => 'true', + ], + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'example' => 'g-14e80de4866bf7ffed0bab6154d738', + ], + 'name' => [ + 'description' => '组名', + 'type' => 'string', + 'example' => 'abc', + ], + 'notifyConfig' => [ + 'description' => '通知配置', + 'type' => 'array', + 'items' => [ + 'description' => '通知配置', + 'type' => 'object', + 'properties' => [ + 'notifyPath' => [ + 'description' => '通知的路径配置', + 'type' => 'string', + 'example' => '/', + ], + 'notifyType' => [ + 'description' => '通知类型：'."\n" + .'DingDing', + 'type' => 'string', + 'example' => 'DingDing', + ], + ], + ], + ], + 'notifyOperationTypes' => [ + 'description' => '通知操作类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '通知操作类型'."\n" + ."\n" + .'- apply：执行'."\n" + .'- refresh：刷新'."\n" + .'- destroy：销毁', + 'type' => 'string', + 'example' => 'refresh', + ], + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-4267dcfbf1b6d126edcadf0e949', + ], + 'ramRole' => [ + 'description' => 'RAM角色，（1-128）'."\n" + .'触发新作业时由系统扮演角色来执行模版'."\n" + .'作业触发方式非手动触发时必填', + 'type' => 'string', + 'example' => 'ramRoleName', + ], + 'reportExportField' => [ + 'description' => '报表导出位置框列表', + 'type' => 'array', + 'items' => [ + 'description' => '报表导出位置框列表', + 'type' => 'string', + 'example' => 'Task', + ], + ], + 'reportExportPath' => [ + 'description' => '运行报告的导出地址，支持oss地址'."\n" + .'https://<Oss bucket地址>/<路径>', + 'type' => 'string', + 'example' => '/', + ], + 'taskCnt' => [ + 'description' => '任务数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本'."\n" + .'选择一个Terraform Provider版本，分组中任务将按照指定的Terraform Provider版本执行计划。任务上配置的优先级更高。与module中设置的Terraform Provider版本冲突', + 'type' => 'string', + 'example' => '1.191.0', + ], + 'triggerConfig' => [ + 'description' => '触发策略'."\n" + .'autoTrigger为true时不能为空', + 'type' => 'array', + 'items' => [ + 'description' => '触发策略'."\n" + .'autoTrigger为true时不能为空', + 'type' => 'object', + 'properties' => [ + 'triggerStrategy' => [ + 'description' => '触发策略，取值：'."\n" + ."\n" + .'- ProviderNewVersion 新Provider版本发布时触发'."\n" + .'- Cron 定时触发', + 'type' => 'string', + 'example' => 'Cron', + ], + 'triggerValue' => [ + 'description' => '定时触发时需要维护策略值，cron表达式', + 'type' => 'string', + 'example' => '0 0 8 * * ?', + ], + ], + ], + ], + 'triggerResourceType' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'array', + 'items' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'string', + 'example' => 'SceneTestingTask', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"group\\": {\\n \\"autoDestroy\\": true,\\n \\"autoTrigger\\": true,\\n \\"createTime\\": \\"2022-08-21T10:57:11Z\\",\\n \\"description\\": \\"OK\\",\\n \\"forcedSetting\\": true,\\n \\"groupId\\": \\"g-14e80de4866bf7ffed0bab6154d738\\",\\n \\"name\\": \\"abc\\",\\n \\"notifyConfig\\": [\\n {\\n \\"notifyPath\\": \\"/\\",\\n \\"notifyType\\": \\"DingDing\\"\\n }\\n ],\\n \\"notifyOperationTypes\\": [\\n \\"refresh\\"\\n ],\\n \\"projectId\\": \\"p-4267dcfbf1b6d126edcadf0e949\\",\\n \\"ramRole\\": \\"ramRoleName\\",\\n \\"reportExportField\\": [\\n \\"Task\\"\\n ],\\n \\"reportExportPath\\": \\"/\\",\\n \\"taskCnt\\": 3,\\n \\"terraformProviderVersion\\": \\"1.191.0\\",\\n \\"triggerConfig\\": [\\n {\\n \\"triggerStrategy\\": \\"Cron\\",\\n \\"triggerValue\\": \\"0 0 8 * * ?\\"\\n }\\n ],\\n \\"triggerResourceType\\": [\\n \\"SceneTestingTask\\"\\n ]\\n },\\n \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\"\\n}","type":"json"}]', + 'title' => '获取分组信息', + ], + 'ListGroup' => [ + 'summary' => '查询分组列表。', + 'path' => '/group', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，默认1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-14e80de4866bf7ffed0c4072ed9b37', + ], + ], + [ + 'name' => 'keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词，支持名称搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-case2', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'groups' => [ + 'description' => '服务组id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务组id列表。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-09-14T07:19:13Z', + ], + 'description' => [ + 'description' => '组描述', + 'type' => 'string', + 'example' => 'OK', + ], + 'groupId' => [ + 'description' => '分组ID', + 'type' => 'string', + 'example' => 'g-148e7853433574fffe9fec72ed9b73', + ], + 'isDefault' => [ + 'description' => '是否为默认分组。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'moduleCnt' => [ + 'description' => '模板数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'name' => [ + 'description' => '组名', + 'type' => 'string', + 'example' => '1', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'example' => 'p-4267dcfbf1b6d126edcadf0e949', + ], + 'sceneTestingTaskCnt' => [ + 'description' => '场景化测试任务数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'tags' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'key', + ], + 'value' => [ + 'description' => '标签值', + 'type' => 'string', + 'example' => 'iac', + ], + ], + ], + ], + 'taskCnt' => [ + 'description' => '任务数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + 'pageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '分页大小，每页做多显示的返回结果数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 3,\\n \\"groups\\": [\\n {\\n \\"createTime\\": \\"2022-09-14T07:19:13Z\\",\\n \\"description\\": \\"OK\\",\\n \\"groupId\\": \\"g-148e7853433574fffe9fec72ed9b73\\",\\n \\"isDefault\\": true,\\n \\"moduleCnt\\": 1,\\n \\"name\\": \\"1\\",\\n \\"projectId\\": \\"p-4267dcfbf1b6d126edcadf0e949\\",\\n \\"sceneTestingTaskCnt\\": 1,\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"iac\\"\\n }\\n ],\\n \\"taskCnt\\": 3\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\"\\n}","type":"json"}]', + 'title' => '获取分组列表', + ], + 'DeleteGroup' => [ + 'summary' => '删除分组。', + 'path' => '/group/{groupId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3\\"\\n}","type":"json"}]', + 'title' => '删除分组', + ], + 'AssociateGroup' => [ + 'summary' => '分组关联。', + 'path' => '/group/{groupId}/associate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => true, + 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => false, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'projectId' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead7560571a87349d054b4', + ], + 'resourceIds' => [ + 'description' => '资源ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'task-433aead7560571a87', + ], + 'required' => true, + ], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- SceneTestingTask 场景化测试任务'."\n" + .'- Task 常规任务'."\n" + .'- Module 模板', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + ], + 'required' => false, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\"\\n}","type":"json"}]', + 'title' => '资源关联分组', + ], + 'DissociateGroup' => [ + 'summary' => '取消关联分组。', + 'path' => '/group/{groupId}/dissociate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => false, + 'example' => 'p-433aead7560572f8d95b25775c', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => true, + 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => false, + 'example' => '2daf4227f747cbf11a5501f18cc5e004', + ], + 'resourceIds' => [ + 'description' => '资源ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'task-abc', + ], + 'required' => true, + ], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- Module 模版'."\n" + .'- SceneTestingTask 场景化测试任务'."\n" + .'- Task 常规任务', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + ], + 'required' => false, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '17793D91-A26F-520D-A948-3452A45D15B1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"17793D91-A26F-520D-A948-3452A45D15B1\\"\\n}","type":"json"}]', + 'title' => '资源解除分组关联', + ], + 'ManageTerraformState' => [ + 'summary' => '支持状态文件的资源导入和移除', + 'path' => '/terraformState/manage', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREopenapiexplorer7MPML0', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'type' => 'string', + 'required' => true, + 'example' => 'a65451293e64979ba7a4b573950217fe', + ], + 'type' => [ + 'description' => '任务类型'."\n" + .'- Stack'."\n" + .'- Task', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Task' => 'Task', + 'Stack' => 'Stack', + ], + 'example' => 'Stack', + ], + 'identifier' => [ + 'description' => '任务标识符。Stack 任务为 <$stackId>:<$deploymentName>；Task 任务为 <$TaskId>', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'stack-as11xxxxxxxxx:developmentA', + ], + 'resourceIdentifier' => [ + 'description' => '资源在 Terraform 模版中的标识符。Stack 任务为<$componetName>:<$resourceName>。Task 任务为<$resourceName>', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc:alicloud_vswitch.vswitches[0]', + ], + 'action' => [ + 'description' => '状态文件修改行为，支持导入和移除'."\n" + .'- Import'."\n" + .'- StateRemove', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Import' => 'Import', + 'StateRemove' => 'StateRemove', + ], + 'example' => 'Import', + ], + 'importResourceId' => [ + 'description' => 'Terraform 资源真实的资源 Id', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0A80B4F1-4E8C-515A-B3C1-0E1A9B85B6A7', + ], + 'jobId' => [ + 'description' => '作业ID', + 'type' => 'string', + 'example' => 'job-5fd38c9xxxxx', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A80B4F1-4E8C-515A-B3C1-0E1A9B85B6A7\\",\\n \\"jobId\\": \\"job-5fd38c9xxxxx\\"\\n}","type":"json"}]', + 'title' => '管理任务状态文件', + 'description' => '该API主要用于进行自动化服务台上资源编排任务和资源栈任务状态文件的管理。'."\n" + ."\n" + .'使用此API前，请确保已正确配置了所有必要的认证信息，并且Terraform代码符合预期的功能需求。', + ], + 'GenerateModule' => [ + 'summary' => '生成Terraform HCL模板代码', + 'path' => '/explorer/generate/module', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body。', + 'type' => 'object', + 'properties' => [ + 'parameters' => [ + 'description' => '参数集合，通过key:value的格式传参，比如{"vpc_name":"vpc-test"}', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'readOnly' => false, + 'example' => 'vpc-test', + 'description' => '参数值', + ], + 'readOnly' => false, + ], + 'regionId' => [ + 'description' => '区域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + 'readOnly' => false, + ], + 'syntax' => [ + 'description' => '语法'."\n" + .'- hcl（默认）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'hcl' => 'hcl', + ], + 'example' => 'hcl', + 'readOnly' => false, + ], + 'terraformProviderVersion' => [ + 'description' => 'terraformProvider版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.260.0', + 'readOnly' => false, + ], + 'terraformResourceType' => [ + 'description' => 'terraform资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud_vpc', + 'readOnly' => false, + ], + 'generateSource' => [ + 'description' => '生成来源，枚举：'."\n" + .'- Resource：根据资源属性生成Terraform HCL模版'."\n" + .'- VariableToCode：根据变量和Terraform HCL模版生成最终结合后的Terraform HCL模版'."\n" + .'- CodeToVariable：根据Terraform HCL模版提取其中的变量信息'."\n" + .'- Module：根据变量生成Terraform Module代码；', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Resource' => 'Resource', + 'VariableToCode' => 'VariableToCode', + 'CodeToVariable' => 'CodeToVariable', + 'Module' => 'Module', + ], + 'example' => 'Resource', + ], + 'template' => [ + 'description' => '原有的Terraform HCL模版内容', + 'type' => 'string', + 'required' => false, + 'example' => 'terraform {'."\n" + .'}', + ], + ], + 'required' => false, + 'readOnly' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'module' => [ + 'description' => '生成的Terraform HCL模版代码内容', + 'type' => 'string', + 'example' => 'terraform {'."\n" + .' required_providers {'."\n" + .' alicloud = {'."\n" + .' source = "aliyun/alicloud"'."\n" + .' version = "1.260.0"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'resource "alicloud_vpc" "default" {'."\n" + .' vpc_name = "vpc-test"'."\n" + .'}', + 'readOnly' => false, + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '6B40D088-E929-504B-8802-C1759A993FA2', + 'readOnly' => false, + ], + 'properties' => [ + 'description' => '生成的模版代码中的变量和资源属性；', + 'type' => 'object', + 'example' => '{"vpc_name":"vpc-test"}', + ], + ], + 'readOnly' => false, + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"module\\": \\"terraform {\\\\n required_providers {\\\\n alicloud = {\\\\n source = \\\\\\"aliyun/alicloud\\\\\\"\\\\n version = \\\\\\"1.260.0\\\\\\"\\\\n }\\\\n }\\\\n}\\\\n\\\\nresource \\\\\\"alicloud_vpc\\\\\\" \\\\\\"default\\\\\\" {\\\\n vpc_name = \\\\\\"vpc-test\\\\\\"\\\\n}\\",\\n \\"requestId\\": \\"6B40D088-E929-504B-8802-C1759A993FA2\\",\\n \\"properties\\": {\\n \\"vpc_name\\": \\"vpc-test\\"\\n }\\n}","type":"json"}]', + 'title' => '生成Terraform HCL模板代码', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'iac.cn-zhangjiakou.aliyuncs.com', + ], + ], +]; |