'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Advisor', 'version' => '2018-01-20', ], 'directories' => [ [ 'id' => 204006, 'title' => '多维巡检', 'type' => 'directory', 'children' => [ 'DescribeAdvisorChecks', 'DescribeAdvices', 'DescribeAdvisorResources', 'RefreshAdvisorCheck', 'RefreshAdvisorResource', 'DescribeAdvicesPage', 'GetTaskStatusById', 'GetHistoryAdvices', 'DescribeAdvicesFlatPage', ], ], [ 'id' => 204007, 'title' => '成本优化', 'type' => 'directory', 'children' => [ 'GetProductList', 'DescribeCostCheckResults', 'DescribeCostCheckAdvices', 'GetInspectProgress', 'RefreshAdvisorCostCheck', 'DescribeAdvisorChecksFoPages', 'DescribeCostOptimizationOverview', ], ], ], 'components' => [ 'schemas' => [ 'RdAccountDTO' => [ 'title' => 'A short description of struct', 'description' => 'Rd成员账号对象', 'type' => 'object', 'properties' => [ 'Id' => [ 'title' => '成员账号UID', 'type' => 'integer', 'format' => 'int64', ], 'Name' => [ 'title' => '成员账号名称', 'type' => 'string', ], 'DisplayName' => [ 'title' => '展示名称', 'type' => 'string', ], 'AccountType' => [ 'title' => '账号类型', 'type' => 'string', ], 'Checked' => [ 'title' => '是否选中', 'type' => 'boolean', ], 'Tags' => [ 'title' => '标签信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagKey' => [ 'title' => '标签键', 'type' => 'string', ], 'TagValue' => [ 'title' => '标签值', 'type' => 'string', ], ], ], ], ], ], 'RdAccountFolderDTO' => [ 'title' => 'A short description of struct', 'description' => 'Rd多账号文件夹', 'type' => 'object', 'properties' => [ 'ResourceDirectoryId' => [ 'title' => 'RD ID', 'type' => 'string', ], 'FolderId' => [ 'title' => '文件夹ID', 'type' => 'string', ], 'FolderName' => [ 'title' => '文件夹展示名', 'type' => 'string', ], 'ResourceDirectoryPath' => [ 'title' => '文件夹路径', 'type' => 'string', ], 'ResourceDirectoryPathName' => [ 'title' => '文件夹路径名', 'type' => 'string', ], 'AccountCount' => [ 'title' => '文件夹节点账号数量', 'type' => 'integer', 'format' => 'int32', ], 'SelectedCount' => [ 'title' => '文件夹节点选中数量', 'type' => 'integer', 'format' => 'int32', ], 'FolderList' => [ 'title' => '文件夹节点下属子文件夹', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/RdAccountFolderDTO', ], ], 'AccountList' => [ 'title' => '文件夹节点下述账号列表', 'type' => 'array', 'items' => [ '$ref' => '#/components/schemas/RdAccountDTO', ], ], ], ], ], ], 'apis' => [ 'DescribeAdvisorChecks' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AdvisorCheck' => [ 'description' => '查询结果。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '诊断项是否被禁用状态：'."\n" ."\n" .'- **enabled**: 可用'."\n" ."\n" .'- **disabled**: 禁用', 'type' => 'string', 'example' => 'enabled', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'OperateColumn' => [ 'description' => '操作字段，使用前端模板或诊断建议action中定义json字段。', 'type' => 'string', 'example' => '[{"key": "Detail", "value": "/diagnosis?product=${Product}&resourceId=${Resource.resourceId}", "type": "template"} ]', ], 'GmtModified' => [ 'description' => '巡检项配置更新时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'ViewColumn' => [ 'description' => '展示列，即控制台展示巡检项详情的具体配置。', 'type' => 'string', 'example' => '[{"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, {"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, {"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, ]', ], 'GmtCreated' => [ 'description' => '巡检项配置创建时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明。', 'type' => 'string', 'example' => 'CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高', ], 'Tips' => [ 'description' => '巡检建议一句话简述。', 'type' => 'string', 'example' => '请排查实例资源占用情况或升级实例规格', ], 'Code' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsHighCpuUtilization', ], 'Category' => [ 'description' => '巡检项分类：'."\n" ."\n" .'- **1**: 安全合规'."\n" ."\n" .'- **2**: 性能效率'."\n" ."\n" .'- **3**: 业务稳定'."\n" ."\n" .'- **4**: 成本优化'."\n" ."\n" .'- **5**: 服务限制', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => 'ECS 性能负载巡检', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Data\\": {\\n \\"AdvisorCheck\\": [\\n {\\n \\"Status\\": \\"enabled\\",\\n \\"Product\\": \\"ecs\\",\\n \\"OperateColumn\\": \\"[{\\\\\\"key\\\\\\": \\\\\\"Detail\\\\\\", \\\\\\"value\\\\\\": \\\\\\"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\\\\\\", \\\\\\"type\\\\\\": \\\\\\"template\\\\\\"} ]\\",\\n \\"GmtModified\\": \\"2023-07-01 00:00:00\\",\\n \\"ViewColumn\\": \\"[{\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"type\\\\\\":\\\\\\"DEFAULT\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"type\\\\\\":\\\\\\"DEFAULT\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"type\\\\\\":\\\\\\"DEFAULT\\\\\\"}, ]\\",\\n \\"GmtCreated\\": \\"2023-07-01 00:00:00\\",\\n \\"Description\\": \\"CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\",\\n \\"Tips\\": \\"请排查实例资源占用情况或升级实例规格\\",\\n \\"Code\\": \\"EcsHighCpuUtilization\\",\\n \\"Category\\": \\"1\\",\\n \\"Name\\": \\"ECS 性能负载巡检\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n \\n enabled\\n ecs\\n [{\\"key\\": \\"Detail\\", \\"value\\": \\"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\\", \\"type\\": \\"template\\"} ]\\n 2023-07-01 00:00:00\\n [{\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"type\\":\\"DEFAULT\\"}, {\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"type\\":\\"DEFAULT\\"}, {\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"type\\":\\"DEFAULT\\"}, ]\\n 2023-07-01 00:00:00\\n CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\n 请排查实例资源占用情况或升级实例规格\\n EcsHighCpuUtilization\\n 1\\n ECS 性能负载巡检\\n \\n","errorExample":""}]', 'title' => '获取巡检项', 'summary' => '获取用户当前可用的巡检项。', ], 'DescribeAdvices' => [ 'summary' => '可根据多个维度获取用户最新的巡检结果，全量返回。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], ], 'parameters' => [ [ 'name' => 'AdviceId', 'in' => 'query', 'schema' => [ 'description' => '巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40200899', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => '巡检项Code。', 'type' => 'string', 'required' => false, 'example' => 'EcsHighCpuUtilization', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-2zecnwitr2s7aca6****', ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '请求使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ExcludeAdviceId', 'in' => 'query', 'schema' => [ 'description' => '不包含的巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40200889', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'description' => '巡检方案ID（不填则默认为系统方案）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Advice' => [ 'description' => '查询结果。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'Severity' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'GmtModified' => [ 'description' => '巡检项结果更新时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'IsExpired' => [ 'description' => '是否已过期：'."\n" ."\n" .'- **false**: 未过期，'."\n" .'- **true**: 已过期', 'type' => 'boolean', 'example' => 'false', ], 'GmtCreated' => [ 'description' => '巡检项结果创建时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'Resource' => [ 'description' => '资源详情Json，具体请参考各个云产品实例详情查询相关api文档。', 'type' => 'string', 'example' => '{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...}', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明。', 'type' => 'string', 'example' => 'CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高', ], 'CheckId' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsHighCpuUtilization', ], 'AliyunId' => [ 'description' => '阿里云用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '192895059480****', ], 'ResourceId' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'example' => 'i-2zecnwitr2s7aca6****', ], 'Content' => [ 'description' => '结果Json详情，与控制台配置的展示列格式保持一致。', 'type' => 'string', 'example' => '[{"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}]', ], 'Id' => [ 'description' => '巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '40200899', ], 'CheckName' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => 'ECS 性能负载巡检'."\n", ], 'CheckPlanId' => [ 'description' => '巡检方案ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Data\\": {\\n \\"Advice\\": [\\n {\\n \\"Severity\\": 1,\\n \\"Product\\": \\"ecs\\",\\n \\"GmtModified\\": \\"2023-07-01 00:00:00\\",\\n \\"IsExpired\\": false,\\n \\"GmtCreated\\": \\"2023-07-01 00:00:00\\",\\n \\"Resource\\": \\"{\\\\\\"resourceId\\\\\\": \\\\\\"i-2zecnwitr2s7aca6****\\\\\\",\\\\\\"resourceName\\\\\\": \\\\\\"ecs-20230701\\\\\\",\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",...}\\",\\n \\"Description\\": \\"CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\",\\n \\"CheckId\\": \\"EcsHighCpuUtilization\\",\\n \\"AliyunId\\": 0,\\n \\"ResourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\n \\"Content\\": \\"[{\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}]\\",\\n \\"Id\\": 40200899,\\n \\"CheckName\\": \\"ECS 性能负载巡检\\\\n\\",\\n \\"CheckPlanId\\": 111\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n \\n 1\\n ecs\\n 2023-07-01 00:00:00\\n false\\n 2023-07-01 00:00:00\\n {\\"resourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\"resourceName\\": \\"ecs-20230701\\",\\"regionId\\": \\"cn-hangzhou\\",...}\\n CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\n EcsHighCpuUtilization\\n i-2zecnwitr2s7aca6****\\n [{\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"value\\":\\"xxx\\"}, {\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"value\\":\\"xxx\\"}, {\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"value\\":\\"xxx\\"}]\\n 40200899\\n ECS 性能负载巡检\\n\\n \\n","errorExample":""}]', 'title' => '获取最新巡检结果', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'DescribeAdvisorResources' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-2zecnwitr2s7aca6****'."\n", ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '查询关键词，可用来模糊匹配资源/实例ID或资源/实例名称。', 'type' => 'string', 'required' => false, 'example' => 'ecs001', ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '请求的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Data' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Total' => [ 'description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Resource' => [ 'description' => '查询结果数组。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '资源详情Json，具体请参考各个云产品实例详情查询相关api文档。', 'type' => 'string', 'example' => '{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...}', ], 'ResourceId' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'example' => 'i-2zecnwitr2s7aca6****', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'ResourceName' => [ 'description' => '资源名称。', 'type' => 'string', 'example' => 'ecs-20230701', ], 'RegionId' => [ 'description' => '地域信息。', 'type' => 'string', 'example' => 'cn-hangzhou', ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Result\\": {\\n \\"Resource\\": [\\n {\\n \\"Data\\": \\"{\\\\\\"resourceId\\\\\\": \\\\\\"i-2zecnwitr2s7aca6****\\\\\\",\\\\\\"resourceName\\\\\\": \\\\\\"ecs-20230701\\\\\\",\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",...}\\",\\n \\"ResourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\n \\"Product\\": \\"ecs\\",\\n \\"ResourceName\\": \\"ecs-20230701\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n \\n 1\\n 10\\n 100\\n \\n {\\"resourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\"resourceName\\": \\"ecs-20230701\\",\\"regionId\\": \\"cn-hangzhou\\",...}\\n i-2zecnwitr2s7aca6****\\n ecs\\n ecs-20230701\\n cn-hangzhou\\n \\n \\n","errorExample":""}]', 'title' => '获取资源列表', 'summary' => '拉取巡检资源列表（需要在触发资源信息同步后才能获取最新结果）。', ], 'RefreshAdvisorCheck' => [ 'summary' => '刷新诊断项，触发该巡检项的资源指标同步并重新巡检。'."\n" .'该API会按照输入的多个维度（云产品、云资源、诊断项名称）创建巡检任务，都为空则默认按照该用户下所有资源为所有诊断项创建巡检任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-2zecnwitr2s7aca6****', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => '巡检项Code。', 'type' => 'string', 'required' => false, 'example' => 'EcsHighCpuUtilization', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'ResourceDimensionList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Product' => [ 'type' => 'string', 'required' => false, ], 'Security' => [ 'type' => 'boolean', 'required' => false, ], 'Performance' => [ 'type' => 'boolean', 'required' => false, ], 'Reliablility' => [ 'type' => 'boolean', 'required' => false, ], 'Cost' => [ 'type' => 'boolean', 'required' => false, ], 'Service' => [ 'type' => 'boolean', 'required' => false, ], 'ProductName' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'AssumeAliyunId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'description' => '巡检方案ID（不填则默认为系统方案）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '请求返回数据。', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'TraceId' => [ 'description' => '链路追踪ID。', 'type' => 'string', 'example' => 'manual-1be17af1121b4974822e69daee4f2481', ], 'TaskId' => [ 'description' => '后台生成的任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '95906135', ], 'Message' => [ 'type' => 'string', ], ], ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"TraceId\\": \\"manual-1be17af1121b4974822e69daee4f2481\\",\\n \\"TaskId\\": 95906135,\\n \\"Message\\": \\"\\"\\n },\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n true\\n manual-1be17af1121b4974822e69daee4f2481\\n 95906135\\n \\n 566331F9-5AB3-550F-B745-A730331F97A9\\n","errorExample":""}]', 'title' => '刷新并触发巡检', ], 'RefreshAdvisorResource' => [ 'summary' => '根据具体的产品+资源ID，触发资源信息同步任务，返回创建的任务ID。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecs', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'title' => '', 'description' => '资源/实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'i-2zecnwitr2s7aca6****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '后台生成的任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '95906134', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 95906134,\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 95906134\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n","errorExample":""}]', 'title' => '资源信息同步', ], 'DescribeAdvicesPage' => [ 'summary' => '可根据多个维度获取用户最新的巡检结果，分页返回。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], ], 'parameters' => [ [ 'name' => 'AdviceId', 'in' => 'query', 'schema' => [ 'description' => '巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345678', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => '巡检项Code。', 'type' => 'string', 'required' => false, 'example' => 'EcsHighCpuUtilization', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-2zecnwitr2s7aca6****'."\n", ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '请求使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'description' => '巡检方案ID（不填则默认为系统方案）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Data' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Total' => [ 'description' => '数据总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Result' => [ 'description' => '查询结果对象数组。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'AliyunId' => [ 'description' => '阿里云用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '192895059480****', ], 'CheckId' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsHighCpuUtilization', ], 'CheckName' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => 'ECS 性能负载巡检', ], 'Content' => [ 'description' => '结果Json详情，与控制台配置的展示列格式保持一致。', 'type' => 'string', 'example' => '[{"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, ]', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明。', 'type' => 'string', 'example' => 'CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高', ], 'GmtCreated' => [ 'description' => '巡检项结果创建时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'GmtModified' => [ 'description' => '巡检项结果更新时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'Id' => [ 'description' => '巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '40200899', ], 'IsExpired' => [ 'description' => '是否已过期：'."\n" ."\n" .'- **false**: 未过期，'."\n" .'- **true**: 已过期', 'type' => 'boolean', 'example' => 'false', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'Resource' => [ 'description' => '资源详情Json，具体请参考各个云产品实例详情查询相关api文档。', 'type' => 'string', 'example' => '{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...}', ], 'ResourceId' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'example' => 'i-2zecnwitr2s7aca6****', ], 'Severity' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Result\\": [\\n {\\n \\"AliyunId\\": 0,\\n \\"CheckId\\": \\"EcsHighCpuUtilization\\",\\n \\"CheckName\\": \\"ECS 性能负载巡检\\",\\n \\"Content\\": \\"[{\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, ]\\",\\n \\"Description\\": \\"CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\",\\n \\"GmtCreated\\": \\"2023-07-01 00:00:00\\",\\n \\"GmtModified\\": \\"2023-07-01 00:00:00\\",\\n \\"Id\\": 40200899,\\n \\"IsExpired\\": false,\\n \\"Product\\": \\"ecs\\",\\n \\"Resource\\": \\"{\\\\\\"resourceId\\\\\\": \\\\\\"i-2zecnwitr2s7aca6****\\\\\\",\\\\\\"resourceName\\\\\\": \\\\\\"ecs-20230701\\\\\\",\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",...}\\",\\n \\"ResourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\n \\"Severity\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n \\n 1\\n 10\\n 100\\n \\n EcsHighCpuUtilization\\n ECS 性能负载巡检\\n [{\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"value\\":\\"xxx\\"}, {\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"value\\":\\"xxx\\"}, {\\"key\\":\\"EcsHighCpuUtilization_xxxx\\", \\"value\\":\\"xxx\\"}, ]\\n CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\n 2023-07-01 00:00:00\\n 2023-07-01 00:00:00\\n 40200899\\n false\\n ecs\\n {\\"resourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\"resourceName\\": \\"ecs-20230701\\",\\"regionId\\": \\"cn-hangzhou\\",...}\\n i-2zecnwitr2s7aca6****\\n 1\\n \\n \\n","errorExample":""}]', 'title' => '分页获取最新巡检结果', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'GetTaskStatusById' => [ 'summary' => '根据任务ID查询任务执行状态。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '所要查询的任务ID。', 'type' => 'string', 'required' => true, 'example' => '95906135', ], ], ], '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' => '566331F9-5AB3-550F-B745-A730331F97A9'."\n", ], 'Data' => [ 'description' => '请求返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '95906135', ], 'TaskStatus' => [ 'description' => '任务状态：'."\n" .'- **1**: 任务进行中'."\n" .'- **2**: 任务已完成'."\n" .'- **3**: 任务执行失败', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'The user is not authorized to operate on the specified resource, or this API does not support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\\\n\\",\\n \\"Data\\": {\\n \\"TaskId\\": 95906135,\\n \\"TaskStatus\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n\\n \\n 95906135\\n 1\\n \\n","errorExample":""}]', 'title' => '查询任务状态', ], 'GetHistoryAdvices' => [ 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '请求使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'Severity', 'in' => 'query', 'schema' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => '时间范围查询条件起始时间，输入日期格式为 yyyy-mm-dd。', 'type' => 'string', 'required' => false, 'example' => '2023-07-01', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => '时间范围查询条件结束时间，输入日期格式为 yyyy-mm-dd。', 'type' => 'string', 'required' => false, 'example' => '2023-07-01'."\n", ], ], [ 'name' => 'Reverse', 'in' => 'query', 'schema' => [ 'description' => '是否降序：'."\n" ."\n" .' - **true**：按降序排序'."\n" .' - **false**：按升序排序', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Data' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Total' => [ 'description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'description' => '查询结果对象数组。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'Severity' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'GmtCreated' => [ 'description' => '巡检项结果创建时间，格式为yyyy-mm-dd hh:mm:ss。', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明。', 'type' => 'string', 'example' => 'CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高', ], 'CheckId' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsHighCpuUtilization', ], 'ResourceId' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'example' => 'i-2zecnwitr2s7aca6****', ], 'CheckName' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => 'ECS 性能负载巡检', ], 'Url' => [ 'description' => '巡检项对应资源跳转url。', 'type' => 'string', 'example' => 'https://ecs.console.aliyun.com/#/server/i-2zecnwitr2s7aca6****/detail?regionId=cn-hangzhou', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'The user is not authorized to operate on the specified resource, or this API does not support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"Total\\": 100,\\n \\"Result\\": [\\n {\\n \\"Severity\\": 1,\\n \\"Product\\": \\"ecs\\",\\n \\"GmtCreated\\": \\"2023-07-01 00:00:00\\",\\n \\"Description\\": \\"CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\",\\n \\"CheckId\\": \\"EcsHighCpuUtilization\\",\\n \\"ResourceId\\": \\"i-2zecnwitr2s7aca6****\\",\\n \\"CheckName\\": \\"ECS 性能负载巡检\\",\\n \\"Url\\": \\"https://ecs.console.aliyun.com/#/server/i-2zecnwitr2s7aca6****/detail?regionId=cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 566331F9-5AB3-550F-B745-A730331F97A9\\n \\n 1\\n 100\\n \\n 1\\n ecs\\n 2023-07-01 00:00:00\\n CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\n EcsHighCpuUtilization\\n i-2zecnwitr2s7aca6****\\n ECS 性能负载巡检\\n https://ecs.console.aliyun.com/#/server/i-2zecnwitr2s7aca6****/detail?regionId=cn-hangzhou\\n \\n \\n","errorExample":""}]', 'title' => '分页获取历史巡检结果', 'summary' => '分页获取历史巡检结果，按产品、日期、严重级别查询。', ], 'DescribeAdvicesFlatPage' => [ 'summary' => '可根据多个维度获取用户最新的巡检结果，分页返回（部分字段展平）。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'AdviceId', 'in' => 'query', 'schema' => [ 'description' => '巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345678', ], ], [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => '巡检项Code。', 'type' => 'string', 'required' => false, 'example' => 'EcsHighCpuUtilization', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-2zecnwitr2s7aca6****'."\n", ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '请求使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Data' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Total' => [ 'description' => '数据总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Result' => [ 'description' => '查询结果对象数组。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'AliyunId' => [ 'description' => '阿里云用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '192895059480****', ], 'CheckId' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsHighCpuUtilization', ], 'CheckName' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => 'ECS 性能负载巡检', ], 'Content' => [ 'description' => '结果Json详情，与控制台配置的展示列格式保持一致，展平返回。', 'type' => 'string', 'example' => '[{"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, ]', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明。', 'type' => 'string', 'example' => 'CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高', ], 'GmtCreated' => [ 'description' => '巡检项结果创建时间，格式为yyyy-mm-dd hh:mm:ss', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'GmtModified' => [ 'description' => '巡检项结果更新时间，格式为yyyy-mm-dd hh:mm:ss', 'type' => 'string', 'example' => '2023-07-01 00:00:00', ], 'Id' => [ 'description' => '巡检结果ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '40200899', ], 'IsExpired' => [ 'description' => '是否已过期：'."\n" ."\n" .'- **false**: 未过期，'."\n" .'- **true**: 已过期', 'type' => 'boolean', 'example' => 'false', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'Resource' => [ 'description' => '资源详情Json，具体请参考各个云产品实例详情查询相关api文档，展平返回。', 'type' => 'string', 'example' => '{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...}', ], 'ResourceId' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'example' => 'i-bp67acfmxazb4p****', ], 'Severity' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Result\\": [\\n {\\n \\"AliyunId\\": 0,\\n \\"CheckId\\": \\"EcsHighCpuUtilization\\",\\n \\"CheckName\\": \\"ECS 性能负载巡检\\",\\n \\"Content\\": \\"[{\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, {\\\\\\"key\\\\\\":\\\\\\"EcsHighCpuUtilization_xxxx\\\\\\", \\\\\\"value\\\\\\":\\\\\\"xxx\\\\\\"}, ]\\",\\n \\"Description\\": \\"CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高\\",\\n \\"GmtCreated\\": \\"2023-07-01 00:00:00\\",\\n \\"GmtModified\\": \\"2023-07-01 00:00:00\\",\\n \\"Id\\": 40200899,\\n \\"IsExpired\\": false,\\n \\"Product\\": \\"ecs\\",\\n \\"Resource\\": \\"{\\\\\\"resourceId\\\\\\": \\\\\\"i-2zecnwitr2s7aca6****\\\\\\",\\\\\\"resourceName\\\\\\": \\\\\\"ecs-20230701\\\\\\",\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",...}\\",\\n \\"ResourceId\\": \\"i-bp67acfmxazb4p****\\",\\n \\"Severity\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '分页获取最新巡检结果(展平)', ], 'GetProductList' => [ 'summary' => '获取云产品的列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Token', 'in' => 'query', 'schema' => [ 'description' => '所需的Token。', 'type' => 'string', 'required' => false, 'example' => '****', ], ], ], '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' => '566331F9-****-550F-B745-A730331F97A9'."\n", ], 'Data' => [ 'description' => '请求返回数据。', 'type' => 'array', 'items' => [ 'description' => '请求返回数据。', 'type' => 'object', 'properties' => [ 'Category' => [ 'description' => '云产品分类：', 'type' => 'string', 'example' => '"大数据计算"'."\n", ], 'ProductList' => [ 'description' => '阿里云产品列表', 'type' => 'array', 'items' => [ 'description' => '接入的产品列表。', 'type' => 'object', 'properties' => [ 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'hologres', ], 'NewLabel' => [ 'description' => '云产品中文描述', 'type' => 'string', 'example' => '实时数仓 Hologres', ], ], ], ], ], ], ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True', ], 'Code' => [ 'description' => '请求编码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '详细信息', 'type' => 'string', 'example' => 'success', ], 'UserMessage' => [ 'description' => '提示详情', 'type' => 'string', 'example' => '*', ], 'AccessDeniedDetail' => [ 'description' => '权限校验失败详情。', 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'description' => '鉴权Action', 'type' => 'string', 'example' => '*', ], 'AuthPrincipalDisplayName' => [ 'description' => '授权主体显示名称。', 'type' => 'string', 'example' => '*', ], 'AuthPrincipalOwnerId' => [ 'description' => '鉴权主账号id。', 'type' => 'string', 'example' => '*', ], 'AuthPrincipalType' => [ 'description' => '授权类型', 'type' => 'string', 'example' => '*', ], 'EncodedDiagnosticMessage' => [ 'description' => '异常信息', 'type' => 'string', 'example' => '****', ], 'NoPermissionType' => [ 'description' => '无权限类型。', 'type' => 'string', 'example' => '*', ], 'PolicyType' => [ 'description' => '鉴权类型', 'type' => 'string', 'example' => '*', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'The user is not authorized to operate on the specified resource, or this API does not support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"566331F9-****-550F-B745-A730331F97A9\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"Category\\": \\"\\\\\\"大数据计算\\\\\\"\\\\n\\",\\n \\"ProductList\\": [\\n {\\n \\"Product\\": \\"hologres\\",\\n \\"NewLabel\\": \\"实时数仓 Hologres\\"\\n }\\n ]\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"UserMessage\\": \\"*\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"*\\",\\n \\"AuthPrincipalDisplayName\\": \\"*\\",\\n \\"AuthPrincipalOwnerId\\": \\"*\\",\\n \\"AuthPrincipalType\\": \\"*\\",\\n \\"EncodedDiagnosticMessage\\": \\"****\\",\\n \\"NoPermissionType\\": \\"*\\",\\n \\"PolicyType\\": \\"*\\"\\n }\\n}","type":"json"}]', 'title' => '获取全量产品', ], 'DescribeCostCheckResults' => [ 'summary' => '查询巡检项聚合成本优化结果概览', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], ], 'parameters' => [ [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecs', ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '检查项的ID列表。', 'type' => 'array', 'items' => [ 'description' => '检查项的ID列表。', 'type' => 'string', 'required' => false, 'example' => 'EcsCostLowUtilizationCheck', ], 'required' => false, 'docRequired' => false, ], ], [ 'name' => 'Severity', 'in' => 'query', 'schema' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'description' => '资源名称。', 'type' => 'string', 'required' => false, 'example' => 'SYNC_********_TASK', ], ], [ 'name' => 'RegionIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '地域ID集合 为数组格式对象', 'type' => 'array', 'items' => [ 'description' => '地域ID列表；属于查询的过滤条件，支持多选，以","号分割；默认查询所有。', 'type' => 'string', 'required' => false, 'example' => '[\\"ap-southeast-1\\"]', ], 'required' => false, ], ], [ 'name' => 'ResourceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '资源ID列表。最多支持100个ID。', 'type' => 'array', 'items' => [ 'description' => '要查询的DDoS高防（中国内地）实例的ID列表。', 'type' => 'string', 'required' => false, 'example' => '[\\"Create-cpdprod\\"]', ], 'required' => false, ], ], [ 'name' => 'AssumeAliyunIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '查询成员账号id集合', 'type' => 'array', 'items' => [ 'description' => '查询成员账号id集合', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[180*********100]', ], 'required' => false, ], ], [ 'name' => 'GroupBy', 'in' => 'query', 'schema' => [ 'description' => '指定分组的维度，各场景取值：'."\n" .'- Category：按类型分组(默认值)。 '."\n" .'- Product：按产品分组。', 'type' => 'string', 'required' => false, 'example' => 'Category', ], ], [ 'name' => 'TagKeys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '符合条件的标签键列表。', 'type' => 'array', 'items' => [ 'description' => '标签键详情列表。', 'type' => 'string', 'required' => false, 'example' => '[{\'TagKey\': \'acs:tag:createdby\', \'TagCount\': 1}]', ], 'required' => false, ], ], [ 'name' => 'TagValues', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '标签值', 'type' => 'array', 'items' => [ 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => '{\'TagValue\': []}', ], 'required' => false, ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '标签列表', 'type' => 'array', 'items' => [ 'description' => '业务标签', 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'ERP', ], 'TagValue' => [ 'description' => '标签值', 'type' => 'array', 'items' => [ 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => '1', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'ResourceGroupIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '资源组id筛选项', 'type' => 'array', 'items' => [ 'description' => '资源组id', 'type' => 'string', 'required' => false, 'example' => 'xxxx', ], 'required' => false, ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'ResourceCount' => [ 'description' => '各类型资源数量', 'type' => 'integer', 'format' => 'int32', 'example' => '76', ], 'AdviceResourceCount' => [ 'description' => '巡检资源数', 'type' => 'integer', 'format' => 'int32', 'example' => '巡检资源数量', ], 'TotalCount' => [ 'description' => '分页信息：总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'WarningCount' => [ 'description' => 'Warning事件数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NormalCount' => [ 'description' => '正常数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GroupBy' => [ 'description' => '指定分组的维度，各场景取值：'."\n" .'- Category：按类型分组(默认值)。 '."\n" .'- Product：按产品分组。', 'type' => 'string', 'example' => 'Category', ], 'ViewGroup' => [ 'description' => '分组展示项', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupCode' => [ 'description' => '分组code，按照GroupBy入参不同分为两种情况：'."\n" .'- **Product**: '."\n" .' * 产品code'."\n" ."\n" .'- **Category**: '."\n" .' * 21 低资源利用率'."\n" .' * 22 闲置资源'."\n" .' * 23 付费方式', 'type' => 'string', 'example' => '22', ], 'GroupName' => [ 'description' => '分组名称', 'type' => 'string', 'example' => 'aut***8ainRh1', ], 'GroupCount' => [ 'description' => '分组数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'GroupExpectedSavingCost' => [ 'description' => '分组预计可节省金额', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'CheckItems' => [ 'description' => '用户自定义检查配置名称。', 'type' => 'array', 'items' => [ 'description' => '检查项风险的描述类型为text时的文本内容。', 'type' => 'object', 'properties' => [ 'Severity' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AdviceCount' => [ 'description' => '满足该巡检规则的云产品实例数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Summary' => [ 'description' => '按照product分类，各产品有多少个诊断建议', 'type' => 'string', 'example' => 'true', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'slb', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明。', 'type' => 'string', 'example' => '云盘创建时间超过设置的阈值天，未挂载实例', ], 'Tips' => [ 'description' => '巡检建议一句话简述。', 'type' => 'string', 'example' => '云盘闲置资源建议结合实际业务考虑对实例进行释放，参考文档。', ], 'CheckId' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EbsCostIdleCheck', ], 'Category' => [ 'description' => '巡检项分类：'."\n" ."\n" .'- **1**: 安全合规'."\n" ."\n" .'- **2**: 性能效率'."\n" ."\n" .'- **3**: 业务稳定'."\n" ."\n" .'- **4**: 成本优化'."\n" ."\n" .'- **5**: 服务限制', 'type' => 'string', 'example' => '4', ], 'CheckName' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => '云盘闲置资源检查', ], 'AdviceResourceCount' => [ 'description' => '巡检资源数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CurrentCost' => [ 'description' => '当前费用', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'OptimizedCost' => [ 'description' => '优化后费用', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'ExpectedSavingCost' => [ 'description' => '预计可节省', 'type' => 'number', 'format' => 'float', 'example' => '1', ], ], ], ], ], ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '566331F9-****-550F-B745-A730331F97A9', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'string', 'example' => 'True', ], 'Message' => [ 'description' => '错误信息。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ResourceCount\\": 76,\\n \\"AdviceResourceCount\\": 0,\\n \\"TotalCount\\": 4,\\n \\"WarningCount\\": 1,\\n \\"NormalCount\\": 1,\\n \\"GroupBy\\": \\"Category\\",\\n \\"ViewGroup\\": [\\n {\\n \\"GroupCode\\": \\"22\\",\\n \\"GroupName\\": \\"aut***8ainRh1\\",\\n \\"GroupCount\\": 0,\\n \\"GroupExpectedSavingCost\\": 1,\\n \\"CheckItems\\": [\\n {\\n \\"Severity\\": 1,\\n \\"AdviceCount\\": 100,\\n \\"Summary\\": \\"true\\",\\n \\"Product\\": \\"slb\\",\\n \\"Description\\": \\"云盘创建时间超过设置的阈值天，未挂载实例\\",\\n \\"Tips\\": \\"云盘闲置资源建议结合实际业务考虑对实例进行释放，参考文档。\\",\\n \\"CheckId\\": \\"EbsCostIdleCheck\\",\\n \\"Category\\": \\"4\\",\\n \\"CheckName\\": \\"云盘闲置资源检查\\",\\n \\"AdviceResourceCount\\": 1,\\n \\"CurrentCost\\": 1,\\n \\"OptimizedCost\\": 1,\\n \\"ExpectedSavingCost\\": 1\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"566331F9-****-550F-B745-A730331F97A9\\",\\n \\"Success\\": \\"True\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '巡检项聚合成本优化结果概览', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'DescribeCostCheckAdvices' => [ 'summary' => '查询成本优化结果详情', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], ], 'parameters' => [ [ 'name' => 'CheckId', 'in' => 'query', 'schema' => [ 'description' => '巡检项Code。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'EcsCostLowUtilizationCheck', ], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'description' => '资源名称。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'Severity', 'in' => 'query', 'schema' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RegionIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '边缘节点ID列表；属于查询的过滤条件，支持多选，以","号分割；默认查询所有。', 'type' => 'array', 'items' => [ 'description' => '地域信息列表。', 'type' => 'string', 'required' => false, 'example' => '[\\"cn-beijing\\"]', ], 'required' => false, ], ], [ 'name' => 'ResourceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '资源ID列表（即实例名称列表）。', 'type' => 'array', 'items' => [ 'description' => '要查询的实例的ID列表。', 'type' => 'string', 'required' => false, 'example' => '[\\"trigger_hotfix_install\\"]', ], 'required' => false, ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '实例状态列表的页码。起始值：1。默认值：1 。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ 'description' => '使用的语言。', 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], [ 'name' => 'TagKeys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '符合条件的标签键列表。', 'type' => 'array', 'items' => [ 'description' => '标签键集合。', 'type' => 'string', 'required' => false, 'example' => '[]', ], 'required' => false, ], ], [ 'name' => 'TagValues', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '标签值', 'type' => 'array', 'items' => [ 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => '[\'x20\', \'x29\', \'x30\']', ], 'required' => false, ], ], [ 'name' => 'AssumeAliyunIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '查询成员账号id集合', 'type' => 'array', 'items' => [ 'description' => '查询成员账号id集合', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[1802******3100]', ], 'required' => false, ], ], [ 'name' => 'TagList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '标签列表', 'type' => 'array', 'items' => [ 'description' => '标签列表', 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => '标签键', 'type' => 'string', 'required' => false, 'example' => 'ecs_***_shanghai', ], 'TagValue' => [ 'description' => '标签值', 'type' => 'array', 'items' => [ 'description' => '标签值', 'type' => 'string', 'required' => false, 'example' => 'region', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], [ 'name' => 'ResourceGroupIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', 'required' => false, ], 'required' => false, ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'PageNumber' => [ 'description' => '分页信息：当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageSize' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CheckId' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsHighCpuUtilization', ], 'AdviceList' => [ 'description' => '巡检结果集合', 'type' => 'array', 'items' => [ 'description' => '巡检结果', 'type' => 'object', 'properties' => [ 'AliyunId' => [ 'description' => '阿里云用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '111******767', ], 'ResourceId' => [ 'description' => '资源/实例ID。', 'type' => 'string', 'example' => 'i-2ze5*****ef7d2lk63in', ], 'ResourceName' => [ 'description' => '资源名称。', 'type' => 'string', 'example' => '1200***bles_df', ], 'Product' => [ 'description' => '云产品Code。', 'type' => 'string', 'example' => 'ecs', ], 'RegionId' => [ 'description' => '地域信息。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Severity' => [ 'description' => '严重级别：'."\n" ."\n" .'- **1**: 警告'."\n" .'- **2**: 严重', 'type' => 'string', 'example' => '1', ], 'Content' => [ 'description' => '结果Json详情，与控制台配置的展示列格式保持一致。', 'type' => 'string', 'example' => '{\'Domains\': [{\'Status\': \'success\', \'\': \'cn\', \'DomainName\': \'www.****.com\', Region\'Desc\': \'ok\'}]}', ], 'StartTime' => [ 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-02-04T16:00:00Z', ], 'EndTime' => [ 'description' => '查询的结束时间。'."\n" ."\n" .'日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-05T02:02:00Z', ], 'GmtDeleted' => [ 'description' => '删除时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-03-05T02:02:00Z'."\n", ], 'Url' => [ 'description' => '巡检项对应资源跳转url。', 'type' => 'string', 'example' => 'https://fs1.xuece.cn/exam/import/***/30***0-9d16-c07b43c8ca6a.png', ], 'UserName' => [ 'description' => '用户名称', 'type' => 'string', 'example' => 'test', ], 'ZoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-h', ], 'Tags' => [ 'description' => '服务标签键', 'type' => 'array', 'items' => [ 'description' => 'Tag的键。', 'type' => 'object', 'properties' => [ 'TagKey' => [ 'description' => '标签键。', 'type' => 'string', 'example' => 'autoTest-7', ], 'TagValue' => [ 'description' => '标签值。', 'type' => 'string', 'example' => 'basic', ], ], ], ], 'AccountFolderId' => [ 'description' => '资源夹id', 'type' => 'string', 'example' => '1', ], 'AccountFolderName' => [ 'description' => '资源夹名称', 'type' => 'string', 'example' => '1', ], 'Email' => [ 'description' => 'Email', 'type' => 'string', 'example' => 'xxx', ], ], ], ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '566331F9-****-550F-B745-A730331F97A9', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'string', 'example' => 'True', ], 'Message' => [ 'description' => '消息。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 0,\\n \\"PageNumber\\": 4,\\n \\"PageSize\\": 10,\\n \\"CheckId\\": \\"EcsHighCpuUtilization\\",\\n \\"AdviceList\\": [\\n {\\n \\"AliyunId\\": 0,\\n \\"ResourceId\\": \\"i-2ze5*****ef7d2lk63in\\",\\n \\"ResourceName\\": \\"1200***bles_df\\",\\n \\"Product\\": \\"ecs\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"Severity\\": \\"1\\",\\n \\"Content\\": \\"{\'Domains\': [{\'Status\': \'success\', \'\': \'cn\', \'DomainName\': \'www.****.com\', Region\'Desc\': \'ok\'}]}\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"GmtDeleted\\": 0,\\n \\"Url\\": \\"https://fs1.xuece.cn/exam/import/***/30***0-9d16-c07b43c8ca6a.png\\",\\n \\"UserName\\": \\"test\\",\\n \\"ZoneId\\": \\"cn-beijing-h\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"autoTest-7\\",\\n \\"TagValue\\": \\"basic\\"\\n }\\n ],\\n \\"AccountFolderId\\": \\"1\\",\\n \\"AccountFolderName\\": \\"1\\",\\n \\"Email\\": \\"xxx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"566331F9-****-550F-B745-A730331F97A9\\",\\n \\"Success\\": \\"True\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '成本优化结果详情', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'GetInspectProgress' => [ 'summary' => '获取任务执行进度(普通用户、RD单账号)', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', 'FEATUREadvisorKJHIKI', ], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '所要查询的任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '95***135', ], ], [ 'name' => 'AssumeAliyunId', 'in' => 'query', 'schema' => [ 'description' => '巡检主账号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14********37', ], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => [ 'description' => '集成ARMS Prometheus监控所需的Token。', 'type' => 'string', 'required' => false, 'example' => '***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '566331F9-****-550F-B745-A730331F97A9'."\n", ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], 'Message' => [ 'description' => '返回结果的提示信息。', 'type' => 'string', 'example' => 'Successful', ], 'Data' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'AllSubtaskCount' => [ 'description' => '所有子任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Finish' => [ 'description' => '任务是否结束：'."\n" ."\n" .'- **true**：任务结束。'."\n" .'- **false**：任务未结束。', 'type' => 'boolean', 'example' => 'True', ], 'FinishRate' => [ 'description' => '任务完成率。', 'type' => 'number', 'format' => 'double', 'example' => '1', ], 'FinishSubtaskCount' => [ 'description' => '完成子任务计数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'LastInspectDate' => [ 'description' => '上次检查日期', 'type' => 'integer', 'format' => 'int64', 'example' => '111', ], 'TaskId' => [ 'description' => '后台生成的任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '95***135', ], 'UsedTime' => [ 'description' => '耗时。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"566331F9-****-550F-B745-A730331F97A9\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"AllSubtaskCount\\": 100,\\n \\"Finish\\": true,\\n \\"FinishRate\\": 1,\\n \\"FinishSubtaskCount\\": 1,\\n \\"LastInspectDate\\": 111,\\n \\"TaskId\\": 0,\\n \\"UsedTime\\": 1\\n }\\n}","type":"json"}]', 'title' => '获取任务执行进度', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'RefreshAdvisorCostCheck' => [ 'summary' => '发起成本优化巡检', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], ], 'parameters' => [ [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'ResourceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '这次更新的资源ID。', 'type' => 'array', 'items' => [ 'description' => '资源ID列表， 列表的长度范围为1~20，JSON数组格式。', 'type' => 'string', 'required' => false, 'example' => 'asg-8*********0yv8lph44', ], 'required' => false, ], ], [ 'name' => 'CheckIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '检查项的ID列表。', 'type' => 'array', 'items' => [ 'description' => '检查项的ID列表。', 'type' => 'string', 'required' => false, 'example' => '["EcsCostLowUtilizationCheck"]', ], 'required' => false, 'docRequired' => true, ], ], [ 'name' => 'RefreshResource', 'in' => 'query', 'schema' => [ 'description' => '是否刷新资源状态 默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'AssumeAliyunIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '查询成员账号id集合', 'type' => 'array', 'items' => [ 'description' => '查询成员账号id集合', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[1802*****3100]', ], 'required' => false, ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '请求返回数据。', 'type' => 'object', 'properties' => [ 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true', ], 'CommandId' => [ 'description' => '命令ID。', 'type' => 'string', 'example' => 'c-wl*****n0g', ], 'TaskId' => [ 'description' => '后台生成的任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '959***135', ], 'ManagerTaskId' => [ 'description' => '后台生成的主任务ID（RD账号专用）', 'type' => 'integer', 'format' => 'int64', 'example' => '11***********35', ], ], ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '566331F9-****-550F-B745-A730331F97A9', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True', ], 'Message' => [ 'description' => '返回消息', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"CommandId\\": \\"c-wl*****n0g\\",\\n \\"TaskId\\": 0,\\n \\"ManagerTaskId\\": 0\\n },\\n \\"RequestId\\": \\"566331F9-****-550F-B745-A730331F97A9\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => '发起成本优化巡检', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'DescribeAdvisorChecksFoPages' => [ 'summary' => '巡检项设置-分页', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '218228', 'abilityTreeNodes' => [ 'FEATUREadvisorZ01KCY', ], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '算法库列表的页码。起始值：1。默认值：1 。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '巡检项名称。', 'type' => 'string', 'required' => false, 'example' => '****', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => '该参数为无效参数，成本优化暂不支持', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => '*', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '云产品Code。', 'type' => 'string', 'required' => false, 'example' => 'ecs', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '诊断项是否被禁用状态：'."\n" ."\n" .'- **enabled**: 可用'."\n" ."\n" .'- **disabled**: 禁用', 'type' => 'string', 'required' => false, 'example' => 'enabled', ], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => [ 'description' => '凭证Token内容。', 'type' => 'string', 'required' => false, 'example' => '***', ], ], [ 'name' => 'BizCategory', 'in' => 'query', 'schema' => [ 'description' => '巡检类型', 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'AssumeAliyunId', 'in' => 'query', 'schema' => [ 'description' => '巡检主账号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11*********35', ], ], [ 'name' => 'CheckTypes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '该参数为无效参数，成本优化暂不支持', 'type' => 'array', 'items' => [ 'description' => '巡检分类', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '*', ], 'required' => false, ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'description' => '该参数为无效参数，成本优化暂不支持', 'type' => 'string', 'required' => false, 'example' => '*', ], ], ], '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' => '566331F9-5AB3-550F-B745-A730331F97A9', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '查询结果对象体。', 'type' => 'array', 'items' => [ 'description' => '查询结果。', 'type' => 'object', 'properties' => [ 'PageNo' => [ 'description' => '分页号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每页数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Total' => [ 'description' => '数据总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Result' => [ 'description' => '查询结果对象体。', 'type' => 'array', 'items' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '巡检项名称。', 'type' => 'string', 'example' => 'ECS低利用率检查', ], 'Code' => [ 'description' => '巡检项Code。', 'type' => 'string', 'example' => 'EcsCostLowUtilizationCheck', ], 'Tips' => [ 'description' => '巡检建议一句话简述', 'type' => 'string', 'example' => 'ECS低利用率建议结合实际业务考虑对实例进行降配操作，参考文档。', ], 'Category' => [ 'description' => '巡检项分类：'."\n" ."\n" .'- **21**: 低资源利用率'."\n" ."\n" .'- **22**: 闲置资源'."\n" ."\n" .'- **23**: 付费方式'."\n" ."\n" .'- **24**: 代次升级', 'type' => 'string', 'example' => '21', ], 'SubCategory' => [ 'description' => '暂不支持返回', 'type' => 'array', 'items' => [ 'description' => '暂不支持', 'type' => 'integer', 'format' => 'int64', 'example' => '*', ], ], 'Status' => [ 'description' => '诊断项是否被禁用状态：'."\n" ."\n" .'- **enabled**: 可用'."\n" ."\n" .'- **disabled**: 禁用', 'type' => 'string', 'example' => 'enabled', ], 'ConfigSupport' => [ 'description' => '是否支持自定义配置', 'type' => 'string', 'example' => 'false', ], 'ViewColumn' => [ 'description' => '展示列，即控制台展示巡检项详情的具体配置。', 'type' => 'string', 'example' => '[{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_resourceId\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_resourceName\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_regionId\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_instanceChargeType\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_instanceType\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_severity\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_costBefore\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_costAfter\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"EcsCostIdleCheck_costSavings\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"First_time\\"},{\\"type\\":\\"DEFAULT\\",\\"key\\":\\"Duration_time\\"}]', ], 'OperateColumn' => [ 'description' => '操作字段，使用前端模板或诊断建议action中定义json字段。', 'type' => 'string', 'example' => '[{\\"type\\":\\"template\\",\\"value\\":\\"cloudmonitor.console.aliyun.com/index.htm?custom_trace=ecs_console#/hostDetail/chart/instanceId=${Resource.resourceId}&system=Linux®ion=${Resource.regionId}&aliyunhost=true\\",\\"key\\":\\"Detail\\"},{\\"type\\":\\"template\\",\\"value\\":\\"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\\",\\"key\\":\\"Refresh\\"}]'."\n", ], 'InspectionScope' => [ 'description' => '巡检范围', 'type' => 'string', 'example' => 'false', ], 'Product' => [ 'description' => '云产品Code', 'type' => 'string', 'example' => 'ECS', ], 'Description' => [ 'description' => '巡检项描述，推荐操作和操作说明', 'type' => 'string', 'example' => 'Advisor 将检查账号下所有ECS实例，规格为r5或g5规格的ECS，建议升级为r6或g6', ], 'Source' => [ 'description' => '巡检项来源。'."\n" .'- **Advisor**: 智能顾问自建巡检项'."\n" ."\n" .'- **Governance**: 云治理中心'."\n" ."\n" .'- **Config**: 配置审计', 'type' => 'string', 'example' => 'Advisor', ], 'RiskLevel' => [ 'description' => '风险等级'."\n" .'- 1：预警'."\n" ."\n" .'- 2：严重', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True', ], 'Message' => [ 'description' => '消息详情', 'type' => 'string', 'example' => 'OK', ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'User not authorized to operate on the specified resource, or this API doesn\'t support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"566331F9-5AB3-550F-B745-A730331F97A9\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Result\\": [\\n {\\n \\"Name\\": \\"ECS低利用率检查\\",\\n \\"Code\\": \\"EcsCostLowUtilizationCheck\\",\\n \\"Tips\\": \\"ECS低利用率建议结合实际业务考虑对实例进行降配操作，参考文档。\\",\\n \\"Category\\": \\"21\\",\\n \\"SubCategory\\": [\\n 0\\n ],\\n \\"Status\\": \\"enabled\\",\\n \\"ConfigSupport\\": \\"false\\",\\n \\"ViewColumn\\": \\"[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_resourceId\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_resourceName\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_regionId\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_instanceChargeType\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_instanceType\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_severity\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_costBefore\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_costAfter\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EcsCostIdleCheck_costSavings\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"First_time\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"DEFAULT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Duration_time\\\\\\\\\\\\\\"}]\\",\\n \\"OperateColumn\\": \\"[{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"template\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cloudmonitor.console.aliyun.com/index.htm?custom_trace=ecs_console#/hostDetail/chart/instanceId=${Resource.resourceId}&system=Linux®ion=${Resource.regionId}&aliyunhost=true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Detail\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"template\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Refresh\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"InspectionScope\\": \\"false\\",\\n \\"Product\\": \\"ECS\\",\\n \\"Description\\": \\"Advisor 将检查账号下所有ECS实例，规格为r5或g5规格的ECS，建议升级为r6或g6\\",\\n \\"Source\\": \\"Advisor\\",\\n \\"RiskLevel\\": 1\\n }\\n ]\\n }\\n ],\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', 'title' => '分页获取巡检项', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], 'DescribeCostOptimizationOverview' => [ 'summary' => '成本优化-概览', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '218237', 'abilityTreeNodes' => [ 'FEATUREadvisorP5QXH3', ], ], 'parameters' => [ [ 'name' => 'AssumeAliyunId', 'in' => 'query', 'schema' => [ 'description' => '巡检主账号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11***********35', ], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => [ 'description' => '请求所需的Token（暂不支持）。', 'type' => 'string', 'required' => false, 'example' => '***', ], ], [ 'name' => 'AssumeAliyunIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '查询成员账号id集合', 'type' => 'array', 'items' => [ 'description' => '查询成员账号id集合', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '[18**********00]', ], 'required' => false, ], ], [ 'name' => 'CheckPlanId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '566331F9-****-550F-B745-A730331F97A9', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => '200', ], 'Data' => [ 'description' => '查询结果对象体。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '后台生成的任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '95***135', ], 'CurrentBillingCost' => [ 'description' => '上一月支出金额', 'type' => 'string', 'example' => '100', ], 'BillingCycleDate' => [ 'description' => '账单周期（yyyy-MM）', 'type' => 'string', 'example' => '100', ], 'OptCheckItemNum' => [ 'description' => '可优化巡检项数量', 'type' => 'string', 'example' => '100', ], 'OptResourceNum' => [ 'description' => '最多可优化资源数量', 'type' => 'string', 'example' => '100', ], 'ExpectedSavingCost' => [ 'description' => '预计最多可节省金额', 'type' => 'string', 'example' => '100', ], 'GmtModified' => [ 'description' => '巡检项结果更新时间，格式为yyyy-mm-dd hh:mm:ss', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-07-01 00:00:00', ], 'WaitProcessResourceCount' => [ 'type' => 'string', ], 'ProcessedResourceCount' => [ 'type' => 'string', ], 'ProcessedSaveAmount' => [ 'type' => 'string', ], ], ], 'Message' => [ 'description' => '消息。', 'type' => 'string', 'example' => 'Internal service issue. Detail:.', ], 'Success' => [ 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True', ], 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息。', 'type' => 'object', 'properties' => [ 'AuthAction' => [ 'description' => 'AuthAction', 'type' => 'string', 'example' => 'null', ], 'AuthPrincipalDisplayName' => [ 'description' => '鉴权主体信息。', 'type' => 'string', 'example' => 'null', ], 'AuthPrincipalOwnerId' => [ 'description' => '鉴权主账号id。', 'type' => 'string', 'example' => 'null', ], 'AuthPrincipalType' => [ 'description' => '授权主体类型。', 'type' => 'string', 'example' => 'null', ], 'EncodedDiagnosticMessage' => [ 'description' => '异常信息', 'type' => 'string', 'example' => '*****', ], 'NoPermissionType' => [ 'description' => '无权限类型。', 'type' => 'string', 'example' => 'null', ], 'PolicyType' => [ 'description' => '策略类型。', 'type' => 'string', 'example' => 'PauseNotify', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'Rd.NoMasterRole', 'errorMessage' => 'Login account is not RD management or co-management role.', ], [ 'errorCode' => 'Forbidden.NotActivated', 'errorMessage' => 'User has not activated Advisor Service.', ], [ 'errorCode' => 'Forbidden.NotAuthorized', 'errorMessage' => 'User has not authorized Advisor to provide services.', ], [ 'errorCode' => 'Rd.NoManagePermission', 'errorMessage' => 'The RD management account does not have the specified member account management permission.', ], [ 'errorCode' => 'Forbidden.RAM', 'errorMessage' => 'The user is not authorized to operate on the specified resource, or this API does not support RAM.', ], ], 500 => [ [ 'errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"566331F9-****-550F-B745-A730331F97A9\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"CurrentBillingCost\\": \\"100\\",\\n \\"BillingCycleDate\\": \\"100\\",\\n \\"OptCheckItemNum\\": \\"100\\",\\n \\"OptResourceNum\\": \\"100\\",\\n \\"ExpectedSavingCost\\": \\"100\\",\\n \\"GmtModified\\": 0,\\n \\"WaitProcessResourceCount\\": \\"\\",\\n \\"ProcessedResourceCount\\": \\"\\",\\n \\"ProcessedSaveAmount\\": \\"\\"\\n },\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"Success\\": true,\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"null\\",\\n \\"AuthPrincipalDisplayName\\": \\"null\\",\\n \\"AuthPrincipalOwnerId\\": \\"null\\",\\n \\"AuthPrincipalType\\": \\"null\\",\\n \\"EncodedDiagnosticMessage\\": \\"*****\\",\\n \\"NoPermissionType\\": \\"null\\",\\n \\"PolicyType\\": \\"PauseNotify\\"\\n }\\n}","type":"json"}]', 'title' => '成本数据概览', 'description' => '不兼容Go SDK，如需要Go SDK请使用DescribeAdvicesFlatPage API。', ], ], 'endpoints' => [ [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'advisor.cn-hangzhou.aliyuncs.com', ], ], ];