'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Advisor',
'version' => '2018-01-20',
],
'directories' => [
[
'id' => 204006,
'title' => null,
'type' => 'directory',
'children' => [
'DescribeAdvisorChecks',
'DescribeAdvices',
'DescribeAdvisorResources',
'RefreshAdvisorCheck',
'RefreshAdvisorResource',
'DescribeAdvicesPage',
'GetTaskStatusById',
'GetHistoryAdvices',
'DescribeAdvicesFlatPage',
],
],
[
'id' => 204007,
'title' => null,
'type' => 'directory',
'children' => [
'GetProductList',
'DescribeCostCheckResults',
'DescribeCostCheckAdvices',
'GetInspectProgress',
'RefreshAdvisorCostCheck',
'DescribeAdvisorChecksFoPages',
'DescribeCostOptimizationOverview',
],
],
],
'components' => [
'schemas' => [],
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '566331F9-5AB3-550F-B745-A730331F97A9'."\n",
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AdvisorCheck' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'enabled',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'ecs',
],
'OperateColumn' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'ViewColumn' => [
'description' => '',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "type":"DEFAULT"'."\n"
.' },'."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "type":"DEFAULT"'."\n"
.' },'."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "type":"DEFAULT"'."\n"
.' },'."\n"
.']',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Tips' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'EcsHighCpuUtilization',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
],
],
],
'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":""}]',
],
'DescribeAdvices' => [
'summary' => '根据多个维度获取用户最新的巡检结果,全量返回-openApi',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'CheckId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'EcsHighCpuUtilization',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'i-bp67acfmxazb4p****',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'ExcludeAdviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'Product',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'CheckPlanId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'ecs',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'IsExpired' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'Resource' => [
'description' => '',
'type' => 'string',
'example' => '{'."\n"
.' "resourceId": xxxx,'."\n"
.' "resourceName": xxxxxx,'."\n"
.' "regionId": xxxx,'."\n"
.' ...'."\n"
.'}',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'CheckId' => [
'description' => '',
'type' => 'string',
'example' => 'EcsHighCpuUtilization',
],
'AliyunId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567891234567',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp67acfmxazb4p****',
],
'Content' => [
'description' => '',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "value":xxx'."\n"
.' },'."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "value":xxx'."\n"
.' },'."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "value":xxx'."\n"
.' },'."\n"
.']',
],
'Id' => [
'description' => 'ID',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'CheckName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'CheckPlanId' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
'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":""}]',
],
'DescribeAdvisorResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'i-bp67acfmxazb4p****'."\n",
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'abcd',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'Product',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => '{'."\n"
.' "resourceId": "xxxxx",'."\n"
.' "deviceAvailable": true,'."\n"
.' ...'."\n"
.'}',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp67acfmxazb4p****',
],
'Product' => [
'description' => '',
'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":""}]',
],
'RefreshAdvisorCheck' => [
'summary' => '触发立即巡检',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'i-bp67acfmxazb4p****',
],
],
[
'name' => 'CheckId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'EcsHighCpuUtilization',
],
],
[
'name' => 'Product',
'in' => 'query',
'schema' => [
'description' => '',
'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',
],
'Security' => [
'type' => 'boolean',
],
'Performance' => [
'type' => 'boolean',
],
'Reliablility' => [
'type' => 'boolean',
],
'Cost' => [
'type' => 'boolean',
],
'Service' => [
'type' => 'boolean',
],
'ProductName' => [
'type' => 'string',
],
],
],
],
],
[
'name' => 'AssumeAliyunId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
[
'name' => 'CheckPlanId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'TraceId' => [
'description' => '',
'type' => 'string',
'example' => 'manual-1be17af1121b4974822e69daee4f2481',
],
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '12345678',
],
'Message' => [
'type' => 'string',
],
],
],
'RequestId' => [
'description' => '',
'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":""}]',
],
'RefreshAdvisorResource' => [
'summary' => 'RefreshAdvisorResource',
'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' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ecs',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'i-bp67acfmxazb4p****',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '12345678',
],
'RequestId' => [
'description' => '',
'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":""}]',
],
'DescribeAdvicesPage' => [
'summary' => 'DescribeAdvices分页',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'CheckId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'EcsHighCpuUtilization',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'i-bp67acfmxazb4p****',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'Product',
'in' => 'query',
'schema' => [
'description' => '',
'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' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => ' '."\n"
.'1234567891234567',
],
'CheckId' => [
'description' => '',
'type' => 'string',
'example' => 'EcsHighCpuUtilization',
],
'CheckName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Content' => [
'description' => '',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "value":xxx'."\n"
.' },'."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "value":xxx'."\n"
.' },'."\n"
.' {'."\n"
.' "key":"EcsHighCpuUtilization_xxxx",'."\n"
.' "value":xxx'."\n"
.' },'."\n"
.']',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'Id' => [
'description' => 'ID',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'IsExpired' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'ecs',
],
'Resource' => [
'description' => '',
'type' => 'string',
'example' => '{'."\n"
.' "resourceId": xxxx,'."\n"
.' "resourceName": xxxxxx,'."\n"
.' "regionId": xxxx,'."\n"
.' ...'."\n"
.'}',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp67acfmxazb4p****',
],
'Severity' => [
'description' => '',
'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":""}]',
],
'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' => '',
'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' => '',
'type' => 'string',
'example' => '566331F9-5AB3-550F-B745-A730331F97A9'."\n",
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '95906135',
],
'TaskStatus' => [
'description' => '',
'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":""}]',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'Severity',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '2023-07-01',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2023-07-01'."\n",
],
],
[
'name' => 'Reverse',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'ecs',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'CheckId' => [
'description' => '',
'type' => 'string',
'example' => 'EcsHighCpuUtilization',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp67acfmxazb4p****',
],
'CheckName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Url' => [
'description' => '',
'type' => 'string',
'example' => 'https://ecs.console.aliyun.com/#/server/i-bp67acfmxazb4p****/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":""}]',
],
'DescribeAdvicesFlatPage' => [
'summary' => 'DescribeAdvicesFlat分页',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'AdviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'CheckId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'EcsHighCpuUtilization',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '192895059480****',
],
'CheckId' => [
'description' => '',
'type' => 'string',
'example' => 'EcsHighCpuUtilization',
],
'CheckName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Content' => [
'description' => '',
'type' => 'string',
'example' => '[{"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, ]',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'GmtCreated' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'GmtModified' => [
'description' => '',
'type' => 'string',
'example' => '2023-07-01 00:00:00',
],
'Id' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '40200899',
],
'IsExpired' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'ecs',
],
'Resource' => [
'description' => '',
'type' => 'string',
'example' => '{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...}',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'i-bp67acfmxazb4p****',
],
'Severity' => [
'description' => '',
'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"}]',
],
'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' => '',
'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' => '',
'type' => 'string',
'example' => '566331F9-****-550F-B745-A730331F97A9'."\n",
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Category' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ProductList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'hologres',
],
'NewLabel' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
'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' => '',
'type' => 'string',
'example' => '*',
],
'AuthPrincipalDisplayName' => [
'description' => '',
'type' => 'string',
'example' => '*',
],
'AuthPrincipalOwnerId' => [
'description' => '',
'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"}]',
],
'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' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ecs',
],
],
[
'name' => 'CheckIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'EcsCostLowUtilizationCheck',
],
'required' => false,
'docRequired' => false,
],
],
[
'name' => 'Severity',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"ap-southeast-1\\"]',
],
'required' => false,
],
],
[
'name' => 'ResourceIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"Create-cpdprod\\"]',
],
'required' => false,
],
],
[
'name' => 'AssumeAliyunIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '[180*********100]',
],
'required' => false,
],
],
[
'name' => 'GroupBy',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'xxxx',
],
'required' => false,
],
],
[
'name' => 'CheckPlanId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'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' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NormalCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'GroupBy' => [
'description' => '',
'type' => 'string',
'example' => 'Category',
],
'ViewGroup' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupCode' => [
'description' => '',
'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' => '',
'type' => 'object',
'properties' => [
'Severity' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AdviceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Summary' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'slb',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Tips' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'CheckId' => [
'description' => '',
'type' => 'string',
'example' => 'EbsCostIdleCheck',
],
'Category' => [
'description' => '',
'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"}]',
],
'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' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegionIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"cn-beijing\\"]',
],
'required' => false,
],
],
[
'name' => 'ResourceIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '[\\"trigger_hotfix_install\\"]',
],
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'array',
'items' => [
'description' => '',
'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',
],
],
[
'name' => 'ResourceGroupIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'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' => '',
'type' => 'string',
'example' => 'EcsHighCpuUtilization',
],
'AdviceList' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'AliyunId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '111******767',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'i-2ze5*****ef7d2lk63in',
],
'ResourceName' => [
'description' => '',
'type' => 'string',
'example' => '1200***bles_df',
],
'Product' => [
'description' => '',
'type' => 'string',
'example' => 'ecs',
],
'RegionId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-shanghai',
],
'Severity' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'Content' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => 'https://fs1.xuece.cn/exam/import/***/30***0-9d16-c07b43c8ca6a.png',
],
'UserName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'ZoneId' => [
'description' => '',
'type' => 'string',
'example' => 'cn-beijing-h',
],
'Tags' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '',
'type' => 'string',
'example' => 'autoTest-7',
],
'TagValue' => [
'description' => '',
'type' => 'string',
'example' => 'basic',
],
],
],
],
'AccountFolderId' => [
'description' => '',
'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"}]',
],
'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' => '',
'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' => '',
'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' => '',
'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' => '',
'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"}]',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'ResourceIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'asg-8*********0yv8lph44',
],
'required' => false,
],
],
[
'name' => 'CheckIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '["EcsCostLowUtilizationCheck"]',
],
'required' => false,
'docRequired' => true,
],
],
[
'name' => 'RefreshResource',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'AssumeAliyunIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '[1802*****3100]',
],
'required' => false,
],
],
[
'name' => 'CheckPlanId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'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' => '',
'type' => 'string',
'example' => 'c-wl*****n0g',
],
'TaskId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '959***135',
],
'ManagerTaskId' => [
'description' => '',
'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"}]',
],
'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' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'ecs',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'enabled',
],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
],
'Code' => [
'description' => '',
'type' => 'string',
'example' => 'EcsCostLowUtilizationCheck',
],
'Tips' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Category' => [
'description' => '',
'type' => 'string',
'example' => '21',
],
'SubCategory' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '*',
],
],
'Status' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => 'ECS',
],
'Description' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'Advisor',
],
'RiskLevel' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
'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"}]',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => '***',
],
],
[
'name' => 'AssumeAliyunIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '[18**********00]',
],
'required' => false,
],
],
[
'name' => 'CheckPlanId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
'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' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '95***135',
],
'CurrentBillingCost' => [
'description' => '',
'type' => 'string',
'example' => '100',
],
'BillingCycleDate' => [
'description' => '',
'type' => 'string',
'example' => '100',
],
'OptCheckItemNum' => [
'description' => '',
'type' => 'string',
'example' => '100',
],
'OptResourceNum' => [
'description' => '',
'type' => 'string',
'example' => '100',
],
'ExpectedSavingCost' => [
'description' => '',
'type' => 'string',
'example' => '100',
],
'GmtModified' => [
'description' => '',
'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' => '',
'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"}]',
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'advisor.cn-hangzhou.aliyuncs.com',
],
],
];