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 | 17861 |
1 files changed, 9625 insertions, 8236 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 index 8b7e6fa..a198362 100644 --- a/data/zh_cn/iacservice/2021-08-06/api-docs.php +++ b/data/zh_cn/iacservice/2021-08-06/api-docs.php @@ -1,220 +1,145 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'IaCService', - 'version' => '2021-08-06', - ], + 'info' => ['style' => 'ROA', 'product' => 'IaCService', 'version' => '2021-08-06'], 'directories' => [ [ - 'id' => 171780, - 'title' => '模板', + 'children' => ['UpdateProject', 'ListProject', 'GetProject', 'DeleteProject', 'CreateProject'], 'type' => 'directory', - 'children' => [ - 'CreateModule', - 'UpdateModuleAttribute', - 'ListModules', - 'GetModule', - 'DeleteModule', - ], + 'title' => '项目', + 'id' => 459278, ], [ - 'id' => 172110, - 'title' => '模板版本', + 'children' => ['GetStack', 'GetStackDeployments', 'UpdateStack', 'TriggerStackExecution', 'ListStacks', 'ListStackConfigs', 'GetStackExecutionResult', 'DeleteStack', 'CreateStack'], 'type' => 'directory', - 'children' => [ - 'CreateModuleVersion', - 'GetModuleVersion', - 'ListModuleVersion', - ], + 'title' => 'Stack', + 'id' => 423985, ], [ - 'id' => 171831, - 'title' => '任务', + 'children' => ['CreateModule', 'UpdateModuleAttribute', 'ListModules', 'GetModule', 'DeleteModule'], 'type' => 'directory', - 'children' => [ - 'CreateTask', - 'UpdateTaskAttribute', - 'ListTasks', - 'GetTask', - 'DeleteTask', - ], + 'title' => '模板', + 'id' => 288807, ], [ - 'id' => 171775, - 'title' => '作业', + 'children' => ['CreateModuleVersion', 'GetModuleVersion', 'ListModuleVersion'], 'type' => 'directory', - 'children' => [ - 'CreateJob', - 'OperateJob', - 'ListJobs', - 'GetJob', - ], + 'title' => '模板版本', + 'id' => 288895, ], [ - 'id' => 171820, - 'title' => '资源导出任务', + 'children' => ['ListTasks', 'GetTask', 'DeleteTask', 'CreateTask', 'UpdateTaskAttribute'], 'type' => 'directory', - 'children' => [ - 'CreateResourceExportTask', - 'UpdateResourceExportTaskAttribute', - 'ListResourceExportTasks', - 'GetResourceExportTask', - 'CancelResourceExportTask', - 'ExecuteResourceExportTask', - 'DeleteResourceExportTask', - 'ListResourceExportTaskVersions', - ], + 'title' => '任务', + 'id' => 288845, ], [ - 'id' => 205402, - 'title' => '工作空间', + 'children' => ['ListJobs', 'CreateJob', 'OperateJob', 'GetJob'], 'type' => 'directory', - 'children' => [ - 'CreateRegistryNamespace', - 'UpdateRegistryNamespaceAttribute', - 'ListRegistryNamespaces', - 'GetRegistryNamespace', - 'DeleteRegistryNamespace', - 'AddSharedAccounts', - 'RemoveSharedAccounts', - ], + 'title' => '作业', + 'id' => 288802, ], [ - 'id' => 205400, - 'title' => 'Registry模版', + 'children' => ['CreateResourceExportTask', 'UpdateResourceExportTaskAttribute', 'ListResourceExportTasks', 'GetResourceExportTask', 'CancelResourceExportTask', 'ExecuteResourceExportTask', 'DeleteResourceExportTask', 'ListResourceExportTaskVersions'], 'type' => 'directory', - 'children' => [ - 'CreateRegistryModule', - 'UpdateRegistryModuleAttribute', - 'ListRegistryModules', - 'GetRegistryModule', - 'DeleteRegistryModule', - 'PublishRegistryModuleVersion', - 'ListRegistryModuleVersions', - 'GetRegistryModuleVersion', - 'DeleteRegistryModuleVersion', - ], + 'title' => '资源导出任务', + 'id' => 288835, ], [ - 'id' => 172263, + 'children' => ['CreateRegistryNamespace', 'UpdateRegistryNamespaceAttribute', 'ListRegistryNamespaces', 'GetRegistryNamespace', 'DeleteRegistryNamespace', 'AddSharedAccounts', 'RemoveSharedAccounts'], + 'type' => 'directory', + 'title' => '工作空间', + 'id' => 288942, + ], + [ + 'children' => ['CreateRegistryModule', 'UpdateRegistryModuleAttribute', 'ListRegistryModules', 'GetRegistryModule', 'DeleteRegistryModule', 'PublishRegistryModuleVersion', 'ListRegistryModuleVersions', 'GetRegistryModuleVersion', 'DeleteRegistryModuleVersion'], + 'type' => 'directory', + 'title' => 'Registry模版', + 'id' => 288932, + ], + [ + 'children' => ['GetProviderDocument', 'ListProducts', 'ListTerraformProviderVersions', 'ListResourceTypes', 'GetResourceType'], + 'type' => 'directory', 'title' => '元数据', + 'id' => 288916, + ], + [ + 'children' => ['UploadModule'], 'type' => 'directory', - 'children' => [ - 'ListTerraformProviderVersions', - 'ListProducts', - 'ListResourceTypes', - 'GetResourceType', - ], + 'title' => '模板任务相关', + 'id' => 288969, ], [ - 'id' => 205406, - 'title' => 'Explorer模板', + 'children' => ['DetectTerraformState', 'GetDetectConfig', 'DeleteDetectConfig', 'DissociateDetectConfig', 'ListDetectConfigs', 'AssociateDetectConfig', 'CreateDetectConfig', 'ListDetectConfigRelations', 'UpdateDetectConfig'], 'type' => 'directory', - 'children' => [ - 'UpdateExplorerModuleAttribute', - ], + 'title' => '偏差检测', + 'id' => 459279, ], [ - 'id' => 244873, - 'title' => 'Terraform执行', + 'children' => ['UpdateExplorerModuleAttribute'], 'type' => 'directory', - 'children' => [ - 'ValidateModule', - 'ExecuteTerraformApply', - 'ExecuteTerraformDestroy', - 'GetExecuteState', - 'ExecuteTerraformPlan', - ], + 'title' => 'Explorer模板', + 'id' => 288956, ], [ - 'id' => 245334, - 'title' => '官方RegistryModule', + 'children' => ['ValidateModule', 'ExecuteTerraformApply', 'ExecuteTerraformDestroy', 'GetExecuteState', 'ExecuteTerraformPlan'], 'type' => 'directory', - 'children' => [ - 'ExecuteRegistryModule', - 'ListExplorerRegistryModuleVersions', - 'ListExplorerRegistryModules', - 'ListExplorerRegistryModuleExamples', - ], + 'title' => 'Terraform执行', + 'id' => 288977, ], [ - 'id' => 171803, - 'title' => '项目', + 'children' => ['ExecuteRegistryModule', 'ListExplorerRegistryModuleVersions', 'ListExplorerRegistryModules', 'ListExplorerRegistryModuleExamples'], 'type' => 'directory', - 'children' => [ - 'CreateProject', - 'UpdateProject', - 'ListProject', - 'GetProject', - 'DeleteProject', - ], + 'title' => '官方RegistryModule', + 'id' => 288983, ], [ - 'id' => 171885, - 'title' => '分组', + 'children' => ['CreateParameterSet', 'UpdateParameterSetAttribute', 'ListParameterSets', 'GetParameterSet', 'DeleteParameterSet', 'AssociateParameterSet', 'DissociateParameterSet', 'ListParameterSetRelation'], 'type' => 'directory', - 'children' => [ - 'CreateGroup', - 'UpdateGroup', - 'GetGroup', - 'ListGroup', - 'DeleteGroup', - 'AssociateGroup', - 'DissociateGroup', - ], + 'title' => '参数集', + 'id' => 288813, ], [ - 'id' => 371929, - 'title' => '状态管理', + 'children' => ['DeleteGroup', 'CreateGroup', 'GetGroup', 'ListGroup', 'UpdateGroup', 'AssociateGroup', 'DissociateGroup'], 'type' => 'directory', - 'children' => [ - 'ManageTerraformState', - ], + 'title' => '分组', + 'id' => 288884, ], [ - 'id' => 171857, - 'title' => '其他', + 'children' => ['GetTerraformStateDetection', 'ManageTerraformState'], 'type' => 'directory', - 'children' => [ - 'GenerateModule', - ], + 'title' => '状态管理', + 'id' => 361797, + ], + [ + 'children' => ['GenerateModule', 'ListResources'], + 'type' => 'directory', + 'title' => '其他', + 'id' => 288852, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateModule' => [ - 'summary' => '创建一个模板。', - 'path' => '/modules', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AddSharedAccounts' => [ + 'summary' => '添加共享账号。', + 'path' => '/sharedAccounts', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ @@ -222,117 +147,31 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '请求体参数', + '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', + 'accountIds' => [ + 'description' => '云账号ID列表', + 'type' => 'array', + 'items' => ['description' => '云账号ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '云账号ID'], 'required' => false, - 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/terraform.tfstate', + 'maxItems' => 100, + 'minItems' => 1, ], - 'versionStrategy' => [ - 'description' => '版本生成策略,取值'."\n" + 'resourceId' => ['description' => '共享的资源ID'."\n" + ."\n" + .' - 类型为Namespace时取值工作空间名称 '."\n" + ."\n" + .'- 类型为RegistryModule时取值 \\<namespaceName>/\\<ModuleName>', 'type' => 'string', 'required' => false, 'example' => 'terraform-alicloud-modules/mongodb'], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" ."\n" - .'- Manual :手动生成版本(默认)'."\n" - .'- SourcePathUpdated ：'."\n" - .' 修改sourcePath触发生成新版本', + .'- RegistryModule :Registry模板'."\n" + .'- Namespace：工作空间', '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, + 'example' => 'RegistryModule', + 'enum' => ['RegistryModule', 'Namespace'], ], ], 'required' => false, @@ -343,57 +182,57 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '0D797DC3-FF04-5C21-81EB-XXXXXXXXX'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"moduleId\\": \\"mod-518855d9a058cfffcc446d8fe3c99\\",\\n \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-92C7799512E3\\"\\n}","type":"json"}]', - 'title' => '创建模板', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '添加共享账号', 'description' => '单用户调用频率：100 次/秒。', - ], - 'UpdateModuleAttribute' => [ - 'summary' => '修改模板的属性。', - 'path' => '/modules/{moduleId}', - 'methods' => [ - 'put', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSharedAccounts'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:AddSharedAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-XXXXXXXXX\\"\\n}","type":"json"}]', + ], + 'AssociateDetectConfig' => [ + 'summary' => '关联偏差检测配置', + 'path' => '/terraformState/detectConfig/operations/associate', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ @@ -401,117 +240,90 @@ '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', + 'detectConfigId' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'required' => true, 'example' => 'dc-xxxx'], + 'targetId' => ['description' => '关联目标 Id。StackId 或 TaskId', 'type' => 'string', 'required' => true, 'example' => 'stack-xxxxx'], + 'targetType' => [ + 'description' => '关联目标类型'."\n" + .'- Task 编排任务'."\n" + .'- Stack 资源栈', '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, + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', ], ], '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' => 'BF75EF50-955D-5E1F-AB23-A657C2C6D3C7'], + ], + ], + ], + ], + 'title' => '关联偏差检测配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF75EF50-955D-5E1F-AB23-A657C2C6D3C7\\"\\n}","type":"json"}]', + ], + 'AssociateGroup' => [ + 'summary' => '分组关联。', + 'path' => '/group/{groupId}/associate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'moduleId', + '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' => '模板ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mod-62ecaa43022ce189d65f8d4a794', + '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, ], ], ], @@ -522,344 +334,463 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', + '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' => '资源关联分组', + 'changeSet' => [], + 'ramActions' => [], + ], + 'AssociateParameterSet' => [ + 'summary' => '关联参数集。', + 'path' => '/parameterSets/operations/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' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'parameterSetIds' => [ + 'description' => '新增关联到资源上的参数集ID列表，最大长度 5', + 'type' => 'array', + 'items' => ['description' => '参数集ID', 'type' => 'string', 'required' => true, 'example' => 'pts-xxxxx'], + 'required' => true, + ], + 'resourceId' => ['description' => '资源ID'."\n" + .'资源类型为ModuleVersion时，'."\n" + .'由<moduleId>-<moduleversion>拼接而成，'."\n" + .'如mod-34535345df123fr-v3', 'type' => 'string', 'required' => true, 'example' => 'task-433aead756057ffdf5326bf1e12ed'], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- Module 模板'."\n" + .'- ModuleVersion 模板版本'."\n" + .'- Task 任务'."\n" + .'- Stack 资源栈', 'type' => 'string', - 'example' => 'CA05185E-6B90-5941-98D4-7212688AECC8', + 'required' => true, + 'enumValueTitles' => ['Task' => 'Task', 'ModuleVersion' => 'ModuleVersion', 'Module' => 'Module', 'Stack' => 'Stack'], + 'example' => 'Task', ], ], + 'required' => false, ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CA05185E-6B90-5941-98D4-7212688AECC8\\"\\n}","type":"json"}]', - 'title' => '修改模板', - 'description' => '单用户调用频率：100 次/秒。', - ], - 'ListModules' => [ - 'summary' => '获取模板列表。', - 'path' => '/modules', - 'methods' => [ - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BF75EF50-955D-5E1F-AB23-A657C2C6D3C7'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF75EF50-955D-5E1F-AB23-A657C2C6D3C7\\"\\n}","type":"json"}]', + 'title' => '关联参数集', + 'description' => '创建参数集之后需要绑定资源，资源类型，取值'."\n" + ."\n" + .'- Module 模板'."\n" + .'- ModuleVersion 模板版本'."\n" + .'- Task 任务。', + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:06.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:AssociateParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CancelResourceExportTask' => [ + 'summary' => '取消执行资源导出任务。', + 'path' => '/exportTasks/cancel/{exportTaskId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], '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' => 'exportTaskId', + 'in' => 'path', + 'schema' => ['description' => '资源导出ID', 'type' => 'string', 'required' => true, 'example' => 'ex-445dcb7d0ac661ff08be459a75f'], ], [ - 'name' => 'pageNumber', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + ], 'required' => false, - 'minimum' => '1', - 'example' => '1', ], ], - [ - 'name' => 'projectId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => false, - 'example' => 'p-al1c58tb2lu9oej36kclvf', + '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 次/秒。', + 'changeSet' => [], + 'ramActions' => [], + ], + 'CreateDetectConfig' => [ + 'path' => '/terraformState/detectConfig', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'groupId', - 'in' => 'query', - 'schema' => [ - 'description' => '分组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'g-kw1a50tj8rk7cki2q8bbat', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'tag', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '模板标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模板标签列表。', - 'type' => 'object', - 'properties' => [ - 'tagKey' => [ - 'description' => '模板的标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'tagValue' => [ - 'description' => '模板的标签值。', - 'type' => 'string', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等token，格式: `[0-9a-zA-Z-]{1,64}`，建议使用UUID'."\n", 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'description' => ['description' => '描述，长度不超过 256 个字符。', 'type' => 'string', 'required' => false, 'example' => 'example'], + 'enabled' => ['description' => '是否开启检测功能，默认为 `true`'."\n", 'type' => 'boolean', 'required' => false], + 'triggerType' => [ + 'description' => '触发类型'."\n" + .'- Manual: 手动执行'."\n" + .'- Cron: 定时触发'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Manual', + 'enum' => ['Manual', 'Cron'], + ], + 'cronExpression' => ['description' => 'cron 表达式（北京时间）。当触发类型为 `Cron` 时必填'."\n", 'type' => 'string', 'required' => false, 'example' => '0 0 0 ? * 1'], + 'alarmConfigs' => [ + 'description' => '告警地址列表'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '报警途径。当前仅支持 `cms`', 'type' => 'string', 'required' => false, 'example' => 'cms'], + 'address' => ['description' => '报警地址。'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://metrichub-cms-cn-hangzhou.aliyuncs.com/event/notify?xxxxx'], + ], 'required' => false, - 'example' => 'TestValue', + 'description' => '', ], + 'required' => false, ], - 'required' => false, + 'detectConfigName' => ['description' => '检测配置名称'."\n", 'type' => 'string', 'required' => true, 'example' => 'test'], ], 'required' => false, ], ], - [ - 'name' => 'moduleName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => '- **requestId**: 请求ID'."\n" + .'- **detectConfigId**: 检测配置的ID'."\n", 'type' => 'object', 'properties' => [ - 'modules' => [ - 'description' => '模板列表。', + 'detectConfigId' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'example' => 'dc-xxxx'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => 'String'], + ], + ], + ], + ], + 'title' => '创建偏差检测配置', + 'summary' => '用于创建偏差检测配置，支持手动或定时触发。', + 'description' => '## 请求说明'."\n" + .'- `triggerType` 设置为 `Cron` 时，必须提供有效的 `cronExpression`。'."\n" + .'- `alarmConfigs` 列表中每个元素需指定报警途径 `type` 和对应的报警地址 `address`。'."\n" + .'- 如果未明确设置 `enabled` 参数，默认值为 `true`，即新创建的检测配置默认处于启用状态。'."\n" + .'- 建议使用 UUID 作为 `clientToken` 的值以确保请求的幂等性。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"detectConfigId\\": \\"dc-xxxx\\",\\n \\"requestId\\": \\"String\\"\\n}","type":"json"}]', + ], + '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' => '模板列表。', + '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', - ], - ], - ], - ], + 'notifyPath' => ['description' => '通知的路径配置', 'type' => 'string', 'required' => false, 'example' => '/'], + 'notifyType' => ['description' => '通知类型：'."\n" + .'DingDing', 'type' => 'string', 'required' => false, 'example' => 'DingDing'], ], + 'required' => false, ], + 'required' => false, ], - 'pageNumber' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'notifyOperationTypes' => [ + 'description' => '通知操作类型列表', + 'type' => 'array', + 'items' => ['description' => '通知操作类型'."\n" + .'- apply：执行'."\n" + .'- refresh：刷新'."\n" + .'- destroy：销毁', 'type' => 'string', 'required' => false, 'example' => 'refresh'], + 'required' => false, ], - 'pageSize' => [ - 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + '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, ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C617E03B-3DD2-5F0C-A6CF-3028B499A2D5', + '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, ], - 'totalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2790', + '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, ], ], ], - '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', + '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' => '创建分组', + 'changeSet' => [ + ['createdAt' => '2023-01-10T09:03:10.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/*'], + ], + ], + ], + ], + ], + 'CreateJob' => [ + 'summary' => '创建作业并运行任务。', + 'path' => '/tasks/{taskId}/jobs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'moduleId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '模板ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mod-148e7853433574fffe9ca86154d77a', + '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 => [ @@ -868,186 +799,137 @@ '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', - ], + 'jobId' => ['description' => '作业ID', 'type' => 'string', 'example' => 'job-518855d98c319561f'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9'], ], ], ], ], - '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' => '获取模板详情', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"jobId\\": \\"job-518855d98c319561f\\",\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '创建作业并运行', 'description' => '单用户调用频率：100 次/秒。', - ], - 'DeleteModule' => [ - 'summary' => '删除模板。', - 'path' => '/modules/{moduleId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-04-18T09:09:02.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-02-11T03:32:12.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-07-23T09:04:16.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2023-04-13T07:25:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/*'], + ], + ], + 'additionalActions' => [], + ], ], + ], + 'CreateModule' => [ + 'summary' => '创建一个新的 Terraform模板，支持多种来源方式（OSS 导入、Registry 导入、文件上传、在线编辑等）', + 'path' => '/modules', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'moduleId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ 'title' => 'A short description of struct', - 'description' => '模板ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mod-14e80de4866bf71ef354cc82d17f', + 'description' => '请求参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等参数，建议使用uuid。', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'description' => ['description' => '模板描述，长度不超过256个字符。', 'type' => 'string', 'required' => false, 'example' => 'ECS instance module'], + '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' => 'my-ecs-module'], + 'source' => [ + 'description' => '创建来源，取值'."\n" + .'- OSS：从OSS存储的ZIP文件导入；'."\n" + .'- Registry : 使用模板中心的模块来创建；'."\n" + .'- ExportTask：引用资源导出任务导出的模板'."\n" + .'- Editor：空白模板，支持在线编辑；'."\n" + .'- Upload：用本地的模板文件上传生成；', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['ExportTask' => '通过资源导出任务生成的模板创建', 'Upload' => '用本地的模板文件上传生成', 'Registry' => '使用Registry的模块创建', 'Editor' => '空白模板，支持在线编辑', 'OSS' => '基于OSS中的模板文件导入生成'], + 'example' => 'OSS', + ], + 'sourcePath' => ['description' => '模板来源的路径值，当source为Registry、OSS、ExportTask时有效'."\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'."\n" + .'- 来源为Editor或者Upload时，该参数为空', 'type' => 'string', 'required' => false, 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'], + 'statePath' => ['description' => '模板对应的State文件的路径值，目前只针对source为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, ], ], ], @@ -1058,60 +940,64 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '49DA6457-E545-5095-A930-EB8F0BCD4DAA', - ], + '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 \\"requestId\\": \\"49DA6457-E545-5095-A930-EB8F0BCD4DAA\\"\\n}","type":"json"}]', - 'title' => '删除模板', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"moduleId\\": \\"mod-518855d9a058cfffcc446d8fe3c99\\",\\n \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-92C7799512E3\\"\\n}","type":"json"}]', + 'title' => '创建模板', 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [ + ['createdAt' => '2022-11-30T05:38:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:48.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/*'], + ], + ], + ], + ], ], 'CreateModuleVersion' => [ - 'summary' => '发布模板版本。', + 'summary' => '为指定模板发布新版本', 'path' => '/modules/{moduleId}/versions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ 'name' => 'moduleId', 'in' => 'path', - 'schema' => [ - 'description' => '模板ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mod-433aead756057143bd9145a5258', - ], + 'schema' => ['description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => 'mod-433aead756057143bd9145a5258'], ], [ 'name' => 'body', @@ -1121,27 +1007,12 @@ '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', - ], + '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, ], @@ -1154,74 +1025,191 @@ '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', - ], + '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', + 'title' => '创建模板版本', + 'description' => '## 请求说明'."\n" + .'- 使用 `clientToken` 参数可以保证请求的幂等性，防止网络重试导致的重复提交。'."\n" + .'- 建议使用语义化版本号（如 `v1.0.0`）。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModuleVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/*'], + ], + ], + ], ], + ], + 'CreateParameterSet' => [ + 'summary' => '用于添加新的参数集，支持设置名称、描述及参数列表等信息。', + 'path' => '/parameterSets', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'moduleId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '模板ID', - 'type' => 'string', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe', 'title' => '幂等参数，建议使用uuid。'], + 'description' => ['description' => '参数集描述，最大长度 1024', 'type' => 'string', 'required' => false, 'example' => 'This is parameterSet', 'title' => '参数描述。取值范围：1~1024个字符。'], + 'name' => ['description' => '参数集名称，最大长度128', 'type' => 'string', 'required' => true, 'example' => 'demo', 'title' => '参数集名称。取值范围：内容限制为字母、数字、中划线、下划线，长度不能超过128字符，且不能以aliyun、acs、alibaba、alicloud、oos开头。'], + 'parameters' => [ + 'description' => '参数列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数集内容', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'region', 'title' => '参数名称'], + 'type' => [ + 'description' => '参数类型（string/number/bool/map(string)/list(string)）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['number' => '数值', 'string' => '字符', 'bool' => '布尔', 'map(string)' => 'map', 'list(string)' => '数组'], + 'example' => 'string', + 'title' => '参数类型', + ], + 'value' => ['description' => '参数值（复杂类型用 JSON）', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => '参数值'], + 'status' => [ + 'description' => '参数集状态，枚举：'."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值'."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为null', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['EXPLICIT_NULL' => '显式设置为 null', 'HAS_VALUE' => '定义具体值'], + 'example' => 'HAS_VALUE', + 'title' => '参数集状态，枚举：'."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值'."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为null', + ], + 'secret' => ['title' => '是否保密参数，保密参数在接口返回时以及控制台展示会进行隐藏，并进行加密存储', 'type' => 'boolean'], + ], + 'required' => false, + 'title' => '参数', + ], + 'required' => false, + 'title' => '参数集中包含的参数。最多支持1000个参数', + ], + ], 'required' => false, - 'example' => 'mod-14e80de4866bf71c92a04fe353b1', + 'title' => '请求体参数。', ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'parameterSetId' => ['description' => '参数集ID', 'type' => 'string', 'example' => 'pts-3b6cb9fa4751afff89a4b73779e0d'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '7FA0FF4A-ABD4-54F6-BEAC-B4273EBA10A2'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建参数集', + 'description' => '## 请求说明'."\n" + .'- 该接口用于创建一个新的参数集。'."\n" + .'- `name` 字段为必填项，最大长度为128个字符。'."\n" + .'- `parameters` 数组中每个元素必须包含 `name` 字段，其他字段为可选项。'."\n" + .'- 支持通过 `clientToken` 字段保证请求的幂等性。'."\n" + .'- 请求头需要包含认证信息以确保安全访问。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:07.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:ParameterSet/*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parameterSetId\\": \\"pts-3b6cb9fa4751afff89a4b73779e0d\\",\\n \\"requestId\\": \\"7FA0FF4A-ABD4-54F6-BEAC-B4273EBA10A2\\"\\n}","type":"json"}]', + ], + 'CreateProject' => [ + 'summary' => '创建项目。', + 'path' => '/project', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'moduleVersion', - 'in' => 'path', + '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' => 'string', + '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, - 'example' => 'v1', ], ], ], @@ -1232,161 +1220,165 @@ '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', - ], - ], - ], + '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 \\"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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"projectId\\": \\"p-433aead7560572f8d95b25775c\\",\\n \\"requestId\\": \\"3E49127A-BB65-5CCD-AB93-0EC0A43E5446\\"\\n}","type":"json"}]', + 'title' => '创建项目', + 'changeSet' => [ + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProject'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/*'], + ], + ], + ], ], + ], + 'CreateRegistryModule' => [ + 'summary' => '创建Registry模版。', + 'path' => '/registryModule', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'moduleId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '模板ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mod-433aead756057fff39b2f7ac8b798', + '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, ], ], - [ - 'name' => 'keyword', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '搜索关键词，支持对版本名称的模糊搜索', - 'type' => 'string', - 'required' => false, - 'example' => 'key', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRegistryModule'], + ], + ], + 'ramActions' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/*'], + ], ], ], + ], + ], + 'CreateRegistryNamespace' => [ + 'summary' => '创建工作空间。', + 'path' => '/registryNamespace', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', + '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' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', + '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, - 'example' => '1', ], ], ], @@ -1397,107 +1389,55 @@ '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', - ], - ], - ], - ], + 'namespaceName' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'NamespaceName'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'B4672AE3-C313-5B7A-BB24-45345570D398'], ], ], ], ], - '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' => '获取模板版本列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"requestId\\": \\"B4672AE3-C313-5B7A-BB24-45345570D398\\"\\n}","type":"json"}]', + 'title' => '创建工作空间', 'description' => '单用户调用频率：100 次/秒。', - ], - 'CreateTask' => [ - 'summary' => '创建任务。', - 'path' => '/tasks', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRegistryNamespace'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateRegistryNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/*'], + ], + ], + ], ], + ], + 'CreateResourceExportTask' => [ + 'summary' => '创建资源导出任务。', + 'path' => '/exportTasks', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -1510,186 +1450,92 @@ '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' => '项目分组信息。', + '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' => [ - 'groupId' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'g-5fd38c9b83a86432e2', - ], - 'projectId' => [ - 'description' => '项目ID', + 'source' => [ + 'description' => '导出后的模板保存的Module类型。可选值：'."\n" + ."\n" + .'- OSS ：OSS'."\n" + .'- Registry: Terraform Registry', 'type' => 'string', 'required' => false, - 'example' => 'p-433aeade5d9167608', + '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, ], - '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' => '资源保护策略列表', + 'includeRules' => [ + 'description' => '导出资源时使用的包含规则列表', 'type' => 'array', 'items' => [ - 'description' => '资源保护策略：'."\n" - ."\n" - .'- PreventDestroy：对应的是删除保护，即不允许删除'."\n" - .'- PreventUpdate：对应的是原地变更保护，即不允许任何变更'."\n" - .'- PreventReplace：对应的是ForceNew，即不允许删除重建', - 'type' => 'string', + '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, - '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', - ], + '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" - ."\n" - .'- Manual ：手动触发（默认）'."\n" - .'- NewVersion ：模板发布新版本时触发'."\n" - .'- ParameterSetUpdated 参数集自身参数内容变更或参数集绑定关系变更时 触发'."\n" - .'- Auto ：当任务自身属性，如新建任务、执行版本或者作业触发策略（由其他改为Auto时），发生变更时自动触发'."\n" + 'description' => '触发策略，有效值：'."\n" + .'- Auto： 当修改规则或触发策略被改为Auto触发'."\n" + .'- Manual：手动触发'."\n" ."\n" - .'非手动触发时必填**ramRole**参数', + .'默认值为：Manual', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Auto' => 'Auto', - 'NewVersion' => 'NewVersion', - 'ParameterSetUpdated' => 'ParameterSetUpdated', - 'Manual' => 'Manual', - ], - 'example' => 'Manual', + 'enumValueTitles' => ['Auto' => 'Auto', 'Manual' => 'Manual'], + 'example' => 'Auto', 'default' => 'Manual', - 'enum' => [ - 'Always', - 'NewVersion', - 'Manual', - ], + 'enum' => ['Manual', 'Auto'], ], - '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' => '任务的标签列表。', + 'variables' => [ + 'description' => '变量列表，将资源导出后的参数设置为变量', 'type' => 'array', 'items' => [ - 'description' => '任务的标签列表。', + 'description' => '变量列表，将资源导出后的参数设置为变量', 'type' => 'object', 'properties' => [ - 'tagValue' => [ - 'description' => '任务的标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue'."\n", - ], - 'tagKey' => [ - 'description' => '任务的标签键。', - 'type' => 'string', + 'properties' => [ + 'description' => '资源类型对应的Terraform资源的属性列表', + 'type' => 'array', + 'items' => ['description' => '资源类型对应的Terraform资源的属性', 'type' => 'string', 'required' => false, 'example' => 'vswitch_name'], 'required' => false, - 'example' => 'TestKey'."\n", ], + 'resourceType' => ['description' => '资源类型，使用 **ListResourceTypes** 查看支持的资源列表。', 'type' => 'string', 'required' => false, 'example' => 'ALIYUN::VPC::VSwitch'], ], 'required' => false, ], @@ -1707,173 +1553,184 @@ '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', - ], + '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 \\"requestId\\": \\"CD478792-6952-5A1C-9F57-78932BF0FAC6\\",\\n \\"taskId\\": \\"task-433aead756057fffeaba4828f5195\\"\\n}","type":"json"}]', - 'title' => '创建任务', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-4a1ec8b7003d24528326821be\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"CFD8C2A8-5BE7-56D2-916D-64039B8E06E3\\"\\n}","type":"json"}]', + 'title' => '创建资源导出任务', 'description' => '单用户调用频率：100 次/秒。', - ], - 'UpdateTaskAttribute' => [ - 'summary' => '更新任务属性。', - 'path' => '/tasks/{taskId}', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2023-04-13T08:36:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-14T14:28:18.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceExportTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/*'], + ], + ], + ], ], + ], + 'CreateStack' => [ + 'summary' => '创建资源栈并触发部署', + 'path' => '/stacks', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'taskId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'task-4267dcfbf1b6dfff67fea425525e2', + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'source' => [ + 'description' => '创建来源，取值'."\n" + .'- OSS ：通过OSS对象存储的模板'."\n" + .'- IAC_SERVICE_MODULE ： 自动化服务台中创建的模板', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['IAC_SERVICE_MODULE' => 'IAC_SERVICE_MODULE', 'OSS' => 'OSS'], + 'example' => 'OSS', + ], + 'sourcePath' => ['description' => '配置来源的路径值，不超过 1000 个字符'."\n" + .'- 来源为 OSS 时，取值为 oss::<文件链接>，必须为 zip 文件，例如 oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为 IAC_SERVICE_MODULE 时，取值为<模板Id>，例如: mod-xxxxx', 'type' => 'string', 'required' => false, 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'], + 'name' => ['description' => '资源栈名称，长度为 2~128 个字符，允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾', 'type' => 'string', 'required' => false, 'example' => 'stack-test'], + 'description' => ['description' => '资源栈描述信息，不超过256个字符', 'type' => 'string', 'required' => false, 'example' => 'Stack to create ecs and related resource for multiple enviroments.'], + 'ramRole' => ['description' => '选择一个RAM角色授权给任务，用于在自动触发或者离线情况下自动完成计划任务的继续执行。', 'type' => 'string', 'required' => false, 'example' => 'TestIacRole'], + 'workingDirectory' => ['description' => '配置文件所在的工作目录（如在根目录下则输入 /），如：config/ 或 /', 'type' => 'string', 'required' => false, 'example' => '/stack'], + ], + 'required' => false, ], ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '79284133-D4BA-56B3-954C-D538256F7EAA'], + 'stackId' => ['description' => 'StackId，Stack创建后的唯一标识', 'type' => 'string', 'example' => 'stack-as1d4vld898ppnqbxxxxx'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建资源栈', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"79284133-D4BA-56B3-954C-D538256F7EAA\\",\\n \\"stackId\\": \\"stack-as1d4vld898ppnqbxxxxx\\"\\n}","type":"json"}]', + ], + 'CreateTask' => [ + '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' => '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", - ], + '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-433aead7560571e66e31274ffd3', - ], - 'projectId' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => false, - 'example' => 'p-433aead75605713865c386cb9d', - ], + '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', - ], - 'moduleVersion' => [ - 'description' => '模板版本', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], - 'name' => [ - 'description' => '任务名称，需满足下述要求：'."\n" - ."\n" - .'- 长度为 2~128 个字符。'."\n" - .'- 允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾。'."\n" - .'- 名称在当前账号的任务资源下唯一。', - 'type' => 'string', - 'required' => false, - 'example' => 'TaskName', - ], + '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' => 'role', - ], - 'skipPropertyValidation' => [ - 'description' => '是否跳过枚举值，默认false', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'terraformVersion' => [ - 'description' => 'Terraform版本，通过 **ListAvailableTerraformVersions** API获取支持的版本列表，默认为1.5.7。', - 'type' => 'string', + 'items' => ['description' => '资源保护策略：'."\n" + ."\n" + .'- PreventDestroy：对应的是删除保护，即不允许删除'."\n" + .'- PreventUpdate：对应的是原地变更保护，即不允许任何变更'."\n" + .'- PreventReplace：对应的是ForceNew，即不允许删除重建', 'type' => 'string', 'required' => false, 'example' => 'PreventDestroy'], 'required' => false, - 'example' => '1.5.7', ], + '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" @@ -1885,26 +1742,20 @@ .'非手动触发时必填**ramRole**参数', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Auto' => 'Auto', - 'NewVersion' => 'NewVersion', - 'ParameterSetUpdated' => 'ParameterSetUpdated', - 'Manual' => 'Manual', - ], + 'enumValueTitles' => ['Auto' => 'Auto', 'NewVersion' => 'NewVersion', 'ParameterSetUpdated' => 'ParameterSetUpdated', 'Manual' => 'Manual'], 'example' => 'Manual', 'default' => 'Manual', - 'enum' => [ - 'Always', - 'NewVersion', - 'Manual', - 'ParameterSetUpdated', - ], + 'enum' => ['Always', 'NewVersion', 'Manual'], ], - 'clientToken' => [ - 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', - 'type' => 'string', - 'required' => true, - 'example' => 'a65451293e64979ba7a4b573950217fe', + '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' => '任务的标签列表。', @@ -1913,23 +1764,20 @@ 'description' => '任务的标签列表。', 'type' => 'object', 'properties' => [ - 'tagValue' => [ - 'description' => '任务的标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - 'tagKey' => [ - 'description' => '任务的标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], + 'tagKey' => ['description' => '任务的标签键。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'."\n"], + 'tagValue' => ['description' => '任务的标签值。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'."\n"], ], 'required' => false, ], 'required' => false, ], + 'parameterSetIds' => [ + 'description' => '关联的参数集集合', + 'type' => 'array', + 'items' => ['description' => '关联的参数集ID', 'type' => 'string', 'required' => false, 'example' => 'pts-adfadfadf'], + 'required' => false, + ], + 'terraformProviderVersion' => ['type' => 'string'], ], 'required' => false, ], @@ -1942,182 +1790,435 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '17793D91-A26F-520D-A948-3452A45D15B1', - ], + '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\\": \\"17793D91-A26F-520D-A948-3452A45D15B1\\"\\n}","type":"json"}]', - 'title' => '修改任务', + 'title' => '创建任务', + 'summary' => '创建任务。', 'description' => '单用户调用频率：100 次/秒。', - ], - 'ListTasks' => [ - 'summary' => '获取任务列表。', - 'path' => '/tasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-04-17T06:45:23.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-07-11T07:34:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-29T13:37:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-09-01T06:23:45.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:50.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD478792-6952-5A1C-9F57-78932BF0FAC6\\",\\n \\"taskId\\": \\"task-433aead756057fffeaba4828f5195\\"\\n}","type":"json"}]', + ], + 'DeleteDetectConfig' => [ + 'path' => '/terraformState/detectConfig/{detectConfigId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'keyword', - 'in' => 'query', + 'name' => 'detectConfigId', + 'in' => 'path', + 'schema' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'required' => false, 'example' => 'dc-xxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '关键字，按照任务ID或任务名称模糊搜索', - 'type' => 'string', - 'required' => false, - 'example' => 'key', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => 'BF75EF50-955D-5E1F-AB23-A657C2C6D3C7'], + ], ], ], + ], + 'title' => '删除偏差检测配置', + 'summary' => '删除偏差检测配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF75EF50-955D-5E1F-AB23-A657C2C6D3C7\\"\\n}","type":"json"}]', + ], + 'DeleteGroup' => [ + 'summary' => '删除分组。', + 'path' => '/group/{groupId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'taskId', - 'in' => 'query', + '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' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => false, - 'example' => 'task-433aead756057fffeaba4828f5195', + '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' => '删除分组', + 'changeSet' => [ + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + ], + ], + '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' => 'query', + 'in' => 'path', + 'schema' => ['title' => 'A short description of struct', 'description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => 'mod-14e80de4866bf71ef354cc82d17f'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '模板ID', - 'type' => 'string', - 'required' => false, - 'example' => 'mod-1525e992f1b62139d1c437d64ae', + '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' => '## 请求说明'."\n" + .'- 该接口用于删除指定的模板。'."\n" + .'- 删除操作不可逆，请谨慎操作。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ], + ], + ], + ], + ], + 'DeleteParameterSet' => [ + 'summary' => '根据参数集ID删除指定的参数集。', + 'path' => '/parameterSets/{parameterSetId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'parameterSetId', + 'in' => 'path', + 'schema' => ['description' => '参数集ID', 'type' => 'string', 'required' => true, 'example' => 'pts-4c44f5be946dc446a326821b8'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '708D670B-67C4-5653-9F88-8F7800429EE1'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"708D670B-67C4-5653-9F88-8F7800429EE1\\"\\n}","type":"json"}]', + 'title' => '删除参数集', + 'description' => '删除参数集', + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:07.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + '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' => 'query', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => false, 'example' => 'p-148e7853433574fffe9fec72ed9b72'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => false, - 'example' => 'p-433aead7560572f8d95b25775c', + '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' => '删除项目', + 'changeSet' => [ + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProject'], + ], + ], + 'ramActions' => [ [ - 'name' => 'groupId', - 'in' => 'query', - 'schema' => [ - 'description' => '分组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ], ], ], + ], + ], + 'DeleteRegistryModule' => [ + 'summary' => '删除Registry模板。', + 'path' => '/registryModule/{namespaceName}/{moduleName}', + 'methods' => ['delete'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'status', - 'in' => 'query', + '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' => [ - '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', + 'title' => 'Schema of Response', + 'description' => '响应体结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '545995A8-243D-5963-A940-B74FAF6009B5'], ], - 'example' => 'Errored', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"545995A8-243D-5963-A940-B74FAF6009B5\\"\\n}","type":"json"}]', + 'title' => '删除Registry模板', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRegistryModule'], + ], + ], + 'ramActions' => [ [ - '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, + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], ], - 'required' => false, ], ], ], + ], + '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' => [ @@ -2125,209 +2226,125 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '491A1E2E-EA1E-5F90-958A-A53EB67780FC'], ], ], ], ], - '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' => '获取任务列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"491A1E2E-EA1E-5F90-958A-A53EB67780FC\\"\\n}","type":"json"}]', + 'title' => '删除Registry模板版本', 'description' => '单用户调用频率：100 次/秒。', - ], - 'GetTask' => [ - 'summary' => '获取任务详情。', - 'path' => '/tasks/{taskId}', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRegistryModuleVersion'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteRegistryModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], ], + ], + 'DeleteRegistryNamespace' => [ + 'summary' => '删除工作空间。', + 'path' => '/registryNamespace/{namespaceName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'taskId', + 'name' => 'namespaceName', 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'task-433aead7560571f8c2e176e7325', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRegistryNamespace'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteRegistryNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], + ], ], ], ], + ], + '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' => [ @@ -2335,254 +2352,112 @@ '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', - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9'], ], ], ], ], - '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' => '获取任务详情', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '删除资源导出任务', 'description' => '单用户调用频率：100 次/秒。', - ], - 'DeleteTask' => [ - 'summary' => '删除任务。', - 'path' => '/tasks/{taskId}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceExportTask'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], ], + ], + 'DeleteStack' => [ + 'path' => '/stacks/{stackId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + ], + 'parameters' => [ + [ + 'name' => 'stackId', + 'in' => 'path', + 'schema' => ['description' => 'StackId，Stack 创建后的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'stack-as1d4vld898ppnqbxxxxx'], + ], + [ + 'name' => 'cleanResources', + 'in' => 'query', + 'schema' => ['title' => '是否同步清理Stack管理的资源，默认不清理', 'description' => '是否同步清理Stack管理的资源，默认不清理', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => 'C7070EC3-DF66-58BA-A1DD-A8574FF53143'], + ], + ], + ], ], - 'produces' => [ - 'application/json', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除资源栈', + 'summary' => '删除资源栈', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7070EC3-DF66-58BA-A1DD-A8574FF53143\\"\\n}","type":"json"}]', + ], + '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', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => false, - 'example' => 'task-123456', - ], + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'task-123456'], ], ], 'responses' => [ @@ -2592,12 +2467,7 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '73B38F77-62BA-5878-8952-530DFE21C93B', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '73B38F77-62BA-5878-8952-530DFE21C93B'], ], ], ], @@ -2607,36 +2477,46 @@ 'description' => '单用户调用频率：100 次/秒。'."\n" ."\n\n" .'删除任务，如果任务存在未销毁资源，不允许删除。', - ], - 'CreateJob' => [ - 'summary' => '创建作业并运行任务。', - 'path' => '/tasks/{taskId}/jobs', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTask'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], + ], + ], + ], ], + ], + 'DetectTerraformState' => [ + 'summary' => '发起状态文件一致性检测', + 'path' => '/terraformState/detect', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -2644,65 +2524,164 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数', + '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）', + '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, - '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', + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', ], - 'taskType' => [ - 'description' => '任务类型'."\n" - ."\n" - .'Task：常规任务（默认）'."\n" + 'identifier' => ['description' => '任务标识符。Stack 任务为 <$stackId>:<$deploymentName>；Task 任务为 <$TaskId>', 'type' => 'string', 'required' => true, 'example' => 'stack-as11xxxxxxxxx:developmentA'], + ], + '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' => 'BF75EF50-955D-5E1F-AB23-A657C2C6D3C7'], + 'detectionId' => ['description' => '检测任务 Id', 'type' => 'string', 'example' => 'job-dcsdxxxxxx'], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '发起偏差检测', + 'description' => '该API主要用于进行自动化服务台上资源编排任务和资源栈任务状态文件的偏差检测。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF75EF50-955D-5E1F-AB23-A657C2C6D3C7\\",\\n \\"detectionId\\": \\"job-dcsdxxxxxx\\"\\n}","type":"json"}]', + ], + 'DissociateDetectConfig' => [ + 'summary' => '解除偏差检测配置关联', + 'path' => '/terraformState/detectConfig/operations/dissociate', + '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' => [ + 'detectConfigId' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'required' => false, 'example' => 'dc-xxxx'."\n"], + 'targetId' => ['description' => '关联目标 Id。StackId 或 TaskId', 'type' => 'string', 'required' => true, 'example' => 'stack-xxxx'], + 'targetType' => [ + 'description' => '关联目标类型'."\n" ."\n" - .'SceneTestingTask：场景化测试任务', + .'- Task 编排任务'."\n" + .'- Stack 资源栈', 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SceneTestingTask' => 'SceneTestingTask', - 'Task' => 'Task', - ], - 'example' => 'Task', + 'required' => true, + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', ], ], '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' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9'], + ], + ], + ], + ], + 'title' => '解除偏差检测配置关联', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\"\\n}","type":"json"}]', + ], + 'DissociateGroup' => [ + 'summary' => '取消关联分组。', + 'path' => '/group/{groupId}/dissociate', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'taskId', + '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' => '任务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'task-433aead756057fffeaba4828f5195', + '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, ], ], ], @@ -2713,123 +2692,239 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'jobId' => [ - 'description' => '作业ID', - 'type' => 'string', - 'example' => 'job-518855d98c319561f', + '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' => '资源解除分组关联', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:DissociateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + ], + ], + 'DissociateParameterSet' => [ + 'summary' => '解除参数集与其他资源的关联关系。', + 'path' => '/parameterSets/operations/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' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'parameterSetIds' => [ + 'description' => '新增关联到资源上的参数集ID列表，最大长度 5', + 'type' => 'array', + 'items' => ['description' => '参数集ID', 'type' => 'string', 'required' => true, 'example' => 'pts-adfadfadf'], + 'required' => true, ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', + 'resourceId' => ['description' => '资源ID'."\n" + .'资源类型为ModuleVersion时，'."\n" + .'由<moduleId>-<moduleversion>拼接而成，'."\n" + .'如mod-34535345df123fr-v3', 'type' => 'string', 'required' => true, 'example' => 'mod-39cd1e5e58c50e79dd8cd901cd'], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- Module 模板'."\n" + .'- ModuleVersion 模板版本'."\n" + .'- Task 任务'."\n" + .'- Stack 资源栈', 'type' => 'string', - 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9', + 'required' => true, + 'enumValueTitles' => ['Task' => 'Task', 'ModuleVersion' => 'ModuleVersion', 'Module' => 'Module', 'Stack' => 'Stack'], + 'example' => 'Module', ], ], + 'required' => false, ], ], ], - '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', + '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'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"136B3926-DD90-5DB2-96EC-8BAD6407D1C9\\"\\n}","type":"json"}]', + 'title' => '解除参数集与其他资源的关联关系', + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:06.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:DissociateParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ExecuteRegistryModule' => [ + 'summary' => '执行阿里云 Terraform 官方提供的 Module。', + 'path' => '/registryModule/{namespaceName}/{moduleName}/execution', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'taskId', + 'name' => 'namespaceName', 'in' => 'path', - 'schema' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'task-518855d9a058cfffe0e0a92745bbc', - ], + 'schema' => ['description' => 'Module所属的工作空间，当前官方RegistryModule的工作空间：alibaba、alibabacloud-automation、aliyun、terraform-alicloud-modules', 'type' => 'string', 'required' => true, 'example' => 'alibaba'], ], [ - 'name' => 'jobId', + 'name' => 'moduleName', 'in' => 'path', - 'schema' => [ - 'description' => '作业ID', - 'type' => 'string', - 'required' => true, - 'example' => 'job-5fd38c9b92d54fff865d936f22a39', - ], + 'schema' => ['description' => '模板名称，可以通过ListExplorerRegistryModules查询', 'type' => 'string', 'required' => true, 'example' => 'vpc'], ], [ - 'name' => 'operationType', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '操作类型，'."\n" - .'取值范围：'."\n" - .'- execute 执行'."\n" - .'- abolish 放弃'."\n" - .'- cancel 取消', - 'type' => 'string', + '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, - 'example' => 'execute', - 'enum' => [ - 'execute', - 'abolish', - 'cancel', + ], + ], + ], + '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 代码符合预期的功能需求。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteRegistryModule'], + ], + ], + 'ramActions' => [ [ - 'name' => 'comment', - 'in' => 'query', - 'schema' => [ - 'description' => '描述，长度（0-128）', - 'type' => 'string', - 'required' => true, - 'example' => 'dasd', - 'maxLength' => 128, + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], ], ], + ], + ], + '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' => 'taskType', - 'in' => 'query', + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => ['description' => '资源导出ID', 'type' => 'string', 'required' => true, 'example' => 'ex-3b6cb9fa4751a6e645ad8365e6'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '任务类型'."\n" - ."\n" - .'Task：常规任务（默认）'."\n" - ."\n" - .'SceneTestingTask：场景化测试任务', - 'type' => 'string', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + ], 'required' => false, - 'example' => 'Task', ], ], ], @@ -2837,158 +2932,578 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体参数', + 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E602681C-A811-5787-9DC3-48BED7537071', - ], + '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'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E602681C-A811-5787-9DC3-48BED7537071\\"\\n}","type":"json"}]', - 'title' => '操作作业', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-3b6cb9fa4751a6e645ad8365e6\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"0B0A7C19-9077-5975-ACBD-DEE718787992\\"\\n}","type":"json"}]', + 'title' => '执行资源导出任务', 'description' => '单用户调用频率：100 次/秒。', - ], - 'ListJobs' => [ - 'summary' => '查询作业列表。', - 'path' => '/tasks/{taskId}/jobs', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteResourceExportTask'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], ], + ], + 'ExecuteTerraformApply' => [ + 'summary' => '执行TerraformApply。', + 'path' => '/terraform/execution/apply', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'taskId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'task-55f1739d9050fff', + '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代码符合预期的功能需求。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteTerraformApply'], + ], + ], + 'ramActions' => [ [ - 'name' => 'status', - 'in' => 'query', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteTerraformApply', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + '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' => '作业状态'."\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', + '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, - 'enumValueTitles' => [ - 'PlanQueued' => 'PlanQueued', - 'Errored' => 'Errored', - 'Planning' => 'Planning', - 'PlannedAndFinished' => 'PlannedAndFinished', - 'Applying' => 'Applying', - 'Canceled' => 'Canceled', - 'Planned' => 'Planned', - 'Applied' => 'Applied', - 'Pending' => 'Pending', + ], + ], + ], + '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'], ], - 'example' => 'Errored', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"stateId\\": \\"task-xxxx\\",\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\"\\n}","type":"json"}]', + 'title' => '执行Terraform Destroy', + 'description' => '执行Terraform Destroy命令，销毁通过Terraform创建的资源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteTerraformDestroy'], + ], + ], + 'ramActions' => [ [ - 'name' => 'pageSize', - 'in' => 'query', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteTerraformDestroy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + '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' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', + '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, - 'maximum' => '100', - 'exclusiveMaximum' => false, - 'minimum' => '1', - 'exclusiveMinimum' => false, - 'example' => '20', ], ], + ], + '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代码符合预期的功能需求。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteTerraformPlan'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteTerraformPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GenerateModule' => [ + 'summary' => '生成Terraform HCL模板代码', + 'path' => '/explorer/generate/module', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', + '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' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', + '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, - 'exclusiveMaximum' => false, - 'minimum' => '1', - 'exclusiveMinimum' => false, - 'example' => '1', + '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模板代码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateModule'], + ], + ], + 'ramActions' => [], + ], + 'GetDetectConfig' => [ + 'summary' => '获取偏差检测配置', + 'path' => '/terraformState/detectConfig/{detectConfigId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'taskType', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + ], + 'parameters' => [ + [ + 'name' => 'detectConfigId', + 'in' => 'path', + 'schema' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'required' => true, 'example' => 'dc-xxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务类型'."\n" - ."\n" - .'Task：常规任务（默认）'."\n" - ."\n" - .'SceneTestingTask：场景化测试任务', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SceneTestingTask' => 'SceneTestingTask', - 'Task' => 'Task', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'detectConfig' => [ + 'description' => '偏差检测配置信息', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-04-10T02:30:04Z'], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => 'this is a description'], + 'detectConfigId' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'example' => 'dc-xxxx'], + 'enabled' => ['description' => '是否开启定时检测', 'type' => 'boolean', 'example' => 'true'], + 'triggerType' => ['description' => '触发类型'."\n" + ."\n" + .'- Manual: 手动执行'."\n" + .'- Cron: 定时触发', 'type' => 'string', 'example' => 'Cron'], + 'cronExpression' => ['description' => 'cron 表达式（北京时间）。当触发类型为 Cron 时必填', 'type' => 'string', 'example' => '0 0 0 ? * 1'."\n"], + 'alarmConfigs' => [ + 'description' => '告警地址列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '报警途径。当前仅支持 `cms`', 'type' => 'string', 'example' => 'cms'], + 'address' => ['description' => '报警地址。', 'type' => 'string', 'example' => 'https://metrichub-cms-cn-hangzhou.aliyuncs.com/event/notify?xxxxx'], + ], + 'description' => '', + ], + ], + 'detectConfigName' => ['description' => '偏差检测配置名称', 'type' => 'string', 'example' => 'test'], + ], + ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BF72A6FB-B071-5F2E-A036-9D62545B962C'], ], - 'example' => 'SceneTestingTask', ], ], + ], + 'title' => '获取偏差检测配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"detectConfig\\": {\\n \\"createTime\\": \\"2026-04-10T02:30:04Z\\",\\n \\"description\\": \\"this is a description\\",\\n \\"detectConfigId\\": \\"dc-xxxx\\",\\n \\"enabled\\": true,\\n \\"triggerType\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0 0 0 ? * 1\\\\n\\",\\n \\"alarmConfigs\\": [\\n {\\n \\"type\\": \\"cms\\",\\n \\"address\\": \\"https://metrichub-cms-cn-hangzhou.aliyuncs.com/event/notify?xxxxx\\"\\n }\\n ],\\n \\"detectConfigName\\": \\"test\\"\\n },\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\"\\n}","type":"json"}]', + ], + 'GetExecuteState' => [ + 'summary' => '获取Terraform运行结果', + 'path' => '/terraform/execution/{stateId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'jobType', - 'in' => 'query', + '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' => '作业类型', - 'description' => '作业类型', - 'type' => 'string', - 'required' => false, - 'example' => 'Default', + '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运行的结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExecuteState'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetExecuteState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + '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' => [ @@ -2996,218 +3511,142 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'jobs' => [ - 'description' => '作业信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Job详情。', - 'type' => 'object', - 'properties' => [ - 'config' => [ - 'description' => '作业配置', + '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' => [ - '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', - ], + 'notifyPath' => ['description' => '通知的路径配置', 'type' => 'string', 'example' => '/'], + 'notifyType' => ['description' => '通知类型：'."\n" + .'DingDing', 'type' => 'string', 'example' => 'DingDing'], ], ], - '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' => '状态详情。', + ], + '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', - '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' => '状态详情。', + 'properties' => [ + 'triggerStrategy' => ['description' => '触发策略，取值：'."\n" + ."\n" + .'- ProviderNewVersion 新Provider版本发布时触发'."\n" + .'- Cron 定时触发', 'type' => 'string', 'example' => 'Cron'], + 'triggerValue' => ['description' => '定时触发时需要维护策略值，cron表达式', 'type' => 'string', 'example' => '0 0 8 * * ?'], ], ], - 'taskId' => [ - 'description' => '任务ID', - 'type' => 'string', - 'example' => 'task-518876866c2c3efb', - ], - 'terraformProviderVersion' => [ - 'description' => 'terraformProvider版本', - 'type' => 'string', - 'example' => '1.240.0', - ], + ], + 'triggerResourceType' => [ + 'description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', + 'type' => 'array', + 'items' => ['description' => '触发执行的资源类型，取值：'."\n" + ."\n" + .'- Task：常规任务'."\n" + .'- SceneTestingTask：场景化测试任务', 'type' => 'string', 'example' => 'SceneTestingTask'], ], ], ], - '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取分组信息', + 'changeSet' => [ + ['createdAt' => '2023-01-10T09:03:10.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], ], - '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', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => '任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'task-55f1739d9050fffee8fe2a2c4a605', - ], + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => 'task-55f1739d9050fffee8fe2a2c4a605'], ], [ 'name' => 'jobId', 'in' => 'path', - 'schema' => [ - 'description' => '作业ID', - 'type' => 'string', - 'required' => true, - 'example' => 'job-433aead756057ffef0028917e6f26', - ], + 'schema' => ['description' => '作业ID', 'type' => 'string', 'required' => true, 'example' => 'job-433aead756057ffef0028917e6f26'], ], [ 'name' => 'taskType', @@ -3217,13 +3656,12 @@ ."\n" .'Task：常规任务（默认）'."\n" ."\n" - .'SceneTestingTask：场景化测试任务', + .'SceneTestingTask：场景化测试任务'."\n" + ."\n" + .'Stack：资源栈', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'SceneTestingTask' => 'SceneTestingTask', - 'Task' => 'Task', - ], + 'enumValueTitles' => ['SceneTestingTask' => 'SceneTestingTask', 'Task' => 'Task', 'Stack' => 'Stack'], 'example' => 'SceneTestingTask', ], ], @@ -3246,36 +3684,20 @@ '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', - ], + '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'], ], ], ], @@ -3283,407 +3705,331 @@ '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' => '/', - ], + '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' => ['description' => '这个作业是否进行合规预检', 'type' => 'string', 'example' => 'true'], + ], + ], + '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', - ], + '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" + .'- ConfigProactiveInProgress：合规预检中（需要账号开启合规预检功能）'."\n" + .'- ConfigProactiveSuccess：合规预检成功（需要账号开启合规预检功能）'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff（最终状态）'."\n" + .'- Confirmed：资源Job执行Plan完成后等待确认的状态'."\n" + .'- ApplyQueued：Job执行时，如果没有可用的工作流，需要排队等待状态'."\n" + .'- Applying：资源Job正处于执行Apply阶段'."\n" + .'- Applied：资源Job完成Apply的执行（最终状态）'."\n" + .'- Errored：Job的执行错误（最终状态）'."\n" + .'- Canceled：Job的执行被取消（最终状态）'."\n" + .'- Discarded：资源Job的plan被废弃（最终状态）'."\n" + .'- ConfigProactiveFailure：合规预检失败（需要账号开启合规预检功能）', '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', - ], + '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', 'example' => 'Error：Cannot import non-existent remote object', 'description' => '错误详情'], ], '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', + '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' => ['description' => 'Plan阶段的变更详情', 'type' => 'any', 'example' => '{'."\n" + .' "formatVersion": "1.2",'."\n" + .' "terraformVersion": "1.5.7",'."\n" + .' "providerVersion": "1.262.1",'."\n" + .' "plannedValues": {'."\n" + .' "root_module": {'."\n" + .' }'."\n" + .' },'."\n" + .' "resourceChanges": ['."\n" + .' {'."\n" + .' "address": "alicloud_instance.uuid_ae98dda8_xxxxxxx",'."\n" + .' "mode": "managed",'."\n" + .' "type": "alicloud_instance",'."\n" + .' "name": "uuid_ae98dda8_xxxxxx",'."\n" + .' "providerName": "registry.terraform.io/aliyun/alicloud",'."\n" + .' "change": {'."\n" + .' "actions": ['."\n" + .' "delete"'."\n" + .' ],'."\n" + .' "before": Object{...},'."\n" + .' "after_unknown": {'."\n" + .' },'."\n" + .' "before_sensitive": Object{...},'."\n" + .' "after_sensitive": false'."\n" + .' },'."\n" + .' "cloudSpecResourceCode": "ACS::ECS::Instance"'."\n" + .' }'."\n" + .' ],'."\n" + .' "configuration": Object{...}'."\n" + .'}'], + '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'], + 'allParameters' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'example' => 'regionId'], + 'value' => ['type' => 'string', 'example' => 'cn-zhangjiakou'], + 'secret' => ['type' => 'boolean', 'example' => 'false'], + ], + ], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '1435C78A-AED9-53D6-B7A6-E2661D29B1FA', - ], + '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取作业信息', + 'summary' => '获取作业信息。', 'description' => '单用户调用频率：100 次/秒。', - ], - 'CreateResourceExportTask' => [ - 'summary' => '创建资源导出任务。', - 'path' => '/exportTasks', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-12-04T02:30:13.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-12-03T08:20:42.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-11-24T15:27:28.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-10-29T12:45:57.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-07-23T09:04:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-07-05T09:05:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-07-04T09:30:11.000Z', 'description' => '错误码发生变更、响应参数发生变更'], + ['createdAt' => '2023-05-11T09:53:18.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-29T14:16:55.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-27T11:26:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/{#JobId}'], + ], + ], + 'additionalActions' => [], + ], ], + '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\\": \\"true\\"\\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\\": \\"Error：Cannot import non-existent remote object\\"\\n }\\n },\\n \\"taskId\\": \\"task-3b6cb9fa4751a1b9b5f22cbcf4e\\",\\n \\"taskType\\": \\"SceneTestingTask\\",\\n \\"terraformProviderVersion\\": \\"1.230.0\\",\\n \\"outputJsonPlan\\": \\"{\\\\n \\\\\\"formatVersion\\\\\\": \\\\\\"1.2\\\\\\",\\\\n \\\\\\"terraformVersion\\\\\\": \\\\\\"1.5.7\\\\\\",\\\\n \\\\\\"providerVersion\\\\\\": \\\\\\"1.262.1\\\\\\",\\\\n \\\\\\"plannedValues\\\\\\": {\\\\n \\\\\\"root_module\\\\\\": {\\\\n }\\\\n },\\\\n \\\\\\"resourceChanges\\\\\\": [\\\\n {\\\\n \\\\\\"address\\\\\\": \\\\\\"alicloud_instance.uuid_ae98dda8_xxxxxxx\\\\\\",\\\\n \\\\\\"mode\\\\\\": \\\\\\"managed\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"alicloud_instance\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"uuid_ae98dda8_xxxxxx\\\\\\",\\\\n \\\\\\"providerName\\\\\\": \\\\\\"registry.terraform.io/aliyun/alicloud\\\\\\",\\\\n \\\\\\"change\\\\\\": {\\\\n \\\\\\"actions\\\\\\": [\\\\n \\\\\\"delete\\\\\\"\\\\n ],\\\\n \\\\\\"before\\\\\\": Object{...},\\\\n \\\\\\"after_unknown\\\\\\": {\\\\n },\\\\n \\\\\\"before_sensitive\\\\\\": Object{...},\\\\n \\\\\\"after_sensitive\\\\\\": false\\\\n },\\\\n \\\\\\"cloudSpecResourceCode\\\\\\": \\\\\\"ACS::ECS::Instance\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"configuration\\\\\\": Object{...}\\\\n}\\",\\n \\"logFile\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"jobType\\": \\"Default\\",\\n \\"allParameters\\": [\\n {\\n \\"name\\": \\"regionId\\",\\n \\"value\\": \\"cn-zhangjiakou\\",\\n \\"secret\\": false\\n }\\n ]\\n },\\n \\"requestId\\": \\"1435C78A-AED9-53D6-B7A6-E2661D29B1FA\\"\\n}","type":"json"}]', + ], + 'GetModule' => [ + 'summary' => '查询指定模板的详细信息', + 'path' => '/modules/{moduleId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, - 'style' => 'json', + 'name' => 'moduleId', + 'in' => 'path', + 'schema' => ['description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => 'mod-148e7853433574fffe9ca86154d77a'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体参数', + 'title' => 'Schema of Response', + '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中', + 'module' => [ + 'description' => '模板信息', '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', + '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'], ], ], - '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', + 'tags' => [ + 'description' => '模板的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagValue' => ['description' => '模板的标签值。', 'type' => 'string', 'example' => 'TestValue'], + 'tagKey' => ['description' => '模板的标签键。', 'type' => 'string', 'example' => 'TestKey'], ], - 'required' => false, - ], - 'resourceType' => [ - 'description' => '资源类型，使用 **ListResourceTypes** 查看支持的资源列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'ALIYUN::VPC::VSwitch', ], ], - 'required' => false, ], - 'required' => false, ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3'], ], - 'required' => false, ], ], ], + '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' => '## 请求说明'."\n" + .'通过此接口，用户可以获取指定模板的详细信息，包括但不限于模板名称、描述、来源、状态以及最新版本等。请求时需要提供模板 ID，并且必须包含认证信息。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-08-09T01:54:55.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ], + ], + ], + ], + ], + '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' => [ @@ -3691,237 +4037,226 @@ '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', + '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 \\"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', + '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' => '## 请求说明'."\n" + .'通过此接口，您可以获取指定模板的某个具体版本的详细信息，包括版本号、描述、发布时间等。请确保提供的模板 ID 和版本号是正确的。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-08-09T01:54:55.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:47.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:47.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModuleVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/{#ModuleVersionId}'], + ], + ], + ], ], + ], + 'GetParameterSet' => [ + 'summary' => '根据参数集ID获取单个参数集的详细信息。', + 'path' => '/parameterSets/{parameterSetId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, - 'style' => 'json', + 'name' => 'parameterSetId', + 'in' => 'path', + 'schema' => ['description' => '参数集ID', 'type' => 'string', 'required' => true, 'example' => 'pts-433aead7560571fc2556dc33a4a'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体参数。', + 'title' => 'Schema of Response', + '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中', + 'parameterSet' => [ + 'description' => '参数集详情', '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', + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-30T02:14:16Z', 'title' => '参数集创建时间'], + 'description' => ['description' => '参数集描述', 'type' => 'string', 'example' => 'This is parameterSet', 'title' => '参数集描述'], + 'name' => ['description' => '参数集名称', 'type' => 'string', 'example' => 'demo', 'title' => '参数集名称'], + 'parameterSetId' => ['description' => '参数集ID', 'type' => 'string', 'example' => 'pts-3b6cb9fa4751afff9c5e4e01624b9', 'title' => '参数集Id'], + 'parameters' => [ + 'description' => '参数集内容', + 'type' => 'array', + 'items' => [ + 'description' => '参数集内容', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '参数名称', 'type' => 'string', 'example' => 'region', 'title' => '参数名称'], + 'type' => ['description' => '参数类型（string/number/bool/map(string)/list(string)）', 'type' => 'string', 'example' => 'string', 'title' => '参数类型'], + 'value' => ['description' => '参数值', 'type' => 'any', 'example' => 'cn-hangzhou', 'title' => '参数值'], + 'status' => [ + 'description' => '参数集状态，枚举：'."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值'."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为 null', + 'type' => 'string', + 'enumValueTitles' => ['EXPLICIT_NULL' => '显式设置为 null', 'HAS_VALUE' => '定义具体值'], + 'example' => 'HAS_VALUE', + 'title' => '参数集状态，枚举：'."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值'."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为 null', + ], + 'secret' => ['title' => '是否保密参数，保密参数在接口返回时以及控制台展示会进行隐藏，并进行加密存储', 'type' => 'boolean'], ], - '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', + 'title' => '参数。', ], + 'title' => '参数列表', ], - '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", + 'relationList' => [ + 'description' => '关联关系', + 'type' => 'array', + 'items' => [ + 'description' => '关联关系', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-04-24T22:58:50Z', 'title' => '关联时间'], + 'resourceId' => ['description' => '资源ID'."\n" + .'资源类型为ModuleVersion时，'."\n" + .'由<moduleId>-<moduleversion>拼接而成，'."\n" + .'如mod-34535345df123fr-v3', 'type' => 'string', 'example' => 'mod-433aead756057101546eb5d50c1', 'title' => '资源id'], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- Module 模板'."\n" + .'- ModuleVersion 模板版本'."\n" + .'- Task 任务', + 'type' => 'string', + 'enumValueTitles' => ['Task' => '任务', 'ModuleVersion' => '模板版本', 'Module' => '模板'], + 'example' => 'Module', + 'title' => '资源类型', + ], ], - 'required' => false, - ], - 'resourceType' => [ - 'description' => '资源类型，使用 **ListResourceTypes** 查看支持的资源列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'ALIYUN::VPC::VSwitch'."\n", + 'title' => '关联的资源列表', ], + 'title' => '关联资源的列表', ], - 'required' => false, ], - 'required' => false, + 'title' => '参数集信息', ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '99905C7C-1320-5E7F-A798-3071482EB08E'], ], - 'required' => false, ], ], + ], + 'title' => '获取参数集详情', + 'description' => '## 请求说明'."\n" + .'- 该接口用于通过指定的`parameterSetId`来获取详细的参数集信息。'."\n" + .'- 需要认证信息才能访问此接口。'."\n" + .'- 如果请求成功，将返回包括参数集名称、描述、参数列表等在内的详细数据。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:07.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parameterSet\\": {\\n \\"createTime\\": \\"2022-01-30T02:14:16Z\\",\\n \\"description\\": \\"This is parameterSet\\",\\n \\"name\\": \\"demo\\",\\n \\"parameterSetId\\": \\"pts-3b6cb9fa4751afff9c5e4e01624b9\\",\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"region\\",\\n \\"type\\": \\"string\\",\\n \\"value\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"HAS_VALUE\\",\\n \\"secret\\": true\\n }\\n ],\\n \\"relationList\\": [\\n {\\n \\"createTime\\": \\"2022-04-24T22:58:50Z\\",\\n \\"resourceId\\": \\"mod-433aead756057101546eb5d50c1\\",\\n \\"resourceType\\": \\"Module\\"\\n }\\n ]\\n },\\n \\"requestId\\": \\"99905C7C-1320-5E7F-A798-3071482EB08E\\"\\n}","type":"json"}]', + ], + 'GetProject' => [ + 'summary' => '查询项目。', + 'path' => '/project/{projectId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'exportTaskId', + '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' => true, - 'example' => 'ex-al1811jl980g5ffd115nhgt', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => false, 'example' => 'p-433aead7560572f8d95b25775c'], ], ], 'responses' => [ @@ -3931,108 +4266,318 @@ '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', + '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 \\"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', + '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' => '获取项目详情', + 'changeSet' => [ + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProject'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ], + ], + ], + ], + ], + 'GetProviderDocument' => [ + 'summary' => '获取TerraformProvider资源文档', + 'path' => '/version/terraform/provider/document', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'keyword', + 'name' => 'providerVersion', 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键词，支持对任务名称的模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], + 'schema' => ['type' => 'string', 'readOnly' => false, 'description' => ''], ], [ - 'name' => 'exportTaskId', + 'name' => 'terraformResourceType', 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'readOnly' => false, 'description' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源导出任务ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ex-al1c11jl9g2tbte727otp85', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'providerVersion' => ['type' => 'string', 'readOnly' => false, 'description' => ''], + 'terraformResourceType' => ['type' => 'string', 'readOnly' => false, 'description' => ''], + 'document' => ['type' => 'string', 'readOnly' => false, 'description' => ''], + 'requestId' => ['title' => 'Id of the request', 'type' => 'string', 'readOnly' => false, 'description' => 'Id of the request'], + ], + 'readOnly' => false, + 'description' => 'Schema of Response', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"providerVersion\\": \\"\\",\\n \\"terraformResourceType\\": \\"\\",\\n \\"document\\": \\"\\",\\n \\"requestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetRegistryModule' => [ + 'summary' => '查询Registry模板。', + 'path' => '/registryModule/{namespaceName}/{moduleName}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'pageSize', - 'in' => 'query', + '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' => [ - 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegistryModule'], + ], + ], + 'ramActions' => [ [ - 'name' => 'pageNumber', - 'in' => 'query', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + ], + ], + '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' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegistryModuleVersion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetRegistryModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + ], + ], + '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' => [ @@ -4040,262 +4585,83 @@ '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', - ], + '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'], ], ], - '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', - ], + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegistryNamespace'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetRegistryNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], ], ], ], ], - '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', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ 'name' => 'exportTaskId', 'in' => 'path', - 'schema' => [ - 'description' => '资源导出任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ex-al171j05rlog5tbri1pmkk', - ], + 'schema' => ['description' => '资源导出任务ID', 'type' => 'string', 'required' => true, 'example' => 'ex-al171j05rlog5tbri1pmkk'], ], [ 'name' => 'exportVersion', 'in' => 'query', - 'schema' => [ - 'description' => '导出版本。', - 'type' => 'string', - 'required' => false, - 'example' => 'v3', - ], + 'schema' => ['description' => '导出版本。', 'type' => 'string', 'required' => false, 'example' => 'v3'], ], ], 'responses' => [ @@ -4305,75 +4671,33 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'FC49AA8C-0A19-5556-8929-E7447F18D529', - ], + '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', - ], + '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' => '/', - ], + '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', - ], + 'exportVersion' => ['description' => '资源导出版本', 'type' => 'string', 'example' => 'v2'], + 'failedReason' => ['description' => '失败原因。', 'type' => 'string', 'example' => 'Reason'], 'includeRules' => [ 'description' => '一组资源导出时的包含规则的值', 'type' => 'array', @@ -4384,75 +4708,35 @@ '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', + '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', - ], + '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', @@ -4463,17 +4747,9 @@ 'properties' => [ 'description' => '资源类型对应的Terraform资源的属性列表', 'type' => 'array', - 'items' => [ - 'description' => '资源类型对应的Terraform资源的属性', - 'type' => 'string', - 'example' => 'vswitch_name'."\n", - ], - ], - 'resourceType' => [ - 'description' => '资源类型', - 'type' => 'string', - 'example' => 'ALIYUN::VPC::VSwitch'."\n", + 'items' => ['description' => '资源类型对应的Terraform资源的属性', 'type' => 'string', 'example' => 'vswitch_name'."\n"], ], + 'resourceType' => ['description' => '资源类型', 'type' => 'string', 'example' => 'ALIYUN::VPC::VSwitch'."\n"], ], ], ], @@ -4484,25 +4760,13 @@ '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", - ], + '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"], ], ], ], @@ -4515,653 +4779,634 @@ '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', + 'changeSet' => [ + ['createdAt' => '2023-04-13T08:36:09.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-01-10T09:03:10.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-12-14T14:28:18.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceExportTask'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - ], - 'parameters' => [ + 'ramActions' => [ [ - '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', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], ], - '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', - ], + 'GetResourceType' => [ + 'summary' => '获取资源类型信息。', + 'path' => '/resourceType/{resourceType}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorerY5UU1D'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'exportTaskId', + 'name' => 'resourceType', 'in' => 'path', - 'schema' => [ - 'description' => '资源导出ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ex-3b6cb9fa4751a6e645ad8365e6', - ], + 'schema' => ['description' => '资源Code，用于获取指定资源类型的详细信息', 'type' => 'string', 'required' => false, 'example' => 'alicloud_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', - ], - ], - 'required' => false, - ], + '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' => '响应体结构', + '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', + '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'], + 'resourceType' => ['type' => 'string'], + ], ], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取资源类型详情', + 'description' => '## 请求说明', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceType'], + ], ], + 'ramActions' => [], + '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 \\"resourceType\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetStack' => [ + 'path' => '/stacks/{stackId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'exportTaskId', + 'name' => 'stackId', 'in' => 'path', - 'schema' => [ - 'description' => '资源导出ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ex-3b6cb9fa4751a16b006b03333a', - ], + 'schema' => ['description' => 'StackId，Stack创建后的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'stack-as1d4vld898ppnqxxxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => '请求体', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '136B3926-DD90-5DB2-96EC-8BAD6407D1C9', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'C7070EC3-DF66-58BA-A1DD-A8574FF53143'], + 'stack' => [ + 'description' => '资源栈信息', + 'type' => 'object', + 'properties' => [ + 'stackId' => ['description' => 'StackId，Stack创建后的唯一标识', 'type' => 'string', 'example' => 'stack-as1d4vld898ppnqxxxxxx'], + 'name' => ['description' => '资源栈名称', 'type' => 'string', 'example' => 'stack-test'], + 'description' => ['description' => '资源栈描述信息', 'type' => 'string', 'example' => 'the description of stack'], + 'source' => [ + 'description' => '资源栈的配置来源'."\n" + .'- OSS ：通过OSS对象存储的模板'."\n" + .'- IAC_SERVICE_MODULE ： 自动化服务台中创建的模板', + 'type' => 'string', + 'enumValueTitles' => ['IAC_SERVICE_MODULE' => 'IAC_SERVICE_MODULE', 'OSS' => 'OSS'], + 'example' => 'OSS', + ], + 'sourcePath' => ['description' => '配置来源的路径值，不超过 1000 个字符'."\n" + .'- 来源为 OSS 时，取值为 oss::<文件链接>，必须为 zip 文件，例如 oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为 IAC_SERVICE_MODULE 时，取值为<模板Id>，例如: mod-xxxxx', 'type' => 'string', 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'], + 'triggerStrategy' => [ + 'description' => '资源栈部署触发方式，暂未对外开放该字段'."\n" + .'- SetUpdated: 文件变更触发', + 'type' => 'string', + 'enumValueTitles' => ['SetUpdated' => 'SetUpdated'], + 'example' => 'SetUpdated', + ], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2025-07-24T02:58:53Z'], + 'config' => [ + 'description' => '资源栈配置', + 'type' => 'object', + 'properties' => [ + 'deploymentContent' => ['description' => '部署配置', 'type' => 'string', 'example' => 'format_version: IaCService/2021-08-06\\ndescription: create ALB \\nvariable:\\n - name: region\\n type: string\\n ...'], + 'componentContent' => ['description' => '组件配置', 'type' => 'string', 'example' => 'format_version: IaCService/2021-08-06\\ndescription: create ALB\\nupstream_input:\\n - name: stack_network\\n ...'], + ], + ], + 'ramRole' => ['description' => '资源栈部署过程中由系统扮演角色执行资源变更操作', 'type' => 'string', 'example' => 'TestIacRole'], + 'status' => [ + 'description' => '资源栈状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Creating | 创建中 |'."\n" + .'| Created | 创建完成 |'."\n" + .'| Waiting | 等待部署中 |'."\n" + .'| Deploying | 部署中 |'."\n" + .'| Deployed | 部署完成 |'."\n" + .'| Errored | 部署失败 |'."\n" + .'| Deleting | 删除中 |'."\n" + .'| Deleted | 已删除 |'."\n" + .'| DeleteFailed | 删除失败 |'."\n" + .'| DetectTriggered | 偏差检测触发成功 |', + 'type' => 'string', + 'enumValueTitles' => ['Creating' => 'Creating', 'Deploying' => 'Deploying', 'Errored' => 'Errored', 'DeleteFailed' => 'DeleteFailed', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Deleting' => 'Deleting', 'Created' => 'Created', 'Waiting' => 'Waiting'], + 'example' => 'Deployed', + ], + 'workingDirectory' => ['description' => 'stack 的部署和组件配置文件所在的目录，根目录时设置为/', 'type' => 'string', 'example' => '/'], + 'currentConfigVersion' => ['description' => '当前的配置版本号，如：v1。初始值为v1，每次资源栈更新或刷新且配置发生变更时，版本号递增。', 'type' => 'string', 'example' => 'v1'], + ], ], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询资源栈', + 'summary' => '查询资源栈', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C7070EC3-DF66-58BA-A1DD-A8574FF53143\\",\\n \\"stack\\": {\\n \\"stackId\\": \\"stack-as1d4vld898ppnqxxxxxx\\",\\n \\"name\\": \\"stack-test\\",\\n \\"description\\": \\"the description of stack\\",\\n \\"source\\": \\"OSS\\",\\n \\"sourcePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip\\",\\n \\"triggerStrategy\\": \\"SetUpdated\\",\\n \\"createTime\\": \\"2025-07-24T02:58:53Z\\",\\n \\"config\\": {\\n \\"deploymentContent\\": \\"format_version: IaCService/2021-08-06\\\\\\\\ndescription: create ALB \\\\\\\\nvariable:\\\\\\\\n - name: region\\\\\\\\n type: string\\\\\\\\n ...\\",\\n \\"componentContent\\": \\"format_version: IaCService/2021-08-06\\\\\\\\ndescription: create ALB\\\\\\\\nupstream_input:\\\\\\\\n - name: stack_network\\\\\\\\n ...\\"\\n },\\n \\"ramRole\\": \\"TestIacRole\\",\\n \\"status\\": \\"Deployed\\",\\n \\"workingDirectory\\": \\"/\\",\\n \\"currentConfigVersion\\": \\"v1\\"\\n }\\n}","type":"json"}]', + ], + 'GetStackDeployments' => [ + 'summary' => '查询资源栈部署列表', + 'path' => '/stacks/{stackId}/deployments', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'keyword', - 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键词，支持对导出版本名称的模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - ], - [ - 'name' => 'exportTaskId', + 'name' => 'stackId', 'in' => 'path', - 'schema' => [ - 'description' => '资源导出任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ex-al1f11jlh9llnk8drc4g1c', - ], + 'schema' => ['description' => 'StackId，Stack创建后的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'stack-as1d4vld8bgqxxxxxxxx'], ], [ - 'name' => 'pageSize', + 'name' => 'deploymentName', 'in' => 'query', - 'schema' => [ - 'description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => '部署名称', 'type' => 'string', 'required' => false, 'example' => 'production'], ], [ 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '当前页面序号，从1开始', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'status', 'in' => 'query', 'schema' => [ - 'description' => '导出状态'."\n" - ."\n" - .'- Queue：排队中'."\n" - .'- Pending：准备运行'."\n" - .'- Success：运行成功'."\n" - .'- Errored：运行错误'."\n" - .'- Canceled：被取消', + 'description' => '部署状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Pending | deployment被创建后的初始状态 |'."\n" + .'| PriorityQueued | 优先级排队中 |'."\n" + .'| PlanQueued | deployment被创建后，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| ApplyQueued | deployment执行时，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| Planning | 资源deployment正处于执行Plan阶段 |'."\n" + .'| Planned | 资源deployment完成Plan的执行 |'."\n" + .'| ConfigProactiveInProgress | 合规预检中 |'."\n" + .'| ConfigProactiveSuccess | 合规预检成功 |'."\n" + .'| DetectInProgress | 偏差检测中 |'."\n" + .'| ImportQueued | deployment执行Import时，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| Importing | 资源deployment正在进行Import阶段 |'."\n" + .'| Imported | 资源deployment完成Import的执行 |'."\n" + .'| StateQueued | deployment执行state命令时，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| Stating | 资源deployment正在进行state命令的执行 |'."\n" + .'| Stated | 资源deployment完成state命令的执行 |'."\n" + .'| Confirmed | 资源deployment执行Plan之后被确认 |'."\n" + .'| PlannedAndFinished | 执行完Plan之后，发现没有任何diff，此时deployment处于最终状态 |'."\n" + .'| Applying | 资源deployment正处于执行Apply阶段 |'."\n" + .'| Applied | 资源deployment完成Apply的执行 |'."\n" + .'| Discarded | 资源deployment被丢弃，进入最终状态 |'."\n" + .'| Errored | deployment的执行有错误，进入最终状态 |'."\n" + .'| ConfigProactiveFailure | 合规预检失败 |'."\n" + .'| Canceled | deployment的执行被取消，进入最终状态 |', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ - 'Errored' => 'Errored', - 'Canceled' => 'Canceled', - 'Queue' => 'Queue', - 'Pending' => 'Pending', - 'Success' => 'Success', + 'Stated' => '状态检测完成', 'ConfigProactiveInProgress' => '合规预检中', 'ConfigProactiveFailure' => '合规预检失败', 'DetectInProgress' => '偏差检测中', 'Imported' => '状态导入完成', 'Stating' => '状态检测中', 'ApplyQueued' => '执行排队中', 'Planned' => '预览成功', 'Discarded' => '已废弃', 'Applied' => '执行成功', + 'PriorityQueued' => '优先级排队中', 'StateQueued' => '状态检测排队中', 'PlanQueued' => '预览排队中', 'Errored' => '执行失败', 'ConfigProactiveSuccess' => '合规预检成功', 'Planning' => '预览中', 'Confirmed' => '已确认', 'PlannedAndFinished' => '预览成功（无变更）', 'Applying' => '执行中', 'Canceled' => '已取消', + 'Pending' => 'deployment被创建后的初始状态', 'ImportQueued' => '状态导入排队中', ], - 'example' => 'Errored', + 'example' => 'Applied', ], ], [ - 'name' => 'exportVersion', + 'name' => 'configVersion', 'in' => 'query', - 'schema' => [ - 'description' => '导出版本号。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'schema' => ['description' => '配置版本，如：v1。初始值为 v1，每次资源栈更新或刷新且配置发生变更时，版本号递增。', 'type' => 'string', 'required' => false, 'example' => 'v1'], + ], + [ + 'name' => 'deploymentNo', + 'in' => 'query', + 'schema' => ['description' => '部署编号，每个 Stack 的部署编号都从 1 开始，每次成功触发部署后，部署编号都会递增。', 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'exportTasks' => [ - 'description' => '导出任务版本列表。', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => 'BF72A6FB-B071-5F2E-A036-9D62545B962C'], + 'deployments' => [ + 'description' => 'Stack的部署结果', 'type' => 'array', 'items' => [ - 'description' => '导出任务版本列表。', + 'description' => '部署任务的结果', 'type' => 'object', 'properties' => [ - 'exportTaskId' => [ - 'description' => '资源导出任务ID', - 'type' => 'string', - 'example' => 'ex-al1711jl6hd8u5crggeq6v', - ], - 'exportToModule' => [ - 'description' => '将导出后的模板保存为Module。 如果未设置，那么将自动保存在Registry中', + 'deploymentName' => ['description' => '部署名称', 'type' => 'string', 'example' => 'production'], + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-04-01T12:10:18Z'], + 'elapsedTime' => ['description' => '执行耗时，单位：毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '38000'], + 'executeType' => ['description' => '执行类型'."\n" + ."\n" + .'Manual：手动执行（默认）'."\n" + ."\n" + .'Auto：自动执行', 'type' => 'string', 'example' => 'Manual'], + 'config' => [ + 'description' => '配置项。', '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' => '/', - ], + 'autoApply' => ['description' => '是否自动执行任务，默认值为false。-**false**：否。-**true**：是。', 'type' => 'boolean', 'example' => 'false'], + 'isDestroy' => ['description' => '是否为销毁作业', 'type' => 'boolean', 'example' => 'false'], ], ], - 'variables' => [ - 'description' => '变量列表，将资源导出后的参数设置为变量', + 'status' => ['description' => '部署状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Pending | deployment被创建后的初始状态 |'."\n" + .'| PriorityQueued | 优先级排队中 |'."\n" + .'| PlanQueued | deployment被创建后，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| ApplyQueued | deployment执行时，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| Planning | 资源deployment正处于执行Plan阶段 |'."\n" + .'| Planned | 资源deployment完成Plan的执行 |'."\n" + .'| ConfigProactiveInProgress | 合规预检中 |'."\n" + .'| ConfigProactiveSuccess | 合规预检成功 |'."\n" + .'| DetectInProgress | 偏差检测中 |'."\n" + .'| ImportQueued | deployment执行Import时，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| Importing | 资源deployment正在进行Import阶段 |'."\n" + .'| Imported | 资源deployment完成Import的执行 |'."\n" + .'| StateQueued | deployment执行state命令时，如果没有可用的工作流，需要排队等待状态 |'."\n" + .'| Stating | 资源deployment正在进行state命令的执行 |'."\n" + .'| Stated | 资源deployment完成state命令的执行 |'."\n" + .'| Confirmed | 资源deployment执行Plan之后被确认 |'."\n" + .'| PlannedAndFinished | 执行完Plan之后，发现没有任何diff，此时deployment处于最终状态 |'."\n" + .'| Applying | 资源deployment正处于执行Apply阶段 |'."\n" + .'| Applied | 资源deployment完成Apply的执行 |'."\n" + .'| Discarded | 资源deployment被丢弃，进入最终状态 |'."\n" + .'| Errored | deployment的执行有错误，进入最终状态 |'."\n" + .'| ConfigProactiveFailure | 合规预检失败 |'."\n" + .'| Canceled | deployment的执行被取消，进入最终状态 |', 'type' => 'string', 'example' => 'Pending'], + 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'task-as1d4vld8ogb2l32xxxxxx'], + 'jobId' => ['description' => '作业ID', 'type' => 'string', 'example' => 'job-as154vldqt46mv0ixxxxx'], + 'parameters' => [ + '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', - ], + 'name' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'region'], + 'type' => ['description' => '参数类型', 'type' => 'string', 'example' => 'string'], + 'description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'region of the resource'], + 'value' => ['description' => '参数值', 'type' => 'string', 'example' => 'ap-southeast-6'], + 'defaultValue' => ['description' => '参数默认值。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'sensitive' => ['title' => '是否敏感参数，敏感参数值在控制台及api中都不可见'."\n" + .'- true：是敏感值'."\n" + .'- false：非敏感值', 'type' => 'boolean'], ], + 'description' => '', ], ], - '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' => '导出资源时使用的包含规则列表', + 'outputs' => [ + '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' => 'project_name'], + 'type' => ['description' => '参数类型', 'type' => 'string', 'example' => 'string'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'The name of the SLS log project'], + 'value' => ['description' => '部署完成后的实际值', 'type' => 'string', 'example' => 'log-project-xxxx'], + 'expression' => ['description' => '表达式，可以引用组件输出，格式：component.{组件名称}.{组件输出名称}', 'type' => 'string', 'example' => 'component.sls.project_name'], ], + 'description' => '', ], ], - 'modules' => [ - 'description' => '将资源导出后的Module配置', + 'deploymentVersion' => ['description' => '废弃字段', 'type' => 'string', 'example' => 'v1'], + 'failedReason' => ['description' => '失败原因。', 'type' => 'string', 'example' => '\\n Error: Invalid value for input variable\\n \\n on main.tf line 17, in module \\"alb\\":\\n 17: log_project = var.log_project.project_name\\n \\n The given value is not suitable for module.alb.var.log_project declared at\\n modules/alb/main.tf:34,1-23: string required.\\n╵\\n'], + 'deploymentNo' => ['description' => '部署编号，每个Stack的部署编号都从1开始，每次成功触发部署后，部署编号都会递增。', 'type' => 'string', 'example' => '1'], + 'configVersion' => ['description' => '配置版本，如：v1。初始值为 v1，每次资源栈更新或刷新且配置发生变更时，版本号递增。', 'type' => 'string', 'example' => 'v1'], + 'planOutputs' => [ + 'description' => '状态文件输出结果', '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', + 'stackModuleName' => ['description' => '资源栈的组件名称', 'type' => 'string', 'example' => 'sls'], + 'resourceChanges' => [ + 'description' => '资源变更信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceIdentifier' => ['description' => '资源唯一标识符', 'type' => 'string', 'example' => 'alicloud_log_store.default'], + 'resourceActions' => [ + 'description' => '本次资源变更包括的具体的资源变更动作的类型', + 'type' => 'array', + 'items' => ['description' => '资源变更类型'."\n" + .'- create:资源新增'."\n" + .'- update：资源更新'."\n" + .'- delete：资源删除'."\n" + .'- no-op：无变更'."\n" + .'- read：资源查询', 'type' => 'string', 'example' => 'update'], + ], + 'change' => ['description' => '资源变更的差异信息', 'type' => 'string', 'example' => ' ~ resource \\"alicloud_log_store\\" \\"default\\" {\\n id = \\"alb-log-project-v1-ph-xxxxx:alb-log-store-ph\\"\\n ~ max_split_shard_count = 64 -> 32\\n name = \\"alb-log-store-ph\\"\\n\\n # (13 unchanged attributes hidden)\\n }'], + ], + 'description' => '', + ], ], - '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", + 'moduleAction' => ['description' => '组件的变更类型'."\n" + .'- create：组件中资源变更都为新增；'."\n" + .'- delete：组件中资源变更都为删除；'."\n" + .'- read：组件中资源变更都为资源读取；'."\n" + .'- update: 组件中资源变更包括新增、删除或读取中两种及以上变更类型', 'type' => 'string', 'example' => 'update'], + 'moduleActionDetail' => [ + 'description' => '本次部署包含新增、更新和销毁资源的数量', + 'type' => 'object', + 'properties' => [ + 'add' => ['description' => '新创建资源的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'change' => ['description' => '发生变更资源的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'destroy' => ['description' => '被销毁资源的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], ], ], + 'description' => '', ], ], - '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', - ], + 'totalCount' => ['description' => '总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询资源栈部署列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetStackDeployments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\",\\n \\"deployments\\": [\\n {\\n \\"deploymentName\\": \\"production\\",\\n \\"createTime\\": \\"2026-04-01T12:10:18Z\\",\\n \\"elapsedTime\\": 38000,\\n \\"executeType\\": \\"Manual\\",\\n \\"config\\": {\\n \\"autoApply\\": false,\\n \\"isDestroy\\": false\\n },\\n \\"status\\": \\"Pending\\",\\n \\"taskId\\": \\"task-as1d4vld8ogb2l32xxxxxx\\",\\n \\"jobId\\": \\"job-as154vldqt46mv0ixxxxx\\",\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"region\\",\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"region of the resource\\",\\n \\"value\\": \\"ap-southeast-6\\",\\n \\"defaultValue\\": \\"cn-hangzhou\\",\\n \\"sensitive\\": true\\n }\\n ],\\n \\"outputs\\": [\\n {\\n \\"name\\": \\"project_name\\",\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"The name of the SLS log project\\",\\n \\"value\\": \\"log-project-xxxx\\",\\n \\"expression\\": \\"component.sls.project_name\\"\\n }\\n ],\\n \\"deploymentVersion\\": \\"v1\\",\\n \\"failedReason\\": \\"\\\\\\\\n Error: Invalid value for input variable\\\\\\\\n \\\\\\\\n on main.tf line 17, in module \\\\\\\\\\\\\\"alb\\\\\\\\\\\\\\":\\\\\\\\n 17: log_project = var.log_project.project_name\\\\\\\\n \\\\\\\\n The given value is not suitable for module.alb.var.log_project declared at\\\\\\\\n modules/alb/main.tf:34,1-23: string required.\\\\\\\\n╵\\\\\\\\n\\",\\n \\"deploymentNo\\": \\"1\\",\\n \\"configVersion\\": \\"v1\\",\\n \\"planOutputs\\": [\\n {\\n \\"stackModuleName\\": \\"sls\\",\\n \\"resourceChanges\\": [\\n {\\n \\"resourceIdentifier\\": \\"alicloud_log_store.default\\",\\n \\"resourceActions\\": [\\n \\"update\\"\\n ],\\n \\"change\\": \\" ~ resource \\\\\\\\\\\\\\"alicloud_log_store\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"default\\\\\\\\\\\\\\" {\\\\\\\\n id = \\\\\\\\\\\\\\"alb-log-project-v1-ph-xxxxx:alb-log-store-ph\\\\\\\\\\\\\\"\\\\\\\\n ~ max_split_shard_count = 64 -> 32\\\\\\\\n name = \\\\\\\\\\\\\\"alb-log-store-ph\\\\\\\\\\\\\\"\\\\\\\\n\\\\\\\\n # (13 unchanged attributes hidden)\\\\\\\\n }\\"\\n }\\n ],\\n \\"moduleAction\\": \\"update\\",\\n \\"moduleActionDetail\\": {\\n \\"add\\": 0,\\n \\"change\\": 1,\\n \\"destroy\\": 0\\n }\\n }\\n ]\\n }\\n ],\\n \\"totalCount\\": 10\\n}","type":"json"}]', + ], + 'GetStackExecutionResult' => [ + 'path' => '/stacks/trigger/{triggerId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'triggerId', + 'in' => 'path', + 'schema' => ['description' => '触发的唯一ID。'."\n" + .'通过TriggerStackExecution接口得到', 'type' => 'string', 'required' => false, 'example' => 'event-xxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'acl' => [ - 'description' => '权限，private：私有的', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'private' => 'private', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2D40488-3F74-568B-87EC-1C04D098DF8B'], + 'triggerId' => ['description' => '触发的唯一ID。', 'type' => 'string', 'example' => 'event-xxx'], + 'stackResults' => [ + 'description' => '触发的Stack执行结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'stackName' => ['description' => 'Stack名称', 'type' => 'string', 'example' => 'stack-demo'], + 'stackId' => ['description' => 'Stack唯一标识', 'type' => 'string', 'example' => 'stack-al181av2bloah5s53hacbp4'], + 'stackStatus' => [ + 'description' => 'Stack执行状态', + 'type' => 'string', + 'enumValueTitles' => ['Deploying' => '部署中', 'Errored' => '部署失败', 'Deployed' => '部署完成', 'Waiting' => '等待部署中'], + 'example' => 'Deployed', + ], + 'message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'No corresponding Stack found.'], + 'deployments' => [ + 'description' => 'Stack的部署结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'deploymentName' => ['description' => '部署名称', 'type' => 'string', 'example' => 'prod'], + 'status' => ['description' => '部署状态', 'type' => 'string', 'example' => 'Applied'], + 'jobResult' => ['description' => '部署任务的结果', 'type' => 'string', 'example' => 'Service returned null result'], + 'url' => ['description' => '部署详情查看链接', 'type' => 'string', 'example' => 'https://iacnext.console.aliyun.com/stack/stack-al181av2bloah5s53hacbp4/details?deploymentName=production&deploymentNo=6&configVersion=v1'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], - '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', ], + 'triggeredStatus' => ['type' => 'string'], ], - 'required' => false, ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取Stack触发结果', + 'summary' => '获取Stack触发结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetStackExecutionResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F2D40488-3F74-568B-87EC-1C04D098DF8B\\",\\n \\"triggerId\\": \\"event-xxx\\",\\n \\"stackResults\\": [\\n {\\n \\"stackName\\": \\"stack-demo\\",\\n \\"stackId\\": \\"stack-al181av2bloah5s53hacbp4\\",\\n \\"stackStatus\\": \\"Deployed\\",\\n \\"message\\": \\"No corresponding Stack found.\\",\\n \\"deployments\\": [\\n {\\n \\"deploymentName\\": \\"prod\\",\\n \\"status\\": \\"Applied\\",\\n \\"jobResult\\": \\"Service returned null result\\",\\n \\"url\\": \\"https://iacnext.console.aliyun.com/stack/stack-al181av2bloah5s53hacbp4/details?deploymentName=production&deploymentNo=6&configVersion=v1\\"\\n }\\n ]\\n }\\n ],\\n \\"triggeredStatus\\": \\"\\"\\n}","type":"json"}]', + ], + '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' => [ @@ -5169,364 +5414,481 @@ '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', + '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'], + ], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"requestId\\": \\"B4672AE3-C313-5B7A-BB24-45345570D398\\"\\n}","type":"json"}]', - 'title' => '创建工作空间', + '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 次/秒。', - ], - 'UpdateRegistryNamespaceAttribute' => [ - 'summary' => '修改工作空间。', - 'path' => '/registryNamespace/{namespaceName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2023-07-11T07:34:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-29T13:37:13.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-09-01T06:23:45.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], + ], + ], + ], ], + ], + 'GetTerraformStateDetection' => [ + 'summary' => '获取状态文件检测结果', + 'path' => '/terraformState/detect/{detectionId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'detectionId', + 'in' => 'path', + 'schema' => ['description' => '检测任务Id', 'type' => 'string', 'required' => false, 'example' => 'job-ascxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '请求体', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'acl' => [ - 'description' => '权限，private：私有的', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'private' => 'private', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9'], + 'job' => [ + 'description' => '作业详情', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '任务类型', + 'type' => 'string', + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', + ], + 'identifier' => ['description' => '任务标识符。Stack 任务为 <$stackId>:<$deploymentName>；Task 任务为 <$TaskId>', 'type' => 'string', 'example' => 'stack-as181axxxxxx:development_xxxx'], + 'status' => ['description' => '作业状态'."\n" + ."\n" + .'- Pending：Job被创建后的初始状态'."\n" + .'- PlanQueued：Job被创建后，如果没有可用的容器，需要排队等待状态'."\n" + .'- Planning：资源Job正处于执行Plan阶段'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff，此时Job处于最终状态'."\n" + .'- Errored：Job的执行有错误，进入最终状态', 'type' => 'string', 'example' => 'Errored'], + 'errorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'planned failed'], + 'changedResources' => [ + 'description' => '状态变更资源集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceIdentifier' => ['description' => '资源在 Terraform 模版中的标识符。Stack 任务为<$componetName>:<$resourceName>。Task 任务为<$resourceName>', 'type' => 'string', 'example' => 'vpc:alicloud_vpc.default'], + 'resourceId' => ['description' => 'Terraform 资源 Id', 'type' => 'string', 'example' => 'vpc-axxxxx'], + 'changedType' => ['description' => '变更类型', 'type' => 'string', 'example' => 'create'], + 'attributeChanges' => [ + 'description' => '属性变更集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'attributePath' => ['description' => '属性名', 'type' => 'string', 'example' => 'vpc_name'], + 'remoteValue' => ['description' => '服务端状态值', 'type' => 'string', 'example' => 'test_remote'], + 'templateValue' => ['description' => '模版声明值', 'type' => 'string', 'example' => 'test_hcl'], + ], + 'description' => '', + ], + ], + 'hasDrift' => ['description' => '是否存在资源漂移', 'type' => 'boolean', 'example' => 'false'], + ], + 'description' => '', + ], + ], + 'driftedResources' => [ + 'description' => '状态漂移资源集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceIdentifier' => ['description' => '资源在 Terraform 模版中的标识符。Stack 任务为<$componetName>:<$resourceName>。Task 任务为<$resourceName>', 'type' => 'string', 'example' => 'vpc:alicloud_vpc.default2'."\n"], + 'resourceId' => ['description' => 'Terraform 资源 Id', 'type' => 'string', 'example' => 'vpc-bxxxxx'], + 'driftedType' => ['description' => '漂移类型', 'type' => 'string', 'example' => 'update'], + 'attributeDrifts' => [ + 'description' => '属性漂移集合', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'attributePath' => ['description' => '属性名', 'type' => 'string', 'example' => 'vpc_name'], + 'stateValue' => ['description' => '状态文件存储值', 'type' => 'string', 'example' => 'test_state'], + 'remoteValue' => ['description' => '服务端状态值', 'type' => 'string', 'example' => 'test_remote'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], ], - '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, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取状态文件检测结果', + 'description' => '该API主要用于获取自动化服务台上资源编排任务和资源栈任务状态文件的检测结果。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\",\\n \\"job\\": {\\n \\"type\\": \\"Stack\\",\\n \\"identifier\\": \\"stack-as181axxxxxx:development_xxxx\\",\\n \\"status\\": \\"Errored\\",\\n \\"errorMessage\\": \\"planned failed\\",\\n \\"changedResources\\": [\\n {\\n \\"resourceIdentifier\\": \\"vpc:alicloud_vpc.default\\",\\n \\"resourceId\\": \\"vpc-axxxxx\\",\\n \\"changedType\\": \\"create\\",\\n \\"attributeChanges\\": [\\n {\\n \\"attributePath\\": \\"vpc_name\\",\\n \\"remoteValue\\": \\"test_remote\\",\\n \\"templateValue\\": \\"test_hcl\\"\\n }\\n ],\\n \\"hasDrift\\": false\\n }\\n ],\\n \\"driftedResources\\": [\\n {\\n \\"resourceIdentifier\\": \\"vpc:alicloud_vpc.default2\\\\n\\",\\n \\"resourceId\\": \\"vpc-bxxxxx\\",\\n \\"driftedType\\": \\"update\\",\\n \\"attributeDrifts\\": [\\n {\\n \\"attributePath\\": \\"vpc_name\\",\\n \\"stateValue\\": \\"test_state\\",\\n \\"remoteValue\\": \\"test_remote\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDetectConfigRelations' => [ + 'summary' => '列举偏差检测关联关系', + 'path' => '/terraformState/detectConfig/operations/relation', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'namespaceName', - 'in' => 'path', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + ], + 'parameters' => [ + [ + 'name' => 'targetType', + 'in' => 'query', 'schema' => [ - 'description' => '工作空间名称，需满足下述要求：'."\n" + 'description' => '关联目标类型'."\n" ."\n" - .'- 长度为 3~63 个字符。'."\n" - .'- 允许大小写字母、数字、短横线（-）、下划线（_），且不能以短横线开头或结尾。'."\n" - .'- 名称在全局工作空间资源下唯一。', + .'- Task 编排任务'."\n" + .'- Stack 资源栈', 'type' => 'string', - 'required' => true, - 'example' => 'NamespaceName', + 'required' => false, + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', ], ], + [ + 'name' => 'targetId', + 'in' => 'query', + 'schema' => ['description' => '关联目标 Id。StackId 或 TaskId', 'type' => 'string', 'required' => false, 'example' => 'stack-xxxxx'], + ], + [ + 'name' => 'detectConfigId', + 'in' => 'query', + 'schema' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'required' => false, 'example' => 'dc-xxxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + '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', + 'detectConfigRelations' => [ + 'description' => '关联关系列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'detectConfigId' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'example' => 'dc-xxxx'], + 'targetType' => [ + 'description' => '关联目标类型'."\n" + ."\n" + .'- Task 编排任务'."\n" + .'- Stack 资源栈', + 'type' => 'string', + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', + ], + 'targetId' => ['description' => '关联目标 Id。StackId 或 TaskId', 'type' => 'string', 'example' => 'stack-xxxx'], + 'attachDate' => ['description' => '关联时间', 'type' => 'string', 'example' => '2026-04-08T08:53:07.000+00:00'], + 'targetName' => ['description' => '关联目标名称', 'type' => 'string', 'example' => 'stack-name-xxx'], + 'enabled' => ['description' => '是否开启', 'type' => 'string', 'example' => 'true'], + ], + 'description' => '', + ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0D797DC3-FF04-5C21-81EB-XXXXXXXXX'], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '列举偏差检测关联关系', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"requestId\\": \\"CA5C5B39-D1DC-5309-8E97-B9A91DA21094\\"\\n}","type":"json"}]', - 'title' => '修改工作空间', - 'description' => '单用户调用频率：100 次/秒。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"detectConfigRelations\\": [\\n {\\n \\"detectConfigId\\": \\"dc-xxxx\\",\\n \\"targetType\\": \\"Stack\\",\\n \\"targetId\\": \\"stack-xxxx\\",\\n \\"attachDate\\": \\"2026-04-08T08:53:07.000+00:00\\",\\n \\"targetName\\": \\"stack-name-xxx\\",\\n \\"enabled\\": \\"true\\"\\n }\\n ],\\n \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-XXXXXXXXX\\",\\n \\"totalCount\\": 5\\n}","type":"json"}]', ], - 'ListRegistryNamespaces' => [ - 'summary' => '查询工作空间列表。', - 'path' => '/registryNamespace', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListDetectConfigs' => [ + 'summary' => '列举偏差检测配置', + 'path' => '/terraformState/detectConfig', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'keyword', + 'name' => 'detectConfigName', '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', - ], - ], + 'schema' => ['description' => '偏差检测配置名称（模糊匹配）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。最大值为100。'."\n" - .'默认值：20', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '一次获取的最大记录数。范围 1～200，默认 100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', - 'type' => 'string', - 'required' => false, - 'example' => 'hg7nXVngyM6tQtvCagmtY=', - ], + 'schema' => ['description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。'."\n", 'type' => 'string', 'required' => false, 'example' => '30BaZ9ekYWXJdqshYecA++coNg7qT1Zbm3RfLyFIZeY='], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'count' => [ - 'description' => '总记录数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53', - ], - 'maxResults' => [ - 'description' => '一次获取的最大记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '24', - ], - 'namespaces' => [ - 'description' => '工作空间列表', + 'detectConfigs' => [ + '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' => '共享账号列表', + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-04-10T02:30:04Z'."\n"], + 'description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'this is a description'."\n"], + 'detectConfigName' => ['description' => '偏差检测配置名称', 'type' => 'string', 'example' => 'test'], + 'detectConfigId' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'example' => 'dc-xxxx'], + 'enabled' => ['description' => '是否开启定时检测', 'type' => 'boolean', 'example' => 'true'], + 'triggerType' => ['description' => '触发类型'."\n" + ."\n" + .'- Manual: 手动执行'."\n" + .'- Cron: 定时触发', 'type' => 'string', 'example' => 'Cron'], + 'cronExpression' => ['description' => 'cron 表达式（北京时间）。当触发类型为 Cron 时必填', 'type' => 'string', 'example' => '0 0 0 ? * 1'."\n"], + 'alarmConfigs' => [ + 'description' => '告警地址列表', 'type' => 'array', 'items' => [ - 'description' => '共享账号UID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '报警途径。当前仅支持 `cms`', 'type' => 'string', 'example' => 'cms'], + 'address' => ['description' => '报警地址。', 'type' => 'string', 'example' => 'https://metrichub-cms-cn-hangzhou.aliyuncs.com/event/notify?xxxxx'], + ], + 'description' => '', ], ], - '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', - ], ], + 'description' => '', ], ], - 'nextToken' => [ - 'description' => '下一页token，为null表示没有下一页', - 'type' => 'string', - 'example' => 'IPTL1XAYFTgtpI04QQpc5dyKpESXBc=', - ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5FFB0033-A016-5A9D-9283-C123AAA7F71D', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '79284133-D4BA-56B3-954C-D538256F7EAA'], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '82'], + 'nextToken' => ['description' => '分页nextToken', 'type' => 'string', 'example' => '30BaZ9ekYWXJdqshYecA++coNg7qT1Zbm3RfLyFIZeY='], + 'maxResults' => ['description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '列举偏差检测配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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 次/秒。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"detectConfigs\\": [\\n {\\n \\"createTime\\": \\"2026-04-10T02:30:04Z\\\\n\\",\\n \\"description\\": \\"this is a description\\\\n\\",\\n \\"detectConfigName\\": \\"test\\",\\n \\"detectConfigId\\": \\"dc-xxxx\\",\\n \\"enabled\\": true,\\n \\"triggerType\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0 0 0 ? * 1\\\\n\\",\\n \\"alarmConfigs\\": [\\n {\\n \\"type\\": \\"cms\\",\\n \\"address\\": \\"https://metrichub-cms-cn-hangzhou.aliyuncs.com/event/notify?xxxxx\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"79284133-D4BA-56B3-954C-D538256F7EAA\\",\\n \\"totalCount\\": 82,\\n \\"nextToken\\": \\"30BaZ9ekYWXJdqshYecA++coNg7qT1Zbm3RfLyFIZeY=\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', ], - 'GetRegistryNamespace' => [ - 'summary' => '查询工作空间。', - 'path' => '/registryNamespace/{namespaceName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListExplorerRegistryModuleExamples' => [ + 'summary' => '获取官方的 Terraform Module 示例列表。', + 'path' => '/explorerRegistryModule/example', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'namespaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'terraform-alicloud-modules', - ], + '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' => [ @@ -5536,115 +5898,111 @@ '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', + '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'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '26684763-5BAB-58C8-BA4F-9D622AB7AD14', - ], + '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', + '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、总条目数、当前页数据及分页信息，便于处理查询结果。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExplorerRegistryModuleExamples'], + ], ], - '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 次/秒。', + 'ramActions' => [], ], - 'DeleteRegistryNamespace' => [ - 'summary' => '删除工作空间。', - 'path' => '/registryNamespace/{namespaceName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListExplorerRegistryModuleVersions' => [ + 'summary' => '列举阿里云 Terraform 官方提供的 Module版本信息。', + 'path' => '/explorerRegistryModule/version', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'namespaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + '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' => [ @@ -5654,203 +6012,231 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '1D0CD708-E433-5F13-8A42-823C95FC756C', + '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', + '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、总条目数、当前页数据及分页信息，便于处理查询结果。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExplorerRegistryModuleVersions'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1D0CD708-E433-5F13-8A42-823C95FC756C\\"\\n}","type":"json"}]', - 'title' => '删除工作空间', - 'description' => '单用户调用频率：100 次/秒。', + 'ramActions' => [], ], - 'AddSharedAccounts' => [ - 'summary' => '添加共享账号。', - 'path' => '/sharedAccounts', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListExplorerRegistryModules' => [ + 'summary' => '列举阿里云 Terraform 官方提供的 Module 信息。', + 'path' => '/explorerRegistryModule', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], '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, - ], + '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' => '响应体', + 'description' => '响应参数对象'."\n", 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0D797DC3-FF04-5C21-81EB-XXXXXXXXX', + '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 \\"requestId\\": \\"0D797DC3-FF04-5C21-81EB-XXXXXXXXX\\"\\n}","type":"json"}]', - 'title' => '添加共享账号', - 'description' => '单用户调用频率：100 次/秒。', - ], - 'RemoveSharedAccounts' => [ - 'summary' => '移除共享账号。', - 'path' => '/sharedAccounts', - 'methods' => [ - 'delete', + '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、总条目数、当前页数据及分页信息，便于处理查询结果。', + 'changeSet' => [ + ['createdAt' => '2025-08-01T07:19:06.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExplorerRegistryModules'], + ], ], + 'ramActions' => [], + ], + 'ListGroup' => [ + 'summary' => '查询分组列表。', + 'path' => '/group', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'resourceId', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '取消共享的资源ID'."\n" - ."\n" - .' - 类型为Namespace时取值工作空间名称 '."\n" - ."\n" - .'- 类型为RegistryModule时取值 \\<namespaceName>/\\<ModuleName>', - 'type' => 'string', - 'required' => true, - 'example' => 'terraform-alicloud-modules/mongodb'."\n", - ], + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', 'type' => 'string', 'required' => false, 'example' => '200'], ], [ - 'name' => 'resourceType', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型，取值'."\n" - ."\n" - .'- RegistryModule :Registry模板'."\n" - .'- Namespace：工作空间', - 'type' => 'string', - 'required' => true, - 'example' => 'RegistryModule', - 'enum' => [ - 'Namespace', - 'RegistryModule', - ], - ], + 'schema' => ['description' => '页码，默认1。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'accountIds', + 'name' => 'projectId', 'in' => 'query', - 'style' => 'simple', + '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' => '云账号ID列表', + 'description' => '标签列表。', 'type' => 'array', 'items' => [ - 'description' => '云账号UID', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'key'], + 'value' => ['description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], 'required' => false, - 'example' => '12345678', ], - 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, + 'required' => false, ], ], ], @@ -5861,112 +6247,160 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8294F4ED-8DBA-5441-B3F2-61C3C5374990', + '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'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取分组列表', + 'changeSet' => [ + ['createdAt' => '2023-05-24T06:38:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-05-05T07:48:41.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-30T05:11:27.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-29T17:40:22.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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', - ], + 'ListJobs' => [ + 'summary' => '查询作业列表。', + 'path' => '/tasks/{taskId}/jobs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => 'task-55f1739d9050fff'], + ], + [ + 'name' => 'status', + 'in' => 'query', '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', - ], + 'description' => '作业状态'."\n" + ."\n" + .'- Pending：Job被创建后的初始状态'."\n" + .'- PlanQueued：Job被创建后，如果没有可用的工作流，需要排队等待状态'."\n" + .'- Planning：资源Job正处于执行Plan阶段'."\n" + .'- ConfigProactiveInProgress：合规预检中（需要账号开启合规预检功能）'."\n" + .'- ConfigProactiveSuccess：合规预检成功（需要账号开启合规预检功能）'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff（最终状态）'."\n" + .'- Confirmed：资源Job执行Plan完成后等待确认的状态'."\n" + .'- ApplyQueued：Job执行时，如果没有可用的工作流，需要排队等待状态'."\n" + .'- Applying：资源Job正处于执行Apply阶段'."\n" + .'- Applied：资源Job完成Apply的执行（最终状态）'."\n" + .'- Errored：Job的执行错误（最终状态）'."\n" + .'- Canceled：Job的执行被取消（最终状态）'."\n" + .'- Discarded：资源Job的plan被废弃（最终状态）'."\n" + .'- ConfigProactiveFailure：合规预检失败（需要账号开启合规预检功能）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ConfigProactiveInProgress' => '合规预检中（需要账号开启合规预检功能）', 'ConfigProactiveFailure' => '合规预检失败（需要账号开启合规预检功能）', 'Planned' => '资源 Job 完成 Plan 的执行完成', 'ApplyQueued' => 'Job 执行时，如果没有可用的工作流，需要排队等待状态', 'Discarded' => '资源 Job 的 plan 被废弃（最终状态）', 'Applied' => '资源 Job 完成 Apply 的执行（最终状态）', 'PlanQueued' => 'Job 被创建后，如果没有可用的工作流，需要排队等待状态', 'Errored' => 'Job 的执行错误（最终状态）', 'ConfigProactiveSuccess' => '合规预检成功（需要账号开启合规预检功能）', 'Planning' => '资源 Job 正处于执行 Plan 阶段', + 'PlannedAndFinished' => '执行完 Plan 之后，发现没有任何 diff（最终状态）', 'Applying' => '资源 Job 正处于执行 Apply 阶段', 'Canceled' => 'Job 的执行被取消（最终状态）', 'Confirmed' => '资源 Job 执行 Plan 完成后等待确认的状态', 'Pending' => 'Job 被创建后的初始状态', ], + '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 => [ @@ -5975,111 +6409,151 @@ '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', + '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" + .'- ConfigProactiveInProgress：合规预检中（需要账号开启合规预检功能）'."\n" + .'- ConfigProactiveSuccess：合规预检成功（需要账号开启合规预检功能）'."\n" + .'- Planned：资源Job完成Plan的执行完成'."\n" + .'- PlannedAndFinished：执行完Plan之后，发现没有任何diff（最终状态）'."\n" + .'- Confirmed：资源Job执行Plan完成后等待确认的状态'."\n" + .'- ApplyQueued：Job执行时，如果没有可用的工作流，需要排队等待状态'."\n" + .'- Applying：资源Job正处于执行Apply阶段'."\n" + .'- Applied：资源Job完成Apply的执行（最终状态）'."\n" + .'- Errored：Job的执行错误（最终状态）'."\n" + .'- Canceled：Job的执行被取消（最终状态）'."\n" + .'- Discarded：资源Job的plan被废弃（最终状态）'."\n" + .'- ConfigProactiveFailure：合规预检失败（需要账号开启合规预检功能）', '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'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C896FE0A-1BEA-5D01-BFF4-B03B82B9CA3D\\",\\n \\"source\\": \\"namespaceName/ModuleName\\"\\n}","type":"json"}]', - 'title' => '创建Registry模板', + '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 次/秒。', - ], - 'UpdateRegistryModuleAttribute' => [ - 'summary' => '修改Registry模板。', - 'path' => '/registryModule/{namespaceName}/{moduleName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [ + ['createdAt' => '2025-12-04T02:30:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-07-23T09:04:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-07-05T09:05:18.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-12-07T08:49:56.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-29T14:16:54.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '360', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/*'], + ], + ], + 'additionalActions' => [], + ], ], + ], + 'ListModuleVersion' => [ + 'summary' => '获取模板版本列表。', + 'path' => '/modules/{moduleId}/versions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + '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' => 'moduleId', + 'in' => 'path', + 'schema' => ['description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => 'mod-433aead756057fff39b2f7ac8b798'], ], [ - 'name' => 'namespaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'NamespaceName', - ], + 'name' => 'keyword', + 'in' => 'query', + 'schema' => ['description' => '搜索关键词，支持对版本名称的模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'key'], ], [ - 'name' => 'moduleName', - 'in' => 'path', - 'schema' => [ - 'description' => 'Registry模板名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ModuleName', - ], + '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' => [ @@ -6089,129 +6563,124 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '127A5B81-D1E7-5E33-8D44-B89507C4B81F', + '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'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"127A5B81-D1E7-5E33-8D44-B89507C4B81F\\"\\n}","type":"json"}]', - 'title' => '修改Registry模板', + '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 次/秒。', - ], - 'ListRegistryModules' => [ - 'summary' => '查询Registry模板列表。', - 'path' => '/registryModules', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModuleVersion'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/*'], + ], + ], + ], ], + ], + 'ListModules' => [ + 'summary' => '获取当前用户下的模板列表，支持分页和条件筛选', + 'path' => '/modules', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'namespaceName', + 'name' => 'keyword', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => false, - 'example' => 'NamespaceName', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '搜索关键词，支持对模板名称的模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'key'], ], [ - 'name' => 'type', + 'name' => 'pageSize', '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', - ], - ], + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20'], ], [ - 'name' => 'keyword', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键词，支持对模板名称的模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'maxResults', + 'name' => 'projectId', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。最大值为100。默认值：20', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => false, 'example' => 'p-al1c58tb2lu9oej36kclvf'], ], [ - 'name' => 'nextToken', + 'name' => 'groupId', 'in' => 'query', - 'schema' => [ - 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', - 'type' => 'string', - 'required' => false, - 'example' => 'NFzbQCa7/yd7rAuSo5xZb54dD+2BRJj42DLT6GrZysw=', - ], + 'schema' => ['description' => '分组ID', 'type' => 'string', 'required' => false, 'example' => 'g-kw1a50tj8rk7cki2q8bbat'], ], [ - 'name' => 'status', + 'name' => 'tag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + '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, 'description' => ''], + ], ], 'responses' => [ 200 => [ @@ -6220,322 +6689,240 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'registryModules' => [ - 'description' => 'Registry模板列表', + 'modules' => [ + 'description' => '模板列表。', 'type' => 'array', 'items' => [ - 'description' => 'Registry模板', + 'description' => '模板列表。', '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', + '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'], + ], ], - 'sharedAccounts' => [ - 'description' => '共享Registry模板账号列表', + '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' => '共享Registry模板账号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', + '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'], + ], ], ], - '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', - ], + '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'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '## 请求说明'."\n" + ."\n" + .'该接口用于列举当前用户下的所有 Terraform 模板。可以通过指定查询参数来实现分页、模糊匹配模板名称、筛选模板来源或状态等功能。此外，还可以通过标签进行更细粒度的筛选。'."\n" + ."\n" + .'### 特别注意'."\n" + .'- 分页参数 `pageNumber` 和 `pageSize` 可以帮助控制返回结果的数量。'."\n" + .'- 使用 `name` 参数可以对模板名称进行模糊匹配搜索。'."\n" + .'- 通过 `source` 参数可按模板来源（如 OSS 导入、文件上传等）筛选模板。'."\n" + .'- 利用 `status` 参数可以根据模板的状态（如已创建、已发布等）进行过滤。'."\n" + .'- 标签筛选需提供 JSON 格式的字符串，例如 `[{"key":"env","value":"prod"}]`。'."\n", + 'changeSet' => [ + ['createdAt' => '2025-10-16T07:10:35.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-14T16:07:42.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-24T06:38:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-11-29T14:16:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:48.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModules'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListModules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/*'], + ], + ], + ], ], - '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', - ], + 'ListParameterSetRelation' => [ + 'summary' => '关联到资源的参数集列表', + 'path' => '/parameterSets/operations/relation', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'namespaceName', - 'in' => 'path', + 'name' => 'resourceType', + 'in' => 'query', 'schema' => [ - 'description' => '工作空间名称', + 'description' => '其他资源类型，有效值为：'."\n" + .'- Module'."\n" + .'- ModuleVersion'."\n" + .'- Task'."\n" + .'- SceneTestingTask'."\n" + .'- Stack', 'type' => 'string', 'required' => true, - 'example' => 'NamespaceName', + 'enumValueTitles' => ['SceneTestingTask' => 'SceneTestingTask', 'Task' => 'Task', 'ModuleVersion' => 'ModuleVersion', 'Module' => 'Module', 'Stack' => 'Stack'], + 'example' => 'Module', ], ], [ - 'name' => 'moduleName', - 'in' => 'path', - 'schema' => [ - 'description' => '模板名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ModuleName', - ], + 'name' => 'resourceId', + 'in' => 'query', + 'schema' => ['description' => '其他资源ID，'."\n" + .'ModuleVersion用<moduleId>-<versionId>拼接', 'type' => 'string', 'required' => true, 'example' => 'mod-edf123fr-v3'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + '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', + 'parameterSets' => [ + 'description' => '参数集列表', + 'type' => 'array', + 'items' => [ + 'description' => '参数集列表', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-05-14T10:05:19Z'], + 'description' => ['description' => '描述。', 'type' => 'string', 'example' => '123111'], + 'name' => ['description' => '参数集名称', 'type' => 'string', 'example' => 'alb_enable_ipv6_4.2'], + 'parameterSetId' => ['description' => '参数集ID', 'type' => 'string', 'example' => 'pts-kw1b11jlssrabb638ptums'], + 'parameters' => [ + 'description' => '参数集内容', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '参数名称', 'example' => 'name'], ], ], - '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '2F24E990-E8D3-5C18-ABEA-C7A3F1831C57'], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '查询资源关联的参数集列表', + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:06.000Z', 'description' => 'OpenAPI 下线'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListParameterSetRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parameterSets\\": [\\n {\\n \\"createTime\\": \\"2022-05-14T10:05:19Z\\",\\n \\"description\\": \\"123111\\",\\n \\"name\\": \\"alb_enable_ipv6_4.2\\",\\n \\"parameterSetId\\": \\"pts-kw1b11jlssrabb638ptums\\",\\n \\"parameters\\": {\\n \\"key\\": \\"name\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"2F24E990-E8D3-5C18-ABEA-C7A3F1831C57\\",\\n \\"totalCount\\": 5\\n}","type":"json"}]', + ], + 'ListParameterSets' => [ + 'path' => '/parameterSets', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'namespaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'NamespaceName', - ], + 'name' => 'keyword', + 'in' => 'query', + 'schema' => ['description' => '关键字，按照全匹配搜索，不区分大小写。', 'type' => 'string', 'required' => false, 'example' => 'vpc'], ], [ - 'name' => 'moduleName', - 'in' => 'path', - 'schema' => [ - 'description' => '模板名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ModuleName ', - ], + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：200。', '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' => 'kmsKeyId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '21a90f5d-a469-4ac4-a8ea-f6e1e7470e6f'], ], ], 'responses' => [ @@ -6545,91 +6932,266 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '545995A8-243D-5963-A940-B74FAF6009B5', + 'pageNumber' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：200。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'parameterSets' => [ + 'description' => '参数集合', + 'type' => 'array', + 'items' => [ + 'description' => '参数集合', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-05-14T10:05:19Z'], + 'deletionProtection' => ['description' => '开启删除保护', 'type' => 'boolean', 'example' => 'false'], + 'description' => ['description' => '参数集描述', 'type' => 'string', 'example' => 'This is parameterSet'], + 'name' => ['description' => '参数集名称', 'type' => 'string', 'example' => 'demo'], + 'parameterSetId' => ['description' => '参数集ID', 'type' => 'string', 'example' => 'pts-433aead756057ea135b21e89c'], + 'parameters' => [ + 'description' => '参数集内容', + 'type' => 'array', + 'items' => [ + 'description' => '参数集内容', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '参数名称', 'type' => 'string', 'example' => 'region'], + 'type' => ['description' => '参数类型（string/number/bool/map(string)/list(string)）', 'type' => 'string', 'example' => 'string'], + 'value' => ['description' => '参数值', 'type' => 'any', 'example' => 'cn-beijing'], + 'status' => [ + 'description' => '参数集状态，枚举：'."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值'."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为 null', + 'type' => 'string', + 'enumValueTitles' => ['EXPLICIT_NULL' => '显式设置为 null', 'HAS_VALUE' => '定义具体值'], + 'example' => 'HAS_VALUE', + ], + 'secret' => ['type' => 'boolean'], + ], + ], + ], + 'relationList' => [ + 'description' => '关联关系', + 'type' => 'array', + 'items' => [ + 'description' => '关联关系'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-06-09T03:46:18Z'], + 'resourceId' => ['description' => '资源ID'."\n" + .'资源类型为ModuleVersion时，'."\n" + .'由<moduleId>-<moduleversion>拼接而成，'."\n" + .'如mod-34535345df123fr-v3', 'type' => 'string', 'example' => 'task-433aead756057ffdf5326bf1e12ed'], + 'resourceType' => [ + 'description' => '资源类型，取值'."\n" + ."\n" + .'- Module 模板'."\n" + .'- ModuleVersion 模板版本'."\n" + .'- Task 任务', + 'type' => 'string', + 'enumValueTitles' => ['Task' => '任务', 'ModuleVersion' => '模板版本', 'Module' => '模板'], + 'example' => 'Module', + ], + ], + ], + ], + ], + ], ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '4E188A8C-D77A-53F2-9578-E9AD8ABF2FA9'], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取参数集列表', + 'summary' => '查询并分页获取参数集列表，支持关键词搜索。', + 'description' => '## 请求说明'."\n" + .'该接口用于查询系统中的所有参数集，并支持通过关键词进行过滤以及分页显示结果。请求时需要提供认证信息。'."\n" + ."\n" + .'### 特殊说明'."\n" + .'- `keyword` 参数可用于根据名称或描述模糊匹配参数集。'."\n" + .'- 分页功能通过 `pageNumber` 和 `pageSize` 控制，默认从第一页开始，每页显示数量可自定义但需合理设置以避免性能问题。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-06-27T10:03:06.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListParameterSets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:ParameterSet/*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"545995A8-243D-5963-A940-B74FAF6009B5\\"\\n}","type":"json"}]', - 'title' => '删除Registry模板', - 'description' => '单用户调用频率：100 次/秒。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"parameterSets\\": [\\n {\\n \\"createTime\\": \\"2022-05-14T10:05:19Z\\",\\n \\"deletionProtection\\": false,\\n \\"description\\": \\"This is parameterSet\\",\\n \\"name\\": \\"demo\\",\\n \\"parameterSetId\\": \\"pts-433aead756057ea135b21e89c\\",\\n \\"parameters\\": [\\n {\\n \\"name\\": \\"region\\",\\n \\"type\\": \\"string\\",\\n \\"value\\": \\"cn-beijing\\",\\n \\"status\\": \\"HAS_VALUE\\",\\n \\"secret\\": true\\n }\\n ],\\n \\"relationList\\": [\\n {\\n \\"createTime\\": \\"2022-06-09T03:46:18Z\\",\\n \\"resourceId\\": \\"task-433aead756057ffdf5326bf1e12ed\\",\\n \\"resourceType\\": \\"Module\\"\\n }\\n ]\\n }\\n ],\\n \\"requestId\\": \\"4E188A8C-D77A-53F2-9578-E9AD8ABF2FA9\\",\\n \\"totalCount\\": 50\\n}","type":"json"}]', ], - 'PublishRegistryModuleVersion' => [ - 'summary' => '发布Registry模板版本。', - 'path' => '/registryModuleVersion', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListProducts' => [ + 'summary' => '所有产品列表。', + 'path' => '/products', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', + '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'], + ], ], - 'produces' => [ - 'application/json', + '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'], + ], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', + '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、总条目数、当前页数据及分页信息，便于处理查询结果。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '800', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], ], ], + 'ramActions' => [], + ], + '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' => 'body', - 'in' => 'body', + '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' => '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', + '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 => [ @@ -6638,100 +7200,110 @@ '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', + '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'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '获取项目列表', + 'changeSet' => [ + ['createdAt' => '2023-05-24T06:38:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-11-30T05:11:27.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-11-29T17:40:22.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProject'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/*'], + ], + ], + ], ], - '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', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'namespaceName', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'MamespaceName', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'MamespaceName'], ], [ 'name' => 'moduleName', 'in' => 'query', - 'schema' => [ - 'description' => 'Registry模板名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ModuleName', - ], + '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', - ], + '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=', - ], + 'schema' => ['description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'TRkuCaTw/VsEHrnCZgrBA0ftQSEJU/lzo2ei7MJjplg='], ], ], 'responses' => [ @@ -6748,138 +7320,114 @@ '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", - ], + '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', - ], + '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', - ], + '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegistryModuleVersions'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListRegistryModuleVersions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], ], + ], + 'ListRegistryModules' => [ + 'summary' => '查询Registry模板列表。', + 'path' => '/registryModules', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ 'name' => 'namespaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'NamespaceName', - ], + 'in' => 'query', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => false, 'example' => 'NamespaceName'], ], [ - 'name' => 'moduleName', - 'in' => 'path', + 'name' => 'type', + 'in' => 'query', 'schema' => [ - 'description' => '模板名称', + 'description' => '工作空间类型。可选值：'."\n" + ."\n" + .'- system：公共Module'."\n" + ."\n" + .'- self：自定义Module'."\n" + ."\n" + .'- shared：共享Module'."\n" + ."\n" + .'- community：社区Module'."\n" + ."\n" + .'默认返回所有的', 'type' => 'string', - 'required' => true, - 'example' => 'ModuleName', + 'required' => false, + 'example' => 'system', + 'enum' => ['system', 'self', 'shared', 'community'], ], ], [ - 'name' => 'version', - 'in' => 'path', - 'schema' => [ - 'description' => '版本号', - 'type' => 'string', - 'required' => true, - 'example' => '1.1.0', - ], + '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'], ], ], 'responses' => [ @@ -6889,134 +7437,122 @@ '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', + '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'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '62DF26B0-53F0-5747-9D7F-FEF444FB4E24', - ], + '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 \\"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模板版本', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询Registry模板列表', 'description' => '单用户调用频率：200 次/秒。', - ], - 'DeleteRegistryModuleVersion' => [ - 'summary' => '删除Registry模板版本。', - 'path' => '/registryModuleVersion/{namespaceName}/{moduleName}/{version}', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegistryModules'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListRegistryModules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/*'], + ], + ], + ], ], + '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"}]', + ], + 'ListRegistryNamespaces' => [ + 'summary' => '查询工作空间列表。', + 'path' => '/registryNamespace', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'namespaceName', - 'in' => 'path', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'example' => 'NamespaceName ', - ], + 'name' => 'keyword', + 'in' => 'query', + 'schema' => ['description' => '搜索关键词，支持工作空间名称模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'key'], ], [ - 'name' => 'moduleName', - 'in' => 'path', + 'name' => 'type', + 'in' => 'query', 'schema' => [ - 'description' => '模板名称', + 'description' => '工作空间类型。可选值：'."\n" + ."\n" + .'- system：公共工作空间'."\n" + ."\n" + .'- self：自定义工作空间'."\n" + ."\n" + .'- shared：共享工作空间'."\n" + ."\n" + .' - community：社区工作空间'."\n" + ."\n" + .'默认返回所有的', 'type' => 'string', - 'required' => true, - 'example' => 'ModuleName', + 'required' => false, + 'example' => 'self', + 'enum' => ['system', 'self', 'shared', 'community'], ], ], [ - 'name' => 'version', - 'in' => 'path', - 'schema' => [ - 'description' => '版本号', - 'type' => 'string', - 'required' => true, - 'example' => '1.0.0', - ], + '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' => [ @@ -7026,101 +7562,123 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '491A1E2E-EA1E-5F90-958A-A53EB67780FC', + '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 \\"requestId\\": \\"491A1E2E-EA1E-5F90-958A-A53EB67780FC\\"\\n}","type":"json"}]', - 'title' => '删除Registry模板版本', - 'description' => '单用户调用频率：100 次/秒。', - ], - 'ListTerraformProviderVersions' => [ - 'summary' => '获取TerraformProvider版本列表。', - 'path' => '/version/terraform/provider', - 'methods' => [ - 'get', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegistryNamespaces'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListRegistryNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/*'], + ], + ], + ], ], + ], + 'ListResourceExportTaskVersions' => [ + 'summary' => '获取资源导出任务版本列表。', + 'path' => '/exportTasks/{exportTaskId}/exportVersions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ 'name' => 'keyword', 'in' => 'query', - 'schema' => [ - 'description' => '搜索版本关键词 支持模糊查询', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - 'readOnly' => false, - ], + 'schema' => ['description' => '搜索关键词，支持对导出版本名称的模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'key'], ], [ - 'name' => 'nextToken', + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => ['description' => '资源导出任务ID', 'type' => 'string', 'required' => true, 'example' => 'ex-al1f11jlh9llnk8drc4g1c'], + ], + [ + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '下一页token，为null表示没有下一页', - 'type' => 'string', - 'required' => false, - 'example' => 'ar9lHbaidqWequN5orMba54dD+2BRJj42DLT6GrZysw=', - ], + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20'], ], [ - 'name' => 'maxResults', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '0', - 'example' => '20', - 'readOnly' => false, - ], + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'usage', + 'name' => 'status', 'in' => 'query', 'schema' => [ - 'description' => '用途'."\n" - .'取Explorer展示Meta信息', + 'description' => '导出状态'."\n" + ."\n" + .'- Queue：排队中'."\n" + .'- Pending：准备运行'."\n" + .'- Success：运行成功'."\n" + .'- Errored：运行错误'."\n" + .'- Canceled：被取消', 'type' => 'string', 'required' => false, - 'example' => 'Explorer', + '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 => [ @@ -7129,399 +7687,378 @@ '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' => '版本列表', + 'exportTasks' => [ + 'description' => '导出任务版本列表。', 'type' => 'array', 'items' => [ - 'description' => '版本列表', + 'description' => '导出任务版本列表。', 'type' => 'object', 'properties' => [ - 'version' => [ - 'description' => '版本。', - 'type' => 'string', - 'example' => '1.242.0', + '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' => '/'], + ], ], - 'publishedTime' => [ - 'description' => '发布时间', - 'type' => 'string', - 'example' => '2025-01-24T05:06:51Z', + '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'], + ], + ], ], - 'status' => [ - 'description' => '状态', - 'type' => 'string', - 'example' => 'Available', + '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'], ], ], - 'readOnly' => false, ], + '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'], ], - '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', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceExportTaskVersions'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListResourceExportTaskVersions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListResourceExportTasks' => [ + 'summary' => '查询资源导出任务列表。', + 'path' => '/exportTasks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], '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', - ], + 'schema' => ['description' => '搜索关键词，支持对任务名称的模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'key'], ], [ - 'name' => 'supportTerraformer', + 'name' => 'exportTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '是否支持Terraformer', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '资源导出任务ID', 'type' => 'string', 'required' => false, 'example' => 'ex-al1c11jl9g2tbte727otp85'], ], [ - 'name' => 'status', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '状态，Available，Deprecated', - 'type' => 'string', - 'required' => false, - 'example' => 'Available', - ], + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20'], ], [ - 'name' => 'sort', + 'name' => 'pageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '排序方式'."\n" - .'- Normal：默认排序（默认值）'."\n" - .'- Top：热门访问排序', - 'type' => 'string', - 'required' => false, - 'example' => 'Normal', - ], + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '成功响应的数据结构', + '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' => '产品列表', + 'exportTasks' => [ + 'description' => '导出任务列表。', 'type' => 'array', 'items' => [ - 'description' => '产品列表', + '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' => '企业应用', + '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' => '/'], + ], ], - 'firstCategoryNameEn' => [ - 'description' => '一级分类英文名称', - 'type' => 'string', - 'example' => 'Enterprise application', + '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"], + ], + ], ], - 'secondCategoryName' => [ - 'description' => '二级分类名称', - 'type' => 'string', - 'example' => '应用服务', + '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'], + ], + ], ], - 'secondCategoryNameEn' => [ - 'description' => '二级分类英文名称', - 'type' => 'string', - 'example' => 'Application service', + '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'], ], ], ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9bcaac3c-420d-4303-87ab-7638c07b0a0b', - ], - 'totalCount' => [ - 'description' => '数据总量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '134', - ], + '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'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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 次/秒。', + 'changeSet' => [ + ['createdAt' => '2022-12-26T03:00:24.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceExportTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListResourceExportTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/*'], + ], + ], + ], ], - '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', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'product', 'in' => 'query', - 'schema' => [ - 'description' => '产品code，支持模糊查询', - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => '产品code，支持模糊查询', 'type' => 'string', 'required' => false, 'example' => 'ECS'], ], [ 'name' => 'terraformProviderVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'TerraformProvider版本，为空时默认为最新版本', - 'type' => 'string', - 'required' => false, - 'example' => '1.227.0', - ], + 'schema' => ['description' => 'TerraformProvider版本，为空时默认为最新版本', 'type' => 'string', 'required' => false, 'example' => '1.227.0'], ], [ 'name' => 'subcategory', 'in' => 'query', - 'schema' => [ - 'description' => 'Terraform中的对于产品的分类', - 'type' => 'string', - 'required' => false, - 'example' => 'compute', - ], + 'schema' => ['description' => 'Terraform中的对于产品的分类', 'type' => 'string', 'required' => false, 'example' => 'compute'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '分页nextToken', - 'type' => 'string', - 'required' => false, - 'example' => 'tokenForNextPage', - ], + 'schema' => ['description' => '分页nextToken', 'type' => 'string', 'required' => false, 'example' => 'tokenForNextPage'], ], [ 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => '筛选的状态列表，枚举：Available（可用）, Deprecated（废弃）', - 'type' => 'string', - 'required' => false, - 'example' => 'Available,Deprecated', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '搜索资源Code或名称关键词支持模糊查询', 'type' => 'string', 'required' => false, 'example' => 'vpc'], ], [ 'name' => 'supportTerraformer', 'in' => 'query', - 'schema' => [ - 'description' => '是否支持Terraformer', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否支持Terraformer', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'terraformResourceTypes', @@ -7530,40 +8067,25 @@ 'schema' => [ 'description' => 'terraform资源列表', 'type' => 'array', - 'items' => [ - 'description' => 'terraform资源列表', - 'type' => 'string', - 'required' => false, - 'example' => 'alicloud_route_table', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '根据汉语、英语返回结果。取值范围：'."\n" + .'- zh-CN：中文。'."\n" + .'- en-US：英文。'."\n" + ."\n" + .'默认值：zh-CN。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], ], ], 'responses' => [ @@ -7573,23 +8095,9 @@ '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', - ], + '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', @@ -7597,841 +8105,864 @@ '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}', - ], + '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}'], + 'resourceType' => ['type' => 'string'], ], ], ], - 'totalCount' => [ - 'description' => '数据总量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '93', - ], + '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '列举资源类型列表', 'description' => '## 请求说明'."\n" ."\n" .'此API允许用户根据产品代码、Terraform Provider版本、子类别、状态、关键词等条件查询资源类型列表。结果包含资源的详细信息，如产品代码、状态、状态生效版本、子类别、Terraform Provider版本及资源类型代码。支持分页返回结果，便于处理大量数据。', - ], - 'GetResourceType' => [ - 'summary' => '获取资源类型信息。', - 'path' => '/resourceType/{resourceType}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + '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 \\"resourceType\\": \\"\\"\\n }\\n ],\\n \\"totalCount\\": 93\\n}","type":"json"}]', + ], + 'ListResources' => [ + 'path' => '/resources/stateparser', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'resourceType', - 'in' => 'path', + 'name' => 'sourceType', + 'in' => 'query', 'schema' => [ - 'description' => '资源Code，用于获取指定资源类型的详细信息', + 'description' => '资源来源的类型。取值：'."\n" + ."\n" + .'- ExportTaskId：资源导出ID'."\n" + ."\n" + .'- TaskId：Module 执行任务Id'."\n" + ."\n" + .'- StatePath：资源状态所在的OSS地址', 'type' => 'string', - 'required' => false, - 'example' => 'alicloud_vpc', + 'required' => true, + 'enumValueTitles' => ['TaskId' => '编排任务ID', 'StatePath' => '资源状态所在的 OSS 地址', 'ExportTaskId' => '资源导出 ID'], + 'example' => 'TaskId', ], ], [ - 'name' => 'terraformProviderVersion', + 'name' => 'sourceValue', 'in' => 'query', - 'schema' => [ - 'description' => 'TerraformProvider版本，为空时默认为最新版本', - 'type' => 'string', - 'required' => false, - 'example' => '1.227.0', - ], + 'schema' => ['description' => '资源来源的具体值。'."\n" + ."\n" + .'- 当sourceType为ExportTaskId时，格式为ExportTaskId:Version'."\n" + ."\n" + .'- 当sourceType为TaskId时，格式为TaskId'."\n" + ."\n" + .'- 当sourceType为StatePath时，格式为State文件的下载地址。', 'type' => 'string', 'required' => true, 'example' => 'task-235436dsfdgd'], ], [ - 'name' => 'filterReadOnly', + 'name' => 'specType', 'in' => 'query', - 'schema' => [ - 'description' => '是否支持过滤只读属性', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '资源属性在响应中所遵循的规范。可选值：CloudSpec，Terraform。'."\n" + .'默认值：CloudSpec。', 'type' => 'string', 'required' => true, 'example' => 'CloudSpec'], ], [ - 'name' => 'acceptLanguage', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '根据汉语、英语返回结果。取值范围：'."\n" - .'- zh-CN：中文。'."\n" - .'- en-US：英文。'."\n" - ."\n" - .'默认值：zh-CN。', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：200。', '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' => '成功响应的数据结构', + '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', + 'Resources' => [ + 'description' => '资源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资源详细信息。', + 'type' => 'object', + 'properties' => [ + 'accountId' => ['description' => '阿里云用户UID', 'type' => 'string', 'example' => '365845'], + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-05-03T02:22:59Z'], + 'dependsOnResourceIds' => [ + 'description' => '依赖资源列表', + 'type' => 'array', + 'items' => ['description' => '资源ID', 'type' => 'string', 'example' => 'vpc-ejfg5fgv'], + ], + 'productCode' => ['description' => '产品code', 'type' => 'string', 'example' => 'ECS'], + 'properties' => ['description' => '资源属性。', 'type' => 'object', 'example' => '{}'], + 'propertyVariables' => ['description' => '属性变量。', 'type' => 'object', 'example' => '{}'], + 'regionId' => ['description' => '区域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'resourceArn' => ['description' => '资源arn。', 'type' => 'string', 'example' => 'acs:vpc:cn-hangzhou:12345:test'], + 'resourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-aekzyqyghofqbxy'], + 'resourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'i-efegsewrttfd'], + 'resourceName' => ['description' => '资源名称。', 'type' => 'string', 'example' => 'test'], + 'resourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'Task'], + 'status' => ['description' => '状态', 'type' => 'string', 'example' => 'enable'], + 'tags' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => '标签键', 'type' => 'string', 'example' => 'test'], + 'tagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'], ], ], ], - ], - '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', + 'terraformArn' => ['description' => 'terraform arn', 'type' => 'string', 'example' => 'alicloud_vpc'], + 'terraformCode' => ['description' => 'terraform code', 'type' => 'string', 'example' => 'alicloud_vpc'], + 'zoneId' => ['description' => '可用区id', 'type' => 'string', 'example' => 'cn-hangzhou-a'], + 'resourcePageUrl' => ['description' => '资源列表页的URL', 'type' => 'string', 'example' => 'https:://ecs.aliyncs.com'], ], ], ], + 'pageNumber' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'pageSize' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：200。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '67585D9B-EFA5-5E51-BAB1-8FF07DA1B36F'], + 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取任务的资源列表', + 'summary' => '获取任务的资源列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => '## 请求说明', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Resources\\": [\\n {\\n \\"accountId\\": \\"365845\\",\\n \\"createTime\\": \\"2024-05-03T02:22:59Z\\",\\n \\"dependsOnResourceIds\\": [\\n \\"vpc-ejfg5fgv\\"\\n ],\\n \\"productCode\\": \\"ECS\\",\\n \\"properties\\": {},\\n \\"propertyVariables\\": {},\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"resourceArn\\": \\"acs:vpc:cn-hangzhou:12345:test\\",\\n \\"resourceGroupId\\": \\"rg-aekzyqyghofqbxy\\",\\n \\"resourceId\\": \\"i-efegsewrttfd\\",\\n \\"resourceName\\": \\"test\\",\\n \\"resourceType\\": \\"Task\\",\\n \\"status\\": \\"enable\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"test\\",\\n \\"tagValue\\": \\"test\\"\\n }\\n ],\\n \\"terraformArn\\": \\"alicloud_vpc\\",\\n \\"terraformCode\\": \\"alicloud_vpc\\",\\n \\"zoneId\\": \\"cn-hangzhou-a\\",\\n \\"resourcePageUrl\\": \\"https:://ecs.aliyncs.com\\"\\n }\\n ],\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"67585D9B-EFA5-5E51-BAB1-8FF07DA1B36F\\",\\n \\"totalCount\\": 9\\n}","type":"json"}]', ], - 'UpdateExplorerModuleAttribute' => [ - 'summary' => '更新Explorer模版。', - 'path' => '/explorerModule/{explorerModuleId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'ListStackConfigs' => [ + 'summary' => '查询资源栈配置列表', + 'path' => '/stacks/{stackId}/configs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '标记当前开始读取的位置，置空表示从头开始', 'description' => '标记当前开始读取的位置，置空表示从头开始', 'type' => 'string', 'required' => false, 'example' => 's8UVlnE23gZvjCvCwkoZ7Z4dD+2BRJj42DLT6GrZysw='], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '本次读取的最大数据记录数量', 'description' => '本次读取的最大数据记录数量，默认值：20，最大值：200', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'status', + 'in' => 'query', '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', - ], - ], + 'description' => '资源栈配置状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Creating | 创建中 |'."\n" + .'| Created | 创建完成 |'."\n" + .'| Waiting | 等待部署中 |'."\n" + .'| Deploying | 部署中 |'."\n" + .'| Deployed | 部署完成 |'."\n" + .'| Errored | 部署失败 |'."\n" + .'| Deleting | 删除中 |'."\n" + .'| Deleted | 已删除 |'."\n" + .'| DeleteFailed | 删除失败 |'."\n" + .'| DetectTriggered | 偏差检测触发成功 |', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['Creating' => 'Creating', 'Deploying' => 'Deploying', 'Errored' => 'Errored', 'DeleteFailed' => 'DeleteFailed', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Deleting' => 'Deleting', 'Created' => 'Created', 'Waiting' => 'Waiting'], + 'example' => 'Deployed', ], ], [ - 'name' => 'explorerModuleId', + 'name' => 'stackId', 'in' => 'path', - 'schema' => [ - 'description' => 'Explorer模版ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mod-al1611jl2tce3nlh2uvklh0', - ], + 'schema' => ['description' => 'StackId，Stack 创建后的唯一标识', 'type' => 'string', 'required' => false, 'example' => 'stack-as1d4vld898ppnqbxxxxx'], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => ['description' => '资源栈配置版本号，如：v1。初始值为 v1，每次资源栈更新或刷新且配置发生变更时，版本号递增。', 'type' => 'string', 'required' => false, 'example' => 'v4'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => '返回值定义', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '25B274BA-E672-58C0-8602-541281B6F758', + 'totalCount' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '43'], + 'nextToken' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'type' => 'string', 'required' => true, 'example' => 'jIFUaFVhy2VD6whh5GaY854dD+2BRJj42DLT6GrZysw='], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '9BEDBCF8-03BE-5A59-AC93-9263942B37E8'], + 'maxResults' => ['title' => 'MaxResults本次请求所返回的最大记录条数', 'description' => '本次请求所返回的最大记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], + 'configs' => [ + 'description' => '资源栈配置列表', + 'type' => 'array', + 'items' => [ + 'description' => '配置信息', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-08-15T16:14:06Z'], + 'status' => [ + 'description' => '资源栈配置状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Creating | 创建中 |'."\n" + .'| Created | 创建完成 |'."\n" + .'| Waiting | 等待部署中 |'."\n" + .'| Deploying | 部署中 |'."\n" + .'| Deployed | 部署完成 |'."\n" + .'| Errored | 部署失败 |'."\n" + .'| Deleting | 删除中 |'."\n" + .'| Deleted | 已删除 |'."\n" + .'| DeleteFailed | 删除失败 |'."\n" + .'| DetectTriggered | 偏差检测触发成功 |', + 'type' => 'string', + 'enumValueTitles' => ['Creating' => 'Creating', 'Deploying' => 'Deploying', 'Errored' => 'Errored', 'DeleteFailed' => 'DeleteFailed', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Deleting' => 'Deleting', 'Created' => 'Created', 'Waiting' => 'Waiting'], + 'example' => 'Deployed', + ], + 'componentContent' => ['description' => '组件配置的内容', 'type' => 'string', 'example' => 'format_version: IaCService/2021-08-06\\ndescription: create ALB \\nvariable:\\n - name: region\\n type: string\\n ...'], + 'deploymentContent' => ['description' => '部署配置的内容', 'type' => 'string', 'example' => 'format_version: IaCService/2021-08-06\\ndescription: create ALB\\nupstream_input:\\n - name: stack_network\\n ...'], + 'version' => ['description' => '配置版本号，如：v1。初始值为 v1，每次资源栈更新或刷新且配置发生变更时，版本号递增。', 'type' => 'string', 'example' => 'v1'], + 'componentConfig' => [ + 'description' => '组件配置', + 'type' => 'object', + 'properties' => [ + 'component' => [ + 'description' => '组件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '组件名称', 'type' => 'string', 'example' => 'log'], + ], + 'description' => '', + ], + ], + 'variable' => [ + 'description' => '组件变量列表', + 'type' => 'array', + 'items' => [ + 'description' => '组件变量', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '变量名称', 'type' => 'string', 'example' => 'region'], + 'type' => ['description' => '变量类型，如：'."\n" + .'- string'."\n" + .'- list(string)'."\n" + .'- map(string)', 'type' => 'string', 'example' => 'string'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'region of sls project'], + 'default' => ['description' => '默认值', 'type' => 'string', 'example' => 'ap-southeast-3'], + 'sensitive' => ['title' => '是否敏感参数，敏感参数的值在控制台及api中都不可见'."\n" + .'- true：是敏感值'."\n" + .'- false：非敏感值', 'type' => 'boolean'], + ], + ], + ], + 'output' => [ + 'description' => '组件输出列表', + 'type' => 'array', + 'items' => [ + 'description' => '组件输出', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '输出名称', 'type' => 'string', 'example' => 'project_name'], + 'type' => ['description' => '输出类型', 'type' => 'string', 'example' => 'string'], + 'description' => ['description' => '输出描述信息', 'type' => 'string', 'example' => 'the name of sls project'], + 'value' => ['description' => '输出值', 'type' => 'string', 'example' => 'log-test'], + ], + ], + ], + ], + ], + 'deploymentConfig' => [ + 'description' => '部署配置', + 'type' => 'object', + 'properties' => [ + 'deployment' => [ + 'description' => '部署列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '部署名称', 'type' => 'string', 'example' => 'production'], + ], + 'description' => '', + ], + ], + 'upstreamInput' => [ + 'description' => '上游输入列表', + 'type' => 'array', + 'items' => [ + 'description' => '上游输入', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '输入名称', 'type' => 'string', 'example' => 'network'], + 'source' => ['description' => '输入来源，当前只支持指定上游Stack，格式为{iacEndpoint}/{accountId}/{upstreamStackName}', 'type' => 'string', 'example' => 'IacEndpoint/156718871222312/stack_network'], + ], + ], + ], + 'publishOutput' => [ + 'description' => '输出列表', + 'type' => 'array', + 'items' => [ + 'description' => '输出', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '输出名称', 'type' => 'string', 'example' => 'project_name'], + 'description' => ['description' => '输出描述', 'type' => 'string', 'example' => 'the name of sls project'], + 'value' => ['description' => '输出值的原始定义，当前支持string 或 list(string)。可以引用部署输出，格式：deployment.{部署名称}.{部署输出名称}', 'type' => 'string', 'example' => 'deployment.production.project_name'], + 'result' => ['description' => '资源栈部署完成后的实际输出值', 'type' => 'string', 'example' => 'log-test'], + 'type' => ['description' => '输出类型，例如：string 或 list(string)', 'type' => 'string', 'example' => 'string'], + ], + ], + ], + ], + ], + 'failedReason' => ['title' => '配置处理失败的提示信息', 'type' => 'string'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询资源栈配置列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListStackConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 43,\\n \\"nextToken\\": \\"jIFUaFVhy2VD6whh5GaY854dD+2BRJj42DLT6GrZysw=\\",\\n \\"requestId\\": \\"9BEDBCF8-03BE-5A59-AC93-9263942B37E8\\",\\n \\"maxResults\\": 24,\\n \\"configs\\": [\\n {\\n \\"createTime\\": \\"2025-08-15T16:14:06Z\\",\\n \\"status\\": \\"Deployed\\",\\n \\"componentContent\\": \\"format_version: IaCService/2021-08-06\\\\\\\\ndescription: create ALB \\\\\\\\nvariable:\\\\\\\\n - name: region\\\\\\\\n type: string\\\\\\\\n ...\\",\\n \\"deploymentContent\\": \\"format_version: IaCService/2021-08-06\\\\\\\\ndescription: create ALB\\\\\\\\nupstream_input:\\\\\\\\n - name: stack_network\\\\\\\\n ...\\",\\n \\"version\\": \\"v1\\",\\n \\"componentConfig\\": {\\n \\"component\\": [\\n {\\n \\"name\\": \\"log\\"\\n }\\n ],\\n \\"variable\\": [\\n {\\n \\"name\\": \\"region\\",\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"region of sls project\\",\\n \\"default\\": \\"ap-southeast-3\\",\\n \\"sensitive\\": true\\n }\\n ],\\n \\"output\\": [\\n {\\n \\"name\\": \\"project_name\\",\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"the name of sls project\\",\\n \\"value\\": \\"log-test\\"\\n }\\n ]\\n },\\n \\"deploymentConfig\\": {\\n \\"deployment\\": [\\n {\\n \\"name\\": \\"production\\"\\n }\\n ],\\n \\"upstreamInput\\": [\\n {\\n \\"name\\": \\"network\\",\\n \\"source\\": \\"IacEndpoint/156718871222312/stack_network\\"\\n }\\n ],\\n \\"publishOutput\\": [\\n {\\n \\"name\\": \\"project_name\\",\\n \\"description\\": \\"the name of sls project\\",\\n \\"value\\": \\"deployment.production.project_name\\",\\n \\"result\\": \\"log-test\\",\\n \\"type\\": \\"string\\"\\n }\\n ]\\n },\\n \\"failedReason\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListStacks' => [ + 'summary' => '查询资源栈列表', + 'path' => '/stacks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'allowEmptyValue' => false, - 'style' => 'json', + 'name' => 'keyword', + 'in' => 'query', + 'schema' => ['description' => '关键字，按照资源栈名称模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'key'], + ], + [ + 'name' => 'status', + 'in' => 'query', '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"}', - ], - ], + 'description' => '资源栈状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Creating | 创建中 |'."\n" + .'| Created | 创建完成 |'."\n" + .'| Waiting | 等待部署中 |'."\n" + .'| Deploying | 部署中 |'."\n" + .'| Deployed | 部署完成 |'."\n" + .'| Errored | 部署失败 |'."\n" + .'| Deleting | 删除中 |'."\n" + .'| Deleted | 已删除 |'."\n" + .'| DeleteFailed | 删除失败 |'."\n" + .'| DetectTriggered | 偏差检测触发成功 |', + 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['Creating' => 'Creating', 'Deploying' => 'Deploying', 'Errored' => 'Errored', 'DeleteFailed' => 'DeleteFailed', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Deleting' => 'Deleting', 'Created' => 'Created', 'Waiting' => 'Waiting'], + 'example' => 'Deployed', ], ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '分页Token，没有下一页则为空', 'type' => 'string', 'required' => false, 'example' => 'LC4NJL3Ru2bIiRdnbADPQp4dD+2BRJj42DLT6GrZysw='], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '最大返回数量，默认值：100，最大值：200', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'kmsKeyId', + 'in' => 'query', + 'schema' => ['title' => '密钥Id', 'type' => 'string', 'example' => '21a90f5d-a469-4ac4-a8ea-f6e1e7470e6f'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体', + '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', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '3E49127A-BB65-5CCD-AB93-0EC0A43E5446'], + 'stacks' => [ + 'description' => '资源栈列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'stackId' => ['description' => 'StackId，Stack 创建后的唯一标识', 'type' => 'string', 'example' => "\n" + .'stack-as1d4vld898ppnqxxxxxx'], + 'stackName' => ['description' => 'Stack名称（已废弃），请使用name', 'type' => 'string', 'example' => 'stack-test'], + 'stackDescription' => ['description' => '资源栈描述', 'type' => 'string', 'example' => 'description of stack'], + 'sourcePath' => ['description' => '配置来源的路径值，不超过 1000 个字符'."\n" + .'- 来源为 OSS 时，取值为 oss::<文件链接>，必须为 zip 文件，例如 oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为 IAC_SERVICE_MODULE 时，取值为<模板Id>，例如: mod-xxxxx', 'type' => 'string', 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'], + 'source' => [ + 'description' => '创建来源，取值'."\n" + .'- OSS ：通过OSS对象存储的模板'."\n" + .'- IAC_SERVICE_MODULE ： 自动化服务台中创建的模板', + 'type' => 'string', + 'enumValueTitles' => ['IAC_SERVICE_MODULE' => 'IAC_SERVICE_MODULE', 'OSS' => 'OSS'], + 'example' => 'OSS', + ], + 'createTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-05-07T02:21:28Z'], + 'status' => [ + 'description' => '资源栈状态'."\n" + .'| 名称 | 描述 |'."\n" + .'|------|------|'."\n" + .'| Creating | 创建中 |'."\n" + .'| Created | 创建完成 |'."\n" + .'| Waiting | 等待部署中 |'."\n" + .'| Deploying | 部署中 |'."\n" + .'| Deployed | 部署完成 |'."\n" + .'| Errored | 部署失败 |'."\n" + .'| Deleting | 删除中 |'."\n" + .'| Deleted | 已删除 |'."\n" + .'| DeleteFailed | 删除失败 |', + 'type' => 'string', + 'enumValueTitles' => ['Creating' => 'Creating', 'Deploying' => 'Deploying', 'Errored' => 'Errored', 'DeleteFailed' => 'DeleteFailed', 'Deleted' => 'Deleted', 'Deployed' => 'Deployed', 'Deleting' => 'Deleting', 'Created' => 'Created', 'Waiting' => 'Waiting'], + 'example' => 'Deployed', + ], + 'name' => ['description' => 'Stack名称', 'type' => 'string', 'example' => 'stack-test'], + 'description' => ['description' => '资源栈描述', 'type' => 'string', 'example' => 'description of stack'], + ], + 'description' => '', + ], ], + 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'nextToken' => ['description' => '分页Token，没有下一页则为空', 'type' => 'string', 'example' => 'LC4NJL3Ru2bIiRdnbADPQp4dD+2BRJj42DLT6GrZysw='], + 'maxResults' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to do this action.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询资源栈列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListStacks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/*'], + ], ], ], ], - '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配置文件内容进行预检查', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3E49127A-BB65-5CCD-AB93-0EC0A43E5446\\",\\n \\"stacks\\": [\\n {\\n \\"stackId\\": \\"\\\\nstack-as1d4vld898ppnqxxxxxx\\",\\n \\"stackName\\": \\"stack-test\\",\\n \\"stackDescription\\": \\"description of stack\\",\\n \\"sourcePath\\": \\"oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip\\",\\n \\"source\\": \\"OSS\\",\\n \\"createTime\\": \\"2025-05-07T02:21:28Z\\",\\n \\"status\\": \\"Deployed\\",\\n \\"name\\": \\"stack-test\\",\\n \\"description\\": \\"description of stack\\"\\n }\\n ],\\n \\"totalCount\\": 10,\\n \\"nextToken\\": \\"LC4NJL3Ru2bIiRdnbADPQp4dD+2BRJj42DLT6GrZysw=\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', ], - 'ExecuteTerraformApply' => [ - 'summary' => '执行TerraformApply。', - 'path' => '/terraform/execution/apply', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListTasks' => [ + 'path' => '/tasks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'autoTest' => true, + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], '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, - ], + 'name' => 'keyword', + 'in' => 'query', + 'schema' => ['description' => '关键字，按照任务ID或任务名称模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'key'], ], - ], - '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', - ], - ], - ], + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'task-433aead756057fffeaba4828f5195'], ], - ], - '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' => [], + 'name' => 'moduleId', + 'in' => 'query', + 'schema' => ['description' => '模板ID', 'type' => 'string', 'required' => false, 'example' => 'mod-1525e992f1b62139d1c437d64ae'], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => '每页返回的结果数量。默认值：20，最小值：1，最大值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20'], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', + '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' => '请求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', + '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' => 'kmsKeyId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '21a90f5d-a469-4ac4-a8ea-f6e1e7470e6f'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应体结构', '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', + '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'], + 'createTime' => ['description' => '任务创建时间', 'type' => 'string', 'example' => '2022-07-11T15:09:53Z'], + 'currentJobId' => ['description' => '当前任务的作业ID', 'type' => 'string', 'example' => 'job-123asd'], + 'currentJobStatus' => ['description' => '当前作业状态', 'type' => 'string', 'example' => 'Pending'], + 'deletionProtection' => ['description' => '是否开启了删除保护，包含管理的资源时自动开启保护。', 'type' => 'boolean', 'example' => 'false'], + 'groupInfo' => [ + 'description' => '任务分组信息', + 'type' => 'object', + 'properties' => [ + 'groupId' => ['description' => '分组ID。', 'type' => 'string', 'example' => 'g-4267dcfbf1b6d1e0652bfbbe995'], + 'groupName' => ['description' => '分组名称', 'type' => 'string', 'example' => 'abc'], + 'projectId' => ['description' => '项目ID', 'type' => 'string', 'example' => 'p-433aead7560571cf1b2bfbbe92b'], + 'projectName' => ['description' => '项目名称', 'type' => 'string', 'example' => 'abc'], + ], + ], + 'moduleId' => ['description' => '模板ID', 'type' => 'string', 'example' => 'mod-518855d9a058c331e9c60bc0ce'], + 'moduleName' => ['description' => '模板名称', 'type' => 'string', 'example' => 'mod-name'], + 'moduleVersion' => ['description' => '模板版本', 'type' => 'string', 'example' => 'v1'], + 'name' => ['description' => '任务名称', 'type' => 'string', 'example' => 'TaskName'], + 'status' => ['description' => '任务状态'."\n" + ."\n" + .'- Available：可用状态，没有任何job在运行'."\n" + .'- Running：运行状态，当前job正在运行', 'type' => 'string', 'example' => 'Running'], + 'tags' => [ + 'description' => '任务标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '任务标签列表', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '任务标签键', 'type' => 'string', 'example' => 'name'], + 'value' => ['description' => '任务标签值', 'type' => 'string', 'example' => 'iac-demo'], + 'tagKey' => ['description' => '模板的标签键', 'type' => 'string', 'example' => 'name'], + 'tagValue' => ['description' => '任务的标签值。', 'type' => 'string', 'example' => 'iac-demo'."\n"], + ], + ], + ], + 'taskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'task-1525e992f1b621b0ca51647876e'], + 'latestModuleVersion' => ['description' => '模板的最新版本号', 'type' => 'string', 'example' => 'v3'], + ], + ], ], + 'totalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '55'], ], ], ], ], - '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', + 'title' => '获取任务列表', + 'summary' => '获取任务列表。', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [ + ['createdAt' => '2023-08-14T16:07:42.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-24T06:38:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-04-13T07:25:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-29T14:27:37.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 20,\\n \\"requestId\\": \\"98610149-488B-5E48-B981-8D4CE1AF77CD\\",\\n \\"tasks\\": [\\n {\\n \\"autoApply\\": false,\\n \\"createTime\\": \\"2022-07-11T15:09:53Z\\",\\n \\"currentJobId\\": \\"job-123asd\\",\\n \\"currentJobStatus\\": \\"Pending\\",\\n \\"deletionProtection\\": false,\\n \\"groupInfo\\": {\\n \\"groupId\\": \\"g-4267dcfbf1b6d1e0652bfbbe995\\",\\n \\"groupName\\": \\"abc\\",\\n \\"projectId\\": \\"p-433aead7560571cf1b2bfbbe92b\\",\\n \\"projectName\\": \\"abc\\"\\n },\\n \\"moduleId\\": \\"mod-518855d9a058c331e9c60bc0ce\\",\\n \\"moduleName\\": \\"mod-name\\",\\n \\"moduleVersion\\": \\"v1\\",\\n \\"name\\": \\"TaskName\\",\\n \\"status\\": \\"Running\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"name\\",\\n \\"value\\": \\"iac-demo\\",\\n \\"tagKey\\": \\"name\\",\\n \\"tagValue\\": \\"iac-demo\\\\n\\"\\n }\\n ],\\n \\"taskId\\": \\"task-1525e992f1b621b0ca51647876e\\",\\n \\"latestModuleVersion\\": \\"v3\\"\\n }\\n ],\\n \\"totalCount\\": 55\\n}","type":"json"}]', + ], + 'ListTerraformProviderVersions' => [ + 'summary' => '获取TerraformProvider版本列表。', + 'path' => '/version/terraform/provider', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'stateId', - 'in' => 'path', - 'schema' => [ - 'description' => '状态文件ID', - 'type' => 'string', - 'required' => true, - 'example' => 'task-xxxx', - ], + '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' => 'Schema of Response', + 'description' => '响应体结构', '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"}', + '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, ], ], ], - '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', + '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版本列表', + 'changeSet' => [ + ['createdAt' => '2025-04-11T02:14:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-03-19T03:07:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-20T03:38:22.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-03-18T02:32:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTerraformProviderVersions'], + ], ], + 'ramActions' => [], + ], + 'ManageTerraformState' => [ + 'summary' => '支持状态文件的资源导入和移除', + 'path' => '/terraformState/manage', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -8442,40 +8973,34 @@ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'clientToken' => [ - 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + '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, - 'example' => 'a65451293e64979ba7a4b573950217fe', + 'enumValueTitles' => ['Task' => 'Task', 'Stack' => 'Stack'], + 'example' => 'Stack', ], - 'stateId' => [ - 'description' => '状态文件ID，该字段不为空时，在原有状态文件基础上面继续执行Plan命令', + 'identifier' => [ + 'description' => '任务标识符。Stack 任务为 <$stackId>:<$deploymentName>；Task 任务为 <$TaskId>', 'type' => 'string', - 'required' => false, - 'example' => 'task-xxx', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'stack-as11xxxxxxxxx:developmentA', ], - 'code' => [ - 'description' => '需要执行的Terraform代码内容，如果执行内容无变化，可以只传入stateId', + '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' => 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' => true, + 'enumValueTitles' => ['Import' => 'Import', 'StateRemove' => 'StateRemove'], + 'example' => 'Import', ], + 'importResourceId' => ['description' => 'Terraform 资源真实的资源 Id', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxx'], ], 'required' => false, ], @@ -8488,421 +9013,174 @@ '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', - ], + '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'], ], ], ], ], - '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" + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '管理任务状态文件', + 'description' => '该API主要用于进行自动化服务台上资源编排任务和资源栈任务状态文件的管理。'."\n" ."\n" .'使用此API前，请确保已正确配置了所有必要的认证信息，并且Terraform代码符合预期的功能需求。', - ], - 'ExecuteRegistryModule' => [ - 'summary' => '执行阿里云 Terraform 官方提供的 Module。', - 'path' => '/registryModule/{namespaceName}/{moduleName}/execution', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:ManageTerraformState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A80B4F1-4E8C-515A-B3C1-0E1A9B85B6A7\\",\\n \\"jobId\\": \\"job-5fd38c9xxxxx\\"\\n}","type":"json"}]', + ], + 'OperateJob' => [ + 'summary' => '创建作业后，在运行过程中 【取消】操作可以终止作业的运行。'."\n" + .'作业在到达等待确认状态后，【放弃】操作可以终止作业的继续运行，【执行】操作则继续完成作业的执行操作。', + 'path' => '/tasks/{taskId}/jobs/{jobId}/operation/{operationType}', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'namespaceName', + 'name' => 'taskId', 'in' => 'path', - 'schema' => [ - 'description' => 'Module所属的工作空间，当前官方RegistryModule的工作空间：alibaba、alibabacloud-automation、aliyun、terraform-alicloud-modules', - 'type' => 'string', - 'required' => true, - 'example' => 'alibaba', - ], + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => 'task-518855d9a058cfffe0e0a92745bbc'], ], [ - 'name' => 'moduleName', + 'name' => 'jobId', 'in' => 'path', - 'schema' => [ - 'description' => '模板名称，可以通过ListExplorerRegistryModules查询', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc', - ], + 'schema' => ['description' => '作业ID', 'type' => 'string', 'required' => true, 'example' => 'job-5fd38c9b92d54fff865d936f22a39'], ], [ - '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', + 'name' => 'operationType', + 'in' => 'path', 'schema' => [ - 'description' => '搜索关键字，支持根据 Module 的名称模糊搜索', + 'description' => '操作类型'."\n" + .'- execute：Plan完成后继续执行Apply操作'."\n" + .'- abolish：放弃已完成 Plan 预览的 Job'."\n" + .'- cancel：取消正在执行中或排队中的 Job', 'type' => 'string', 'required' => false, - 'example' => 'key', + 'example' => 'execute', + 'enum' => ['execute', 'abolish', 'cancel'], ], ], [ - 'name' => 'maxResults', + 'name' => 'comment', 'in' => 'query', - 'schema' => [ - 'description' => '每页的最大数据条数。'."\n" - ."\n" - .'取值范围：0~200。'."\n" - ."\n" - .'默认值：100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '描述，长度（0-128）', 'type' => 'string', 'required' => true, 'example' => 'dasd', 'maxLength' => 128], ], [ - 'name' => 'nextToken', + 'name' => 'taskType', 'in' => 'query', - 'schema' => [ - 'description' => '查询返回结果下一页的令牌。'."\n" - ."\n" - .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', - 'type' => 'string', - 'required' => false, - 'example' => 'lJTuhMWkNH89zZWyYM9GjpAbgRb+bPPPwN0Q3pclzKI=', - ], + 'schema' => ['description' => '任务类型'."\n" + ."\n" + .'Task：常规任务（默认）'."\n" + ."\n" + .'SceneTestingTask：场景化测试任务', 'type' => 'string', 'required' => false, 'example' => 'Task'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'E602681C-A811-5787-9DC3-48BED7537071'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E602681C-A811-5787-9DC3-48BED7537071\\"\\n}","type":"json"}]', + 'title' => '操作作业', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [ + ['createdAt' => '2024-07-23T09:04:16.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:48.000Z', 'description' => '请求参数发生变更'], ], - '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', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateJob'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:OperateJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/{#JobId}'], + ], + ], + 'additionalActions' => [], + ], ], + ], + 'PublishRegistryModuleVersion' => [ + 'summary' => '发布Registry模板版本。', + 'path' => '/registryModuleVersion', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], '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', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Module 的名称。'."\n" - ."\n" - .'注意：Module 的名称与产品名称、资源名称不一定是一致的。', - 'type' => 'string', + '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, ], ], @@ -8911,208 +9189,93 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应参数对象'."\n", + 'description' => '响应体结构', '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', - ], + '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 \\"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', + '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 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishRegistryModuleVersion'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:PublishRegistryModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], ], + ], + 'RemoveSharedAccounts' => [ + 'path' => '/sharedAccounts', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], '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', + 'name' => 'resourceId', 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键词，支持根据 Module 名称或者 Module 的示例模糊搜索', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], + 'schema' => ['description' => '取消共享的资源ID'."\n" + ."\n" + .' - 类型为Namespace时取值工作空间名称 '."\n" + ."\n" + .'- 类型为RegistryModule时取值 \\<namespaceName>/\\<ModuleName>', 'type' => 'string', 'required' => true, 'example' => 'terraform-alicloud-modules/mongodb'."\n"], ], [ - 'name' => 'maxResults', + 'name' => 'resourceType', 'in' => 'query', 'schema' => [ - 'description' => '每页的最大数据条数。'."\n" - ."\n" - .'取值范围：0~200。'."\n" + 'description' => '资源类型，取值'."\n" ."\n" - .'默认值：100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + .'- RegistryModule :Registry模板'."\n" + .'- Namespace：工作空间', + 'type' => 'string', + 'required' => true, + 'example' => 'RegistryModule', + 'enum' => ['Namespace', 'RegistryModule'], ], ], [ - 'name' => 'nextToken', + 'name' => 'accountIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '查询返回结果下一页的令牌。'."\n" - ."\n" - .'当返回结果数据总条数超过maxResults限制，则数据会被截断，您可以使用nextToken查询下一页数据。', - 'type' => 'string', - 'required' => false, - 'example' => 'IbuvZbAXFOiB4nKg8iOH447bhHWDavGTOMijI2Jep7c=', + 'description' => '云账号ID列表', + 'type' => 'array', + 'items' => ['description' => '云账号UID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345678'], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, ], ], ], @@ -9123,130 +9286,56 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '8294F4ED-8DBA-5441-B3F2-61C3C5374990'], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '移除共享账号', + 'summary' => '移除共享账号。', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSharedAccounts'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:RemoveSharedAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8294F4ED-8DBA-5441-B3F2-61C3C5374990\\"\\n}","type":"json"}]', + ], + 'TriggerStackExecution' => [ + 'summary' => '触发Stack执行', + 'path' => '/stacks/trigger', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -9254,29 +9343,29 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数', + 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'clientToken' => [ - 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'action' => [ + 'description' => '执行操作'."\n" + .'- terraform plan'."\n" + .'- terraform apply'."\n" + .'- state detect', 'type' => 'string', 'required' => true, - 'example' => 'a65451293e64979ba7a4b573950217fe', - ], - 'description' => [ - 'description' => '项目描述'."\n" - .'长度（0-1024）', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'enumValueTitles' => ['terraform plan' => 'terraform预览', 'terraform apply' => 'terraform执行', 'state detect' => '状态检测'], + 'example' => 'terraform plan', ], - 'name' => [ - 'description' => '项目名称，'."\n" - .'长度（1-128）', - 'type' => 'string', + 'changedFolders' => [ + 'description' => '变更文件集合，可以只指定变更文件目录', + 'type' => 'array', + 'items' => ['description' => '变更文件，可以只指定变更文件目录', 'type' => 'string', 'required' => true, 'example' => 'iac-stack/'], 'required' => true, - 'example' => 'test', ], + 'codeVersionId' => ['description' => '触发Stack代码版本', 'type' => 'string', 'required' => false, 'example' => 'v1'], + 'codePackagePath' => ['description' => 'Stack代码路径，当前只支持通过IaC模板创建的Stack，'."\n" + .'参数格式：iacservice::{moduleId}', 'type' => 'string', 'required' => true, 'example' => 'iacservice::mod-xxx'], ], 'required' => false, ], @@ -9286,54 +9375,43 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => 'Schema of Response', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2D40488-3F74-568B-87EC-1C04D098DF8B'], + 'triggerId' => ['description' => '触发的唯一ID。', 'type' => 'string', 'example' => 'event-xxxx'], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '触发Stack执行', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F2D40488-3F74-568B-87EC-1C04D098DF8B\\",\\n \\"triggerId\\": \\"event-xxxx\\"\\n}","type":"json"}]', + ], + 'UpdateDetectConfig' => [ + 'path' => '/terraformState/detectConfig/{detectConfigId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -9344,283 +9422,108 @@ '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）', + 'description' => ['description' => '**描述**', 'type' => 'string', 'required' => false, 'example' => 'this is description'."\n"], + 'enabled' => ['description' => '**是否开启检测功能，默认为 true**', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'triggerType' => [ + 'description' => '**触发类型**'."\n" + ."\n" + .'* Manual 手动执行'."\n" + .'* Cron 定时触发', 'type' => 'string', 'required' => false, - 'example' => 'test', + 'example' => 'Manual', + 'enum' => ['Manual', 'Cron'], ], - 'name' => [ - 'description' => '项目名称，'."\n" - .'长度（1-128）', - 'type' => 'string', + 'cronExpression' => ['description' => '**cron 表达式（北京时间）**。当触发类型为 Cron 时必填', 'type' => 'string', 'required' => false, 'example' => '0 0 0 ? * 1'], + 'alarmConfigs' => [ + 'description' => '**告警地址列表**', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => '报警途径。'."\n" + .'当前仅支持 `cms`'."\n", 'type' => 'string', 'required' => false, 'example' => 'cms'], + 'address' => ['description' => '报警地址。'."\n", 'type' => 'string', 'required' => false, 'example' => 'example@example.com'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'example' => 'test', ], + 'detectConfigName' => ['description' => '偏差检测名称', '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' => 'projectId', + 'name' => 'detectConfigId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-433aead7560572f8d95b25775c', - ], + 'schema' => ['description' => '偏差检测配置 Id', 'type' => 'string', 'required' => true, 'example' => 'dc-xxxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C62888F6-254D-5589-BF05-0D9EE698C187', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => 'valueA'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C62888F6-254D-5589-BF05-0D9EE698C187\\"\\n}","type":"json"}]', - 'title' => '更新项目信息', + 'title' => '更新偏差检测配置', + 'summary' => '用于更新指定ID的偏差检测配置信息。', + 'description' => '## 请求说明'."\n" + .'- `detectConfigId` 是必需参数，用来标识要更新的具体检测配置。'."\n" + .'- 当设置 `triggerType` 为 `Cron` 时，必须提供有效的 `cronExpression`。'."\n" + .'- `alarmConfigs` 列表中的每个元素需要包含报警类型 (`type`) 和地址 (`address`)。'."\n" + .'- 如果不希望更改某些属性（如 `name`, `description` 等），可以在请求体中省略这些字段。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"valueA\\"\\n}","type":"json"}]', ], - 'ListProject' => [ - 'summary' => '查询项目列表。', - 'path' => '/project', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateExplorerModuleAttribute' => [ + 'summary' => '更新Explorer模版。', + 'path' => '/explorerModule/{explorerModuleId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], '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', + 'name' => 'body', + 'in' => 'body', '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' => '响应体结构', + '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', - ], + '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, ], ], - ], - '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', + 'name' => 'explorerModuleId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => false, - 'example' => 'p-433aead7560572f8d95b25775c', - ], + 'schema' => ['description' => 'Explorer模版ID', 'type' => 'string', 'required' => true, 'example' => 'mod-al1611jl2tce3nlh2uvklh0'], ], ], 'responses' => [ @@ -9630,140 +9533,50 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '25B274BA-E672-58C0-8602-541281B6F758'], ], ], ], ], - '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' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"25B274BA-E672-58C0-8602-541281B6F758\\"\\n}","type":"json"}]', + 'title' => '更新Explorer模版', + 'description' => '更新Explorer模版。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExplorerModuleAttribute'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ + 'ramActions' => [ [ - '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', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateExplorerModuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"BF72A6FB-B071-5F2E-A036-9D62545B962C\\"\\n}","type":"json"}]', - 'title' => '删除项目', ], - 'CreateGroup' => [ - 'summary' => '创建分组。', - 'path' => '/group', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateGroup' => [ + 'summary' => '修改分组。', + 'path' => '/group/{groupId}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'body', @@ -9773,42 +9586,12 @@ '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', - ], + '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', @@ -9816,19 +9599,9 @@ 'description' => '通知配置', 'type' => 'object', 'properties' => [ - 'notifyPath' => [ - 'description' => '通知的路径配置', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - 'notifyType' => [ - 'description' => '通知类型：'."\n" - .'DingDing', - 'type' => 'string', - 'required' => false, - 'example' => 'DingDing', - ], + 'notifyPath' => ['description' => '通知的路径配置', 'type' => 'string', 'required' => false, 'example' => '/'], + 'notifyType' => ['description' => '通知类型：'."\n" + .'DingDing', 'type' => 'string', 'required' => false, 'example' => 'DingDing'], ], 'required' => false, ], @@ -9837,56 +9610,25 @@ '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', + 'items' => ['description' => '通知操作类型'."\n" + ."\n" + .'- apply：执行'."\n" + .'- refresh：刷新'."\n" + .'- destroy：销毁', 'type' => 'string', 'required' => false, 'example' => 'refresh'], 'required' => false, - 'example' => 'ramName', ], + 'ramRole' => ['description' => 'RAM角色，（1-128）'."\n" + .'触发新作业时由系统扮演角色来执行模版'."\n" + .'作业触发方式非手动触发时必填', 'type' => 'string', 'required' => false, 'example' => '{}'], 'reportExportField' => [ 'description' => '报表的导出字段列表。', 'type' => 'array', - 'items' => [ - 'description' => '报表的导出字段列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'taskName', - ], + 'items' => ['description' => '报表的导出字段列表', 'type' => 'string', 'required' => false, 'example' => 'Task'], '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', - ], + '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时不能为空', @@ -9896,21 +9638,11 @@ .'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 * * ？', - ], + '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, ], @@ -9922,21 +9654,21 @@ .'- Task：常规任务'."\n" .'- SceneTestingTask：场景化测试任务', 'type' => 'array', - 'items' => [ - 'description' => '触发执行的资源类型，取值：'."\n" - ."\n" - .'- Task：常规任务'."\n" - .'- SceneTestingTask：场景化测试任务', - 'type' => 'string', - 'required' => false, - 'example' => 'Task', - ], + '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 => [ @@ -9945,51 +9677,55 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '4EF5E823-AC0D-5CB5-8F18-1352455A488D'], ], ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4EF5E823-AC0D-5CB5-8F18-1352455A488D\\"\\n}","type":"json"}]', + 'title' => '修改指定组信息', + 'changeSet' => [ + ['createdAt' => '2023-01-10T09:03:10.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], ], + ], + 'UpdateModuleAttribute' => [ + 'summary' => '用于更新指定模板的名称、描述、标签等信息。', + 'path' => '/modules/{moduleId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ @@ -9997,237 +9733,276 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ + 'title' => 'A short description of struct', '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' => '群描述。', + '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, - 'example' => 'test', - ], - 'forcedSetting' => [ - 'description' => '是否强制使用分组配置', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'enumValueTitles' => ['Manual' => 'Manual', 'SourcePathUpdated' => 'SourcePathUpdated'], + 'example' => 'Manual', ], - 'name' => [ - 'description' => '群组名。', - 'type' => 'string', + '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, - 'example' => 'test', ], - 'notifyConfig' => [ - 'description' => '通知配置', + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'tags' => [ + 'description' => '模板的标签列表。', 'type' => 'array', 'items' => [ - 'description' => '通知配置', + 'description' => '模板的标签列表。', 'type' => 'object', 'properties' => [ - 'notifyPath' => [ - 'description' => '通知的路径配置', - 'type' => 'string', - 'required' => false, - 'example' => '/', - ], - 'notifyType' => [ - 'description' => '通知类型：'."\n" - .'DingDing', - 'type' => 'string', - 'required' => false, - 'example' => 'DingDing', - ], + 'tagValue' => ['description' => '模板的标签值。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + 'tagKey' => ['description' => '模板的标签键。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], ], '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时不能为空', + ], + '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' => '## 请求说明'."\n" + .'- 该接口允许用户修改已存在的模板的基本属性，包括但不限于模板名称、描述以及标签。'."\n" + .'- 更新操作不会影响模板的内容或版本信息。'."\n" + .'- 若要启用或禁用删除保护，请通过 `deletionProtection` 参数进行设置。'."\n" + .'- 使用 `clientToken` 可以确保请求的幂等性，避免因网络问题导致的重复提交。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-11-29T14:16:55.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-08-09T01:54:55.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:48.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModuleAttribute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateModuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ], + ], + ], + ], + ], + 'UpdateParameterSetAttribute' => [ + 'summary' => '用于更新指定参数集的名称、描述等属性信息。', + 'path' => '/parameterSets/{parameterSetId}', + 'methods' => ['put'], + 'schemes' => ['http', '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' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '参数集描述，最大长度 1024', 'type' => 'string', 'required' => false, 'example' => 'This is parameterSet', 'title' => '参数描述信息。取值范围：1~256个字符。'], + 'name' => ['description' => '参数集名称，最大长度 128', 'type' => 'string', 'required' => true, 'example' => 'demo', 'title' => '参数名称，需满足以下要求：-由小写字母、数字、下划线组成。-长度不超过16个字符。'], + 'parameters' => [ + 'description' => '参数列表', 'type' => 'array', 'items' => [ - 'description' => '触发策略'."\n" - .'autoTrigger为true时不能为空', + 'description' => '参数集内容', 'type' => 'object', 'properties' => [ - 'triggerStrategy' => [ - 'description' => '触发策略，取值：'."\n" - ."\n" - .'- ProviderNewVersion 新Provider版本发布时触发'."\n" - .'- Cron 定时触发', + 'name' => ['description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => 'region', 'title' => '参数名称。取值范围：内容限制为字母、数字、中划线、下划线，长度不能超过180字符，且不能以aliyun、acs、alibaba、alicloud、oos开头。'], + 'type' => [ + 'description' => '参数类型（string/number/bool/map(string)/list(string)）', 'type' => 'string', 'required' => false, - 'example' => 'Cron', + 'enumValueTitles' => ['number' => '数值', 'string' => '字符', 'bool' => '布尔', 'map(string)' => 'map', 'list(string)' => '数组'], + 'example' => 'string', + 'title' => '参数类型', ], - 'triggerValue' => [ - 'description' => '定时触发时需要维护策略值，cron表达式', + 'value' => ['description' => '参数值（复杂类型用 JSON）', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou', 'title' => '参数的值。'], + 'status' => [ + 'description' => '参数集状态，枚举： '."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值 '."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为 null', 'type' => 'string', 'required' => false, - 'example' => '0 0 * * * ？', + 'enumValueTitles' => ['EXPLICIT_NULL' => '显式设置为 null', 'HAS_VALUE' => '定义具体值'], + 'example' => 'HAS_VALUE', + 'title' => '参数集状态，枚举： '."\n" + ."\n" + .'HAS_VALUE（默认值）：定义具体值 '."\n" + ."\n" + .'EXPLICIT_NULL：显式设置为 null', ], + 'secret' => ['title' => '是否保密参数，保密参数在接口返回时以及控制台展示会进行隐藏，并进行加密存储', 'type' => 'boolean'], ], 'required' => false, + 'title' => '参数map，map中可以设置一个或多个参数，参数之间用半角逗号（,）隔开。', ], '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, + 'title' => '参数map，map中可以设置一个或多个参数，参数之间用半角逗号（,）隔开。', ], ], 'required' => false, + 'title' => '请求体参数。', ], ], [ - 'name' => 'groupId', + 'name' => 'parameterSetId', 'in' => 'path', - 'schema' => [ - 'description' => '分组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', - ], + 'schema' => ['description' => '参数集ID', 'type' => 'string', 'required' => true, 'example' => 'pts-433aead7560571fc2556dc33a4a', 'title' => '新增参数集Id'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应体结构', + 'description' => '请求体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '4EF5E823-AC0D-5CB5-8F18-1352455A488D', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '81CF7E18-D318-5670-9A4D-C08476BC4899'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4EF5E823-AC0D-5CB5-8F18-1352455A488D\\"\\n}","type":"json"}]', - 'title' => '修改指定组信息', - ], - 'GetGroup' => [ - 'summary' => '查询分组。', - 'path' => '/group/{groupId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新参数集属性', + 'description' => '## 请求说明'."\n" + .'- 该接口允许用户修改已存在的参数集的基本信息，包括名称和描述。'."\n" + .'- 如果请求中包含`parameters`字段，则会更新参数集中的参数列表。'."\n" + .'- `clientToken`字段可用于保证请求的幂等性。'."\n" + .'- 更新操作需要提供有效的`parameterSetId`作为路径参数。'."\n" + .'- 请求必须携带认证信息以通过身份验证。'."\n", + 'changeSet' => [ + ['createdAt' => '2022-08-09T01:54:55.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-27T10:03:07.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateParameterSetAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"81CF7E18-D318-5670-9A4D-C08476BC4899\\"\\n}","type":"json"}]', + ], + 'UpdateProject' => [ + 'summary' => '更新项目信息。', + 'path' => '/project/{projectId}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'groupId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '分组ID', - 'type' => 'string', + '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, - 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', ], ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-433aead7560572f8d95b25775c'], + ], ], 'responses' => [ 200 => [ @@ -10236,270 +10011,87 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'C62888F6-254D-5589-BF05-0D9EE698C187'], ], ], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"C62888F6-254D-5589-BF05-0D9EE698C187\\"\\n}","type":"json"}]', + 'title' => '更新项目信息', + 'changeSet' => [ + ['createdAt' => '2022-11-30T07:20:14.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:27.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProject'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ], + ], + ], + ], + ], + 'UpdateRegistryModuleAttribute' => [ + 'summary' => '修改Registry模板。', + 'path' => '/registryModule/{namespaceName}/{moduleName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], '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', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', + '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, - 'example' => 'p-14e80de4866bf7ffed0c4072ed9b37', ], ], [ - 'name' => 'keyword', - 'in' => 'query', - 'schema' => [ - 'description' => '搜索关键词，支持名称搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-case2', - ], + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'example' => 'NamespaceName'], ], [ - '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, - ], + 'name' => 'moduleName', + 'in' => 'path', + 'schema' => ['description' => 'Registry模板名称', 'type' => 'string', 'required' => true, 'example' => 'ModuleName'], ], ], 'responses' => [ @@ -10509,154 +10101,86 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '127A5B81-D1E7-5E33-8D44-B89507C4B81F'], ], ], ], ], - '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"127A5B81-D1E7-5E33-8D44-B89507C4B81F\\"\\n}","type":"json"}]', + 'title' => '修改Registry模板', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRegistryModuleAttribute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateRegistryModuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], ], + ], + 'UpdateRegistryNamespaceAttribute' => [ + 'summary' => '修改工作空间。', + 'path' => '/registryNamespace/{namespaceName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'groupId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '分组ID', - 'type' => 'string', + '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, - 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', ], ], + [ + 'name' => 'namespaceName', + 'in' => 'path', + 'schema' => ['description' => '工作空间名称，需满足下述要求：'."\n" + ."\n" + .'- 长度为 3~63 个字符。'."\n" + .'- 允许大小写字母、数字、短横线（-）、下划线（_），且不能以短横线开头或结尾。'."\n" + .'- 名称在全局工作空间资源下唯一。', 'type' => 'string', 'required' => true, 'example' => 'NamespaceName'], + ], ], 'responses' => [ 200 => [ @@ -10665,104 +10189,162 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3', - ], + 'namespaceName' => ['description' => '工作空间名称', 'type' => 'string', 'example' => 'NamespaceName'], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'CA5C5B39-D1DC-5309-8E97-B9A91DA21094'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1E7BA3EB-B0EF-53F5-9999-07CAD6D9F8A3\\"\\n}","type":"json"}]', - 'title' => '删除分组', - ], - 'AssociateGroup' => [ - 'summary' => '分组关联。', - 'path' => '/group/{groupId}/associate', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"namespaceName\\": \\"NamespaceName\\",\\n \\"requestId\\": \\"CA5C5B39-D1DC-5309-8E97-B9A91DA21094\\"\\n}","type":"json"}]', + 'title' => '修改工作空间', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRegistryNamespaceAttribute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateRegistryNamespaceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], + ], + ], + ], ], + ], + 'UpdateResourceExportTaskAttribute' => [ + 'summary' => '修改资源导出任务。', + 'path' => '/exportTasks/{exportTaskId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'groupId', - 'in' => 'path', - 'schema' => [ - 'description' => '分组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'g-4267dcfbf1b6d128c87adf0e95f', - ], - ], - [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => '请求体参数', + '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', + '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, - 'example' => 'p-433aead7560571a87349d054b4', ], - 'resourceIds' => [ - 'description' => '资源ID列表', + 'includeRules' => [ + 'description' => '导出资源时使用的包含规则列表', 'type' => 'array', 'items' => [ - 'description' => '资源ID', - 'type' => 'string', + '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, - 'example' => 'task-433aead7560571a87', ], - 'required' => true, + 'required' => false, ], - 'resourceType' => [ - 'description' => '资源类型，取值'."\n" + '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" - .'- SceneTestingTask 场景化测试任务'."\n" - .'- Task 常规任务'."\n" - .'- Module 模板', + .'默认值为：Manual', 'type' => 'string', 'required' => false, - 'example' => 'Task', + '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, - 'minItems' => 1, ], ], + [ + 'name' => 'exportTaskId', + 'in' => 'path', + 'schema' => ['description' => '资源导出任务ID', 'type' => 'string', 'required' => true, 'example' => 'ex-al1811jl980g5ffd115nhgt'], + ], ], 'responses' => [ 200 => [ @@ -10771,68 +10353,133 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9', - ], + '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 \\"requestId\\": \\"B6ED9F71-7FA8-598E-B64D-4606FB3FCCC9\\"\\n}","type":"json"}]', - 'title' => '资源关联分组', - ], - 'DissociateGroup' => [ - 'summary' => '取消关联分组。', - 'path' => '/group/{groupId}/dissociate', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"exportTaskId\\": \\"ex-kw161ol8te1n701e1igt8q8\\",\\n \\"exportVersion\\": \\"v1\\",\\n \\"requestId\\": \\"B43F08A7-F2A3-54D3-BDA4-69C9F32A7B9F\\"\\n}","type":"json"}]', + 'title' => '修改资源导出任务', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [ + ['createdAt' => '2023-04-13T08:36:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-26T03:00:24.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceExportTaskAttribute'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateResourceExportTaskAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], + ], + ], + 'UpdateStack' => [ + 'path' => '/stacks/{stackId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ - 'name' => 'projectId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => false, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'description' => ['description' => '资源栈描述信息', 'type' => 'string', 'required' => false, 'example' => 'description'], + 'sourcePath' => ['description' => '配置来源的路径值，不超过 1000 个字符'."\n" + .'- 来源为 OSS 时，取值为 oss::<文件链接>，必须为 zip 文件，例如 oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'."\n" + .'- 来源为 IAC_SERVICE_MODULE 时，取值为<模板Id>，例如: mod-xxxxx', 'type' => 'string', 'required' => false, 'example' => 'oss::https://terraform-pipeline.oss-eu-central-1.aliyuncs.com/code.zip'], + 'ramRole' => ['description' => '授权给任务的RAM 角色，用于在自动触发或者离线情况下自动完成计划任务的继续执行。', 'type' => 'string', 'required' => false, 'example' => 'TestIacRole'], + 'workingDirectory' => ['description' => '配置文件所在的工作目录（如在根目录下则输入 /），如：config/ 或 /', 'type' => 'string', 'required' => false, 'example' => '/'], + 'name' => ['description' => '资源栈名称，长度为 2~128 个字符，允许大小写字母、数字、中文、短横线（-）、下划线（_）、半角句号（.），且不能以短横线、下划线、半角句号开头或结尾', 'type' => 'string', 'required' => false, 'example' => 'stack-test'], + ], 'required' => false, - 'example' => 'p-433aead7560572f8d95b25775c', ], ], [ - 'name' => 'groupId', + 'name' => 'stackId', 'in' => 'path', + 'schema' => ['description' => 'StackId，Stack 创建后的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'stack-as1d4vld898ppnqbxxxxx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'g-59d8d22e78792ffe3d3eb6154d727', + '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' => '0D298375-F92F-5B65-82E4-EA68F02521F1'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改资源栈', + 'summary' => '修改资源栈，当配置发生变更时，触发资源栈部署', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D298375-F92F-5B65-82E4-EA68F02521F1\\"\\n}","type":"json"}]', + ], + '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', @@ -10841,36 +10488,78 @@ 'description' => '请求体参数', 'type' => 'object', 'properties' => [ - 'clientToken' => [ - 'description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', + '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, - 'example' => '2daf4227f747cbf11a5501f18cc5e004', + 'enumValueTitles' => ['Auto' => 'Auto', 'NewVersion' => 'NewVersion', 'ParameterSetUpdated' => 'ParameterSetUpdated', 'Manual' => 'Manual'], + 'example' => 'Manual', + 'default' => 'Manual', + 'enum' => ['Always', 'NewVersion', 'Manual', 'ParameterSetUpdated'], ], - 'resourceIds' => [ - 'description' => '资源ID列表', + 'clientToken' => ['description' => '幂等token，格式: [0-9a-zA-Z-]{1,64}，建议使用UUID', 'type' => 'string', 'required' => true, 'example' => 'a65451293e64979ba7a4b573950217fe'], + 'tags' => [ + 'description' => '任务的标签列表。', 'type' => 'array', 'items' => [ - 'description' => '资源ID', - 'type' => 'string', + 'description' => '任务的标签列表。', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => '任务的标签键。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'tagValue' => ['description' => '任务的标签值。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], 'required' => false, - 'example' => 'task-abc', ], - 'required' => true, - ], - 'resourceType' => [ - 'description' => '资源类型，取值'."\n" - ."\n" - .'- Module 模版'."\n" - .'- SceneTestingTask 场景化测试任务'."\n" - .'- Task 常规任务', - 'type' => 'string', 'required' => false, - 'example' => 'Task', ], + 'terraformProviderVersion' => ['type' => 'string'], ], 'required' => false, - 'minItems' => 1, ], ], ], @@ -10881,107 +10570,110 @@ 'description' => '响应体结构', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '17793D91-A26F-520D-A948-3452A45D15B1', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '17793D91-A26F-520D-A948-3452A45D15B1'], + ], + ], + ], + ], + 'title' => '修改任务', + 'description' => '单用户调用频率：100 次/秒。', + 'changeSet' => [ + ['createdAt' => '2023-07-11T07:34:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-29T13:37:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-09-01T06:23:45.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-27T10:03:05.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-27T03:21:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-09-13T12:28:49.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTaskAttribute'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateTaskAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"17793D91-A26F-520D-A948-3452A45D15B1\\"\\n}","type":"json"}]', - 'title' => '资源解除分组关联', ], - 'ManageTerraformState' => [ - 'summary' => '支持状态文件的资源导入和移除', - 'path' => '/terraformState/manage', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UploadModule' => [ + 'summary' => '模版上传', + 'path' => '/modules/upload/{resourceType}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREopenapiexplorer7MPML0', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREopenapiexplorer7MPML0'], ], 'parameters' => [ [ + 'name' => 'resourceType', + 'in' => 'path', + 'schema' => [ + 'description' => '资源类型。可选值：'."\n" + .'- Module'."\n" + .'- RegistryModule', + 'type' => 'string', + 'required' => true, + 'example' => 'RegistryModule', + 'enum' => ['Module', 'RegistryModule', 'ModuleVersion'], + ], + ], + [ + 'name' => 'url', + 'in' => 'query', + 'schema' => ['description' => '本地需要上传的zip文件'."\n" + .'不超过10MB', 'type' => 'string', 'required' => false, 'example' => 'url', 'isFileTransferUrl' => true], + ], + [ + 'name' => 'namespaceName', + 'in' => 'query', + 'schema' => ['description' => '工作空间名称。当resourceType为RegistryModule 时有效并且必填。', 'type' => 'string', 'required' => false, 'example' => 'test_namespace'], + ], + [ + 'name' => 'moduleName', + 'in' => 'query', + 'schema' => ['description' => 'Module的名称。当resourceType为RegistryModule 时有效并且必填。', 'type' => 'string', 'required' => false, 'example' => 'RegistryModule-test0ef88'], + ], + [ + 'name' => 'moduleId', + 'in' => 'query', + 'schema' => ['description' => 'Module Id，当resourceType为Module 时有效并且必填。', 'type' => 'string', 'required' => false, 'example' => 'mod-kw1018ogp2m3qp22b3k31d'], + ], + [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求体参数。', + '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', + 'code' => [ + 'description' => '模板内容', + 'type' => 'object', 'required' => false, - 'example' => 'vsw-xxxxxxxx', + 'additionalProperties' => ['type' => 'string', 'example' => 'code', 'description' => '模板内容'], ], ], 'required' => false, @@ -10992,142 +10684,63 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '响应体', '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '0DDD8773-5756-5508-BE36-D03DE43E2450'], + 'version' => ['description' => '如果ResourceType传入ModuleVersion，则该参数生效，返回发布后的版本ID', 'type' => 'string', 'example' => 'v1'], ], ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '上传模板', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A80B4F1-4E8C-515A-B3C1-0E1A9B85B6A7\\",\\n \\"jobId\\": \\"job-5fd38c9xxxxx\\"\\n}","type":"json"}]', - 'title' => '管理任务状态文件', - 'description' => '该API主要用于进行自动化服务台上资源编排任务和资源栈任务状态文件的管理。'."\n" - ."\n" - .'使用此API前，请确保已正确配置了所有必要的认证信息，并且Terraform代码符合预期的功能需求。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0DDD8773-5756-5508-BE36-D03DE43E2450\\",\\n \\"version\\": \\"v1\\"\\n}","type":"json"}]', ], - 'GenerateModule' => [ - 'summary' => '生成Terraform HCL模板代码', - 'path' => '/explorer/generate/module', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ValidateModule' => [ + 'summary' => '模版预检。', + 'path' => '/module/validation', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', + 'allowEmptyValue' => false, 'style' => 'json', 'schema' => [ - 'description' => '请求Body。', + 'description' => '请求体参数。', '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模版内容', + '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, - 'example' => 'terraform {'."\n" - .'}', + 'enumValueTitles' => [], + 'example' => 'Upload', ], + 'sourcePath' => ['description' => '来源路径', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'codeMap' => ['description' => '支持传入多个配置文件', 'type' => 'object', 'required' => false, 'example' => '{"main.tf":"xxx"}'], ], 'required' => false, - 'readOnly' => false, ], ], ], @@ -11138,52 +10751,1828 @@ '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"}', - ], + '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'], ], - 'readOnly' => false, ], ], ], - 'errorCodes' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '您无权限执行此操作'], + ], + ], + '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配置文件内容进行预检查', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateModule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ValidateModule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'iac.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'iac.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'iac.vpc-proxy.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'ACQUIRE.LOCK.FAIL', 'message' => 'The request is too frequent. Please try again later.', 'http_code' => 400, 'description' => '访问频繁，请稍后重试'], + ['code' => 'InvalidBranch.NotExist', 'message' => 'The specified branch does not exist.', 'http_code' => 404, 'description' => '指定的分支不存在'."\n"], + ['code' => 'InvalidClient.NotFound', 'message' => 'The specified VCS client does not exist.', 'http_code' => 404, 'description' => '指定的VCS连接端不存在'], + ['code' => 'InvalidConfiguration.MissingDefaultVersion', 'message' => 'The specified configuration has not set the default version.', 'http_code' => 400, 'description' => '指定的模板还没有设置默认版本'], + ['code' => 'InvalidConfiguration.Name.Repeated', 'message' => 'The specified configuration name already exists.', 'http_code' => 400, 'description' => '指定的模版名称已经存在'], + ['code' => 'InvalidConfiguration.NoDelete', 'message' => 'The specified configuration is being operated by the workspace and cannot be deleted.', 'http_code' => 400, 'description' => '指定的模版被工作空间引用，不能删除。'], + ['code' => 'InvalidConfiguration.NotFound', 'message' => 'The specified configuration does not exist.', 'http_code' => 404, 'description' => '指定的模版不存在'], + ['code' => 'InvalidConfigurationShare.NoDeleted', 'message' => 'The specified configuration has been shared and cannot be deleted', 'http_code' => 400, 'description' => '指定的模版已共享，不能删除'], + ['code' => 'InvalidOperation.CallGithub.Failed', 'message' => 'Invoking GitHub API failed.', 'http_code' => 400, 'description' => '调用GitHub接口失败.'], + ['code' => 'InvalidOperation.DeletionProtection', 'message' => 'The specified workspace has enabled deletion protection.', 'http_code' => 400, 'description' => '操作无效，请先取消该工作空间的删除保护'], + ['code' => 'InvalidOperation.InvalidIdentification', 'message' => 'The operation is not allowed for the current user identity.', 'http_code' => 403, 'description' => '无效的用户身份'], + ['code' => 'InvalidOperation.RoleName.NoPermission', 'message' => 'You do not have permission for the selected role name.', 'http_code' => 403, 'description' => '您没有所选择角色的扮演权限'], + ['code' => 'InvalidOperation.Run.NotAllowDestroyResources', 'message' => 'The workspace does not allow you to create a plan to destroy the resources.', 'http_code' => 400, 'description' => '工作空间不允许发起用于销毁资源的新计划'], + ['code' => 'InvalidOperation.RunStatus.CannotAbolish', 'message' => 'The current status of the specified plan does not allow the abolish operation.', 'http_code' => 400, 'description' => '当前计划的当前状态不允许丢弃操作'], + ['code' => 'InvalidOperation.RunStatus.CannotCancel', 'message' => 'The current status of the specified plan does not allow the cancel operation.', 'http_code' => 400, 'description' => '当前计划的当前状态不允许取消操作'], + ['code' => 'InvalidOperation.RunStatus.CannotExecute', 'message' => 'The current status of the specified plan does not allow the execute operation.', 'http_code' => 400, 'description' => '当前计划的当前状态不允许执行操作'], + ['code' => 'InvalidOperation.TaskStatus', 'message' => 'The task %s is in state %s and cannot perform operation %s.', 'http_code' => 400, 'description' => '当前任务%s状态是%s不支持%s操作'], + ['code' => 'InvalidOperation.WorkspaceStatus', 'message' => 'The workspace is not in a valid state for the operation.', 'http_code' => 400, 'description' => '工作空间当前状态不支持此操作，请稍后再重试'], + ['code' => 'InvalidOssObject.InvalidFormat', 'message' => 'The selected OSS object format is invalid. It should be a ZIP file with terraform configuraiton files.', 'http_code' => 400, 'description' => '所选的OSS文件格式无效。它应该是Terraform模板文件的压缩ZIP包'], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => '参数值校验不通过。'], + ['code' => 'InvalidRamRole.NoPermission', 'message' => 'The RAM role is not authorized to perform the operation.', 'http_code' => 403, 'description' => 'Ram角色无权限执行此操作，请核对Ram角色权限'], + ['code' => 'InvalidRamUser.NoPermission', 'message' => 'The RAM user is not authorized to perform the operation.', 'http_code' => 403, 'description' => 'Ram子账户无权限执行此操作，请核对子账号权限'], + ['code' => 'InvalidResourceControlPlane.NotFound', 'message' => 'The specified resourceControlPlane does not exist.', 'http_code' => 404, 'description' => '指定的资源控制面板不存在'], + ['code' => 'InvalidResourceDashboard.NotFound', 'message' => 'The specified resource dashboard does not exist.', 'http_code' => 404, 'description' => '资源控制面板不存在'], + ['code' => 'InvalidRun.ApplyFailed', 'message' => 'Failed to run in the apply stage.', 'http_code' => 400, 'description' => '执行计划失败'], + ['code' => 'InvalidRun.NotFound', 'message' => 'The specified run does not exist.', 'http_code' => 404, 'description' => '指定的执行计划不存在'], + ['code' => 'InvalidRun.PlanFailed', 'message' => 'Failed to run in the plan stage.', 'http_code' => 400, 'description' => '预览计划失败'], + ['code' => 'InvalidVariable.Name.Repeated', 'message' => 'The specified variable name already exists in the workspace.', 'http_code' => 400, 'description' => '指定的变量名已存在于工作区中'], + ['code' => 'InvalidVariable.NotFound', 'message' => 'The specified variable does not exist.', 'http_code' => 404, 'description' => '指定的变量不存在'], + ['code' => 'InvalidVersion.Name.Repeated', 'message' => 'The specified configuration version name already exists in the configuration.', 'http_code' => 400, 'description' => '指定的版本名已存在于模版中'], + ['code' => 'InvalidVersion.NoDelete', 'message' => 'The specified version is the default version of the current configuration and cannot be deleted.', 'http_code' => 400, 'description' => '指定的版本为当前模版的默认版本，不能删除。'], + ['code' => 'InvalidVersion.NotFound', 'message' => 'The specified configuration version does not exist.', 'http_code' => 404, 'description' => '指定的模版版本不存在'], + ['code' => 'InvalidVersion.Status.Failed', 'message' => 'Failed to create the configuration version.', 'http_code' => 400, 'description' => '创建模板版本失败'], + ['code' => 'InvalidVersion.Status.Unavailable', 'message' => 'The specified configuration version is unavailable.', 'http_code' => 400, 'description' => '指定的模版的版本不可用'], + ['code' => 'InvalidVersionShare.NoDeleted', 'message' => 'The specified configuration version has been shared and cannot be deleted.', 'http_code' => 400, 'description' => '指定的模版版本已共享，不能删除'], + ['code' => 'InvalidWorkspace.MissingBranch', 'message' => 'The specified workspace has not set VCS repo branch or configuration version.', 'http_code' => 400, 'description' => '指定的工作空间未设置VCS仓库分支或者模板版本'], + ['code' => 'InvalidWorkspace.NotFound', 'message' => 'The specified workspace does not exist.', 'http_code' => 404, 'description' => '指定的工作空间不存在'], + ['code' => 'InvalidWorkspace.VcsRepoServiceHttpUrl.MissingParameter', 'message' => 'The input parameter VcsRepoServiceHttpUrl is mandatory when service provider is GitHub or GitLab.', 'http_code' => 400, 'description' => 'VcsRepoServiceHttpUrl 参数不存在'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to do this action.', 'http_code' => 403, 'description' => '您无权限执行此操作'], + ['code' => 'PermissionDenied', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 403, 'description' => '您无权限执行此操作'], + ['code' => 'ServiceProvider.AlreadyOccupied', 'message' => 'The specified repository or configuration has already been occupied by another workspace.', 'http_code' => 400, 'description' => '指定的仓库或者模板已经被其他工作空间所占用'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ['description' => '请求参数发生变更', 'api' => 'ListJobs'], + ], + 'createdAt' => '2025-12-04T02:30:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ], + 'createdAt' => '2025-12-03T08:21:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ], + 'createdAt' => '2025-11-24T15:27:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ], + 'createdAt' => '2025-10-29T12:46:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAvailableTerraformVersions'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTerraformProviderVersions'], + ], + 'createdAt' => '2024-03-18T02:32:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', 'api' => 'CheckResourceName'], + ['description' => '错误码发生变更、请求参数发生变更、响应参数发生变更', 'api' => 'TagResources'], + ], + 'createdAt' => '2024-03-14T12:25:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CloneGroup'], + ], + 'createdAt' => '2023-11-23T12:36:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListModules'], + ['description' => '请求参数发生变更', 'api' => 'ListTasks'], + ], + 'createdAt' => '2023-08-14T16:08:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => '响应参数发生变更', 'api' => 'GetTask'], + ['description' => '请求参数发生变更', 'api' => 'UpdateTaskAttribute'], + ], + 'createdAt' => '2023-07-11T07:35:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListGroup'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListModules'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListProject'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTasks'], + ['description' => 'OpenAPI 下线', 'api' => 'TagResources'], + ], + 'createdAt' => '2023-05-24T06:38:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ], + 'createdAt' => '2023-05-11T09:53:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListGroup'], + ], + 'createdAt' => '2023-05-05T07:48:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateResourceExportTask'], + ['description' => '响应参数发生变更', 'api' => 'GetResourceExportTask'], + ['description' => '请求参数发生变更', 'api' => 'UpdateResourceExportTaskAttribute'], + ], + 'createdAt' => '2023-04-13T08:36:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateJob'], + ['description' => '请求参数发生变更', 'api' => 'GetProjectBuildContext'], + ['description' => '请求参数发生变更', 'api' => 'ListTasks'], + ], + 'createdAt' => '2023-04-13T07:25:38.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'iac.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateGroup'], + ['description' => '响应参数发生变更', 'api' => 'GetGroup'], + ['description' => '响应参数发生变更', 'api' => 'GetRamPolicyExportTaskVersion'], + ['description' => '响应参数发生变更', 'api' => 'GetResourceExportTask'], + ['description' => '请求参数发生变更', 'api' => 'UpdateGroup'], + ], + 'createdAt' => '2023-01-10T09:03:52.000Z', + 'description' => '细化断言粒度', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CheckResourceName'], + ['description' => '响应参数发生变更', 'api' => 'ListResourceExportTasks'], + ['description' => '请求参数发生变更', 'api' => 'UpdateResourceExportTaskAttribute'], + ], + 'createdAt' => '2022-12-26T03:01:16.000Z', + 'description' => '新增API ListExportResourceTypes 提供支持自动化导出资源类型列表UpdateResourceExportTaskAttribute 增加字段terraformProviderVersion 支持 terraformProvider版本', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateResourceExportTask'], + ['description' => '响应参数发生变更', 'api' => 'GetResourceExportTask'], + ], + 'createdAt' => '2022-12-14T14:28:55.000Z', + 'description' => '增加TerraformProviderVersion', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateRamPolicyExportTask'], + ['description' => '响应参数发生变更', 'api' => 'GetRamPolicyExportTask'], + ['description' => '响应参数发生变更', 'api' => 'GetRamPolicyExportTaskVersion'], + ], + 'createdAt' => '2022-12-14T13:55:33.000Z', + 'description' => '增加TerraformProviderVersion', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetTaskPolicy'], + ], + 'createdAt' => '2022-12-14T10:36:41.000Z', + 'description' => '优先级详情API增加taskName', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetRamPolicyExportTaskVersion'], + ], + 'createdAt' => '2022-12-13T11:18:34.000Z', + 'description' => '增加警告参数', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetProjectBuildContext'], + ['description' => '响应参数发生变更', 'api' => 'ListJobs'], + ], + 'createdAt' => '2022-12-07T08:50:32.000Z', + 'description' => '参数集变更', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdateProject'], + ], + 'createdAt' => '2022-11-30T07:20:53.000Z', + 'description' => '规范化API', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateModule'], + ], + 'createdAt' => '2022-11-30T05:39:04.000Z', + 'description' => 'AssociateTaskGroup弃用', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListGroup'], + ['description' => '响应参数发生变更', 'api' => 'ListProject'], + ], + 'createdAt' => '2022-11-30T05:11:56.000Z', + 'description' => '移除一些无用字段', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListGroup'], + ['description' => '响应参数发生变更', 'api' => 'ListProject'], + ], + 'createdAt' => '2022-11-29T17:42:02.000Z', + 'description' => '扩展分组内容', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CheckResourceName'], + ['description' => '请求参数发生变更', 'api' => 'CreateProjectBuild'], + ['description' => '响应参数发生变更', 'api' => 'GetProjectBuildContext'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListProjectBuilds'], + ['description' => '响应参数发生变更', 'api' => 'ListTasks'], + ], + 'createdAt' => '2022-11-29T14:35:18.000Z', + 'description' => '更新', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ['description' => '响应参数发生变更', 'api' => 'ListJobs'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListModules'], + ['description' => '请求参数发生变更', 'api' => 'UpdateModuleAttribute'], + ], + 'createdAt' => '2022-11-29T14:18:19.000Z', + 'description' => '模版增加分组字段', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => '响应参数发生变更', 'api' => 'GetTask'], + ['description' => '请求参数发生变更', 'api' => 'UpdateTaskAttribute'], + ], + 'createdAt' => '2022-11-29T13:39:15.000Z', + 'description' => '任务相关API增加描述信息', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ExecuteRamPolicyExportTask'], + ['description' => '响应参数发生变更', 'api' => 'GetRamPolicyExportTaskVersion'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListRamPolicyExportTasks'], + ['description' => '响应参数发生变更', 'api' => 'ListRamPolicyExportTaskVersions'], + ], + 'createdAt' => '2022-11-15T01:53:10.000Z', + 'description' => '变更任务的描述属性', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AssociateParameterSet'], + ['description' => 'OpenAPI 下线', 'api' => 'AttachRabbitmqPublisher'], + ['description' => '请求参数发生变更', 'api' => 'CreateJob'], + ['description' => '请求参数发生变更', 'api' => 'CreateModule'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateParameterSet'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateRabbitmqPublisher'], + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteParameterSet'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteRabbitmqPublisher'], + ], + 'createdAt' => '2022-10-17T02:12:10.000Z', + 'description' => '集团上云相关API', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ], + 'createdAt' => '2022-10-17T02:12:10.000Z', + 'description' => '返回值增加Runtime类型', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CancelRamPolicyExportTask'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateRamPolicyExportTask'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteRamPolicyExportTask'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteRamPolicyExportTaskVersion'], + ['description' => 'OpenAPI 下线', 'api' => 'GetRamPolicyExportTask'], + ['description' => 'OpenAPI 下线', 'api' => 'GetRamPolicyExportTaskVersion'], + ['description' => 'OpenAPI 下线', 'api' => 'ListRamPolicyExportTasks'], + ['description' => 'OpenAPI 下线', 'api' => 'ListRamPolicyExportTaskVersions'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateRamPolicyExportTaskAttribute'], + ], + 'createdAt' => '2022-09-29T06:09:59.000Z', + 'description' => 'RamPolicyExportAPI发布', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => '响应参数发生变更', 'api' => 'GetTask'], + ['description' => '请求参数发生变更', 'api' => 'UpdateTaskAttribute'], + ], + 'createdAt' => '2022-09-01T06:24:11.000Z', + 'description' => '增加保护策略', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetModule'], + ['description' => '响应参数发生变更', 'api' => 'GetModuleVersion'], + ['description' => '请求参数发生变更', 'api' => 'UpdateModuleAttribute'], + ['description' => '请求参数发生变更', 'api' => 'UpdateParameterSetAttribute'], + ], + 'createdAt' => '2022-08-09T01:56:55.000Z', + 'description' => '删除弃用字段，修复参数类型', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetProjectBuildConfig'], + ], + 'createdAt' => '2022-06-09T06:37:42.000Z', + 'description' => '支持IAC平台项目级别任务运行逻辑', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DeleteResourceLink'], + ['description' => 'OpenAPI 下线', 'api' => 'GetResourceLink'], + ], + 'createdAt' => '2022-04-27T09:06:35.000Z', + 'description' => '增加“跳转资源链接”API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CheckResourceName'], + ['description' => '响应参数发生变更', 'api' => 'ListModules'], + ['description' => '响应参数发生变更', 'api' => 'ListRelationTasks'], + ], + 'createdAt' => '2022-04-01T02:50:16.000Z', + 'description' => '新增名称校验API', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetProject'], + ['description' => '响应参数发生变更', 'api' => 'GetTask'], + ['description' => '响应参数发生变更', 'api' => 'ListGroup'], + ], + 'createdAt' => '2022-02-21T02:56:16.000Z', + 'description' => 'API优化', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListProject'], + ], + 'createdAt' => '2022-02-21T02:55:27.000Z', + 'description' => '测试', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'AssociateTaskGroup'], + ], + 'createdAt' => '2022-01-20T05:54:39.000Z', + 'description' => 'fix API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateProjectBuild'], + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => '请求参数发生变更', 'api' => 'DissociateTaskGroup'], + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ['description' => 'OpenAPI 下线', 'api' => 'GetProjectBuildContext'], + ['description' => '响应参数发生变更', 'api' => 'GetTask'], + ['description' => 'OpenAPI 下线', 'api' => 'GetTaskContext'], + ['description' => '响应参数发生变更', 'api' => 'ListJobs'], + ['description' => 'OpenAPI 下线', 'api' => 'ListProjectBuilds'], + ['description' => 'OpenAPI 下线', 'api' => 'ListRelationTasks'], + ], + 'createdAt' => '2022-01-20T05:19:33.000Z', + 'description' => '重构项目管理功能相关API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'AssociateTaskGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateProject'], + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteProject'], + ['description' => 'OpenAPI 下线', 'api' => 'DissociateTaskGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'GetGroup'], + ['description' => 'OpenAPI 下线', 'api' => 'GetProject'], + ['description' => 'OpenAPI 下线', 'api' => 'GetProjectJobSummary'], + ], + 'createdAt' => '2021-12-28T04:34:56.000Z', + 'description' => '- 新增项目管理、任务管理- 增加查看任务中管理的资源', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListAuthorizations'], + ], + 'createdAt' => '2021-12-17T10:29:09.000Z', + 'description' => '1', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListModuleMarkets'], + ], + 'createdAt' => '2021-12-16T03:28:27.000Z', + 'description' => 'fix', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListAuthorizations'], + ['description' => '请求参数发生变更', 'api' => 'ListJobs'], + ['description' => '请求参数发生变更', 'api' => 'ListModuleMarkets'], + ['description' => '请求参数发生变更', 'api' => 'ListModules'], + ['description' => '请求参数发生变更', 'api' => 'OperateJob'], + ], + 'createdAt' => '2021-12-15T08:01:56.000Z', + 'description' => '查询接口参数校验', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetJob'], + ['description' => '响应参数发生变更', 'api' => 'GetModuleVersion'], + ], + 'createdAt' => '2021-12-01T09:28:54.000Z', + 'description' => 'API增加返回内容', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'CloneModule'], + ], + 'createdAt' => '2021-11-01T06:12:51.000Z', + 'description' => '增加返回属性', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateModule'], + ['description' => '请求参数发生变更', 'api' => 'CreateModuleMarket'], + ['description' => '响应参数发生变更', 'api' => 'GetModuleVersion'], + ['description' => '响应参数发生变更', 'api' => 'ListModuleMarkets'], + ['description' => '请求参数发生变更', 'api' => 'UpdateModuleAttribute'], + ], + 'createdAt' => '2021-10-26T08:04:07.000Z', + 'description' => '增加API返回内容', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateJob'], + ], + 'createdAt' => '2021-09-28T07:01:38.000Z', + 'description' => '无', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateTask'], + ['description' => '请求参数发生变更', 'api' => 'ListTasks'], + ['description' => '请求参数发生变更', 'api' => 'UpdateTaskAttribute'], + ], + 'createdAt' => '2021-09-22T10:10:16.000Z', + 'description' => '修改task相关API的属性必填项和触发策略属性的名称', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSharedAccounts'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegistryModuleVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModuleVersion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRegistryModule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceExportTaskVersions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResourceExportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceExportTask'], + ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateModule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssociateGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetModule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegistryModules'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTerraformProviderVersions'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DissociateGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelResourceExportTask'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResourceType'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModuleVersion'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTasks'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceExportTasks'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRegistryNamespaceAttribute'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExplorerRegistryModuleExamples'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExplorerRegistryModuleVersions'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResourceExportTaskAttribute'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSharedAccounts'], + ['threshold' => '360', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegistryModule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListModules'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTaskAttribute'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteTerraformDestroy'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProject'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRegistryNamespace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateModuleAttribute'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateModule'], + ['threshold' => '800', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProducts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteTerraformPlan'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRegistryNamespace'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteTerraformApply'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateResourceExportTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRegistryModule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegistryNamespace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegistryNamespaces'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRegistryModuleVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteModule'], + ['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteResourceExportTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProject'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRegistryModuleAttribute'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegistryModuleVersions'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExplorerModuleAttribute'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateModuleVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteRegistryModule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExecuteState'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProject'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishRegistryModuleVersion'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExplorerRegistryModules'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'], + ], + ], + 'ram' => [ + 'productCode' => 'IaCService', + 'productName' => 'OpenAPI Explorer', + 'ramCodes' => ['iacservice'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DetectTerraformState', + 'description' => '发起偏差检测', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:DetectTerraformState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteParameterSet', + 'description' => '删除参数集', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteTerraformPlan', + 'description' => '执行Terraform Plan', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteTerraformPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetStackExecutionResult', + 'description' => '获取Stack触发结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetStackExecutionResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ManageTerraformState', + 'description' => '管理任务状态文件', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:ManageTerraformState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDetectConfig', + 'description' => '创建偏差检测配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateDetectConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'DetectConfig', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:detectconfig/*'], + ], + ], + ], + [ + 'apiName' => 'GetModuleVersion', + 'description' => '获取模板版本详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/{#ModuleVersionId}'], + ], + ], + ], + [ + 'apiName' => 'CreateModuleVersion', + 'description' => '创建模板版本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/*'], + ], + ], + ], + [ + 'apiName' => 'RemoveSharedAccounts', + 'description' => '移除共享账号', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:RemoveSharedAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRegistryNamespace', + 'description' => '创建工作空间', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateRegistryNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/*'], + ], + ], + ], + [ + 'apiName' => 'GetRegistryModuleVersion', + 'description' => '查询Registry模板版本', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetRegistryModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'ExecuteTerraformDestroy', + 'description' => '执行Terraform Destroy', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteTerraformDestroy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddSharedAccounts', + 'description' => '添加共享账号', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:AddSharedAccounts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateParameterSetAttribute', + 'description' => '更新参数集属性', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateParameterSetAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetJob', + 'description' => '获取作业信息', + 'operationType' => 'get', + 'additionalActions' => [], + 'ramAction' => [ + 'action' => 'iacservice:GetJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/{#JobId}'], + ], + ], + ], + [ + 'apiName' => 'DissociateGroup', + 'description' => '资源解除分组关联', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:DissociateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + [ + 'apiName' => 'GetStackDeployments', + 'description' => '查询资源栈部署列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetStackDeployments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteRegistryModule', + 'description' => '删除Registry模板', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'ListTasks', + 'description' => '获取任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteProject', + 'description' => '删除项目', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'ValidateModule', + 'description' => '模板预检', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ValidateModule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRegistryNamespaces', + 'description' => '查询工作空间列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListRegistryNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/*'], + ], + ], + ], + [ + 'apiName' => 'CreateRegistryModule', + 'description' => '创建Registry模板', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/*'], + ], + ], + ], + [ + 'apiName' => 'ListDetectConfigs', + 'description' => '列举偏差检测配置', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListDetectConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'DetectConfig', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:detectconfig/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDetectConfig', + 'description' => '更新偏差检测配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateDetectConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRegistryModules', + 'description' => '查询Registry模板列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListRegistryModules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/*'], + ], + ], + ], + [ + 'apiName' => 'ListParameterSetRelation', + 'description' => '查询资源关联的参数集列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListParameterSetRelation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTask', + 'description' => '创建任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateProject', + 'description' => '更新项目信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateTaskAttribute', + 'description' => '修改任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateTaskAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], + ], + ], + ], + [ + 'apiName' => 'GetTerraformStateDetection', + 'description' => '获取状态文件检测结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetTerraformStateDetection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetStack', + 'description' => '查询资源栈', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetStack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], + [ + 'apiName' => 'GetGroup', + 'description' => '获取分组信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateResourceExportTaskAttribute', + 'description' => '修改资源导出任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateResourceExportTaskAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteStack', + 'description' => '删除资源栈', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteStack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateGroup', + 'description' => '修改指定组信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateRegistryModuleAttribute', + 'description' => '修改Registry模板', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateRegistryModuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'ListDetectConfigRelations', + 'description' => '列举偏差检测关联关系', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListDetectConfigRelations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateResourceExportTask', + 'description' => '创建资源导出任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/*'], + ], + ], + ], + [ + 'apiName' => 'ListJobs', + 'description' => '查询作业列表', + 'operationType' => 'list', + 'additionalActions' => [], + 'ramAction' => [ + 'action' => 'iacservice:ListJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/*'], + ], + ], + ], + [ + 'apiName' => 'GetExecuteState', + 'description' => '获取Terraform运行结果', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetExecuteState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRegistryNamespace', + 'description' => '删除工作空间', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteRegistryNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], + ], + ], + ], + [ + 'apiName' => 'ListParameterSets', + 'description' => '获取参数集列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListParameterSets', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:ParameterSet/*'], + ], + ], + ], + [ + 'apiName' => 'ListResourceExportTaskVersions', + 'description' => '获取资源导出任务版本列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListResourceExportTaskVersions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DissociateParameterSet', + 'description' => '解除参数集与其他资源的关联关系', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:DissociateParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListModules', + 'description' => '列举模板', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListModules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/*'], + ], + ], + ], + [ + 'apiName' => 'CreateGroup', + 'description' => '创建分组', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/*'], + ], + ], + ], + [ + 'apiName' => 'ListStacks', + 'description' => '查询资源栈列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListStacks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/*'], + ], + ], + ], + [ + 'apiName' => 'AssociateGroup', + 'description' => '资源关联分组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:AssociateGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + [ + 'apiName' => 'OperateJob', + 'description' => '操作作业', + 'operationType' => 'update', + 'additionalActions' => [], + 'ramAction' => [ + 'action' => 'iacservice:OperateJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/{#JobId}'], + ], + ], + ], + [ + 'apiName' => 'GetParameterSet', + 'description' => '获取参数集详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRegistryModule', + 'description' => '查询Registry模板', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'GetResourceExportTask', + 'description' => '获取资源导出任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], + [ + 'apiName' => 'GetDetectConfig', + 'description' => '获取偏差检测配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetDetectConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDetectConfig', + 'description' => '删除偏差检测配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteDetectConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateProject', + 'description' => '创建项目', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/*'], + ], + ], + ], + [ + 'apiName' => 'CreateParameterSet', + 'description' => '创建参数集', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:ParameterSet/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRegistryNamespaceAttribute', + 'description' => '修改工作空间', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateRegistryNamespaceAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], + ], + ], + ], + [ + 'apiName' => 'GetProject', + 'description' => '获取项目详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ], + ], + ], + [ + 'apiName' => 'CreateJob', + 'description' => '创建作业并运行', + 'operationType' => 'create', + 'additionalActions' => [], + 'ramAction' => [ + 'action' => 'iacservice:CreateJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/*'], + ], + ], + ], + [ + 'apiName' => 'ListResourceExportTasks', + 'description' => '获取资源导出任务列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListResourceExportTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/*'], + ], + ], + ], + [ + 'apiName' => 'GetRegistryNamespace', + 'description' => '查询工作空间', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetRegistryNamespace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], + ], + ], + ], + [ + 'apiName' => 'AssociateDetectConfig', + 'description' => '关联偏差检测配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:AssociateDetectConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DissociateDetectConfig', + 'description' => '解除偏差检测配置关联', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:DissociateDetectConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteResourceExportTask', + 'description' => '执行资源导出任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], + [ + 'apiName' => 'ListGroup', + 'description' => '获取分组列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelResourceExportTask', + 'description' => '取消资源导出任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:CancelResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteResourceExportTask', + 'description' => '删除资源导出任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteResourceExportTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ], + ], + ], + [ + 'apiName' => 'ListModuleVersion', + 'description' => '获取模板版本列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/*'], + ], + ], + ], + [ + 'apiName' => 'ListRegistryModuleVersions', + 'description' => '查询Registry模板版本列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListRegistryModuleVersions', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'PublishRegistryModuleVersion', + 'description' => '发布Registry模板版本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:PublishRegistryModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'TriggerStackExecution', + 'description' => '触发Stack执行', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:TriggerStackExecution', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetModule', + 'description' => '获取模板详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ], + ], + ], + [ + 'apiName' => 'ListProject', + 'description' => '获取项目列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListProject', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteModule', + 'description' => '删除模板', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateExplorerModuleAttribute', + 'description' => '更新Explorer模版', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateExplorerModuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AssociateParameterSet', + 'description' => '关联参数集', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:AssociateParameterSet', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UploadModule', + 'description' => '上传模板', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:UploadModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice:*:{#accountId}:module/{#ModuleId}'], + ], + ], + ], + [ + 'apiName' => 'ExecuteTerraformApply', + 'description' => '执行TerraformApply', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteTerraformApply', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateStack', + 'description' => '修改资源栈', + 'operationType' => 'update', + 'additionalActions' => [ + ['action' => 'iacservice:CreateStack', 'validationType' => 'always'], + ], + 'ramAction' => [ + 'action' => 'iacservice:UpdateStack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], + [ + 'apiName' => 'ExecuteRegistryModule', + 'description' => '执行RegistryModule', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:ExecuteRegistryModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'GetTask', + 'description' => '获取任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:GetTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], + ], + ], + ], + [ + 'apiName' => 'ListResources', + 'description' => '获取任务的资源列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iacservice:ListResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateModuleAttribute', + 'description' => '更新模板属性', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iacservice:UpdateModuleAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteGroup', + 'description' => '删除分组', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'IaCService', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ], + ], + ], + [ + 'apiName' => 'ListStackConfigs', + 'description' => '查询资源栈配置列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iacservice:ListStackConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteRegistryModuleVersion', + 'description' => '删除Registry模板版本', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteRegistryModuleVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteTask', + 'description' => '删除任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iacservice:DeleteTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], + ], + ], + ], + [ + 'apiName' => 'CreateModule', + 'description' => '创建模板', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iacservice:CreateModule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/*'], + ], + ], + ], + [ + 'apiName' => 'CreateStack', + 'description' => '创建资源栈', + 'operationType' => 'create', + 'additionalActions' => [ + ['action' => 'iacservice:CreateStack', 'validationType' => 'always'], + ], + 'ramAction' => [ + 'action' => 'iacservice:CreateStack', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IaCService', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'conditional', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:ParameterSet/ParameterSetId'], + ['validationType' => 'always', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/*'], + ['validationType' => 'always', 'resourceType' => 'DetectConfig', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:detectconfig/*'], + ['validationType' => 'always', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/{#ModuleVersionId}'], + ['validationType' => 'always', 'resourceType' => 'ModuleVersion', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}/moduleversion/*'], + ['validationType' => 'conditional', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice::{#accountId}:stack/*'], + ['validationType' => 'conditional', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/*'], + ['validationType' => 'always', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ['validationType' => 'always', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/{#JobId}'], + ['validationType' => 'conditional', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/{#GroupId}'], + ['validationType' => 'always', 'resourceType' => 'Stack', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:stack/{#stackId}'], + ['validationType' => 'always', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/*'], + ['validationType' => 'conditional', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/{#ProjectId}'], + ['validationType' => 'conditional', 'resourceType' => 'RegistryModule', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/*'], + ['validationType' => 'conditional', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:parameterset/{#ParameterSetId}'], + ['validationType' => 'always', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}'], + ['validationType' => 'always', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/{#ResourceExportTaskId}'], + ['validationType' => 'always', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice::{#accountId}:resourceexporttask/*'], + ['validationType' => 'always', 'resourceType' => 'Job', 'arn' => 'acs:iacservice::{#accountId}:task/{#TaskId}/job/*'], + ['validationType' => 'always', 'resourceType' => 'RegistryNamespace', 'arn' => 'acs:iacservice::{#accountId}:registrynamespace/{#NamespaceName}'], + ['validationType' => 'conditional', 'resourceType' => 'ParameterSet', 'arn' => 'acs:iacservice:*:{#accountId}:ParameterSet/*'], + ['validationType' => 'always', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/*'], + ['validationType' => 'conditional', 'resourceType' => 'Group', 'arn' => 'acs:iacservice:*:{#accountId}:group/*'], + ['validationType' => 'conditional', 'resourceType' => 'Project', 'arn' => 'acs:iacservice:*:{#accountId}:project/*'], + ['validationType' => 'always', 'resourceType' => 'Module', 'arn' => 'acs:iacservice::{#accountId}:module/{#ModuleId}'], + ['validationType' => 'conditional', 'resourceType' => 'ExplorerModule', 'arn' => 'acs:iacservice::{#accountId}:explorerModule/*'], + ['validationType' => 'always', 'resourceType' => 'Module', 'arn' => 'acs:iacservice:*:{#accountId}:module/{#ModuleId}'], + ['validationType' => 'always', 'resourceType' => 'ResourceExportTask', 'arn' => 'acs:iacservice:{#regionId}:{#accountId}:registrynamespace/{#NamespaceName}/registrymodule/{#ModuleName}'], + ['validationType' => 'always', 'resourceType' => 'Task', 'arn' => 'acs:iacservice::{#accountId}:*'], ], ], ]; |