'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'BPStudio', 'version' => '2021-09-31', ], 'directories' => [ [ 'id' => 356458, 'title' => 'Token', 'type' => 'directory', 'children' => [ 'GetToken', ], ], [ 'id' => 356460, 'title' => '模板', 'type' => 'directory', 'children' => [ 'GetTemplate', 'ListTemplate', 'ValuateTemplate', 'GetLinkageAttributesTemplate', ], ], [ 'id' => 356465, 'title' => '应用', 'type' => 'directory', 'children' => [ 'GetApplicationVariables', 'ReConfigApplication', 'GetApplicationVariables4Fail', 'CreateApplication', 'DeleteApplication', 'GetApplication', 'ListApplication', 'DeployApplication', 'ReleaseApplication', 'ValidateApplication', 'ValuateApplication', 'GetResource4ModifyRecord', 'GetResult4QueryInstancePrice4Modify', 'ModifyApplicationSpec', 'QueryInstancePrice4Modify', 'QueryInstanceSpec4Modify', ], ], [ 'id' => 356482, 'title' => '应用操作', 'type' => 'directory', 'children' => [ 'ExecuteOperationSync', 'ExecuteOperationASync', 'GetExecuteOperationResult', 'ListServices', 'ListOperations', 'GetOperationParams', ], ], [ 'id' => 356489, 'title' => '资源组', 'type' => 'directory', 'children' => [ 'ChangeResourceGroup', ], ], [ 'id' => 356491, 'title' => '容灾服务', 'type' => 'directory', 'children' => [ 'AppFailOver', 'GetPotentialFailZones', 'GetFoTaskStatus', 'AppFailBack', 'ListFoCreatedApps', 'InitAppFailOver', ], ], [ 'id' => 356498, 'title' => '其他', 'type' => 'directory', 'children' => [ 'ListTagResources', 'ExecuteTask', 'CreateTask', 'GetTask', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'GetToken' => [ 'summary' => '获取读取架构图的临时授权，有效期30分钟。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91666', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzhfgmw4e6fwq', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '授权信息', 'type' => 'object', 'properties' => [ 'SecurityToken' => [ 'title' => 'oss访问token', 'description' => 'oss访问token', 'type' => 'string', 'example' => 'ABCD', ], 'Endpoint' => [ 'title' => 'oss的endpoint', 'description' => 'oss的endpoint', 'type' => 'string', 'example' => 'https://oss-cn-beijing.aliyuncs.com', ], 'AccessKeySecret' => [ 'title' => 'oss访问access key secret id', 'description' => 'oss访问access key secret', 'type' => 'string', 'example' => '9NG*****K4X', ], 'AccessKeyId' => [ 'title' => 'oss访问access key id', 'description' => 'oss访问access key id', 'type' => 'string', 'example' => 'STS.NTm*****8tu', ], 'Bucket' => [ 'title' => 'oss文件保存bucket位置', 'description' => 'oss文件保存bucket位置', 'type' => 'string', 'example' => 'bucket-1', ], 'SnapshotBucket' => [ 'title' => 'oss快照保存bucket位置', 'description' => 'oss快照保存bucket位置', 'type' => 'string', 'example' => 'bucket-2', ], ], ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'staticInfo' => [ 'substitutions' => [ 'BPStudio::2021-09-31::GetApplication', ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"SecurityToken\\": \\"ABCD\\",\\n \\"Endpoint\\": \\"https://oss-cn-beijing.aliyuncs.com\\",\\n \\"AccessKeySecret\\": \\"9NG*****K4X\\",\\n \\"AccessKeyId\\": \\"STS.NTm*****8tu\\",\\n \\"Bucket\\": \\"bucket-1\\",\\n \\"SnapshotBucket\\": \\"bucket-2\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n A07FFDF2-78FA-1B48-9E38-88E833A93187\\n \\n ABCD\\n https://oss-cn-beijing.aliyuncs.com\\n 9NG*****K4X\\n STS.NTm*****8tu\\n bucket-1\\n bucket-2\\n \\n 200\\n","errorExample":""}]', 'title' => '获取加载架构图token（不推荐使用）', 'description' => '> 该接口不再推荐使用，Application相关图片已在GetApplication中属性中包含访问授权。>', ], 'GetTemplate' => [ 'summary' => '获取模板图片及架构图相关信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91665', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLICAE', 'FEATUREbpstudio3E4W4L', ], ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => 'XFKR6WYRVS24S07R', ], ], [ 'name' => 'Region', 'in' => 'formData', 'schema' => [ 'description' => '模板区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzhfgmw4e6fwq', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '模板详情', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '模板描述', 'type' => 'string', ], 'ImageURL' => [ 'description' => '模板架构图片文件路径', 'type' => 'string', 'example' => 'bp-studio-template/sr-U37UD2YQCRJ75X5V.png', ], 'Name' => [ 'description' => '模板名称', 'type' => 'string', 'example' => 'cadt-template', ], 'TemplateId' => [ 'description' => '模板ID', 'type' => 'string', 'example' => 'XFKR6WYRVS24S07R', ], 'CreateTime' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '2020-09-22 17:08:31', ], 'ResourceGroupId' => [ 'description' => '资源组ID', 'type' => 'string', 'example' => 'rg-aekzhfgmw4e6fwq', ], 'Variables' => [ 'description' => '模板变量详情', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Attribute' => [ 'title' => '变量名', 'description' => '变量名', 'type' => 'string', 'example' => 'instance_name', ], 'DataType' => [ 'title' => '变量类型', 'description' => '变量类型', 'type' => 'string', 'example' => 'String', ], 'DefaultValue' => [ 'title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => 'cadt-app-01', ], 'Variable' => [ 'title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => '${name}', ], 'Options' => [ 'type' => 'string', ], ], ], ], 'DocumentUrl' => [ 'description' => '场景详情', 'type' => 'string', ], ], ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"Description\\": \\"\\",\\n \\"ImageURL\\": \\"bp-studio-template/sr-U37UD2YQCRJ75X5V.png\\",\\n \\"Name\\": \\"cadt-template\\",\\n \\"TemplateId\\": \\"XFKR6WYRVS24S07R\\",\\n \\"CreateTime\\": \\"2020-09-22 17:08:31\\",\\n \\"ResourceGroupId\\": \\"rg-aekzhfgmw4e6fwq\\",\\n \\"Variables\\": [\\n {\\n \\"Attribute\\": \\"instance_name\\",\\n \\"DataType\\": \\"String\\",\\n \\"DefaultValue\\": \\"cadt-app-01\\",\\n \\"Variable\\": \\"${name}\\",\\n \\"Options\\": \\"\\"\\n }\\n ],\\n \\"DocumentUrl\\": \\"\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n A07FFDF2-78FA-1B48-9E38-88E833A93187\\n \\n 无\\n bp-studio-template/sr-U37UD2YQCRJ75X5V.png\\n cadt-template\\n bp-studio-template/topo-0RJH9V408JV6MIT9.json\\n XFKR6WYRVS24S07R\\n 2020-09-22 17:08:31\\n rg-aekzhfgmw4e6fwq\\n \\n 200\\n","errorExample":""}]', 'title' => '获取模板信息', ], 'ListTemplate' => [ 'summary' => '获取模板列表，包括模板名称、架构图地址、架构图序列化文件地址等。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91668', 'abilityTreeNodes' => [ 'FEATUREbpstudioRJ9IF1', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'OrderType', 'in' => 'formData', 'schema' => [ 'title' => '排序字段', 'description' => '排序字段：'."\n" .'- 1：按更新时间排序'."\n" .'- 2：按创建时间排序'."\n" .'- 3：按系统推荐排序'."\n" .'- 4：按使用次数排序'."\n" .'- 不输入任何值或输入除了1，2，3，4之外的任意整数：按系统推荐排序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '5', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => [ 'title' => '搜索关键字', 'description' => '搜索模板名称关键字', 'type' => 'string', 'required' => false, 'example' => '“CADT”', ], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'title' => '类型', 'description' => '“public”代表开放模板，“private”代表私有模板。', 'type' => 'string', 'required' => true, 'example' => 'private', ], ], [ 'name' => 'TagList', 'in' => 'formData', 'schema' => [ 'title' => '模板的标签', 'description' => '模板的标签', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], [ 'name' => 'Tag', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '标签列表。', 'type' => 'array', 'items' => [ 'description' => '标签信息', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'tag', ], 'Value' => [ 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'NextToken' => [ 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '模板列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ImageURL' => [ 'title' => '模板的图片链接', 'description' => '模板的图片链接', 'type' => 'string', 'example' => 'bp-studio-template/sr-U37UD2YQCRJ75X5V.png', ], 'TagId' => [ 'title' => '模板的标签的ID', 'description' => '模板的标签的ID', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => '1', ], 'TagName' => [ 'title' => '模板标签的名称', 'description' => '模板标签的名称', 'type' => 'string', 'deprecated' => true, 'example' => 'TagName', ], 'Name' => [ 'title' => '模板的名称', 'description' => '模板的名称', 'type' => 'string', 'example' => 'cadt-name', ], 'TemplateId' => [ 'title' => '模板的ID', 'description' => '模板的ID', 'type' => 'string', 'example' => 'CJQ6H0XUEQ20IYJQ', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2021-03-18 16:41:31', ], 'ResourceGroupId' => [ 'title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'example' => 'rg-acfmyjt3c5om3hi', ], 'Tag' => [ 'description' => '标签列表', 'type' => 'array', 'items' => [ 'description' => '标签信息', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '标签键', 'type' => 'string', 'example' => 'tag1', ], 'Value' => [ 'description' => '标签值', 'type' => 'string', 'example' => 'value1', ], ], ], ], 'Description' => [ 'description' => '模版描述信息', 'type' => 'string', ], 'DocumentUrl' => [ 'description' => '场景详情', 'type' => 'string', ], ], ], ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 100,\\n \\"Message\\": \\"Success\\",\\n \\"NextToken\\": 1,\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": [\\n {\\n \\"ImageURL\\": \\"bp-studio-template/sr-U37UD2YQCRJ75X5V.png\\",\\n \\"TagId\\": 1,\\n \\"TagName\\": \\"TagName\\",\\n \\"Name\\": \\"cadt-name\\",\\n \\"TemplateId\\": \\"CJQ6H0XUEQ20IYJQ\\",\\n \\"CreateTime\\": \\"2021-03-18 16:41:31\\",\\n \\"ResourceGroupId\\": \\"rg-acfmyjt3c5om3hi\\",\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Description\\": \\"\\",\\n \\"DocumentUrl\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 100\\n Success\\n 1\\n A07FFDF2-78FA-1B48-9E38-88E833A93187\\n \\n bp-studio-template/sr-U37UD2YQCRJ75X5V.png\\n 1\\n 官方模板\\n cadt-name\\n bp-studio-template/topo-0RJH9V408JV6MIT9.json\\n CJQ6H0XUEQ20IYJQ\\n 2021-03-18 16:41:31\\n rg-acfmyjt3c5om3hi\\n \\n 200\\n","errorExample":""}]', 'title' => '查询模板列表', ], 'ValuateTemplate' => [ 'summary' => '查询模板价格。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '181941', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLQBYK', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => '0KSHPM6SJU03TNZP', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1600765710019', ], ], [ 'name' => 'AreaId', 'in' => 'formData', 'schema' => [ 'title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Instances', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '待替换实例列表', 'description' => '待替换实例列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeType' => [ 'title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], 'NodeName' => [ 'title' => '图上实例名', 'description' => '图上实例名', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1q56trhtaq40vlq5oj', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '应用所属资源组ID', 'description' => '应用所属资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3fi', ], ], [ 'name' => 'Variables', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '对于带参数的模板，这个字段用于传递相关参数值，如果未传递，则使用默认值', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'example' => '${var1}', 'description' => '支持类型', ], 'enumValueTitles' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', ], 'Data' => [ 'description' => '询价结果', 'type' => 'object', 'properties' => [ 'ResourceList' => [ 'description' => '询价返回结果集', 'type' => 'array', 'items' => [ 'description' => '结果集', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'description' => '资源类型', 'type' => 'string', 'example' => 'ecs', ], 'Error' => [ 'description' => '询价错误信息', 'type' => 'string', 'example' => 'InvalidSaleComponentFault : The request not refer to the correct order sale component.', ], 'TradePrice' => [ 'description' => '交易金额', 'type' => 'number', 'format' => 'double', 'example' => '10.0', ], 'DiscountAmount' => [ 'description' => '减免金额', 'type' => 'number', 'format' => 'double', 'example' => '73.0', ], 'OriginalPrice' => [ 'description' => '原价', 'type' => 'number', 'format' => 'double', 'example' => '83.0', ], 'PromotionName' => [ 'description' => '优惠信息', 'type' => 'string', ], 'PriceUnit' => [ 'description' => '计价单位。', 'type' => 'string', 'example' => 'CNY / USD', ], 'PriceList' => [ 'description' => '子询价列表', 'type' => 'array', 'items' => [ 'description' => '子询价列表', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'description' => '资源类型', 'type' => 'string', 'example' => 'eip', ], 'ResourceId' => [ 'description' => '资源topo Id', 'type' => 'string', 'example' => '1687225092', ], 'Error' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'ServiceUnavailable : The request has failed due to a temporary failure of the server.\\r\\nRequestId : 4AA302DB-3286-5589-8637-FF6D8507B7A9.', ], 'TradePrice' => [ 'description' => '交易价格', 'type' => 'number', 'format' => 'float', 'example' => '0.01', ], 'DiscountAmount' => [ 'description' => '订单优惠金额', 'type' => 'number', 'format' => 'float', 'example' => '82.99', ], 'OriginalPrice' => [ 'description' => '原价', 'type' => 'number', 'format' => 'float', 'example' => '83.0', ], 'PromotionName' => [ 'description' => '优惠信息', 'type' => 'string', ], 'PriceUnit' => [ 'description' => '计价单位', 'type' => 'string', 'example' => 'CNY / USD'."\n", ], 'Type' => [ 'description' => '是否新购：
1.新建
2已保有
0不计入价格', 'type' => 'string', 'example' => '"1"', ], ], ], ], ], ], ], ], ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], [ 'errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.appNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', ], [ 'errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.nopowerContact', 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', ], [ 'errorCode' => 'bp.java.tempNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', ], [ 'errorCode' => 'bp.java.userNotExist', 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'bp.java.notDelete', 'errorMessage' => 'This template has been shared with other users and cannot be deleted.', ], [ 'errorCode' => 'bp.java.serviceError', 'errorMessage' => 'The server is abnormal. Please try again later.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"847C9D0A-BABD-589C-8A9C-6464409EDED9\\",\\n \\"Data\\": {\\n \\"ResourceList\\": [\\n {\\n \\"NodeType\\": \\"ecs\\",\\n \\"Error\\": \\"InvalidSaleComponentFault : The request not refer to the correct order sale component.\\",\\n \\"TradePrice\\": 10,\\n \\"DiscountAmount\\": 73,\\n \\"OriginalPrice\\": 83,\\n \\"PromotionName\\": \\"\\",\\n \\"PriceUnit\\": \\"CNY / USD\\",\\n \\"PriceList\\": [\\n {\\n \\"NodeType\\": \\"eip\\",\\n \\"ResourceId\\": \\"1687225092\\",\\n \\"Error\\": \\"ServiceUnavailable : The request has failed due to a temporary failure of the server.\\\\\\\\r\\\\\\\\nRequestId : 4AA302DB-3286-5589-8637-FF6D8507B7A9.\\",\\n \\"TradePrice\\": 0.01,\\n \\"DiscountAmount\\": 82.99,\\n \\"OriginalPrice\\": 83,\\n \\"PromotionName\\": \\"\\",\\n \\"PriceUnit\\": \\"CNY / USD\\\\n\\",\\n \\"Type\\": \\"\\\\\\"1\\\\\\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '模板实时询价', ], 'GetLinkageAttributesTemplate' => [ 'summary' => '获取模板变参可选值', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '181941', 'abilityTreeNodes' => [ 'FEATUREbpstudioRJ9IF1', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => 'XFKR6WYRVS24S07R', ], ], [ 'name' => 'AreaId', 'in' => 'formData', 'schema' => [ 'title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Instances', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '待替换实例列表', 'description' => '待替换实例列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeName' => [ 'title' => '图上实例名', 'description' => '图上实例名', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'NodeType' => [ 'title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-**1q56**taq40*****', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'Variables', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '对于带参数的模板，这个字段用于传递相关参数值，如果未传递，则使用默认值', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '参数值', 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}', ], ], ], [ 'name' => 'TargetVariable', 'in' => 'formData', 'schema' => [ 'description' => '查询的模板变量', 'type' => 'string', 'required' => true, 'example' => '${instance_type}', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => '下一个分页', 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '50', 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'OptionalValues' => [ 'description' => '可选值', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "label": "ecs.c6.2xlarge (8c 16g)",'."\n" .' "value": "ecs.c6.2xlarge"'."\n" .' },'."\n" .' {'."\n" .' "label": "ecs.c6.3xlarge (12c 24g)",'."\n" .' "value": "ecs.c6.3xlarge"'."\n" .' }'."\n" .']', ], 'ErrorCode' => [ 'description' => '错误码。', 'type' => 'string', 'example' => '400', ], 'ErrorMessage' => [ 'description' => '错误信息。', 'type' => 'string', 'example' => 'SyntaxError', ], 'TotalCount' => [ 'description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '19', ], 'NextToken' => [ 'description' => '下一个分页', 'type' => 'string', 'example' => '2', ], ], ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], 'AccessDeniedDetail' => [ 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{'."\n" .' "PolicyType": "",'."\n" .' "AuthPrincipalOwnerId": "",'."\n" .' "EncodedDiagnosticMessage": "",'."\n" .' "AuthPrincipalType": "",'."\n" .' "AuthPrincipalDisplayName": "",'."\n" .' "NoPermissionType": "",'."\n" .' "AuthAction": ""'."\n" .' }', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 403 => [ [ 'errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', ], ], [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"OptionalValues\\": \\"[\\\\n {\\\\n \\\\\\"label\\\\\\": \\\\\\"ecs.c6.2xlarge (8c 16g)\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ecs.c6.2xlarge\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"label\\\\\\": \\\\\\"ecs.c6.3xlarge (12c 24g)\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ecs.c6.3xlarge\\\\\\"\\\\n }\\\\n]\\",\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"SyntaxError\\",\\n \\"TotalCount\\": 19,\\n \\"NextToken\\": \\"2\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', 'title' => '获取模板变参可选值', ], 'GetApplicationVariables' => [ 'summary' => '获取一个应用的所有输入的模版变量的值。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240229', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID，可通过ListApplication获取。', 'type' => 'string', 'required' => false, 'example' => 'Q2P4O9YSOKCQ35L9', ], ], ], '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' => '7036DDBE-0ABA-52D7-A39D-75E511970F07', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '返回应用所包含的实例及应用的变量', 'type' => 'array', 'items' => [ 'description' => '返回值', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => '实例id', 'type' => 'string', 'example' => 'ob5epf79uv****', ], 'VariableList' => [ 'description' => '变量集合', 'type' => 'array', 'items' => [ 'description' => '变量列表', 'type' => 'object', 'properties' => [ 'Variable' => [ 'description' => '变量名', 'type' => 'string', 'example' => '${instance_type}', ], 'Value' => [ 'description' => '设置的值', 'type' => 'string', 'example' => 'ecs.c6.4xlarge', ], ], ], ], ], ], ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7036DDBE-0ABA-52D7-A39D-75E511970F07\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ob5epf79uv****\\",\\n \\"VariableList\\": [\\n {\\n \\"Variable\\": \\"${instance_type}\\",\\n \\"Value\\": \\"ecs.c6.4xlarge\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '获取应用输入参数', ], 'ReConfigApplication' => [ 'summary' => '用户可以从上面函数获取到需要重新配置的模版变量列表。然后对这些变量重新赋值后，调用本函数，应用状态会变为“修改中”，同时失败节点的属性值会根据传入的模版变量值重新赋值（例如：修改了失败资源的实例类型等）。执行该函数后，用户可以重新部署该应用。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238269', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID，可以调用ListApplication接口获取，详情请参见ListApplication。', 'type' => 'string', 'required' => false, 'example' => 'Q2P4O9YSOKCT35L9', ], ], [ 'name' => 'Variables', 'in' => 'formData', 'schema' => [ 'description' => '更新属性', 'type' => 'string', 'required' => false, 'example' => '{"${instance_type}":"ecs.c6.3xlarge"}', ], ], ], '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' => '9656C816-1E9A-58D2-86D5-710678D61AF1', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '更新应用属性', ], 'GetApplicationVariables4Fail' => [ 'summary' => '获取需要重新配置的变量列表。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238274', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'description' => '应用ID，可通过调用ListApplication接口获取，详情请参见ListApplication。', 'type' => 'string', 'required' => false, 'example' => 'Q2P4O9YSOKCT35L9', ], ], ], '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' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '返回“部分部署成功”的应用中和部署失败的资源节点相关的模版变量列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Region' => [ 'description' => '区域', 'type' => 'string', 'example' => 'cn-shenzhen', ], 'Attribute' => [ 'description' => '变量名', 'type' => 'string', 'example' => 'instance_name', ], 'Variable' => [ 'description' => '变量值', 'type' => 'string', 'example' => '${name}', ], 'PlaceHolder' => [ 'description' => '变量值', 'type' => 'string', 'example' => '${name}', ], 'Value' => [ 'description' => '设置的属性值', 'type' => 'string', 'example' => 'cadt-app-01', ], 'DefaultValue' => [ 'description' => '默认值', 'type' => 'string', 'example' => 'cadt-app-01', ], ], ], ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": [\\n {\\n \\"Region\\": \\"cn-shenzhen\\",\\n \\"Attribute\\": \\"instance_name\\",\\n \\"Variable\\": \\"${name}\\",\\n \\"PlaceHolder\\": \\"${name}\\",\\n \\"Value\\": \\"cadt-app-01\\",\\n \\"DefaultValue\\": \\"cadt-app-01\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '查询“部分部署成功”的应用中和部署失败的资源节点相关的模版变量列表', ], 'CreateApplication' => [ 'summary' => '请确保在使用该接口前，已充分了解阿里云产品的收费方式和价格。基于CADT上官方模板或私有模板创建新的应用。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91661', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'title' => '模板ID', 'description' => '模板ID', 'type' => 'string', 'required' => true, 'example' => '0KSHPM6SJU03TNZP', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '客户端 Token，用于保证请求的幂等性。'."\n" ."\n" .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。', 'description' => '客户端 Token，用于保证请求的幂等性。'."\n" ."\n" .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1600765710019', ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'title' => '新建应用名', 'description' => '输入应用名称。'."\n" ."\n" .'- 应用名称需唯一，不能与其他应用名称重复，可以调用[ListApplication](~~428266~~)[ListApplication](https://www.alibabacloud.com/help/zh/bp-studio/latest/api-bpstudio-2021-09-31-listapplication)获取应用列表。'."\n" .'- 长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、下划线（_）、或者短划线（-）。', 'type' => 'string', 'required' => true, 'example' => 'cadt-application', ], ], [ 'name' => 'AreaId', 'in' => 'formData', 'schema' => [ 'title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '应用所属资源组ID', 'description' => '应用所属资源组ID'."\n" ."\n" .'>此参数将影响所创应用中所有资源的资源组，请确保导入资源的资源组与之一致>', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], [ 'name' => 'CreateAsync', 'in' => 'formData', 'schema' => [ 'description' => '是否异步创建应用'."\n" ."\n" .'异步创建：立即返回应用ID，但是应用此时没有创建完成，应用状态为 Creating ，需要等待应用创建完成，状态变为 Modified 才可以进行后续的处理。'."\n" ."\n" .'非异步创建：应用创建完成后返回应用ID'."\n" ."\n" .'注：当应用模版很大，模版变量很多时，使用非异步创建可能会发生超时情况，此时需要采用异步创建。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], ], [ 'name' => 'Instances', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '待替换实例列表', 'description' => '支持在已保有VPC下创建', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'NodeType' => [ 'title' => '实例类型', 'description' => '实例类型', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'NodeName' => [ 'title' => '图上实例名', 'description' => '节点名称', 'type' => 'string', 'required' => false, 'example' => 'vpc', ], 'Id' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1q56trhtaq40vlq5ojm', ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'Configuration', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '应用相关配置参数，例如：enableMonitor 代表是否自动创建云监控; enableReport 代表是否生成相关报告,enableCompliance设置为1代表开启合规检查', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '参数值', 'example' => '${var1}', ], ], ], [ 'name' => 'Variables', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '对于带参数的模板，这个字段用于传递相关参数值，如果未传递，则使用默认值', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '参数值', 'example' => '', ], ], ], [ 'name' => 'ProcessVariables', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '流程的变量值列表', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => '002XWH7MXB8MJRU0', ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], [ 'errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.appNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', ], [ 'errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.nopowerContact', 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', ], [ 'errorCode' => 'bp.java.tempNameNotNull', 'errorMessage' => 'Application name cannot be repeated.', ], [ 'errorCode' => 'bp.java.userNotExist', 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'bp.java.notDelete', 'errorMessage' => 'This template has been shared with other users and cannot be deleted.', ], [ 'errorCode' => 'bp.java.serviceError', 'errorMessage' => 'The server is abnormal. Please try again later.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"002XWH7MXB8MJRU0\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '基于模板创建应用接口', ], 'DeleteApplication' => [ 'summary' => '删除应用。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91663', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '002XWH7MXB8MJRU0', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'The request parameter cannot be empty.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '删除应用', 'description' => '调用该接口删除应用前，必须确保应用的状态为`释放成功`（`Destroyed_Success`），否则删除失败。可以调用[GetApplication](~~428265~~)[GetApplication](https://www.alibabacloud.com/help/zh/bp-studio/latest/api-bpstudio-2021-09-31-getapplication)查询应用状态。', ], 'GetApplication' => [ 'summary' => '获取指定应用的基本信息、校验结果、计费结果、部署结果。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91657', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => 'VVK605ZH00OA4MRT', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '请求失败原因', 'description' => '请求失败原因', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '应用详情', 'type' => 'object', 'properties' => [ 'Description' => [ 'title' => '应用描述', 'description' => '应用描述', 'type' => 'string', 'example' => 'remark', ], 'ImageURL' => [ 'title' => '数据库中图片地址', 'description' => '数据库中图片地址', 'type' => 'string', 'example' => 'https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png', ], 'ApplicationId' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'VVK605ZH00OA4MRT', ], 'Name' => [ 'title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'CADT', ], 'TemplateId' => [ 'title' => '应用关联模板ID', 'description' => '应用关联模板ID', 'type' => 'string', 'example' => 'FYS9VZ535U20V7HT', ], 'CreateTime' => [ 'title' => '应用创建时间', 'description' => '应用创建时间', 'type' => 'string', 'example' => '2021-08-09 14:37:16', ], 'ResourceGroupId' => [ 'title' => '应用所属资源组ID', 'description' => '应用所属资源组ID', 'type' => 'string', 'example' => 'rg-aekzhfgmw4e6fwq', ], 'PriceList' => [ 'title' => '计费结果列表', 'description' => '计费结果列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ResourceCode' => [ 'title' => '产品code', 'description' => '产品code', 'type' => 'string', 'example' => 'ecs', ], 'InstanceName' => [ 'title' => '实例名', 'description' => '实例名', 'type' => 'string', 'example' => 'ecs', ], 'OriginalPrice' => [ 'title' => '原价', 'description' => '原价', 'type' => 'number', 'format' => 'double', 'example' => '3.570', ], 'OnePrice' => [ 'title' => '单价', 'description' => '单价', 'type' => 'number', 'format' => 'double', 'example' => '0.01', ], 'Period' => [ 'description' => '时长', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Count' => [ 'title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PriceUnit' => [ 'title' => '单位', 'description' => '单位：元/时'."\n" .'USD/时', 'type' => 'string', 'example' => '200/hour', ], 'Price' => [ 'title' => '总价', 'description' => '总价', 'type' => 'number', 'format' => 'double', 'example' => '0.01', ], 'ChargeType' => [ 'title' => '支付类型', 'description' => '支付类型', 'type' => 'string', 'example' => 'PayAsYouGo', ], 'Region' => [ 'title' => '区域', 'description' => '区域', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Specification' => [ 'title' => '规格', 'description' => '实例规格。'."\n" .'返回实例规格信息，例如VPC返回网段信息“192.168.0.0/16”，ECS返回实例规格“ecs.g5.large”，SLB返回“slb.s1.small”等；如果该实例没有规格属性，则返回空。', 'type' => 'string', 'example' => '"slb.s1.small"'."\n" .' "192.168.0.0/24"'."\n" .'"ecs.c6.large"'."\n" .'"normal"'."\n" .' ""', ], 'Lifecycle' => [ 'title' => '资源标记', 'description' => '资源标记', 'type' => 'string', 'example' => 'Create', ], 'Remark' => [ 'description' => '询价失败时返回错误信息', 'type' => 'string', 'example' => 'ecs Sold Out', ], 'type' => [ 'description' => '创建类型：'."\n" .'
新建-1'."\n" .'
导入-2', 'type' => 'string', 'example' => '1', ], ], ], ], 'Checklist' => [ 'title' => '校验结果列表', 'description' => '校验结果列表', 'type' => 'array', 'items' => [ 'description' => '校验结果列表', 'type' => 'object', 'properties' => [ 'ResourceCode' => [ 'title' => '产品code', 'description' => '产品code', 'type' => 'string', 'example' => 'vpc', ], 'ResourceName' => [ 'title' => '实例名', 'description' => '实例名', 'type' => 'string', 'example' => 'vpc', ], 'Region' => [ 'title' => '区域', 'description' => '区域', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Result' => [ 'title' => '校验结果', 'description' => '校验结果', 'type' => 'string', 'example' => 'Finish', ], 'Remark' => [ 'title' => '失败原因', 'description' => '失败原因', 'type' => 'string', 'example' => 'Verification passed', ], 'Specification' => [ 'title' => '规格', 'description' => '规格', 'type' => 'string', 'example' => '192.168.0.0/16', ], 'Lifecycle' => [ 'title' => '资源标记', 'description' => '资源标记', 'type' => 'string', 'example' => 'Create', ], ], ], ], 'Status' => [ 'title' => '应用状态', 'description' => '应用状态', 'type' => 'string', 'example' => 'Deployed_Success', ], 'ResourceList' => [ 'title' => '资源列表', 'description' => '资源列表', 'type' => 'array', 'items' => [ 'description' => '资源列表', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '资源部署结果', 'description' => '资源部署结果', 'type' => 'string', 'example' => 'Finish', ], 'ResourceCode' => [ 'title' => '产品code', 'description' => '产品code', 'type' => 'string', 'example' => 'ecs', ], 'ResourceName' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'ecs', ], 'ResourceId' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'i-2zehnzxqixu1pywsfbx1', ], 'ChargeType' => [ 'title' => '支付类型', 'description' => '支付类型', 'type' => 'string', 'example' => 'PayAsYouGo', ], 'ResourceType' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'ecs', ], 'Remark' => [ 'title' => '部署结果', 'description' => '部署结果', 'type' => 'string', 'example' => '{"hostName":"iZ2zehnzxqixu1pywsfbx1Z","memory":32768.0,"creationTime":"2021-09-28T11:23:46Z","instanceName":"ecs","internetMaxBandwidthOut":0.0,"description":"","clusterId":"","private_ip":"192.168.0.247","instanceId":"i-2zehnzxqixu1pywsfbx1","requestId":"F1C64344-3723-51A0-855B-5F08B5634323","zoneId":"cn-beijing-b","ioOptimized":"optimized","id":"i-2zehnzxqixu1pywsfbx1","instanceNetworkType":"vpc","instanceChargeType":"PostPaid","imageId":"centos_8_4_x64_20G_alibase_20210824.vhd","serialNumber":"cee246c4-38f3-4bf3-950b-c17e88ff6527","vlanId":"","instanceType":"ecs.e3.large","cpu":4.0,"creditSpecification":"","internetMaxBandwidthIn":-1.0,"expiredTime":"2099-12-31T15:59Z","internetChargeType":"PayByTraffic","regionId":"cn-beijing","refId":"79224644_0","stoppedMode":"Not-applicable","status":"Running"}', ], 'Lifecycle' => [ 'title' => '资源标记', 'description' => '资源标记', 'type' => 'string', 'example' => 'Create', ], 'NodeLabel' => [ 'type' => 'string', ], ], ], ], 'Error' => [ 'title' => '失败原因', 'description' => '失败原因', 'type' => 'string', 'example' => 'Success', ], 'DeployPercent' => [ 'title' => '部署进度', 'description' => '部署进度', 'type' => 'number', 'format' => 'double', 'example' => '0.8', ], 'ComplianceList' => [ 'description' => '合规检查结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Rules' => [ 'description' => '检查结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ruleId' => [ 'description' => '规则ID。', 'type' => 'string', 'example' => 'ecs-instances-in-vpc', ], 'ruleDetail' => [ 'description' => '规则名称', 'type' => 'string', ], ], ], ], 'ResourceName' => [ 'description' => '资源名称。', 'type' => 'string', 'example' => 'ecs', ], 'ResourceCode' => [ 'description' => '产品code', 'type' => 'string', 'example' => 'ecs', ], ], ], ], ], ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.nopowerContact', 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', ], [ 'errorCode' => 'bp.java.userNotExist', 'errorMessage' => 'The user does not exist. The current user does not authenticate AliCloud with his real name.', ], [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'The request parameter cannot be empty.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": {\\n \\"Description\\": \\"remark\\",\\n \\"ImageURL\\": \\"https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png\\",\\n \\"ApplicationId\\": \\"VVK605ZH00OA4MRT\\",\\n \\"Name\\": \\"CADT\\",\\n \\"TemplateId\\": \\"FYS9VZ535U20V7HT\\",\\n \\"CreateTime\\": \\"2021-08-09 14:37:16\\",\\n \\"ResourceGroupId\\": \\"rg-aekzhfgmw4e6fwq\\",\\n \\"PriceList\\": [\\n {\\n \\"ResourceCode\\": \\"ecs\\",\\n \\"InstanceName\\": \\"ecs\\",\\n \\"OriginalPrice\\": 3.57,\\n \\"OnePrice\\": 0.01,\\n \\"Period\\": 1,\\n \\"Count\\": 1,\\n \\"PriceUnit\\": \\"200/hour\\",\\n \\"Price\\": 0.01,\\n \\"ChargeType\\": \\"PayAsYouGo\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Specification\\": \\"\\\\\\"slb.s1.small\\\\\\"\\\\n \\\\\\"192.168.0.0/24\\\\\\"\\\\n\\\\\\"ecs.c6.large\\\\\\"\\\\n\\\\\\"normal\\\\\\"\\\\n \\\\\\"\\\\\\"\\",\\n \\"Lifecycle\\": \\"Create\\",\\n \\"Remark\\": \\"ecs Sold Out\\",\\n \\"type\\": \\"1\\"\\n }\\n ],\\n \\"Checklist\\": [\\n {\\n \\"ResourceCode\\": \\"vpc\\",\\n \\"ResourceName\\": \\"vpc\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Result\\": \\"Finish\\",\\n \\"Remark\\": \\"Verification passed\\",\\n \\"Specification\\": \\"192.168.0.0/16\\",\\n \\"Lifecycle\\": \\"Create\\"\\n }\\n ],\\n \\"Status\\": \\"Deployed_Success\\",\\n \\"ResourceList\\": [\\n {\\n \\"Status\\": \\"Finish\\",\\n \\"ResourceCode\\": \\"ecs\\",\\n \\"ResourceName\\": \\"ecs\\",\\n \\"ResourceId\\": \\"i-2zehnzxqixu1pywsfbx1\\",\\n \\"ChargeType\\": \\"PayAsYouGo\\",\\n \\"ResourceType\\": \\"ecs\\",\\n \\"Remark\\": \\"{\\\\\\"hostName\\\\\\":\\\\\\"iZ2zehnzxqixu1pywsfbx1Z\\\\\\",\\\\\\"memory\\\\\\":32768.0,\\\\\\"creationTime\\\\\\":\\\\\\"2021-09-28T11:23:46Z\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"internetMaxBandwidthOut\\\\\\":0.0,\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"\\\\\\",\\\\\\"private_ip\\\\\\":\\\\\\"192.168.0.247\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-2zehnzxqixu1pywsfbx1\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"F1C64344-3723-51A0-855B-5F08B5634323\\\\\\",\\\\\\"zoneId\\\\\\":\\\\\\"cn-beijing-b\\\\\\",\\\\\\"ioOptimized\\\\\\":\\\\\\"optimized\\\\\\",\\\\\\"id\\\\\\":\\\\\\"i-2zehnzxqixu1pywsfbx1\\\\\\",\\\\\\"instanceNetworkType\\\\\\":\\\\\\"vpc\\\\\\",\\\\\\"instanceChargeType\\\\\\":\\\\\\"PostPaid\\\\\\",\\\\\\"imageId\\\\\\":\\\\\\"centos_8_4_x64_20G_alibase_20210824.vhd\\\\\\",\\\\\\"serialNumber\\\\\\":\\\\\\"cee246c4-38f3-4bf3-950b-c17e88ff6527\\\\\\",\\\\\\"vlanId\\\\\\":\\\\\\"\\\\\\",\\\\\\"instanceType\\\\\\":\\\\\\"ecs.e3.large\\\\\\",\\\\\\"cpu\\\\\\":4.0,\\\\\\"creditSpecification\\\\\\":\\\\\\"\\\\\\",\\\\\\"internetMaxBandwidthIn\\\\\\":-1.0,\\\\\\"expiredTime\\\\\\":\\\\\\"2099-12-31T15:59Z\\\\\\",\\\\\\"internetChargeType\\\\\\":\\\\\\"PayByTraffic\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\",\\\\\\"refId\\\\\\":\\\\\\"79224644_0\\\\\\",\\\\\\"stoppedMode\\\\\\":\\\\\\"Not-applicable\\\\\\",\\\\\\"status\\\\\\":\\\\\\"Running\\\\\\"}\\",\\n \\"Lifecycle\\": \\"Create\\",\\n \\"NodeLabel\\": \\"\\"\\n }\\n ],\\n \\"Error\\": \\"Success\\",\\n \\"DeployPercent\\": 0.8,\\n \\"ComplianceList\\": [\\n {\\n \\"Rules\\": [\\n {\\n \\"ruleId\\": \\"ecs-instances-in-vpc\\",\\n \\"ruleDetail\\": \\"\\"\\n }\\n ],\\n \\"ResourceName\\": \\"ecs\\",\\n \\"ResourceCode\\": \\"ecs\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n A07FFDF2-78FA-1B48-9E38-88E833A93187\\n \\n remark\\n https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png\\n VVK605ZH00OA4MRT\\n CADT应用\\n FYS9VZ535U20V7HT\\n 2021-08-09 14:37:16\\n rg-aekzhfgmw4e6fwq\\n \\n ecs\\n ecs\\n 3.57\\n 0.01\\n 1\\n 1\\n 金额/时\\n 0.01\\n PayAsYouGo\\n cn-hangzhou\\n \\"slb.s1.small\\"\\n \\"192.168.0.0/24\\"\\n\\"ecs.c6.large\\"\\n\\"normal\\"\\n \\"\\"\\n Create\\n ecs售罄\\n 1\\n \\n \\n vpc\\n vpc\\n cn-hangzhou\\n Finish\\n 校验通过\\n 192.168.0.0/16\\n Create\\n \\n Deployed_Success\\n \\n Finish\\n ecs\\n ecs\\n i-2zehnzxqixu1pywsfbx1\\n PayAsYouGo\\n ecs\\n {\\"hostName\\":\\"iZ2zehnzxqixu1pywsfbx1Z\\",\\"memory\\":32768.0,\\"creationTime\\":\\"2021-09-28T11:23:46Z\\",\\"instanceName\\":\\"ecs\\",\\"internetMaxBandwidthOut\\":0.0,\\"description\\":\\"\\",\\"clusterId\\":\\"\\",\\"private_ip\\":\\"192.168.0.247\\",\\"instanceId\\":\\"i-2zehnzxqixu1pywsfbx1\\",\\"requestId\\":\\"F1C64344-3723-51A0-855B-5F08B5634323\\",\\"zoneId\\":\\"cn-beijing-b\\",\\"ioOptimized\\":\\"optimized\\",\\"id\\":\\"i-2zehnzxqixu1pywsfbx1\\",\\"instanceNetworkType\\":\\"vpc\\",\\"instanceChargeType\\":\\"PostPaid\\",\\"imageId\\":\\"centos_8_4_x64_20G_alibase_20210824.vhd\\",\\"serialNumber\\":\\"cee246c4-38f3-4bf3-950b-c17e88ff6527\\",\\"vlanId\\":\\"\\",\\"instanceType\\":\\"ecs.e3.large\\",\\"cpu\\":4.0,\\"creditSpecification\\":\\"\\",\\"internetMaxBandwidthIn\\":-1.0,\\"expiredTime\\":\\"2099-12-31T15:59Z\\",\\"internetChargeType\\":\\"PayByTraffic\\",\\"regionId\\":\\"cn-beijing\\",\\"refId\\":\\"79224644_0\\",\\"stoppedMode\\":\\"Not-applicable\\",\\"status\\":\\"Running\\"}\\n Create\\n \\n Success\\n \\n 200\\n","errorExample":""}]', 'title' => '获取应用详情', 'responseParamsDescription' => '应用状态列表：'."\n" .' - Creating 创建中'."\n" .' - Modified 已修改'."\n" .' - Verifying 校验中'."\n" .' - Verified_Failure 校验失败'."\n" .' - Verified_Success 校验成功'."\n" .' - Valuating 计价中'."\n" .' - Valuating_Failure 计价失败'."\n" .' - Valuating_Success 计价成功'."\n" .' - Deploying 部署中'."\n" .' - Deployed_Failure 部署失败'."\n" .' - Partially_Deployed_Success 部分部署成功'."\n" .' - Deployed_Success 部署成功'."\n" .' - Destroying 释放中'."\n" .' - Delayed_Destroy 延时销毁'."\n" .' - Destroyed_Failure 释放失败'."\n" .' - Partially_Destroyed_Success 部分释放成功'."\n" .' - Destroyed_Success 释放成功'."\n" .' - Revised 架构调整'."\n" .' - Verifying_In_Revision 资源验证（架构调整）'."\n" .' - Verified_Failure_In_Revision 资源验证失败（架构调整）'."\n" .' - Verified_Success_In_Revision 资源验证成功（架构调整）'."\n" .' - Valuating_In_Revision 询价中（架构调整）'."\n" .' - Valuating_Failure_In_Revision 询价失败（架构调整）'."\n" .' - Valuating_Success_In_Revision 询价成功（架构调整）', ], 'ListApplication' => [ 'summary' => '该接口提供当前用户下所有应用的列表。其中可选参数keyword定义应用名中包含的关键字。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91667', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => '结果值的分页页码不能小于最小值 1，不能大于最大值 10000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => '结果值的分页大小不能小于最小值 1，也不能大于最大值 50。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => [ 'description' => '应用名称中的关键字', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'OrderType', 'in' => 'formData', 'schema' => [ 'title' => '排序字段', 'description' => '1 更新时间
2 创建时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => [ 'title' => '应用的状态', 'description' => '应用的状态。', 'type' => 'string', 'required' => false, 'example' => 'If the input value is "success", the returned application list includes all applications in the Deployed_Success state of successful deployment.'."\n" .'If the input value is release, the returned application list includes all applications in the release success (Destroyed_Success) and release failure (Destroyed_Failure) status.'."\n" .'If this parameter is left blank, the returned app list includes apps in all states.'."\n" ."\n", ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '资源组的 ID。', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'ResourceId', 'in' => 'formData', 'schema' => [ 'description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxxxxxxxxxx', ], ], [ 'name' => 'TemplateId', 'in' => 'formData', 'schema' => [ 'description' => '模板ID', 'type' => 'string', 'required' => false, 'example' => '0KSXXX6SJU03TXXX', ], ], [ 'name' => 'ShowHide', 'in' => 'formData', 'schema' => [ 'description' => '是否显示隐藏方案,默认为true,true显示,false不显示', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '返回的条目总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '123', ], 'Message' => [ 'description' => '接口返回信息。', 'type' => 'string', 'example' => 'Success', ], 'NextToken' => [ 'description' => '返回的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'RequestId' => [ 'description' => '应用的 ID。', 'type' => 'string', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', ], 'Data' => [ 'description' => '应用列表信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ImageURL' => [ 'title' => '应用的图片链接', 'description' => '应用Topo图的 URL。', 'type' => 'string', 'example' => 'https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png', ], 'Status' => [ 'title' => '应用状态：Modified、Verifying、Verified_Failure、Verified_Success、Valuating、Valuating_Failure、Valuating_Success、Deploying、Deployed_Failure、Partially_Deployed_Success、Deployed_Success、Destroying、Destroyed_Failure、Partially_Destroyed_Success、Destroyed_Success等，详见应用状态说明', 'description' => '应用状态', 'type' => 'string', 'example' => 'Deployed_Success', ], 'ApplicationId' => [ 'title' => '应用ID', 'description' => '应用的名称。', 'type' => 'string', 'example' => 'JIX9NEZUALGS46UI', ], 'Name' => [ 'title' => '应用的名称', 'description' => 'The name of the application.', 'type' => 'string', 'example' => 'cadt-appName', ], 'CreateTime' => [ 'description' => '创建应用的时间。', 'type' => 'string', 'example' => '2021-09-15 08:30:00', ], 'ResourceGroupId' => [ 'title' => '应用的资源组', 'description' => '应用所属的资源组的 ID。', 'type' => 'string', 'example' => 'default', ], ], ], ], 'Code' => [ 'description' => 'HTTP 状态代码。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 123,\\n \\"Message\\": \\"Success\\",\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Data\\": [\\n {\\n \\"ImageURL\\": \\"https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png\\",\\n \\"Status\\": \\"Deployed_Success\\",\\n \\"ApplicationId\\": \\"JIX9NEZUALGS46UI\\",\\n \\"Name\\": \\"cadt-appName\\",\\n \\"CreateTime\\": \\"2021-09-15 08:30:00\\",\\n \\"ResourceGroupId\\": \\"default\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '获取应用列表', 'responseParamsDescription' => '应用状态列表：'."\n" ."\n" .'Creating 创建中
'."\n" .'Modified 已修改
'."\n" .'Verifying 校验中
'."\n" .'Verified_Failure 校验失败
'."\n" .'Verified_Success 校验成功
'."\n" .'Valuating 计价中
'."\n" .'Valuating_Failure 计价失败
'."\n" .'Valuating_Success 计价成功
'."\n" .'Deploying 部署中
'."\n" .'Deployed_Failure 部署失败
'."\n" .'Partially_Deployed_Success 部分部署成功
'."\n" .'Deployed_Success 部署成功
'."\n" .'Destroying 释放中
'."\n" .'Delayed_Destroy 延时销毁
'."\n" .'Destroyed_Failure 释放失败
'."\n" .'Partially_Destroyed_Success 部分释放成功
'."\n" .'Destroyed_Success 释放成功
'."\n" .'Revised 架构调整
'."\n" .'Verifying_In_Revision 资源验证（架构调整）
'."\n" .'Verified_Failure_In_Revision 资源验证失败（架构调整）
'."\n" .'Verified_Success_In_Revision 资源验证成功（架构调整）
'."\n" .'Valuating_In_Revision 询价中（架构调整）
'."\n" .'Valuating_Failure_In_Revision 询价失败（架构调整）
'."\n" .'Valuating_Success_In_Revision 询价成功（架构调整）
', ], 'DeployApplication' => [ 'summary' => '计费成功后，创建资源。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '91660', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'VVK605ZH00OA4MRT', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'example' => '1600765710019', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '应用数据', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": 123,\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n A07FFDF2-78FA-1B48-9E38-88E833A93187\\n 123\\n 200\\n","errorExample":""}]', 'title' => '部署应用', ], 'ReleaseApplication' => [ 'summary' => '该接口释放应用的资源。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '91662', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => '7QSXFQW46ZNGOUDM', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '资源ID', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'example' => '1600765710019', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误消息', 'type' => 'string', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', ], 'Data' => [ 'description' => '返回值', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Code' => [ 'description' => 'HTTP返回code', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Data\\": 1,\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 应用ID错误\\n BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\n 1\\n 200\\n","errorExample":""}]', 'title' => '释放应用', ], 'ValidateApplication' => [ 'summary' => '对应用下的资源输入的合法性进行校验，异步执行，校验结果调用GetApplication获取。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91658', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '02S7UU41WKJL7ERR', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'example' => '1600765710019', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '应用数据', 'type' => 'string', 'example' => '123', ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'The request parameter cannot be empty.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": \\"123\\",\\n \\"Code\\": 200\\n}","type":"json"}]', 'title' => '应用校验', ], 'ValuateApplication' => [ 'summary' => '对应用下的资源进行询价，通过GetApplication获取询价结果。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '91659', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => true, 'example' => '02S7UU41WKJL7ERR', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'example' => '1600765710019', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误码', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Data' => [ 'description' => '应用数据', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'format' => 'int32', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 200 => [ [ 'errorCode' => 'Success', 'errorMessage' => 'The transaction is successful.', ], ], 400 => [ [ 'errorCode' => 'ParameterEmpty', 'errorMessage' => 'You must specify the request parameter.', ], ], 404 => [ [ 'errorCode' => 'EntityNotExist.ResourceGroup', 'errorMessage' => 'The resource group does not exist.', ], [ 'errorCode' => 'EntityNotExist.ResourceId', 'errorMessage' => 'The resource does not exist.', ], ], 500 => [ [ 'errorCode' => 'ServiceError', 'errorMessage' => 'A server error occurred. Please try again later.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Data\\": 123,\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n A07FFDF2-78FA-1B48-9E38-88E833A93187\\n 123\\n 200\\n","errorExample":""}]', 'title' => '应用计费', ], 'GetResource4ModifyRecord' => [ 'summary' => '获取询价应用变配记录。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbpstudioDXU2R7', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID，用于资源组相关权限校验', 'description' => '应用id', 'type' => 'string', 'required' => true, 'example' => 'BE68D71ZY5YYIU9R', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'description' => '下页页码', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => [ 'description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Message' => [ 'description' => '报错信息', 'type' => 'string', 'example' => 'Success', ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '变更记录'."\n" .'>变配会使CADT应用进入部署状态，请在CADT应用部署完成后进行查询变配结果>', 'type' => 'array', 'items' => [ 'description' => '变更记录', 'type' => 'object', 'properties' => [ 'ResourceId' => [ 'description' => '资源 ID', 'type' => 'string', 'example' => 'rm-uf6308dyal1*****', ], 'Type' => [ 'description' => '资源类型', 'type' => 'string', 'example' => 'rds', ], 'Status' => [ 'description' => '变更状态', 'type' => 'string', 'enumValueTitles' => [ 'Init' => 'Init', 'Finish' => 'Finish', 'Fail' => 'Fail', 'Processing' => 'Processing', ], 'example' => 'Finish', ], 'ModifyTime' => [ 'description' => '修改时间。', 'type' => 'string', 'example' => '2024-10-15 19:09:25', ], 'Attribute' => [ 'description' => '资源详细信息', 'type' => 'string', 'example' => '{'."\n" .' "InstanceId": "",'."\n" .' "AttributeName": "drmCommand",'."\n" .' "Id": 16800,'."\n" .' "Desc": "test"'."\n" .'}', ], 'Error' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Postpaid.NotSupport : The charge type does not support for postpaid.'."\n" .'RequestId : A0XXXDF2-78FA-1B48-9XX8-88E833A93XXX', ], ], ], ], 'TotalCount' => [ 'description' => '总记录数', 'type' => 'string', 'example' => '123', ], 'NextToken' => [ 'description' => '下一个查询开始Token', 'type' => 'string', 'example' => '2', ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '{'."\n" .' "PolicyType": "",'."\n" .' "AuthPrincipalOwnerId": "",'."\n" .' "EncodedDiagnosticMessage": "",'."\n" .' "AuthPrincipalType": "",'."\n" .' "AuthPrincipalDisplayName": "",'."\n" .' "NoPermissionType": "",'."\n" .' "AuthAction": ""'."\n" .' }', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'bp.java.nopowerContact', 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', ], [ 'errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ResourceId\\": \\"rm-uf6308dyal1*****\\",\\n \\"Type\\": \\"rds\\",\\n \\"Status\\": \\"Finish\\",\\n \\"ModifyTime\\": \\"2024-10-15 19:09:25\\",\\n \\"Attribute\\": \\"{\\\\n \\\\\\"InstanceId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AttributeName\\\\\\": \\\\\\"drmCommand\\\\\\",\\\\n \\\\\\"Id\\\\\\": 16800,\\\\n \\\\\\"Desc\\\\\\": \\\\\\"test\\\\\\"\\\\n}\\",\\n \\"Error\\": \\"Postpaid.NotSupport : The charge type does not support for postpaid.\\\\nRequestId : A0XXXDF2-78FA-1B48-9XX8-88E833A93XXX\\"\\n }\\n ],\\n \\"TotalCount\\": \\"123\\",\\n \\"NextToken\\": \\"2\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', 'title' => '获取应用变配记录', ], 'GetResult4QueryInstancePrice4Modify' => [ 'summary' => '获取询价结果。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbpstudioDXU2R7', ], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'title' => '操作ID', 'description' => '变配询价任务id（有效时间为1小时，超时后无法查询到结果并且返回参数没有Data这一属性）', 'type' => 'string', 'required' => true, 'example' => 'price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC', ], ], [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID，用于资源组相关权限校验', 'description' => '应用ID', 'type' => 'string', 'required' => false, 'example' => '02S7UU41WKJL7ERR', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Code' => [ 'description' => '响应码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '变配询价结果', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => 'd9a3e99b-6954-4a16-ad51-954db4a528b7', ], 'Status' => [ 'description' => '应用状态', 'type' => 'string', 'example' => 'SUCCESS', ], 'PriceList' => [ 'description' => '计费结果列表
'."\n" .'（实例如果为按量付费实例，返回三个价格。如果为包年包月实例，查询变配价格时传递了period_unit，period两个Configuration将会返回三个价格；'."\n" .'如果不传递period_unit，period将只返回变配后应该支付金额）
'."\n" .'三个价格（按顺序）：
'."\n" .'- 变配后应该支付金额(按量付费时，等于新规格价格。 包年包月时，为升配后剩余实例时间需要补交的金额，如一个月的实例，用了半个月时升配，剩下半个月的时间需要补交的金额)（包年包月时，随着实例剩余时间不断变少，此金额在不断变化，QueryInstancePrice4Modify时间不同，金额也会有差异。）
'."\n" .'- 原规格价格
'."\n" .'- 新规格价格 （包年包月时，为完整时间周期，如一个月的价格）
', 'type' => 'array', 'items' => [ 'description' => '计费结果列表', 'type' => 'object', 'properties' => [ 'NodeType' => [ 'description' => '产品 code', 'type' => 'string', 'example' => 'vpc', ], 'TradeAmount' => [ 'description' => '最终价，为原价减去折扣金额。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'DiscountAmount' => [ 'description' => '减免金额', 'type' => 'number', 'format' => 'double', 'example' => '2', ], 'OriginalAmount' => [ 'description' => '原价', 'type' => 'number', 'format' => 'double', 'example' => '3', ], 'PriceUnit' => [ 'description' => '单位：金额/时', 'type' => 'string', 'example' => '200/hour', ], 'PromotionName' => [ 'description' => '优惠信息', 'type' => 'string', 'example' => 'Offer Information', ], 'Error' => [ 'description' => '失败原因', 'type' => 'string', 'example' => 'Get information on price failures', ], ], ], ], ], ], 'AccessDeniedDetail' => [ 'description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{'."\n" .' "PolicyType": "",'."\n" .' "AuthPrincipalOwnerId": "",'."\n" .' "EncodedDiagnosticMessage": "",'."\n" .' "AuthPrincipalType": "",'."\n" .' "AuthPrincipalDisplayName": "",'."\n" .' "NoPermissionType": "",'."\n" .' "AuthAction": ""'."\n" .' }', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"d9a3e99b-6954-4a16-ad51-954db4a528b7\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"PriceList\\": [\\n {\\n \\"NodeType\\": \\"vpc\\",\\n \\"TradeAmount\\": 1,\\n \\"DiscountAmount\\": 2,\\n \\"OriginalAmount\\": 3,\\n \\"PriceUnit\\": \\"200/hour\\",\\n \\"PromotionName\\": \\"Offer Information\\",\\n \\"Error\\": \\"Get information on price failures\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', 'title' => '获取询价结果', ], 'ModifyApplicationSpec' => [ 'summary' => '提交应用变配。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230209', 'abilityTreeNodes' => [ 'FEATUREbpstudioRJ9IF1', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '02S7UU41WKJL7ERR', ], ], [ 'name' => 'InstanceSpec', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '变配规格', 'type' => 'array', 'items' => [ 'description' => '变配参数', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'description' => '变配资源id', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8f4ah378a*****', ], 'Configuration' => [ 'description' => '变配参数', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'example' => 'orderType:UPGRADE', 'description' => '变配入参'."\n" .'> '."\n" .'> - 预付费 升级配置：UPGRADE，降级配置：DOWNGRADE。后付费升降配都是UPGRADE ，为改变配置，不区分升降配'."\n" ."\n" .'ecs
'."\n" .'- orderType:UPGRADE
'."\n" .'- instance_type:xxx （实例规格）
'."\n" ."\n" .'rds （可同时改变实例规格和容量）
'."\n" .'- orderType:UPGRADE
'."\n" .'- instance_type:xxx （实例规格）
'."\n" .'- instance_storage:xxx （容量）
'."\n" ."\n" .'kvstore
'."\n" .'- orderType:UPGRADE
'."\n" .'- number:1 （分片数）
'."\n" .'- instance_class:xxx （实例规格）'."\n" ."\n" .'kvstore_prepaid_public_cn
'."\n" .'- orderType:UPGRADE
'."\n" .'- shard_quantity:4 （分片数）
'."\n" .'- shard_class: xxx （分片规格）
'."\n" .'- storage: 10 （磁盘容量）
'."\n" ."\n" .'tair
'."\n" .'- orderType:UPGRADE
'."\n" .'- shard_quantity:4 （分片数）
'."\n" .'- shard_class: xxxx （分片规格）
'."\n" ."\n\n" .'kafka
'."\n" .'- orderType:UPGRADE
'."\n" .'- eip_max(公网流量):
'."\n" .'- IO_max(公网流量):
'."\n" .'- partition_num:分区数
'."\n" .'- disk_size(磁盘容量):
'."\n" ."\n" .'polardb
'."\n" .'- orderType:UPGRADE
'."\n" .'- master_spec(节点规格):
'."\n" ."\n" .'elasticsearch
'."\n" .'- orderType:UPGRADE
'."\n" .'- node_spec(数据节点规格):'."\n" .'- kibana_node_spec(Kibana节点规格):'."\n" .'- master_spec(专有主节点规格)'."\n" .'- warm_node_spec(冷数据节点规格):'."\n" .'- client_node_spec(协调节点规格):'."\n" .'- elastic_node_spec(弹性数据节点):'."\n" ."\n" .'hitsdb_lindormnext_v2
'."\n" .'- orderType:UPGRADE
'."\n" .'- upgrade_type:`SPEC(规格)、OPEN(开通)、COUNT(节点数量)`'."\n" .'- engine_type(引擎类型):`TABLE(宽表引擎),TSDB(时序引擎),LSEARCH(搜索引擎),LTS(LTS引擎),LVECTOR(向量引擎),LCOLUMN(列存引擎)`'."\n" .'- node_type(节点类型):`universal(通用型),calculated(计算型),mem_enhanced(内存型),local_hdd_pro(本地 HDD),local_ssd_pro(本地 SSD)`'."\n" .'- node_spec(节点规格):'."\n" .'- core_num(节点数量):'."\n" .'- is_cloud_disk(是否挂载云盘):true、false'."\n" .'- disk_type(挂载云盘类型):cloud_efficiency，cloud_essd'."\n" .'- disk_size(挂载云盘存储容量):'."\n" .'
'."\n" ."\n" .'slb
'."\n" ."\n" .'> 实例计费方取值(InstanceChargeType)：PayBySpec(按规格计费)、PayByCLCU(按使用量计费)，
'."\n" .'>公网流量费(internet_charge_type):0(按固定带宽计费) 1(按使用流量计费)，
'."\n" .'>当InstanceChargeType为PayBySpec时specification必填，
'."\n" .'>当internet_charge_type=0时bandwidth必填。
'."\n" ."\n" .'- orderType:UPGRADE
'."\n" .'- specification(实例规格):'."\n" .'- InstanceChargeType(实例计费方式):
'."\n" .'- internet_charge_type(公网流量费):'."\n" .'- bandwidth(带宽值):'."\n" ."\n\n" .'hbase
'."\n" .'- orderType:UPGRADE
'."\n" .'- core_instance_type(core规格):'."\n" ."\n" .'dds
'."\n" .'- orderType:UPGRADE
'."\n" .'- db_instance_class(规格):'."\n" ."\n" .'onspre
'."\n" ."\n\n" .'

'."\n" .'

企业铂金版规格的升降配

'."\n" ."\n" .'- orderType:UPGRADE
'."\n" .'- tps_max(TPS峰值):'."\n" .'- topic_capacity(Topic数上限):'."\n" .'- message_capacity(消息存储空间):'."\n" ."\n" .'

'."\n" .'

'."\n" .'

标准升级铂金版本

'."\n" .'- orderType:BUY
'."\n" .'- tps_max(TPS峰值):'."\n" .'- topic_capacity(Topic数上限):'."\n" .'- message_capacity(消息存储空间):'."\n" .'- period_unit(购买单位):Month、Year'."\n" .'- period(购买时长):'."\n" .'

'."\n" ."\n" .'hitsdb_lindorm
'."\n" .'- orderType:UPGRADE
'."\n" .'- lindorm_core_spec(宽表节点规格):'."\n" ."\n" .'drds
'."\n" .'- orderType:UPGRADE
'."\n" .'- drds_instance_spec(实例规格):'."\n" ."\n" .'clickhouse
'."\n" .'企业版变配:'."\n" ."\n" .'- max_ccu(计算单元（CCU） 最大值):'."\n" .'- mini_ccu(计算单元（CCU）最小值):'."\n" ."\n" .'社区实例:
'."\n" .'水平变配：'."\n" ."\n" .'- 节点数量(node_count)：'."\n" ."\n" .'垂直变配:'."\n" ."\n" .'- zkSize(Zookeeper规格):'."\n" .'- instance_class(规格):'."\n" .'- storage_type(存储类型):'."\n" .'- storage_size(存储空间):'."\n" ."\n" .'drds_polarx
'."\n" .'标准版：'."\n" ."\n" .'- node_spec(节点规格):'."\n" ."\n" .'企业版:'."\n" ."\n" .'- cn_node_spec(计算节点规格):'."\n" .'- dn_node_spec(存储节点规格):'."\n" .'- dn_storage_space(存储节点磁盘):'."\n" ."\n" .'opensearch'."\n" ."\n" .'- buytype(集群偏好):'."\n" .'- storage(存储容量):'."\n" .'- compute(计算资源):'."\n" ."\n" .'eip'."\n" ."\n" .'- bandwidths(带宽峰值):'."\n" .'- internet_charge_type(流量):'."\n" .'- bandwidth(带宽):'."\n" ."\n" .'adb'."\n" .'- reserved_node_size(预留资源单节点规格): '."\n" .'- reserved_node_count(预留资源节点数):'."\n" .'- Activate_AI_node(开启AI节点):'."\n" .'- ADB_AI_Node_Size(AI节点规格):'."\n" .'- AI_Node_Count_Postpaid(AI节点数量):'."\n" .'- Deployment_Method(部署模式):'."\n" .'- zone_id(主可用区);'."\n" .'- vswitch_id(主可用区交换机):'."\n" .'- StandbyAZ(备可用区):'."\n" .'- Standby_vswitch_id(备可用区交换机):'."\n" ."\n" .'hologres'."\n" .'- size(计算资源):'."\n" .'- GatewayNum(Gateway节点数量):'."\n" .'- warehouse_cu(计算组预留计算资源):'."\n" .'- enable_serverless_computing(开启Serverless Computing):'."\n" ."\n" .'flink'."\n" .'- max_cu(配额上限):'."\n" .'- min_cu(单可用区计算资源配额):'."\n" .'- min_cu_ha(跨可用区):'."\n" ."\n" .'dts'."\n" .'- instance_class(数据同步变配):'."\n" .'- migration_instance_class(数据迁移变配):'."\n" ."\n" .'hitsdb_lts'."\n" .'- upgrade_type:upgrade-lts-core-num'."\n" .'- core_number(节点数量):'."\n" .'- upgrade_type:upgrade-lts-engine'."\n" .'- core_spec(节点规格):'."\n" ."\n" .'ons_rmq'."\n" .'- msg_process_spec(消息收发计算规格):'."\n" .'- series_type(主系列类型):', ], ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Success' => [ 'title' => 'Id of the request', 'description' => '是否成功', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '报错信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '返回值', 'type' => 'string', 'example' => '-1', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562', ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '{'."\n" .' "PolicyType": "",'."\n" .' "AuthPrincipalOwnerId": "",'."\n" .' "EncodedDiagnosticMessage": "",'."\n" .' "AuthPrincipalType": "",'."\n" .' "AuthPrincipalDisplayName": "",'."\n" .' "NoPermissionType": "",'."\n" .' "AuthAction": ""'."\n" .' }', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'bp.java.8004', 'errorMessage' => 'No permissions.', ], [ 'errorCode' => 'bp.java.nopowerContact', 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', ], [ 'errorCode' => 'bp.java.nopower', 'errorMessage' => 'No permissions.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"-1\\",\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', 'title' => '提交应用变配', ], 'QueryInstancePrice4Modify' => [ 'summary' => '查询变配价格。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '230186', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLQBYK', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '002XWH7MXB8MJRU0', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '变配资源id', 'type' => 'string', 'required' => true, 'example' => 'rm-uf66k9143r2ch*****', ], ], [ 'name' => 'Configuration', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '目标配置列表', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '目标配置参数
'."\n" .'> '."\n" .'> - 预付费升级配置：UPGRADE，降级配置：DOWNGRADE。后付费升降配都是UPGRADE ，为改变配置，不区分升降配'."\n" .'> - 包年包月可选参数。period_unit：价格单位，可选值Month、Week、Year。 period ：价格周期 ，传入1， 则返回1单位时间的价格。'."\n" ."\n" .'ecs
'."\n" .'- orderType:UPGRADE
'."\n" .'- instance_type:xxx （实例规格）
'."\n" ."\n" .'rds（可同时改变实例规格和容量）
'."\n" .'- orderType:UPGRADE
'."\n" .'- instance_type:xxx （实例规格）
'."\n" .'- instance_storage:xxx （容量）
'."\n" ."\n" .'kvstore
'."\n" .'- orderType:UPGRADE
'."\n" .'- number:1 （分片数）
'."\n" .'- instance_class:xxx （实例规格）'."\n" ."\n" .'kvstore_prepaid_public_cn
'."\n" .'- orderType:UPGRADE
'."\n" .'- shard_quantity:4 （分片数）
'."\n" .'- shard_class: xxx （分片规格）
'."\n" .'- storage: 10 （磁盘容量）
'."\n" ."\n" .'tair
'."\n" .'- orderType:UPGRADE
'."\n" .'- shard_quantity:4 （分片数）
'."\n" .'- shard_class: xxxx （分片规格）
'."\n" ."\n" .'kafka
'."\n" .'- orderType:UPGRADE
'."\n" .'- eip_max(公网流量):
'."\n" .'- IO_max(公网流量):
'."\n" .'- partition_num:分区数
'."\n" .'- disk_size(磁盘容量):
'."\n" ."\n" .'polardb
'."\n" .'- orderType:UPGRADE
'."\n" .'- master_spec(节点规格):
'."\n" ."\n" .'elasticsearch
'."\n" .'- orderType:UPGRADE
'."\n" .'- node_spec(数据节点规格):'."\n" .'- kibana_node_spec(Kibana节点规格):'."\n" .'- master_spec(专有主节点规格)'."\n" .'- warm_node_spec(冷数据节点规格):'."\n" .'- client_node_spec(协调节点规格):'."\n" .'- elastic_node_spec(弹性数据节点):'."\n" ."\n\n" .'hitsdb_lindormnext
'."\n" ."\n" .'> '."\n" .'> - 支持添加引擎，下边列出开通每种引擎需要的参数
'."\n" .'> - 支持变配规格，只需要输入对应引擎节点规格'."\n" .'> - 支持变配节点数量，只需要输入节点数量'."\n" .'> - 支持变配云盘存储容量，只需要输入云盘存储容量'."\n" .'> - 以上变配一次只能进行一种，变配成功后在进行后续'."\n" .'- orderType:UPGRADE
'."\n" ."\n\n" .'

'."\n" .'

生产型变配

'."\n" .'添加搜索引擎
'."\n" ."\n" .'- basic_search_engine(添加搜索引擎):true'."\n" .'- basic_search_type(节点类型): '."\n" .'- basic_search_node_spec(节点规格): '."\n" .'- basic_search_core_num(节点数量):'."\n" .'- basic_search_cloud_disk(是否挂载云盘):true'."\n" .'- basic_search_disk_type(挂载云盘类型):'."\n" .'- basic_search_disk_size(挂载云盘存储容量):'."\n" ."\n" .'添加向量引擎'."\n" .'- basic_vector_engine(添加向量引擎):true'."\n" .'- basic_vector_type(节点类型):'."\n" .'- basic_vector_node_spec(节点规格):'."\n" .'- basic_vector_core_num(节点数量):'."\n" .'- basic_vector_cloud_disk(是否挂载云盘):true'."\n" .'- basic_vector_disk_type(挂载云盘类型):'."\n" .'- basic_vector_disk_size(挂载云盘存储容量):'."\n" ."\n" .'添加宽表引擎'."\n" .'- basic_wide_table_engine(添加宽表引擎):'."\n" .'- basic_wide_table_type(节点类型):'."\n" .'- basic_wide_table_node_spec(节点规格): '."\n" .'- basic_wide_table_core_num(节点数量): '."\n" .'- basic_wide_table_cloud_disk(是否挂载云盘): '."\n" .'- basic_wide_table_disk_type(挂载云盘类型):'."\n" .'- basic_wide_table_disk_size(挂载云盘存储容量):'."\n" .'

'."\n" ."\n" .'

'."\n" .'

测试型变配

'."\n" .'添加时序引擎'."\n" .'- timing_engine(添加时序引擎):true'."\n" .'- timing_node_spec(节点规格):'."\n" .'- timing_core_num(节点数量):'."\n" .'- timing_cloud_disk(是否挂载云盘): '."\n" .'- timing_disk_type(挂载云盘类型):'."\n" .'- timing_disk_size(挂载云盘存储容量):'."\n" ."\n" .'添加搜索引擎'."\n" .'- search_engine(添加搜索引擎):'."\n" .'- search_node_spec(节点规格): '."\n" .'- search_core_num(节点数量):'."\n" .'- search_cloud_disk(是否挂载云盘):'."\n" .'- search_disk_type(挂载云盘类型):'."\n" .'- search_disk_size(挂载云盘存储容量):'."\n" ."\n" .'添加LTL引擎'."\n" .'- lts_engine(添加LTL引擎):true'."\n" .'- lts_node_spec(节点规格):'."\n" .'- lts_core_num(节点数量):'."\n" .'- lts_cloud_disk(是否挂载云盘):true'."\n" .'- lts_disk_type(挂载云盘类型):'."\n" .'- lts_disk_size(挂载云盘存储容量):'."\n" ."\n" .'添加向量引擎'."\n" .'- vector_engine(添加向量引擎):'."\n" .'- vector_node_spec(节点规格): '."\n" .'- vector_core_num(节点数量):'."\n" .'- vector_cloud_disk(是否挂载云盘):'."\n" .'- vector_disk_type(挂载云盘类型):'."\n" .'- vector_disk_size(挂载云盘存储容量):'."\n" .'

'."\n" ."\n" .'slb
'."\n" ."\n" .'> 实例计费方取值(InstanceChargeType)：PayBySpec(按规格计费)、PayByCLCU(按使用量计费)，
'."\n" .'>公网流量费(internet_charge_type):0(按固定带宽计费) 1(按使用流量计费)，
'."\n" .'>当InstanceChargeType为PayBySpec时specification必填，
'."\n" .'>当internet_charge_type=0时bandwidth必填。
'."\n" ."\n" .'- orderType:UPGRADE
'."\n" .'- specification(实例规格):'."\n" .'- InstanceChargeType(实例计费方式):
'."\n" .'- internet_charge_type(公网流量费):'."\n" .'- bandwidth(带宽值):'."\n" ."\n\n" .'hbase
'."\n" .'- orderType:UPGRADE
'."\n" .'- core_instance_type(core规格):'."\n" ."\n" .'dds
'."\n" .'- orderType:UPGRADE
'."\n" .'- db_instance_class(规格):'."\n" ."\n" .'onspre
'."\n" ."\n\n" .'

'."\n" .'

企业铂金版规格的升降配

'."\n" ."\n" .'- orderType:UPGRADE
'."\n" .'- tps_max(TPS峰值):'."\n" .'- topic_capacity(Topic数上限):'."\n" .'- message_capacity(消息存储空间):'."\n" ."\n" .'

'."\n" .'

'."\n" .'

标准升级铂金版本

'."\n" ."\n" .'- orderType:BUY
'."\n" .'- tps_max(TPS峰值):'."\n" .'- topic_capacity(Topic数上限):'."\n" .'- message_capacity(消息存储空间):'."\n" .'- period_unit(购买单位):Month、Year'."\n" .'- period(购买时长):'."\n" ."\n" .'

'."\n" ."\n" .'hitsdb_lindorm
'."\n" .'- orderType:UPGRADE
'."\n" .'- lindorm_core_spec(宽表节点规格):'."\n" ."\n" .'drds
'."\n" .'- orderType:UPGRADE
'."\n" .'- drds_instance_spec(实例规格):'."\n" ."\n" .'clickhouse
'."\n" .'企业版变配:'."\n" ."\n" .'- max_ccu(计算单元（CCU） 最大值):'."\n" .'- mini_ccu(计算单元（CCU）最小值):'."\n" ."\n" .'社区实例:
'."\n" .'水平变配：'."\n" ."\n" .'- 节点数量(node_count)：'."\n" ."\n" .'垂直变配:'."\n" ."\n" .'- zkSize(Zookeeper规格):'."\n" .'- instance_class(规格):'."\n" .'- storage_type(存储类型):'."\n" .'- storage_size(存储空间):'."\n" ."\n" .'drds_polarx
'."\n" .'标准版：'."\n" ."\n" .'- node_spec(节点规格):'."\n" ."\n" .'企业版:'."\n" ."\n" .'- cn_node_spec(计算节点规格):'."\n" .'- dn_node_spec(存储节点规格):'."\n" .'- dn_storage_space(存储节点磁盘):'."\n" ."\n" .'opensearch'."\n" ."\n" .'- buytype(集群偏好):'."\n" .'- storage(存储容量):'."\n" .'- compute(计算资源):', 'example' => 'orderType:UPGRADE', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '应用的 ID。', 'type' => 'string', 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1', ], 'Success' => [ 'description' => '是否成功', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => 'TaskId, 可通过GetResult4QueryInstancePrice4Modify这个api查询询价结果。（有效时间为1小时）', 'type' => 'string', 'example' => 'price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC', ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => '{'."\n" .' "PolicyType": "",'."\n" .' "AuthPrincipalOwnerId": "",'."\n" .' "EncodedDiagnosticMessage": "",'."\n" .' "AuthPrincipalType": "",'."\n" .' "AuthPrincipalDisplayName": "",'."\n" .' "NoPermissionType": "",'."\n" .' "AuthAction": ""'."\n" .' }', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"price4modify/19862074****/rm-uf69xr871l***fj39/WQ9ULO4SLD**PQY5/FL1IZLW**3H78OC\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', 'title' => '查询变配价格', ], 'QueryInstanceSpec4Modify' => [ 'summary' => '查询变配规格列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbpstudioDXU2R7', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'description' => '云速搭应用ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BE68D71ZY5YYIU9R', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '变配资源id', 'type' => 'string', 'required' => true, 'example' => 'rm-uf66k9143r2ch*****', ], ], [ 'name' => 'MethodName', 'in' => 'formData', 'schema' => [ 'description' => '对应产品API名'."\n" ."\n" .'- ecs查询规格请输入:describeResourcesModification'."\n" .'- rds查询规格请输入:listAvailableClasses'."\n" .'- kvstore查询规格请输入:getKvstoreInstanceClass'."\n" .'- kvstore查询分片数量请输入:getKvstoreShardNum'."\n" .'- kvstore_prepaid_public_cn查询规格请输入:getShardClass'."\n" .'- kvstore_prepaid_public_cn查询磁盘容量请输入:getStorage'."\n" .'- kvstore_prepaid_public_cn查询分片数量请输入:getShardQuantity'."\n" .'- tair查询规格请输入:getShardClass'."\n" .'- tair查询分片数量请输入:getShardQuantity'."\n" .'- kafka查询公网流量:getEipMax'."\n" .'- kafka查询流量规格:getIoMax'."\n" .'- kafka查询分区数:getPartitionNum'."\n" .'- kafka查询磁盘容量:getDiskSize'."\n" .'- polardb查询节点规格:getMasterSpec'."\n" .'- elasticsearch查询数据节点规格:getNodeSpec'."\n" .'- elasticsearch查询Kibana节点规格:getKibanaNodeSpecList'."\n" .'- elasticsearch查询专有主节点规格:getMasterSpecList'."\n" .'- elasticsearch查询冷数据节点规格:getWarmNodeSpecList'."\n" .'- elasticsearch查询协调节点规格:getClientNodeSpecList'."\n" .'- elasticsearch查询弹性数据节点规格:getElasticNodeSpecList'."\n" .'- hitsdb_lindormnext查询测试型时序引擎、搜索引擎、LTL引擎、向量引擎规格：getLightNodeSpec'."\n" .'- hitsdb_lindormnext查询生产型搜索引擎规格:getBasicSearchNodeSpec'."\n" .'- hitsdb_lindormnext查询生产型向量引擎规格:getBasicVectorNodeSpec'."\n" .'- hitsdb_lindormnext查询生产型宽表引擎规格:getBasicWideTableNodeSpec'."\n" ."\n" .'- slb查询实例规格:getSlbLoadBalancerSpec'."\n" .'- hbase查询规格:getHbaseCoreSpec'."\n" .'- dds查询规格:getDdsClass'."\n" .'- onspre查询TPS峰值:getOnsPreTpsMax'."\n" .'- onspre查询Topic数上限:getOnsPreTopicCapacity'."\n" .'- onspre查询消息存储空间:getOnsPreMessageCapacity'."\n" .'- hitsdb_lindorm查询宽表规格:getHitsdbLindormCoreSpec'."\n" .'- drds查询实例规格:getDrdsInstanceSpec'."\n" .'- clickhouse(计算单元（CCU） 最大值):getClickHouseMaxCcu'."\n" .'- clickhouse(计算单元（CCU）最小值):getClickHouseMinCcu'."\n" .'- clickhouse(Zookeeper 规格): getClickHouseZkSize'."\n" .'- clickhouse(规格):getClickHouseInstanceClass'."\n" .'- clickhouse(存储类型):getClickHouseStorageType'."\n" .'- clickhouse(存储空间): getClickHouseStorageSize'."\n" .'- drds_polarx(node_spec节点规格): getDrdsPolarxNodeSpec'."\n" .'- drds_polarx(cn_node_spec计算节点规格): getDrdsPolarxCnNodeSpec'."\n" .'- drds_polarx(dn_node_spec存储节点规格):getDrdsPolarxDnNodeSpec'."\n" .'- drds_polarx(dn_storage_space存储节点磁盘): getDrdsPolarxDnStorageSpace'."\n" ."\n" .'- opensearch(buytype集群偏好):getOpenSearchBuyType'."\n" .'- opensearch(storage存储容量):getOpenSearchStorage'."\n" .'- opensearch(compute计算资源):getOpenSearchCompute', 'type' => 'string', 'required' => false, 'example' => 'describeResourcesModification', ], ], [ 'name' => 'Parameters', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '规格约束条件', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '参数
'."\n" .'> '."\n" .'> - 预付费 升级配置：UPGRADE，降级配置：DOWNGRADE。后付费升降配都是UPGRADE ，为改变配置，不区分升降配'."\n" ."\n" .'查询ecs变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询rds变配规格
'."\n" .'- orderType:UPGRADE'."\n" ."\n" .'查询kvstore变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询kvstore_prepaid_public_cn变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询kvstore_prepaid_public_cn变配规格对应的磁盘容量
'."\n" .'- orderType:UPGRADE
'."\n" .'- shard_class:xxx
'."\n" ."\n" .'查询tair变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询hitsdb_lindormnext变配属性
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询slb变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n\n" .'查询hbase变配core规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询dds变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询onspre企业铂金版规格的升降配
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询onspre标准升级铂金版本
'."\n" .'- orderType:BUY
'."\n" ."\n" .'查询hitsdb_lindorm变配规格
'."\n" .'- orderType:UPGRADE
'."\n" ."\n" .'查询drds变配规格
'."\n" .'- orderType:UPGRADE
', 'example' => 'orderType:UPGRADE', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '查询结果', 'type' => 'object', 'properties' => [ 'OptionalValues' => [ 'description' => '可选变配规格列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Label' => [ 'description' => '规格名称', 'type' => 'string', 'example' => '1 GB', ], 'Value' => [ 'description' => '规格值', 'type' => 'string', 'example' => 'redis.shard.small.2.ce', ], 'Min' => [ 'description' => '最小值，查询redis分片数量有效', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'Max' => [ 'description' => '最大值，查询redis分片数量有效', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'Step' => [ 'description' => '步长，查询redis分片数量有效', 'type' => 'number', 'format' => 'double', 'example' => '1', ], ], ], ], ], ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '{'."\n" .' "PolicyType": "",'."\n" .' "AuthPrincipalOwnerId": "",'."\n" .' "EncodedDiagnosticMessage": "",'."\n" .' "AuthPrincipalType": "",'."\n" .' "AuthPrincipalDisplayName": "",'."\n" .' "NoPermissionType": "",'."\n" .' "AuthAction": ""'."\n" .' }', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"OptionalValues\\": [\\n {\\n \\"Label\\": \\"1 GB\\",\\n \\"Value\\": \\"redis.shard.small.2.ce\\",\\n \\"Min\\": 1,\\n \\"Max\\": 1,\\n \\"Step\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"847C9D0A-BABD-589C-8A9C-6464409EDED9\\",\\n \\"AccessDeniedDetail\\": \\"{\\\\n \\\\\\"PolicyType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalOwnerId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"EncodedDiagnosticMessage\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthPrincipalDisplayName\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"NoPermissionType\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"AuthAction\\\\\\": \\\\\\"\\\\\\"\\\\n }\\"\\n}","type":"json"}]', 'title' => '查询变配规格列表', ], 'ExecuteOperationSync' => [ 'summary' => '维护应用下资源API（同步操作）', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '212309', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '云速搭应用ID', 'description' => '云速搭应用ID', 'type' => 'string', 'required' => false, 'example' => 'BE68D71ZY5YYIU9R', ], ], [ 'name' => 'ServiceType', 'in' => 'formData', 'schema' => [ 'title' => '资源类型，如果需要修改 dds 的相关参数请填写：dds。', 'description' => '资源类型，例如需要执行 dds 这一资源的操作请填写：dds。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'dds' => 'dds', 'ecs' => 'ecs', ], 'example' => 'dds', ], ], [ 'name' => 'Operation', 'in' => 'formData', 'schema' => [ 'title' => '本次操作类型', 'description' => '本次操作类型', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'modifyConnectionString' => 'modifyConnectionString', 'rename' => 'rename', ], 'example' => 'rename', ], ], [ 'name' => 'Attributes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '操作相关参数，根据不同的Operation值，输入对应的参数', 'description' => '操作相关参数，根据不同的Operation值，输入对应的参数', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '调试时请先选择“参数类型”，再输入参数值。', 'example' => 'Select string type: "CADT"; Select number type: 123', ], ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID，用于资源组权限校验', 'description' => '资源组ID，用于资源组权限校验', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmyjt3c5om3hi', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'example' => '1600765710019', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Access key ID cannot be null.', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'FDC73B05-5331-57AA-BA93-4C9882792FF5', ], 'Data' => [ 'description' => '返回同步操作结果详细信息。', 'type' => 'object', 'properties' => [ 'OperationId' => [ 'title' => '操作ID', 'description' => '操作ID', 'type' => 'string', 'example' => 'op_xxxxxxxx', ], 'Status' => [ 'title' => '当前操作状态', 'description' => '实例状态', 'type' => 'string', 'example' => 'SUCCESS/FAILURE', ], 'Message' => [ 'title' => '操作相关信息', 'description' => '操作相关信息', 'type' => 'string', 'example' => '"[{"vServerGroupId":"rsp-xxxx","healthCheckHttpVersion":"http1.0","status":"running","gzip":"on","requestId":"89xxxx","description":"abcxxx","bandwidth":-1,"healthCheckTimeout":10,"healthCheckType":"http","aclStatus":"off","unhealthyThreshold":3,"xForwardedFor_SLBID":"off","healthCheckHttpCode":"http_3xx,http_2xx","listenerForward":"off","xForwardedFor":"on","idleTimeout":15,"requestTimeout":60,"listenerPort":80,"healthCheckInterval":2,"healthCheckURI":"/","scheduler":"rr","healthyThreshold":3,"xForwardedFor_proto":"off","xForwardedFor_SLBIP":"off","stickySession":"off","healthCheckMethod":"head","healthCheck":"on","rules":[],"aclIds":[]}]"', ], 'Arguments' => [ 'title' => '操作相关输出结果', 'description' => '操作相关输出结果', 'type' => 'string', 'example' => '{'."\n" .' "tagMap":{'."\n" .' "cadt": ['."\n" .' "12xxxxxxx",'."\n" .' "34xxxxxxx"'."\n" .' ]'."\n" .' }'."\n" .'}', ], ], ], 'Code' => [ 'description' => '结果码，200代表成功；其它代表失败。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Access key ID cannot be null.\\",\\n \\"RequestId\\": \\"FDC73B05-5331-57AA-BA93-4C9882792FF5\\",\\n \\"Data\\": {\\n \\"OperationId\\": \\"op_xxxxxxxx\\",\\n \\"Status\\": \\"SUCCESS/FAILURE\\",\\n \\"Message\\": \\"\\\\\\"[{\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-xxxx\\\\\\",\\\\\\"healthCheckHttpVersion\\\\\\":\\\\\\"http1.0\\\\\\",\\\\\\"status\\\\\\":\\\\\\"running\\\\\\",\\\\\\"gzip\\\\\\":\\\\\\"on\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"89xxxx\\\\\\",\\\\\\"description\\\\\\":\\\\\\"abcxxx\\\\\\",\\\\\\"bandwidth\\\\\\":-1,\\\\\\"healthCheckTimeout\\\\\\":10,\\\\\\"healthCheckType\\\\\\":\\\\\\"http\\\\\\",\\\\\\"aclStatus\\\\\\":\\\\\\"off\\\\\\",\\\\\\"unhealthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_SLBID\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckHttpCode\\\\\\":\\\\\\"http_3xx,http_2xx\\\\\\",\\\\\\"listenerForward\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor\\\\\\":\\\\\\"on\\\\\\",\\\\\\"idleTimeout\\\\\\":15,\\\\\\"requestTimeout\\\\\\":60,\\\\\\"listenerPort\\\\\\":80,\\\\\\"healthCheckInterval\\\\\\":2,\\\\\\"healthCheckURI\\\\\\":\\\\\\"/\\\\\\",\\\\\\"scheduler\\\\\\":\\\\\\"rr\\\\\\",\\\\\\"healthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_proto\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor_SLBIP\\\\\\":\\\\\\"off\\\\\\",\\\\\\"stickySession\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckMethod\\\\\\":\\\\\\"head\\\\\\",\\\\\\"healthCheck\\\\\\":\\\\\\"on\\\\\\",\\\\\\"rules\\\\\\":[],\\\\\\"aclIds\\\\\\":[]}]\\\\\\"\\",\\n \\"Arguments\\": \\"{\\\\n \\\\\\"tagMap\\\\\\":{\\\\n \\\\\\"cadt\\\\\\": [\\\\n \\\\\\"12xxxxxxx\\\\\\",\\\\n \\\\\\"34xxxxxxx\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '同步执行操作', 'description' => '同步执行产品操作功能。', ], 'ExecuteOperationASync' => [ 'summary' => '异步执行产品操作功能。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '147059', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'description' => '云速搭应用ID', 'type' => 'string', 'required' => false, 'example' => 'BG**********UQ', ], ], [ 'name' => 'ServiceType', 'in' => 'formData', 'schema' => [ 'title' => '资源类型，当前只支持cadt_app', 'description' => '资源类型，如果需要修改ecs的相关参数请填写：ecs。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'ecs' => 'ecs', ], 'example' => 'ecs', ], ], [ 'name' => 'Operation', 'in' => 'formData', 'schema' => [ 'title' => '本次操作类型，例如：attachTag，批量打标; assignResourceGroup，批量分配资源组等', 'description' => '本次操作类型，是修改产品的操作类型，有的操作类型是通用，有的是单独使用。'."\n" .'下面为ecs的相关编配示例：'."\n" .'- ecs的名称：rename'."\n" .'- ecs的规格：modifyInstanceType'."\n" .'- ecs的启动：modifyInstanceType'."\n" .'- ecs的停止：modifyInstanceType'."\n" .'- ecs的重启：modifyInstanceType'."\n" .'- ecs添加标签：addTags'."\n" .'- ecs的删除：ecsDelete'."\n" .'- ecs的付费类型：modifyPayType', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'addTags' => 'addTags', 'modifyInstanceType' => 'modifyInstanceType', ], 'example' => 'addTags', ], ], [ 'name' => 'Attributes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '操作相关参数，根据不同的Operation值，输入对应的参数', 'description' => '操作相关参数，根据不同的Operation值，输入对应的参数，此次传值是以map的形式传参。'."\n" .'以下为ecs的变配为例：'."\n" .'- ecs的需要传递的公共参数如下：'."\n" .'change_type,'."\n" .'regionId,'."\n" .'instanceId,'."\n" .'appId'."\n" .'- ecs变更规格的参数值示例：'."\n" .'{'."\n" .' "ServiceType": "ecs",'."\n" .' "Operation": "modifyInstanceType",'."\n" .' "Attributes": "{\\"change_type\\":\\"modify_instance_type\\",\\"instance_type\\":\\"ecs.hfr7.2xlarge\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n" .'}'."\n" .'- ecs停止实例如下：'."\n" .'{'."\n" .' "ServiceType": "ecs",'."\n" .' "Operation": "modifyInstanceType",'."\n" .' "Attributes": "{\\"change_type\\":\\"modify_status\\",\\"status\\":\\"Stopped\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n" .'}'."\n" .'- ecs启动的参数实例如下：'."\n" .'{'."\n" .' "ServiceType": "ecs",'."\n" .' "Operation": "modifyInstanceType",'."\n" .' "Attributes": "{\\"change_type\\":\\"modify_status\\",\\"status\\":\\"Running\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n" .'}'."\n" .'- ecs重启的实例如下：'."\n" .'{'."\n" .' "ServiceType": "ecs",'."\n" .' "Operation": "modifyInstanceType",'."\n" .' "Attributes": "{\\"change_type\\":\\"modify_status\\",\\"status\\":\\"Restart\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}"'."\n" .'}', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '调试时请先选择“参数类型”，再输入参数值。', 'example' => '选择string类型：”CADT“；'."\n" .'选择number类型：123', ], 'enumValueTitles' => [ '{ "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\\"change_type\\":\\"modify_instance_type\\",\\"instance_type\\":\\"ecs.hfr7.2xlarge\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}" }' => '{ "ServiceType": "ecs", "Operation": "modifyInstanceType", "Attributes": "{\\"change_type\\":\\"modify_instance_type\\",\\"instance_type\\":\\"ecs.hfr7.2xlarge\\",\\"instanceId\\":\\"i-xxxxxxxxx\\",\\"regionId\\":\\"cn-beijing\\",\\"appId\\":\\"xxxxxxxxxxxxx\\"}" }', ], ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID，用于资源组权限校验', 'description' => '资源组ID，用于资源组权限校验', 'type' => 'string', 'required' => false, 'example' => 'ceshi', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'example' => '1600765710019', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '" "', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'SD-WEF-DSW-32ED-323DDSD-2332D', ], 'Data' => [ 'title' => '异步操作任务ID', 'description' => 'OperationId，可通过GetExecuteOperationResult这个api异步获取操作结果。（有效时间为 1 小时）', 'type' => 'string', 'example' => 'op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL', ], 'Code' => [ 'description' => '结果码，200代表成功；其它代表失败。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\\\\\" \\\\\\"\\",\\n \\"RequestId\\": \\"SD-WEF-DSW-32ED-323DDSD-2332D\\",\\n \\"Data\\": \\"op_xxxxxxxxxxxxxxxxxx_ecs_modifyInstanceType_BYSOQGWUV6PME412_ERMEZLXNN3K9N3OL\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '异步执行操作', ], 'GetExecuteOperationResult' => [ 'summary' => '异步获取操作结果。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '147061', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLQBYK', 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'OperationId', 'in' => 'formData', 'schema' => [ 'title' => '操作ID', 'description' => '操作ID（有效时间为1小时，超时后无法查询到结果并且返回参数没有Data这一属性）', 'type' => 'string', 'required' => true, 'example' => 'op_xxxxxxxxxxxxxxxxxxxxxx', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'formData', 'schema' => [ 'title' => '资源组ID，用于资源组相关权限校验', 'description' => '资源组ID，用于资源组相关权限校验', 'type' => 'string', 'required' => false, 'example' => 'testResourceId', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '" "', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562', ], 'Data' => [ 'description' => '返回异步操作结果详细信息。', 'type' => 'object', 'properties' => [ 'OperationId' => [ 'title' => '操作ID', 'description' => '操作ID', 'type' => 'string', 'example' => 'op_xxxxxxxx', ], 'Status' => [ 'title' => '当前操作状态', 'description' => '当前操作状态', 'type' => 'string', 'example' => 'INIT/RUNNING/SUCCESS/FAILURE'."\n", ], 'Message' => [ 'title' => '操作相关信息', 'description' => '操作相关信息', 'type' => 'string', 'example' => '"[{"vServerGroupId":"rsp-xxxx","healthCheckHttpVersion":"http1.0","status":"running","gzip":"on","requestId":"89xxxx","description":"abcxxx","bandwidth":-1,"healthCheckTimeout":10,"healthCheckType":"http","aclStatus":"off","unhealthyThreshold":3,"xForwardedFor_SLBID":"off","healthCheckHttpCode":"http_3xx,http_2xx","listenerForward":"off","xForwardedFor":"on","idleTimeout":15,"requestTimeout":60,"listenerPort":80,"healthCheckInterval":2,"healthCheckURI":"/","scheduler":"rr","healthyThreshold":3,"xForwardedFor_proto":"off","xForwardedFor_SLBIP":"off","stickySession":"off","healthCheckMethod":"head","healthCheck":"on","rules":[],"aclIds":[]}]"', ], 'Arguments' => [ 'title' => '操作相关输出结果', 'description' => '操作相关输出结果', 'type' => 'string', 'example' => '{'."\n" .' "tagMap":{'."\n" .' "cadt": ['."\n" .' "12xxxxxxx",'."\n" .' "34xxxxxxx"'."\n" .' ]'."\n" .' }'."\n" .'}', ], ], ], 'Code' => [ 'description' => '结果码，200代表成功', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\\\\\" \\\\\\"\\",\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"Data\\": {\\n \\"OperationId\\": \\"op_xxxxxxxx\\",\\n \\"Status\\": \\"INIT/RUNNING/SUCCESS/FAILURE\\\\n\\",\\n \\"Message\\": \\"\\\\\\"[{\\\\\\"vServerGroupId\\\\\\":\\\\\\"rsp-xxxx\\\\\\",\\\\\\"healthCheckHttpVersion\\\\\\":\\\\\\"http1.0\\\\\\",\\\\\\"status\\\\\\":\\\\\\"running\\\\\\",\\\\\\"gzip\\\\\\":\\\\\\"on\\\\\\",\\\\\\"requestId\\\\\\":\\\\\\"89xxxx\\\\\\",\\\\\\"description\\\\\\":\\\\\\"abcxxx\\\\\\",\\\\\\"bandwidth\\\\\\":-1,\\\\\\"healthCheckTimeout\\\\\\":10,\\\\\\"healthCheckType\\\\\\":\\\\\\"http\\\\\\",\\\\\\"aclStatus\\\\\\":\\\\\\"off\\\\\\",\\\\\\"unhealthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_SLBID\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckHttpCode\\\\\\":\\\\\\"http_3xx,http_2xx\\\\\\",\\\\\\"listenerForward\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor\\\\\\":\\\\\\"on\\\\\\",\\\\\\"idleTimeout\\\\\\":15,\\\\\\"requestTimeout\\\\\\":60,\\\\\\"listenerPort\\\\\\":80,\\\\\\"healthCheckInterval\\\\\\":2,\\\\\\"healthCheckURI\\\\\\":\\\\\\"/\\\\\\",\\\\\\"scheduler\\\\\\":\\\\\\"rr\\\\\\",\\\\\\"healthyThreshold\\\\\\":3,\\\\\\"xForwardedFor_proto\\\\\\":\\\\\\"off\\\\\\",\\\\\\"xForwardedFor_SLBIP\\\\\\":\\\\\\"off\\\\\\",\\\\\\"stickySession\\\\\\":\\\\\\"off\\\\\\",\\\\\\"healthCheckMethod\\\\\\":\\\\\\"head\\\\\\",\\\\\\"healthCheck\\\\\\":\\\\\\"on\\\\\\",\\\\\\"rules\\\\\\":[],\\\\\\"aclIds\\\\\\":[]}]\\\\\\"\\",\\n \\"Arguments\\": \\"{\\\\n \\\\\\"tagMap\\\\\\":{\\\\n \\\\\\"cadt\\\\\\": [\\\\n \\\\\\"12xxxxxxx\\\\\\",\\\\n \\\\\\"34xxxxxxx\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '异步获取操作结果', ], 'ListServices' => [ 'summary' => '查看支持的服务列表', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '212309', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'error', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '服务类型集合', 'type' => 'array', 'items' => [ 'description' => '服务类型', 'type' => 'string', 'example' => 'ecs', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"error\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n \\"ecs\\"\\n ]\\n}","type":"json"}]', 'title' => '查看支持的服务列表', ], 'ListOperations' => [ 'summary' => '查看某服务支持的操作', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '212309', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ServiceType', 'in' => 'query', 'schema' => [ 'description' => '服务类型', 'type' => 'string', 'required' => true, 'example' => 'ecs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'NotFound', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '服务结果', 'type' => 'array', 'items' => [ 'description' => '服务列表', 'type' => 'object', 'properties' => [ 'Service' => [ 'description' => '服务类型', 'type' => 'string', 'example' => 'ecs', ], 'Operation' => [ 'description' => '操作名', 'type' => 'string', 'example' => 'addTags', ], 'DisplayName' => [ 'description' => '操作描述', 'type' => 'string', 'example' => 'Add Tag', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"NotFound\\",\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Service\\": \\"ecs\\",\\n \\"Operation\\": \\"addTags\\",\\n \\"DisplayName\\": \\"Add Tag\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看某服务支持的操作', ], 'GetOperationParams' => [ 'summary' => '查看某操作的输入参数', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '212309', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ServiceType', 'in' => 'formData', 'schema' => [ 'description' => '服务类型', 'type' => 'string', 'required' => true, 'example' => 'ecs', ], ], [ 'name' => 'Operation', 'in' => 'formData', 'schema' => [ 'description' => '操作名', 'type' => 'string', 'required' => true, 'example' => 'addTags', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'getBpmOperationParams errors', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'F439A659-3B3D-50FB-A4BC-69FBF16413C8', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '结果集', 'type' => 'object', 'properties' => [ 'Service' => [ 'description' => '服务类型', 'type' => 'string', 'example' => 'ecs', ], 'Operation' => [ 'description' => '操作名', 'type' => 'string', 'example' => 'addTags', ], 'Attributes' => [ 'description' => '输入参数', 'type' => 'object', 'example' => '{'."\n" .' "tags": {'."\n" .' "controlType": "KeyValue",'."\n" .' "display": "Label",'."\n" .' "orderBy": 0,'."\n" .' "associatedLabel": true,'."\n" .' "required": true'."\n" .' }'."\n" .' }', ], 'Properties' => [ 'description' => '输入参数', 'type' => 'object', 'example' => '{'."\n" .' "instanceId": "ResourceId",'."\n" .' "regionId": "region",'."\n" .' "appId": "appId"'."\n" .' }', ], 'Outputs' => [ 'description' => '输出结果', 'type' => 'object', 'example' => '{'."\n" .' "instance_id": {'."\n" .' "display": "ECS instance ID",'."\n" .' "dataType": "String",'."\n" .' "orderBy": 0,'."\n" .' "attributeName": "instance_id",'."\n" .' "enableVariable": "String",'."\n" .' "required": true'."\n" .' },'."\n" .' "instance_name": {'."\n" .' "display": "ECS name",'."\n" .' "dataType": "String",'."\n" .' "orderBy": 0,'."\n" .' "attributeName": "instance_name",'."\n" .' "required": true'."\n" .' },'."\n" .' "private_ip": {'."\n" .' "display": "Intranet IP",'."\n" .' "dataType": "String",'."\n" .' "orderBy": 0,'."\n" .' "value": "private_ip",'."\n" .' "required": true'."\n" .' }'."\n" .' }', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"getBpmOperationParams errors\\",\\n \\"RequestId\\": \\"F439A659-3B3D-50FB-A4BC-69FBF16413C8\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Service\\": \\"ecs\\",\\n \\"Operation\\": \\"addTags\\",\\n \\"Attributes\\": {\\n \\"tags\\": {\\n \\"controlType\\": \\"KeyValue\\",\\n \\"display\\": \\"Label\\",\\n \\"orderBy\\": 0,\\n \\"associatedLabel\\": true,\\n \\"required\\": true\\n }\\n },\\n \\"Properties\\": {\\n \\"instanceId\\": \\"ResourceId\\",\\n \\"regionId\\": \\"region\\",\\n \\"appId\\": \\"appId\\"\\n },\\n \\"Outputs\\": {\\n \\"instance_id\\": {\\n \\"display\\": \\"ECS instance ID\\",\\n \\"dataType\\": \\"String\\",\\n \\"orderBy\\": 0,\\n \\"attributeName\\": \\"instance_id\\",\\n \\"enableVariable\\": \\"String\\",\\n \\"required\\": true\\n },\\n \\"instance_name\\": {\\n \\"display\\": \\"ECS name\\",\\n \\"dataType\\": \\"String\\",\\n \\"orderBy\\": 0,\\n \\"attributeName\\": \\"instance_name\\",\\n \\"required\\": true\\n },\\n \\"private_ip\\": {\\n \\"display\\": \\"Intranet IP\\",\\n \\"dataType\\": \\"String\\",\\n \\"orderBy\\": 0,\\n \\"value\\": \\"private_ip\\",\\n \\"required\\": true\\n }\\n }\\n }\\n}","type":"json"}]', 'title' => '查看某操作的输入参数', ], 'ChangeResourceGroup' => [ 'summary' => '该接口可以将CADT创建的应用或模板从一个资源组转移到另一个资源组。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '150656', 'abilityTreeNodes' => [ 'FEATUREbpstudioINUEOA', ], ], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'formData', 'schema' => [ 'description' => 'CADT应用或模板ID', 'type' => 'string', 'required' => true, 'example' => 'P7RMVSVM9LOVYQOM', ], ], [ 'name' => 'NewResourceGroupId', 'in' => 'formData', 'schema' => [ 'description' => '新资源组ID', 'type' => 'string', 'required' => true, 'example' => 'rg-aek2ajbjoloa23q', ], ], [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ 'description' => '需要更换资源组的资源类型，这里指CADT应用（APPLICATION）或模板（TEMPLATE）。', 'type' => 'string', 'required' => true, 'example' => 'APPLICATION', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562', ], 'Data' => [ 'description' => '该字段不返回具体业务数据', 'type' => 'string', ], 'Message' => [ 'description' => '当变更失败时，返回错误信息。', 'type' => 'string', ], 'Code' => [ 'description' => '执行结果码，200代表成功，其它代表失败。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3488F1D-xxxx-xxxx-xxxx-5374BA0F3562\\",\\n \\"Data\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A3488F1D-C444-17D0-BA4F-5374BA0F3562\\n 无\\n 无\\n 200\\n","errorExample":""}]', 'title' => '更换应用或模板资源组', ], 'AppFailOver' => [ 'summary' => '将容灾集切换至支持的可用区。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208078', 'abilityTreeNodes' => [ 'FEATUREbpstudioJD8QWK', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => false, 'example' => 'BE68D71ZY5YYIU9R', ], ], [ 'name' => 'FailZone', 'in' => 'formData', 'schema' => [ 'title' => '容灾切换目标可用区', 'description' => '容灾切换目标可用区', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-g', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '9656C816-1E9A-58D2-86D5-710678D61AF1', ], 'Message' => [ 'title' => '报错信息', 'description' => '报错信息', 'type' => 'string', 'example' => 'The application has an incorrect state of the master/slave switching group. All groups must be in the state to be switched before switching!', ], 'Code' => [ 'title' => '返回码', 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'title' => '容灾切换任务码TaskId', 'description' => '容灾切换任务ID（TaskId）', 'type' => 'integer', 'format' => 'int32', 'example' => '7441', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9656C816-1E9A-58D2-86D5-710678D61AF1\\",\\n \\"Message\\": \\"The application has an incorrect state of the master/slave switching group. All groups must be in the state to be switched before switching!\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 7441\\n}","type":"json"}]', 'title' => '容灾应用切换', 'description' => '将容灾集切换至支持的可用区。', ], 'GetPotentialFailZones' => [ 'summary' => '获取指定容灾服务可切换的可用区列表。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208010', 'abilityTreeNodes' => [ 'FEATUREbpstudio9F383C', ], ], 'parameters' => [ [ 'name' => 'IsPlanId', 'in' => 'formData', 'schema' => [ 'title' => '是否为容灾集ID', 'description' => '是否为容灾集ID', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ObjectId', 'in' => 'formData', 'schema' => [ 'title' => 'IsPlanId选择false传入ApplicationId（应用ID），IsPlanId选择true传入PlanId（容灾集ID）', 'description' => 'IsPlanId选择false传入ApplicationId（应用ID），IsPlanId选择true传入PlanId（容灾集ID）', 'type' => 'string', 'required' => false, 'example' => 'FS3ATPTOSC4SE1GG', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口返回数据', 'description' => '接口返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C', ], 'Message' => [ 'title' => '报错信息', 'description' => '报错信息', 'type' => 'string', 'example' => 'The specified ResourceIds are not found in our records.', ], 'Code' => [ 'title' => '返回码', 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'title' => '当前容灾服务可切换的可用区列表', 'description' => '当前容灾服务可切换的可用区列表', 'type' => 'array', 'items' => [ 'title' => '当前容灾服务可切换的可用区', 'description' => '当前容灾服务可切换的可用区', 'type' => 'string', 'example' => 'cn-hangzhou-f', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C\\",\\n \\"Message\\": \\"The specified ResourceIds are not found in our records.\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n \\"cn-hangzhou-f\\"\\n ]\\n}","type":"json"}]', 'title' => '获取容灾服务可切换的可用区列表', 'description' => '获取指定容灾服务可切换的可用区列表。', ], 'GetFoTaskStatus' => [ 'summary' => '获取指定容灾任务（TaskId）的状态。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208114', 'abilityTreeNodes' => [ 'FEATUREbpstudioSRFDAT', ], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'title' => '容灾切换任务ID', 'description' => '容灾切换任务ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2615', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '923692F0-A15B-58B4-BAF4-2AFA4AF46240', ], 'Message' => [ 'title' => '报错信息', 'description' => '报错信息', 'type' => 'string', 'example' => 'OKITHEVRQCN6ULQG', ], 'Code' => [ 'title' => '返回码', 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'title' => '容灾切换任务Task的状态', 'description' => '容灾切换任务Task的状态', 'type' => 'string', 'example' => 'Running', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"923692F0-A15B-58B4-BAF4-2AFA4AF46240\\",\\n \\"Message\\": \\"OKITHEVRQCN6ULQG\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"Running\\"\\n}","type":"json"}]', 'title' => '获取指定容灾任务的状态', 'description' => '获取指定容灾任务（TaskId）的状态。', 'responseParamsDescription' => '应用状态列表：'."\n" .'- Creating 创建中'."\n" .'- Modified 已修改'."\n" .'- Verifying 校验中'."\n" .'- Verified_Failure 校验失败'."\n" .'- Verified_Success 校验成功'."\n" .'- Valuating 计价中'."\n" .'- Valuating_Failure 计价失败'."\n" .'- Valuating_Success 计价成功'."\n" .'- Deploying 部署中'."\n" .'- Deployed_Failure 部署失败'."\n" .'- Partially_Deployed_Success 部分部署成功'."\n" .'- Deployed_Success 部署成功'."\n" .'- Destroying 释放中'."\n" .'- Delayed_Destroy 延时销毁'."\n" .'- Destroyed_Failure 释放失败'."\n" .'- Partially_Destroyed_Success 部分释放成功'."\n" .'- Destroyed_Success 释放成功'."\n" .'- Revised 架构调整'."\n" .'- Verifying_In_Revision 资源验证（架构调整）'."\n" .'- Verified_Failure_In_Revision 资源验证失败（架构调整）'."\n" .'- Verified_Success_In_Revision 资源验证成功（架构调整）'."\n" .'- Valuating_In_Revision 询价中（架构调整）'."\n" .'- Valuating_Failure_In_Revision 询价失败（架构调整）'."\n" .'- Valuating_Success_In_Revision 询价成功（架构调整）', ], 'AppFailBack' => [ 'summary' => '将容灾集切回至主可用区。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208124', 'abilityTreeNodes' => [ 'FEATUREbpstudioJD8QWK', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => false, 'example' => '61ZW1DY5Y3FSAOO2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '返回数据', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '7036DDBE-0ABA-52D7-A39D-75E511970F07', ], 'Message' => [ 'title' => '报错信息', 'description' => '报错信息', 'type' => 'string', 'example' => 'OKITHEVRQCN6ULQG', ], 'Code' => [ 'title' => '返回码', 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'title' => '容灾任务切回TaskId', 'description' => '容灾切回任务ID（TaskId）', 'type' => 'integer', 'format' => 'int32', 'example' => '3309', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7036DDBE-0ABA-52D7-A39D-75E511970F07\\",\\n \\"Message\\": \\"OKITHEVRQCN6ULQG\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 3309\\n}","type":"json"}]', 'title' => '容灾应用切回', 'description' => '将容灾集切回至主可用区。', ], 'ListFoCreatedApps' => [ 'summary' => '接口查询当前账户下所有容灾服务计划。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207619', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLQBYK', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '接口返回数据', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '40F63F07-3AB6-53B3-8825-0580C130E3EA', ], 'Message' => [ 'title' => '报错信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'Cannot find region according to your domain.', ], 'Code' => [ 'title' => '返回码', 'description' => '状态码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'title' => '返回值数据列表', 'description' => '模板列表', 'type' => 'array', 'items' => [ 'title' => '返回值数据', 'description' => '应用数据', 'type' => 'object', 'properties' => [ 'ApplicationId' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'JIX9NEZUALGS46UI', ], 'Title' => [ 'title' => '容灾服务名称', 'description' => '标题', 'type' => 'string', 'example' => 'Disaster Recovery Plan', ], 'ReportUrl' => [ 'title' => '报告路径URL', 'description' => '错误报告url', 'type' => 'string', 'example' => '14318082782*****/drs-application-3ET9ZEVPOWRDZK0N.pdf', ], 'Status' => [ 'title' => '容灾服务状态', 'description' => '应用状态', 'type' => 'string', 'example' => 'Deployed_Success', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40F63F07-3AB6-53B3-8825-0580C130E3EA\\",\\n \\"Message\\": \\"Cannot find region according to your domain.\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ApplicationId\\": \\"JIX9NEZUALGS46UI\\",\\n \\"Title\\": \\"Disaster Recovery Plan\\",\\n \\"ReportUrl\\": \\"14318082782*****/drs-application-3ET9ZEVPOWRDZK0N.pdf\\",\\n \\"Status\\": \\"Deployed_Success\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询所有容灾服务计划', 'description' => '接口查询当前账户下所有容灾服务计划。', 'requestParamsDescription' => '无请求参数', 'responseParamsDescription' => '应用状态列表：'."\n" .'- Creating 创建中'."\n" .'- Modified 已修改'."\n" .'- Verifying 校验中'."\n" .'- Verified_Failure 校验失败'."\n" .'- Verified_Success 校验成功'."\n" .'- Valuating 计价中'."\n" .'- Valuating_Failure 计价失败'."\n" .'- Valuating_Success 计价成功'."\n" .'- Deploying 部署中'."\n" .'- Deployed_Failure 部署失败'."\n" .'- Partially_Deployed_Success 部分部署成功'."\n" .'- Deployed_Success 部署成功'."\n" .'- Destroying 释放中'."\n" .'- Delayed_Destroy 延时销毁'."\n" .'- Destroyed_Failure 释放失败'."\n" .'- Partially_Destroyed_Success 部分释放成功'."\n" .'- Destroyed_Success 释放成功'."\n" .'- Revised 架构调整'."\n" .'- Verifying_In_Revision 资源验证（架构调整）'."\n" .'- Verified_Failure_In_Revision 资源验证失败（架构调整）'."\n" .'- Verified_Success_In_Revision 资源验证成功（架构调整）'."\n" .'- Valuating_In_Revision 询价中（架构调整）'."\n" .'- Valuating_Failure_In_Revision 询价失败（架构调整）'."\n" .'- Valuating_Success_In_Revision 询价成功（架构调整）', 'extraInfo' => '无', ], 'InitAppFailOver' => [ 'summary' => '应用容灾切换准备，初始化容灾切换任务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208065', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ApplicationId', 'in' => 'formData', 'schema' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'required' => false, 'example' => '002XWH7MXB8MJRU0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Message' => [ 'title' => '报错信息', 'description' => '报错信息', 'type' => 'string', 'example' => 'Unsupported Operation PrepareEvent->FailOverPrepareSuccess FoApp_DDLJK2WM8ETU9JAC', ], 'Code' => [ 'title' => '返回码', 'description' => '返回码', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'title' => '返回容灾切换任务ID（TaskId）', 'description' => '返回容灾切换任务ID（TaskId）', 'type' => 'integer', 'format' => 'int32', 'example' => '7250', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Unsupported Operation PrepareEvent->FailOverPrepareSuccess FoApp_DDLJK2WM8ETU9JAC\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": 7250\\n}","type":"json"}]', 'title' => '应用容灾准备', 'description' => '应用容灾切换准备，初始化容灾切换任务。', ], 'ListTagResources' => [ 'summary' => '该接口用于查询应用或模板的标签。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '173661', 'abilityTreeNodes' => [ 'FEATUREbpstudioCGSK4A', ], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => '幂等标记', 'description' => '幂等标记', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1600765710019', ], ], [ 'name' => 'RegionId', 'in' => 'formData', 'schema' => [ 'title' => '区域ID', 'description' => '区域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => [ 'title' => '下一个查询开始Token', 'description' => '下一个查询开始Token', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => true, 'example' => 'Application', ], ], [ 'name' => 'ResourceId', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID,最多 50个子项', 'type' => 'array', 'items' => [ 'description' => '如果“ResourceType”是“Application”，则“ResourceId”为应用ID；'."\n" .'如果“ResourceType”是“Template”，则“ResourceId”为模板ID。', 'type' => 'string', 'required' => true, 'example' => 'A926QK1X89YF2G62', ], 'required' => true, ], ], [ 'name' => 'Tag', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => '标签列表，最多包含20个子项', 'description' => '标签列表，最多包含20个子项', 'type' => 'array', 'items' => [ 'description' => '标签信息', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'tag1', ], 'Value' => [ 'title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'value1', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NextToken' => [ 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', 'description' => '下一个查询开始Token，NextToken为空说明没有下一个', 'type' => 'string', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '847C9D0A-BABD-589C-8A9C-6464409EDED9', ], 'Code' => [ 'description' => '结果码，200代表成功', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'bp.java.nopowerContact', ], 'TagResources' => [ 'title' => 'TagResource', 'description' => 'TagResource', 'type' => 'array', 'items' => [ 'description' => '标签资源集合', 'type' => 'object', 'properties' => [ 'ResourceType' => [ 'description' => 'Application或Template', 'type' => 'string', 'example' => 'application', ], 'TagValue' => [ 'description' => '标签值', 'type' => 'string', 'example' => 'Value', ], 'ResourceId' => [ 'description' => 'CADT应用或模板ID', 'type' => 'string', 'example' => 'MW7T1820ACJX9BI7', ], 'TagKey' => [ 'description' => '标签键', 'type' => 'string', 'example' => 'Key', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'bp.java.nopowerContact', 'errorMessage' => 'You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"1\\",\\n \\"RequestId\\": \\"847C9D0A-BABD-589C-8A9C-6464409EDED9\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"bp.java.nopowerContact\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"application\\",\\n \\"TagValue\\": \\"Value\\",\\n \\"ResourceId\\": \\"MW7T1820ACJX9BI7\\",\\n \\"TagKey\\": \\"Key\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询标签接口', ], 'ExecuteTask' => [ 'summary' => '创建任务', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLICAE', ], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2615', ], ], ], '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' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Message' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '执行结果', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '任务id', 'type' => 'integer', 'format' => 'int32', 'example' => '2615', ], 'Name' => [ 'description' => '任务名称', 'type' => 'string', 'example' => 'test_name', ], 'Status' => [ 'description' => '任务状态', 'type' => 'string', 'example' => 'FINISH', ], 'ErrorMessage' => [ 'description' => '错误信息', 'type' => 'string', 'example' => 'SyntaxError', ], ], ], 'Code' => [ 'description' => '状态码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'NoPermission', 'errorMessage' => 'No Permission.', ], [ 'errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Id\\": 2615,\\n \\"Name\\": \\"test_name\\",\\n \\"Status\\": \\"FINISH\\",\\n \\"ErrorMessage\\": \\"SyntaxError\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '执行任务', ], 'CreateTask' => [ 'summary' => '创建任务', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLICAE', ], ], 'parameters' => [ [ 'name' => 'ProcessId', 'in' => 'formData', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => 'P3KTG43SW7**6A17I', ], ], [ 'name' => 'TaskName', 'in' => 'formData', 'schema' => [ 'description' => '任务名称。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'AppId', 'in' => 'formData', 'schema' => [ 'description' => '应用ID，可以调用ListApplication接口获取，详情请参见ListApplication。', 'type' => 'string', 'required' => true, 'example' => 'JXT3MLZJ56**65D6', ], ], [ 'name' => 'Variables', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '流程的变量值列表', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'description' => '"${var}":"value"', 'example' => '"${var}":"value"', ], ], ], ], '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' => 'F439A659-3B3D-50FB-A4BC-69FBF16413C8', ], 'Message' => [ 'description' => '报错信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '任务id', 'type' => 'integer', 'format' => 'int32', 'example' => '1994', ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F439A659-3B3D-50FB-A4BC-69FBF16413C8\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": 1994,\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '创建任务', ], 'GetTask' => [ 'summary' => '获取Task信息。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREbpstudioJLICAE', ], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => [ 'description' => '任务id', 'type' => 'string', 'required' => false, 'example' => '2615', ], ], ], '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' => 'A07FFDF2-78FA-1B48-9E38-88E833A93187', ], 'Message' => [ 'description' => '报错信息', 'type' => 'string', 'example' => 'Success', ], 'Data' => [ 'description' => '任务详情', 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '任务id', 'type' => 'integer', 'format' => 'int32', 'example' => '1333', ], 'Name' => [ 'description' => '任务名称', 'type' => 'string', 'example' => 'test_name', ], 'ProcessId' => [ 'description' => '流程ID。', 'type' => 'string', 'example' => '64QQBC02**FA3W3G', ], 'AppId' => [ 'description' => '应用ID', 'type' => 'string', 'example' => 'JXT**LZJ568665D6', ], 'InstanceIds' => [ 'description' => '获取绑定应用id', 'type' => 'string', 'example' => '{\\"app\\":\\"JJXT**LZJ568665D6\\"}', ], 'ErrorMessage' => [ 'description' => '错误信息。', 'type' => 'string', 'example' => 'SyntaxError', ], 'Status' => [ 'description' => 'FINISH 完成
'."\n" .'BINDING 绑定中', 'type' => 'string', 'example' => 'FINISH ', ], 'GmtCreate' => [ 'description' => '创建时间', 'type' => 'string', 'example' => '2025-08-21 14:07:02', ], ], ], 'Code' => [ 'description' => '返回码', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'NoPermissions', 'errorMessage' => 'No permissions.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A07FFDF2-78FA-1B48-9E38-88E833A93187\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"Id\\": 1333,\\n \\"Name\\": \\"test_name\\",\\n \\"ProcessId\\": \\"64QQBC02**FA3W3G\\",\\n \\"AppId\\": \\"JXT**LZJ568665D6\\",\\n \\"InstanceIds\\": \\"{\\\\\\\\\\\\\\"app\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"JJXT**LZJ568665D6\\\\\\\\\\\\\\"}\\",\\n \\"ErrorMessage\\": \\"SyntaxError\\",\\n \\"Status\\": \\"FINISH \\",\\n \\"GmtCreate\\": \\"2025-08-21 14:07:02\\"\\n },\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '获取Task信息', ], ], 'endpoints' => [ [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'bpstudio.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'bpstudio.ap-southeast-1.aliyuncs.com', ], ], ];