diff options
Diffstat (limited to 'data/en_us/sysom/2023-12-30/api-docs.php')
| -rw-r--r-- | data/en_us/sysom/2023-12-30/api-docs.php | 14286 |
1 files changed, 7237 insertions, 7049 deletions
diff --git a/data/en_us/sysom/2023-12-30/api-docs.php b/data/en_us/sysom/2023-12-30/api-docs.php index 16ea07a..8c5bf2c 100644 --- a/data/en_us/sysom/2023-12-30/api-docs.php +++ b/data/en_us/sysom/2023-12-30/api-docs.php @@ -1,173 +1,76 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'SysOM', - 'version' => '2023-12-30', - ], + 'info' => ['style' => 'ROA', 'product' => 'SysOM', 'version' => '2023-12-30'], 'directories' => [ [ - 'id' => 249151, - 'title' => null, + 'children' => ['CreateInstanceInspection'], 'type' => 'directory', - 'children' => [ - 'UpdateAlertEnabled', - 'GetAlertStrategy', - 'DeleteAlertStrategy', - 'ListAlertItems', - 'ListAlertStrategies', - 'CreateAlertStrategy', - 'UpdateAlertStrategy', - ], + 'title' => 'Inspection', ], [ - 'id' => 203795, - 'title' => null, + 'children' => ['ListAlertDestinations', 'UpdateAlertDestination', 'GetAlertDestination', 'UpdateAlertEnabled', 'GetAlertStrategy', 'DeleteAlertStrategy', 'ListAlertItems', 'ListAlertStrategies', 'DeleteAlertDestination', 'CreateAlertDestination', 'CreateAlertStrategy', 'UpdateAlertStrategy'], 'type' => 'directory', - 'children' => [ - 'UpdateFuncSwitchRecord', - 'GetServiceFuncStatus', - 'GetHotSpotUniqList', - 'GetHotspotTracking', - 'GetHotspotPidList', - 'GetHotspotInstanceList', - 'GetHotspotCompare', - 'GetHotspotAnalysis', - ], + 'title' => 'Alert notification', ], [ - 'id' => 203796, - 'title' => null, + 'children' => ['UpdateFuncSwitchRecord', 'GetServiceFuncStatus', 'GetHotSpotUniqList', 'GetHotspotTracking', 'GetHotspotPidList', 'GetHotspotInstanceList', 'GetHotspotCompare', 'GetHotspotAnalysis'], 'type' => 'directory', - 'children' => [ - 'StartAIAnalysis', - 'GetListRecord', - 'GetAIQueryResult', - ], + 'title' => 'Hotspot analysis', ], [ - 'id' => 203797, - 'title' => null, + 'children' => ['StartAIAnalysis', 'GetListRecord', 'GetAIQueryResult'], 'type' => 'directory', - 'children' => [ - 'GetResources', - 'GetHostCount', - 'InitialSysom', - 'ListClusters', - 'ListInstances', - 'ListPluginsInstances', - 'ListPodsOfInstance', - 'UpgradeAgentForCluster', - 'UpgradeAgent', - 'UninstallAgentForCluster', - 'UninstallAgent', - 'ListRegions', - 'ListInstancesWithEcsInfo', - 'ListInstanceStatus', - 'ListInstancesEcsInfoList', - 'ListClusterAgentInstallRecords', - 'ListAgentInstallRecords', - 'InstallAgentForCluster', - 'InstallAgent', - 'ListAgents', - 'GetAgentTask', - 'GetAgentTask', - 'GetAgent', - 'ListAllInstances', - ], + 'title' => 'AI observability', ], [ - 'id' => 203798, - 'title' => null, + 'children' => ['GetResources', 'GetHostCount', 'InitialSysom', 'ListClusters', 'ListPluginsInstances', 'ListPodsOfInstance', 'UpgradeAgentForCluster', 'UpgradeAgent', 'UninstallAgentForCluster', 'UninstallAgent', 'ListInstancesWithEcsInfo', 'ListInstanceStatus', 'ListInstancesEcsInfoList', 'ListClusterAgentInstallRecords', 'ListAgentInstallRecords', 'InstallAgentForCluster', 'InstallAgent', 'GetAgentTask', 'GetAgent', 'ListAllInstances'], 'type' => 'directory', - 'children' => [ - 'UpdateEventsAttention', - 'ListAbnormalyEvents', - 'ListInstanceHealth', - 'InvokeAnomalyDiagnosis', - 'GetRangeScore', - 'GetProblemPercentage', - 'GetInstantScore', - 'GetHealthPercentage', - 'GetAbnormalEventsCount', - ], + 'title' => 'Component management', ], [ - 'id' => 203799, - 'title' => null, + 'children' => ['UpdateEventsAttention', 'ListAbnormalyEvents', 'ListInstanceHealth', 'InvokeAnomalyDiagnosis', 'GetRangeScore', 'GetProblemPercentage', 'GetInstantScore', 'GetHealthPercentage', 'GetAbnormalEventsCount'], 'type' => 'directory', - 'children' => [ - 'ListDiagnosis', - 'GetDiagnosisResult', - 'InvokeDiagnosis', - 'AuthDiagnosis', - ], + 'title' => 'Health status', ], [ - 'id' => 203800, - 'title' => null, + 'children' => ['ListDiagnosis', 'GetDiagnosisResult', 'InvokeDiagnosis', 'AuthDiagnosis'], 'type' => 'directory', - 'children' => [ - 'GetCopilotHistory', - 'GenerateCopilotStreamResponse', - 'GenerateCopilotResponse', - ], + 'title' => 'Diagnostics', ], [ - 'id' => 204228, - 'title' => null, + 'children' => ['GetCopilotHistory', 'GenerateCopilotStreamResponse', 'GenerateCopilotResponse'], 'type' => 'directory', - 'children' => [ - 'CheckInstanceSupport', - 'StartAIDiffAnalysis', - 'DescribeMetricList', - 'CreateVmcoreDiagnosisTask', - 'GetVmcoreDiagnosisTask', - 'ListVmcoreDiagnosisTask', - ], + 'title' => 'OS copilot', ], [ - 'id' => 0, - 'title' => '其它', + 'children' => ['CheckInstanceSupport', 'StartAIDiffAnalysis', 'CreateVmcoreDiagnosisTask', 'GetVmcoreDiagnosisTask', 'ListVmcoreDiagnosisTask', 'CpuHighAgentStreamResponse', 'DescribeMetricList', 'GetInspectionReport', 'ListAgents', 'ListInstances', 'ListRegions', 'CreateClusterVpcEndpointConnection', 'InstallAgentWithType', 'UninstallAgentWithType', 'UpgradeAgentWithType'], 'type' => 'directory', - 'children' => [ - 'CpuHighAgentStreamResponse', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'UpdateAlertEnabled' => [ - 'summary' => '用户更新推送告警策略的状态', - 'path' => '/api/v1/alertPusher/alert/updateEnabled', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AuthDiagnosis' => [ + 'path' => '/api/v1/openapi/diagnosis/auth', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -175,581 +78,297 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'instances' => [ + 'title' => '', + 'description' => 'The list of instances to authorize for diagnostics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => false, + 'example' => 'i-wz9gdv7qmdhntqmc4rjd', + 'description' => '', + 'title' => '', + ], + 'required' => true, + 'docRequired' => true, + 'example' => '', ], + 'autoCreateRole' => ['title' => '', 'description' => 'Specifies whether to enable automatic creation of the service-linked role.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'autoInstallAgent' => ['title' => '', 'description' => 'Specifies whether to automatically install the agent.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '', - ], + 'code' => ['title' => '', 'description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success'], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error information of the request.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'data' => ['description' => 'This operation does not return data.', 'type' => 'any', 'example' => '{}', 'title' => ''], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.NotSupportedAgentVersion', 'errorMessage' => 'Unsupported sysom agent version.', 'description' => 'Unsupported SysOM client version.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Authorize diagnostics', + 'summary' => 'Authorizes SysOM to diagnose ECS instances under the current account. You must call this operation to authorize diagnostics for a specific ECS instance before you can call the InvokeDiagnosis operation to initiate diagnostics on it.', + 'description' => '><notice>The diagnostics feature requires a service-linked role to be created under the Resource Access Management (RAM) user. This operation automatically checks whether the service-linked role exists and creates it if it does not. The RAM user that invokes this operation must have the ram:CreateServiceLinkedRole permission.</notice>'."\n" + ."\n" + .'Note the following when you invoke this operation to authorize SysOM to diagnose ECS instances:'."\n" + .'- Each authorization is valid for 7 days. After the authorization expires, invoke this operation again to re-authorize.'."\n" + .'- If the SysOM service-linked role (AliyunServiceRoleForSysom) does not exist when you invoke this operation, automatic creation is performed. The RAM user that invokes this operation must have the `ram:CreateServiceLinkedRole` permission.'."\n" + .'- When you invoke this operation to authorize diagnostics for a specific instance, the label `sysom:diagnosis` is automatically associated with the target ECS instance. SysOM only allows diagnostics on instances that have this label.', + 'changeSet' => [ + ['createdAt' => '2024-09-18T04:39:06.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:AuthDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"1808078950770264\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"items\\\\\\": [\\\\n \\\\\\"节点CPU使用率检测\\\\\\"\\\\n ],\\\\n \\\\\\"clusters\\\\\\": [\\\\n \\\\\\"cluster1\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"enabled\\\\\\": true,\\\\n \\\\\\"id\\\\\\": 1,\\\\n \\\\\\"created_at\\\\\\": 1753172727,\\\\n \\\\\\"updated_at\\\\\\": 1753172727\\\\n }\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": \\"{}\\",\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', ], - 'GetAlertStrategy' => [ - 'summary' => '根据策略id，获取用户的一条告警', - 'path' => '/api/v1/alertPusher/alert/getStrategy', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CheckInstanceSupport' => [ + 'summary' => 'Checks whether a target instance is supported by SysOM.', + 'path' => '/api/v1/am/supportInstanceList/checkInstanceSupport', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'id', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'region' => ['title' => '', 'description' => 'The region to which the instances belong. All instance IDs specified in instances must belong to the same region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'required' => false], + 'instances' => [ + 'title' => '', + 'description' => 'The list of instance IDs to check.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-2zxxxxxx', 'required' => false], + 'required' => false, + 'example' => '["i-2zxxxxxx"]', + ], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['title' => '', 'description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success'], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'strategy1', - ], - 'uid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1222933234714935', - ], - 'updatedAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1751254826285', - ], - 'createdAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1751520976660', - ], - 'strategy' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => '', - 'type' => 'any', - 'example' => '', - ], - 'clusters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cluster1', - ], - ], - ], - ], - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'k8sLabel' => [ - 'type' => 'boolean', + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'support' => ['title' => '', 'description' => 'Indicates whether the instance can be managed by SysOM.'."\n" + ."\n" + .'- **true**: The instance can be managed by SysOM.'."\n" + ."\n" + .'- **false**: The instance cannot be managed by SysOM.', 'type' => 'boolean', 'example' => 'true'], + 'reason' => ['title' => '', 'description' => 'The reason why the instance cannot be managed. This field is not empty when success is false.', 'type' => 'string', 'example' => 'instance not found in ecs'], + 'instance' => ['title' => '', 'description' => 'The ECS instance ID.', 'type' => 'string', 'example' => 'i-wz9d00ut2ska3mlyhn6j'], ], + 'example' => '', ], + 'example' => '', ], + 'message' => ['title' => '', 'description' => 'The error message. This field contains the error information when code is not Success.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"strategy1\\",\\n \\"uid\\": \\"1222933234714935\\",\\n \\"updatedAt\\": 1751254826285,\\n \\"createdAt\\": 1751520976660,\\n \\"strategy\\": {\\n \\"items\\": \\"节点CPU使用率检测\\",\\n \\"clusters\\": [\\n \\"cluster1\\"\\n ]\\n },\\n \\"enabled\\": false,\\n \\"k8sLabel\\": true\\n }\\n}","type":"json"}]', - ], - 'DeleteAlertStrategy' => [ - 'summary' => '用户删除推送告警的策略', - 'path' => '/api/v1/alertPusher/alert/deleteStrategy', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"data\\": [\\n {\\n \\"support\\": true,\\n \\"reason\\": \\"instance not found in ecs\\",\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\"\\n }\\n ],\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\"\\n}","type":"json"}]', + 'title' => 'Check whether an instance is supported', + 'description' => 'This operation retrieves the list of instances that are already managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CheckInstanceSupport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CpuHighAgentStreamResponse' => [ + 'summary' => 'Calls the CPU High Agent streaming SSE interface.', + 'path' => '/api/v1/highCpuAgent/streamResponse', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/octet-stream'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinuxGP5QJE'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '', - ], + 'llmParamString' => ['description' => 'The input parameter for the CPU High Agent service. Refer to the standard LLM API input parameter dict, convert it to a string, and pass it in the llmParamString field.', 'type' => 'string', 'required' => false, 'example' => '"llmParamString": "{\\"messages\\": [{\\"role\\": \\"user\\", \\"content\\": \\"用户12345的机器i-67890，最近2分钟CPU使用率高，请结合最近2分钟的火焰图信息，分析原因\\"}]}"', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"1808078950770264\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"items\\\\\\": [\\\\n \\\\\\"节点CPU使用率检测\\\\\\"\\\\n ],\\\\n \\\\\\"clusters\\\\\\": [\\\\n \\\\\\"1\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"enabled\\\\\\": false,\\\\n \\\\\\"id\\\\\\": 1,\\\\n \\\\\\"created_at\\\\\\": 1753170771,\\\\n \\\\\\"updated_at\\\\\\": 1753170811\\\\n }\\"\\n}","type":"json"}]', - ], - 'ListAlertItems' => [ - 'summary' => '获取所有告警项', - 'path' => '/api/v1/alertPusher/alert/listItems', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If code is Success, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the message field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If code is Success, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'string', 'example' => '<SSEResponse>', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"{\\\\n \\\\\\"NODE\\\\\\": {\\\\n \\\\\\"饱和度\\\\\\": [\\\\n \\\\\\"节点CPU使用率检测\\\\\\",\\\\n \\\\\\"节点内核态CPU使用检测\\\\\\",\\\\n \\\\\\"节点软中断CPU使用检测\\\\\\",\\\\n \\\\\\"节点内存使用检测\\\\\\",\\\\n \\\\\\"节点内核内存使用检测\\\\\\",\\\\n \\\\\\"节点文件描述符使用检测\\\\\\",\\\\n \\\\\\"节点根文件系统使用检测\\\\\\",\\\\n \\\\\\"节点cgroup泄漏检测\\\\\\",\\\\n \\\\\\"节点Sockets使用检测\\\\\\",\\\\n \\\\\\"节点TCP内存使用检测\\\\\\"\\\\n ],\\\\n \\\\\\"延时\\\\\\": [\\\\n \\\\\\"节点调度延时检测\\\\\\",\\\\n \\\\\\"节点网络延时检测\\\\\\",\\\\n \\\\\\"节点磁盘写入延迟检测\\\\\\",\\\\n \\\\\\"节点磁盘读取延迟检测\\\\\\"\\\\n ],\\\\n \\\\\\"负载\\\\\\": [\\\\n \\\\\\"节点磁盘IO流量检测\\\\\\",\\\\n \\\\\\"节点load average检测\\\\\\"\\\\n ],\\\\n \\\\\\"错误\\\\\\": [\\\\n \\\\\\"节点网络丢包检测\\\\\\",\\\\n \\\\\\"节点OOM夯机预测及检测\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"POD\\\\\\": {\\\\n \\\\\\"饱和度\\\\\\": [\\\\n \\\\\\"Pod内存使用检测\\\\\\",\\\\n \\\\\\"Pod CPU使用率检测\\\\\\"\\\\n ],\\\\n \\\\\\"错误\\\\\\": [\\\\n \\\\\\"Pod CPU限流检测\\\\\\",\\\\n \\\\\\"Pod OOM事件检测\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n}","type":"json"}]', - ], - 'ListAlertStrategies' => [ - 'summary' => '用于获取用户所有推送告警的策略', - 'path' => '/api/v1/alertPusher/alert/listStrategies', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Call CPU high agent streaming SSE interface', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c2f78a783f49457caba6bace6f6f79e4', - ], - ], - [ - 'name' => 'current', - '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' => 'strategy1', - ], - ], - ], - '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' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'uid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1880327028143673', - ], - 'createdAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1753669116286', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'strategy1', - ], - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'strategy' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - 'clusters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cluster1', - ], - ], - ], - ], - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'updatedAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1753237017710', - ], - 'k8sLabel' => [ - 'type' => 'boolean', - ], - ], - ], - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '92', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c2f78a783f49457caba6bace6f6f79e4', - ], - 'maxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CpuHighAgentStreamResponse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": [\\n {\\n \\"uid\\": \\"1880327028143673\\",\\n \\"createdAt\\": \\"1753669116286\\",\\n \\"name\\": \\"strategy1\\",\\n \\"id\\": 1,\\n \\"strategy\\": {\\n \\"items\\": [\\n \\"Pod OOM事件检测\\"\\n ],\\n \\"clusters\\": [\\n \\"cluster1\\"\\n ]\\n },\\n \\"enabled\\": false,\\n \\"updatedAt\\": 1753237017710,\\n \\"k8sLabel\\": true\\n }\\n ],\\n \\"total\\": 92,\\n \\"nextToken\\": \\"c2f78a783f49457caba6bace6f6f79e4\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": \\"<SSEResponse>\\"\\n}","type":"json"}]', ], - 'CreateAlertStrategy' => [ - 'summary' => '新增推送告警的策略', - 'path' => '/api/v1/alertPusher/alert/createStrategy', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAlertDestination' => [ + 'path' => '/api/v1/alertPusher/alert/createDestination', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -757,133 +376,122 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'strategy1', - ], - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'strategy' => [ - 'description' => '', + 'target' => ['description' => 'The notification target. Currently, only DingTalk chatbots are supported.', 'type' => 'string', 'required' => false, 'example' => 'dingtalk', 'title' => ''], + 'name' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''], + 'source' => ['description' => 'The configuration source.', 'type' => 'string', 'required' => false, 'example' => 'console', 'title' => ''], + 'params' => [ + 'description' => 'The configuration parameters of the alert contact.', 'type' => 'object', 'properties' => [ - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - ], - 'clusters' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster1 ', - ], - 'required' => false, - ], + 'webhook' => ['description' => 'The webhook URL of the chatbot.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx', 'title' => ''], + 'sec' => ['description' => 'The secret key of the chatbot.', 'type' => 'string', 'required' => false, 'example' => 'SECxxx', 'title' => ''], + 'phone' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '1xxx', 'title' => ''], + 'email' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'xxx@email.com', 'title' => ''], ], - 'required' => true, - ], - 'k8sLabel' => [ - 'type' => 'boolean', + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error message of the request.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{'."\n" - .' "uid": "uid-1",'."\n" - .' "name": "test-name",'."\n" - .' "strategy": {'."\n" - .' "clusters": ["test-cluster-1","test-cluster-2"],'."\n" - .' "items": ["test-item1","test-item2"]'."\n" - .' },'."\n" - .' "enabled": True,'."\n" - .' '."\n" - .' }', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'uid' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1222933234714935', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1751254826285', 'title' => ''], + 'name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'SysOM', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753669116286', 'title' => ''], + 'id' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'source' => ['description' => 'The configuration source.', 'type' => 'string', 'example' => 'console', 'title' => ''], + 'target' => ['description' => 'The notification target. Currently, only DingTalk chatbots are supported.', 'type' => 'string', 'example' => 'dingtalk', 'title' => ''], + 'params' => [ + 'description' => 'The configuration parameters of the alert contact.', + 'type' => 'object', + 'properties' => [ + 'webhook' => ['description' => 'The webhook URL of the chatbot.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx', 'title' => ''], + 'sec' => ['description' => 'The secret key of the chatbot.', 'type' => 'string', 'example' => 'SECxxx', 'title' => ''], + 'email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'xxx@email.com', 'title' => ''], + 'phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1xxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', 'description' => 'Server error, please correct the code according to the error message'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create alert contact', + 'summary' => 'Creates a contact for alert notifications.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:CreateAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"创建策略失败\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"uid-1\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"clusters\\\\\\": [\\\\\\"test-cluster-1\\\\\\",\\\\\\"test-cluster-2\\\\\\"],\\\\n \\\\\\"items\\\\\\": [\\\\\\"test-item1\\\\\\",\\\\\\"test-item2\\\\\\"]\\\\n },\\\\n \\\\\\"enabled\\\\\\": True,\\\\n \\\\n }\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"uid\\": \\"1222933234714935\\",\\n \\"updatedAt\\": 1751254826285,\\n \\"name\\": \\"SysOM\\",\\n \\"createdAt\\": 1753669116286,\\n \\"id\\": 1,\\n \\"source\\": \\"console\\",\\n \\"target\\": \\"dingtalk\\",\\n \\"params\\": {\\n \\"webhook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=xxx\\",\\n \\"sec\\": \\"SECxxx\\",\\n \\"email\\": \\"xxx@email.com\\",\\n \\"phone\\": \\"1xxx\\"\\n }\\n }\\n}","type":"json"}]', ], - 'UpdateAlertStrategy' => [ - 'summary' => '更新推送告警策略', - 'path' => '/api/v1/alertPusher/alert/updateStrategy', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAlertStrategy' => [ + 'path' => '/api/v1/alertPusher/alert/createStrategy', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], ], 'parameters' => [ [ @@ -891,494 +499,293 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'strategy1', - ], - 'id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - 'enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'name' => ['description' => 'The name of the alert strategy.', 'type' => 'string', 'required' => true, 'example' => 'strategy1', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether the alert strategy is enabled.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], 'strategy' => [ - 'description' => '', + 'description' => 'The details of the alert strategy.', 'type' => 'object', 'properties' => [ 'items' => [ - 'description' => '', + 'description' => 'The collection of anomaly items for which alerts are received.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'items' => ['description' => 'The anomaly item.', 'type' => 'string', 'required' => false, 'example' => '节点CPU使用率检测', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], 'clusters' => [ - 'description' => '', + 'description' => 'The collection of clusters for which alerts are received.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster1', - ], + 'items' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'cluster1 ', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', + ], + 'destinations' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'required' => true, + 'title' => '', + 'example' => '', ], - 'k8sLabel' => [ - 'type' => 'boolean', - ], + 'k8sLabel' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{'."\n" - .' "uid": "uid-1",'."\n" - .' "name": "test-name",'."\n" - .' "strategy": {'."\n" - .' "clusters": ["test-cluster-1","test-cluster-2"],'."\n" - .' "items": ["test-item1","test-item2"]'."\n" - .' },'."\n" - .' "enabled": True'."\n" - .'}', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the request is successful.'."\n" + .'- Other status codes indicate a failed request. If the request fails, check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error information of the request.', 'type' => 'string', 'example' => '创建策略失败', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '{'."\n" + .' "uid": "uid-1",'."\n" + .' "name": "test-name",'."\n" + .' "strategy": {'."\n" + .' "clusters": ["test-cluster-1","test-cluster-2"],'."\n" + .' "items": ["test-item1","test-item2"]'."\n" + .' },'."\n" + .' "enabled": True,'."\n" + .' '."\n" + .' }', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateAlertStrategy', + 'summary' => 'Creates an alert push strategy.', + 'changeSet' => [ + ['createdAt' => '2025-11-03T02:34:05.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"更新告警策略失败\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"uid-1\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"clusters\\\\\\": [\\\\\\"test-cluster-1\\\\\\",\\\\\\"test-cluster-2\\\\\\"],\\\\n \\\\\\"items\\\\\\": [\\\\\\"test-item1\\\\\\",\\\\\\"test-item2\\\\\\"]\\\\n },\\\\n \\\\\\"enabled\\\\\\": True\\\\n}\\"\\n}","type":"json"}]', - ], - 'UpdateFuncSwitchRecord' => [ - 'summary' => '获取功能模块配置', - 'path' => '/api/v1/func-switch/update-service-func-switch', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CreateAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"创建策略失败\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"uid-1\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"clusters\\\\\\": [\\\\\\"test-cluster-1\\\\\\",\\\\\\"test-cluster-2\\\\\\"],\\\\n \\\\\\"items\\\\\\": [\\\\\\"test-item1\\\\\\",\\\\\\"test-item2\\\\\\"]\\\\n },\\\\n \\\\\\"enabled\\\\\\": True,\\\\n \\\\n }\\"\\n}","type":"json"}]', + ], + 'CreateClusterVpcEndpointConnection' => [ + 'summary' => '', + 'path' => '/api/v1/k8sProxy/access/createClusterVpcEndpointConnection', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinuxV02H6G'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'params', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'function_name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mullprof', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-2zei55fwj8nnu31h3z46', - ], - 'uid' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1664516888213680', - ], - 'op' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'restart', - ], - 'args' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'add_cmd' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'java', - ], - 'mem' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'locks' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'java_store_path' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '/tmp/sysom/java-profiler', - ], - 'system_profiling' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'cpu' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - 'loop' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '-1', - ], - 'pid' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'duration' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'required' => false, - ], - 'region' => [ - 'type' => 'string', - ], + 'region' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'cn-hangzhou'], + 'clusterId' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'ray-bzxw7g2r7301r3f2'], + 'dryRun' => ['type' => 'boolean', 'default' => 'false', 'title' => '', 'description' => '', 'required' => false, 'example' => 'false'], ], - 'required' => true, - ], - ], - [ - 'name' => 'service_name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'livetrace', - ], - ], - [ - 'name' => 'channel', - 'in' => 'query', - 'schema' => [ 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + 'required' => false, + 'title' => '', + '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' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', - ], + 'requestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['type' => 'string', 'description' => '', 'example' => 'Success', 'title' => ''], 'data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '63fc5acb99e642d793f42912612e8001', - ], + 'endpointConnectionId' => ['type' => 'string', 'description' => '', 'example' => 'ep-xxx', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'message' => ['type' => 'string', 'description' => '', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '- 需配合aliyun-tea-openapi-inner包的call_sseapi接口使用'."\n" + .'- 需要按通用LLM服务输入参数填充参数，转为string后赋给llmParamString'."\n" + .'- 返回数据需将string转为dict后使用，参考通用LLM服务返回格式', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": {\\n \\"task_id\\": \\"63fc5acb99e642d793f42912612e8001\\"\\n }\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"data\\": {\\n \\"endpointConnectionId\\": \\"ep-xxx\\"\\n },\\n \\"message\\": \\"success\\"\\n}","type":"json"}]', ], - 'GetServiceFuncStatus' => [ - 'summary' => '获取功能模块配置', - 'path' => '/api/v1/func-switch/get-service-func-status', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateInstanceInspection' => [ + 'summary' => 'Creates a SysOM instance inspection.', + 'path' => '/api/v1/inspection/createInstanceInspection', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], ], 'parameters' => [ [ - 'name' => 'params', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'function_name' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mullprof', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', + 'region' => ['description' => 'The region to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-2ze5ru5rjurix7f71sxv', 'title' => ''], + 'source' => ['description' => 'The source.', 'type' => 'string', 'required' => false, 'example' => 'console', 'title' => ''], + 'items' => [ + 'description' => '异常项', + 'type' => 'array', + 'items' => ['description' => '异常项', 'type' => 'string', 'required' => false, 'example' => 'sysom:metric:slab_leak', 'title' => ''], 'required' => false, - 'example' => 'i-2zei55fwj8nnu31h3z46', + 'title' => '', + 'example' => '', ], - 'uid' => [ - 'description' => '', + 'metricSource' => [ + 'description' => 'The metric source.', + 'enumValueTitles' => ['auto' => 'auto', 'sysom' => 'sysom', 'cms' => 'cms'], 'type' => 'string', 'required' => false, - 'example' => '1338904783509062', + 'example' => 'sysom', + 'title' => '', ], ], - 'required' => true, - ], - ], - [ - 'name' => 'service_name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'livetrace', - ], - ], - [ - 'name' => 'channel', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ecs', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => "\n", - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'args' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'add_cmd' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'java', - ], - 'mem' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'locks' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'java_store_path' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/tmp/sysom/java-profiler', - ], - 'cpu' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'system_profiling' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'loop' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => 'reportId', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create instance inspection', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\n\\",\\n \\"data\\": {\\n \\"args\\": {\\n \\"add_cmd\\": \\"java\\",\\n \\"mem\\": \\"true\\",\\n \\"locks\\": \\"true\\",\\n \\"java_store_path\\": \\"/tmp/sysom/java-profiler\\",\\n \\"cpu\\": \\"true\\",\\n \\"system_profiling\\": \\"true\\",\\n \\"loop\\": -1\\n }\\n }\\n}","type":"json"}]', - ], - 'GetHotSpotUniqList' => [ - 'summary' => '获取实例下的某个字段列表', - 'path' => '/api/v1/livetrace_proxy/hotspot_uniq_list', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:CreateInstanceInspection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"reportId\\"\\n}","type":"json"}]', + ], + 'CreateVmcoreDiagnosisTask' => [ + 'summary' => 'Creates an intelligent breakdown diagnostic node that diagnoses the specified vmcore or dmesg log file based on the input parameters.', + 'path' => '/api/v1/crashAgent/diagnosis/createDiagnosisTask', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '254533', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -1386,570 +793,381 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'uniq' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-bp1g2i0siirefgwnnnvy', - ], - 'pid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], - 'table' => [ - 'description' => '', + 'taskType' => [ + 'title' => '', + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'- vmcore: vmcore file diagnostic task.'."\n" + .'- dmesg: dmesg log diagnostic task.', + 'enumValueTitles' => ['dmesg' => 'dmesg', 'vmcore' => 'vmcore'], 'type' => 'string', - 'required' => false, - 'example' => 'prof_on', - ], - 'beg_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'example' => '1735008551000', - ], - 'beg_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1735010351000', + 'example' => 'vmcore', ], + 'vmcoreUrl' => ['title' => '', 'description' => 'The download URL of the vmcore file. This parameter is required when the diagnostic type is vmcore.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path'], + 'debuginfoUrl' => ['title' => '', 'description' => 'The download URL of the debuginfo file. This parameter is optional when the diagnostic type is vmcore.'."\n" + ."\n" + .'For CentOS or Alinux kernels, the corresponding debuginfo file is automatically downloaded, and you do not need to specify this parameter. For other distribution kernels, manually provide the download URL of the debuginfo file that corresponds to the kernel version.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path'], + 'debuginfoCommonUrl' => ['title' => '', 'description' => 'The download URL of the debuginfo-common file. This parameter is optional when the diagnostic type is vmcore.'."\n" + ."\n" + .'For CentOS or Alinux kernels, the corresponding debuginfo-common file is automatically downloaded, and you do not need to specify this parameter. For other distribution kernels, manually provide the download URL of the debuginfo-common file that corresponds to the kernel version.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path'], + 'dmesgUrl' => ['title' => '', 'description' => 'The download URL of the dmesg log file. This parameter is required when the diagnostic type is dmesg.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => "\n" - .'success', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If code is Success, this field is empty.'."\n" + .'- Otherwise, this field contains the error message for the request.', 'type' => 'string', 'example' => '""', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'column', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ml', - ], + 'taskId' => [ + 'title' => '', + 'description' => 'The ID of the created diagnostic task.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7', ], ], + 'title' => '', + 'example' => '', ], + 'code' => ['description' => 'The status code.'."\n" + .'- If code is Success, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization has failed. Check the message field for the detailed fault message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"success\\": \\"true\\",\\n \\"message\\": \\"\\\\nsuccess\\",\\n \\"data\\": {\\n \\"columns\\": [\\n \\"column\\"\\n ],\\n \\"values\\": [\\n \\"ml\\"\\n ]\\n }\\n}","type":"json"}]', - ], - 'GetHotspotTracking' => [ - 'summary' => '发起热点追踪', - 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_tracking', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"taskId\\": \\"bbe94a98-4192-4172-b856-95777e0a55d7\\"\\n },\\n \\"code\\": \\"Success\\"\\n}","type":"json"}]', + 'title' => 'Create a breakdown diagnostic task', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CreateVmcoreDiagnosisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteAlertDestination' => [ + 'summary' => 'Deletes an alert contact.', + 'path' => '/api/v1/alertPusher/alert/deleteDestination', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '230069', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'table' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'prof_on', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze5ru5rjurix7f71sxv', - ], - 'beg_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725410348000', - ], - 'beg_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725413948000', - ], - 'pid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1657494', - ], - 'hot_type' => [ - 'type' => 'string', - 'required' => true, - ], - ], - 'required' => false, - ], + 'name' => 'id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert contact.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'series' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"time", "EXPR$1"', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"2024-09-04T00:39:50Z", "1"', - ], - ], - ], - ], - ], - 'flame' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"sample"，"time"', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"flamebearer\\":{\\"names\\":[\\"total\\",\\"host\\",\\"AliYunDun:1657494\\",\\"?5043000000000000\\",\\"std::basic_string::basic_string\\",\\"__memmove_ssse3_back\\",\\"_init\\",\\"std::string::_Rep::_M_set_length_and_sharable\\",\\"std::string::_S_copy_chars\\",\\"__strlen_sse2_pminub\\",\\"__read_nocancel\\",\\"system_call_fastpath\\",\\"SyS_read\\",\\"vfs_read\\",\\"seq_read\\",\\"proc_single_show\\",\\"proc_tgid_stat\\",\\"do_task_stat\\",\\"__delayacct_blkio_ticks\\",\\"_raw_spin_unlock_irqrestore\\",\\"proc_pid_status\\",\\"seq_bitmap\\",\\"bitmap_scnprintf\\",\\"bitmap_scnprintf.part.0\\",\\"scnprintf\\",\\"vscnprintf\\",\\"vsnprintf\\",\\"format_decode\\",\\"kernfs_fop_read\\",\\"kernfs_seq_show\\",\\"sysfs_kf_seq_show\\",\\"dev_attr_show\\",\\"part_stat_show\\",\\"part_in_flight\\",\\"blk_mq_in_flight\\",\\"blk_mq_queue_tag_busy_iter\\",\\"copy_user_enhanced_fast_string\\",\\"proc_reg_read\\",\\"meminfo_proc_show\\",\\"get_vmalloc_info\\",\\"aqs::CThreadUtil::ThreadFunc\\",\\"operatordelete\\",\\"CProtocolHandlerThread::run\\",\\"CSingleton::GetInstance\\",\\"CResourceMonitor::SetThreadHeartbeat\\",\\"CMonitor::SetThreadHeartbeat\\",\\"aqs::CMutexLockUtil::CMutexLockUtil\\",\\"aqs::CGetTickClock::GetClock\\",\\"__pthread_rwlock_rdlock\\",\\"pthread_rwlock_rdlock\\",\\"aqs::CReadLockUtil::CReadLockUtil\\",\\"std::map::find\\",\\"std::_Rb_tree\\",\\"std::less::operator\\",\\"std::_Rb_tree_iterator::_Rb_tree_iterator\\",\\"__GI___pthread_mutex_lock\\",\\"pthread_mutex_lock\\",\\"__nanosleep_nocancel\\",\\"SyS_nanosleep\\",\\"__check_object_size\\",\\"__virt_addr_valid\\",\\"hrtimer_nanosleep\\",\\"hrtimer_init\\",\\"do_nanosleep\\",\\"schedule\\",\\"__schedule\\",\\"rcu_note_context_switch\\",\\"finish_task_switch\\",\\"hrtimer_start_range_ns\\",\\"lock_hrtimer_base.isra.20\\",\\"_raw_spin_lock_irqsave\\",\\"__audit_syscall_entry\\",\\"CIpcPrivate::run\\",\\"std::list::empty\\",\\"stIpcRawMsg::stIpcRawMsg\\",\\"CIpcPrivate::HandleRecvRawMsg\\",\\"std::basic_string::~basic_string\\",\\"CIpcPrivate::OnRecvClientData\\",\\"CIpcPrivate::InsertMsg\\",\\"std::list::push_back\\",\\"std::list::_M_insert\\",\\"std::list::_M_create_node\\",\\"__gnu_cxx::new_allocator::allocate\\",\\"ParseIpcDataEx\\",\\"boolCSimpleSerialization::GetInt\\",\\"CSimpleSerialization::GetMemberForInteger\\",\\"CIpcPrivate::HandleSendMsg\\",\\"CIpcPrivate::SendIpcMsgPri\\",\\"CSelfGuardIpc::IpcRecvMsg\\",\\"CNetWork::run\\",\\"CNetWork::PeekRecvMessage\\",\\"CNetWork::ReadOneMessage\\",\\"evthread_use_pthreads\\",\\"pthread_self\\",\\"bufferevent_get_input\\",\\"CAtomicInt64::Get\\",\\"CNetWork::PeekSendMessage\\",\\"CTcpMessageBuffer::MarkSendMessage\\",\\"CNetWork::GetSendMessage\\",\\"__SendMessage::__SendMessage\\",\\"__epoll_wait_nocancel\\",\\"system_call_after_swapgs\\",\\"!48c69361\\",\\"!48c672e9\\",\\"!48c20f45\\",\\"!48c2106d\\",\\"!48c2eca3\\",\\"SyS_epoll_wait\\",\\"ep_poll\\",\\"__fdget\\",\\"__fget_light\\"],\\"maxSelf\\":92,\\"numTicks\\":268,\\"levels\\":[[0,268,0,0],[0,268,0,1],[0,268,92,2],[92,10,0,3,0,6,1,10,0,139,14,40,0,7,0,100,0,14,0,57],[92,8,0,4,0,2,2,9,1,5,0,11,14,3,3,41,0,36,0,42,0,3,3,6,0,45,3,57,0,15,1,72,0,3,3,43,0,20,0,89,0,1,1,101,0,1,0,102,0,5,0,11,0,1,1,101,0,13,0,11],[92,1,1,5,0,2,2,6,0,4,4,7,0,1,1,8,3,5,0,12,17,1,1,43,0,5,5,44,0,30,1,45,6,41,1,11,0,1,1,71,1,1,1,73,0,6,0,45,0,2,2,74,0,3,0,75,0,2,0,86,3,7,0,90,0,1,1,95,0,2,0,45,0,5,0,96,0,1,1,76,0,3,3,99,0,1,1,6,1,1,0,103,0,4,0,107,0,1,1,109,1,13,0,58],[103,5,0,13,24,1,1,46,0,3,3,47,0,5,5,43,0,16,0,44,0,1,1,55,0,1,1,56,0,2,2,6,7,39,1,58,0,1,1,36,3,3,0,44,0,1,1,6,0,2,2,51,2,1,1,76,0,2,0,77,0,1,0,87,0,1,1,6,3,7,1,91,1,2,0,44,0,3,3,97,0,2,0,98,6,1,0,104,0,2,0,108,0,2,0,109,2,2,2,59,0,11,0,61],[103,2,0,14,0,1,0,28,0,1,1,36,0,1,0,37,33,1,1,43,0,2,2,48,0,2,2,49,0,2,2,6,0,2,2,50,0,7,0,51,12,4,2,59,0,1,1,60,0,33,1,61,4,1,1,49,0,1,1,50,0,1,0,51,6,1,0,78,0,1,0,83,0,1,0,88,5,1,1,92,0,1,1,6,0,1,1,93,0,3,3,94,1,1,0,51,0,1,1,48,3,1,1,55,0,1,1,6,6,1,0,105,0,2,2,19,0,2,2,110,4,11,0,63],[103,2,0,15,0,1,0,14,1,1,0,14,42,6,3,52,0,1,1,6,14,2,2,60,2,2,2,62,0,30,0,63,6,1,1,52,6,1,0,79,0,1,0,84,0,1,1,9,12,1,1,52,12,1,1,106,8,5,1,64,0,6,0,68],[103,1,0,16,0,1,0,20,0,1,0,29,1,1,0,38,45,2,2,53,0,1,1,54,21,15,0,64,0,15,0,68,13,1,0,80,0,1,1,85,36,4,0,65,0,6,6,19],[103,1,0,17,0,1,0,21,0,1,0,30,1,1,1,39,69,15,0,65,0,1,0,69,0,14,14,19,13,1,0,81,37,4,4,67],[103,1,0,18,0,1,0,22,0,1,0,31,71,2,2,66,0,13,13,67,0,1,1,70,27,1,1,82],[103,1,1,19,0,1,0,23,0,1,0,32],[104,1,0,24,0,1,0,33],[104,1,0,25,0,1,0,34],[104,1,0,26,0,1,1,35],[104,1,1,27]]},\\"version\\":1,\\"metadata\\":{\\"name\\":\\"liveTrace\\",\\"sampleRate\\":100,\\"spyName\\":\\"cprof\\",\\"units\\":\\"samples\\",\\"maxNodes\\":1024,\\"appName\\":\\"liveTrace.profiling\\",\\"format\\":\\"single\\"}}"'."\n", - ], - ], - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error message of the request.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], + 'data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', 'description' => 'Server error, please correct the code according to the error message'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"Success\\",\\n \\"data\\": {\\n \\"series\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"EXPR$1\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T00:39:50Z\\\\\\", \\\\\\"1\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"flame\\": {\\n \\"columns\\": [\\n \\"\\\\\\"sample\\\\\\"，\\\\\\"time\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"{\\\\\\\\\\\\\\"flamebearer\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"names\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"total\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AliYunDun:1657494\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"?5043000000000000\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::basic_string::basic_string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__memmove_ssse3_back\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_init\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::string::_Rep::_M_set_length_and_sharable\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::string::_S_copy_chars\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__strlen_sse2_pminub\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__read_nocancel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"system_call_fastpath\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SyS_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vfs_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"seq_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_single_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_tgid_stat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_task_stat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__delayacct_blkio_ticks\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_raw_spin_unlock_irqrestore\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_pid_status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"seq_bitmap\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bitmap_scnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bitmap_scnprintf.part.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"scnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vscnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vsnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format_decode\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"kernfs_fop_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"kernfs_seq_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sysfs_kf_seq_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dev_attr_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"part_stat_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"part_in_flight\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"blk_mq_in_flight\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"blk_mq_queue_tag_busy_iter\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"copy_user_enhanced_fast_string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_reg_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"meminfo_proc_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"get_vmalloc_info\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CThreadUtil::ThreadFunc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operatordelete\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CProtocolHandlerThread::run\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CSingleton::GetInstance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CResourceMonitor::SetThreadHeartbeat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CMonitor::SetThreadHeartbeat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CMutexLockUtil::CMutexLockUtil\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CGetTickClock::GetClock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__pthread_rwlock_rdlock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pthread_rwlock_rdlock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CReadLockUtil::CReadLockUtil\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::map::find\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::_Rb_tree\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::less::operator\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::_Rb_tree_iterator::_Rb_tree_iterator\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__GI___pthread_mutex_lock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pthread_mutex_lock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__nanosleep_nocancel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SyS_nanosleep\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__check_object_size\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__virt_addr_valid\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hrtimer_nanosleep\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hrtimer_init\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_nanosleep\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"schedule\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__schedule\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_note_context_switch\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"finish_task_switch\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hrtimer_start_range_ns\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"lock_hrtimer_base.isra.20\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_raw_spin_lock_irqsave\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__audit_syscall_entry\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::run\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::empty\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stIpcRawMsg::stIpcRawMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::HandleRecvRawMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::basic_string::~basic_string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::OnRecvClientData\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::InsertMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::push_back\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::_M_insert\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::_M_create_node\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__gnu_cxx::new_allocator::allocate\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ParseIpcDataEx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"boolCSimpleSerialization::GetInt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CSimpleSerialization::GetMemberForInteger\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::HandleSendMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::SendIpcMsgPri\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CSelfGuardIpc::IpcRecvMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::run\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::PeekRecvMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::ReadOneMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"evthread_use_pthreads\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pthread_self\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bufferevent_get_input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CAtomicInt64::Get\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::PeekSendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CTcpMessageBuffer::MarkSendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::GetSendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__SendMessage::__SendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__epoll_wait_nocancel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"system_call_after_swapgs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c69361\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c672e9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c20f45\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c2106d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c2eca3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SyS_epoll_wait\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ep_poll\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__fdget\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__fget_light\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"maxSelf\\\\\\\\\\\\\\":92,\\\\\\\\\\\\\\"numTicks\\\\\\\\\\\\\\":268,\\\\\\\\\\\\\\"levels\\\\\\\\\\\\\\":[[0,268,0,0],[0,268,0,1],[0,268,92,2],[92,10,0,3,0,6,1,10,0,139,14,40,0,7,0,100,0,14,0,57],[92,8,0,4,0,2,2,9,1,5,0,11,14,3,3,41,0,36,0,42,0,3,3,6,0,45,3,57,0,15,1,72,0,3,3,43,0,20,0,89,0,1,1,101,0,1,0,102,0,5,0,11,0,1,1,101,0,13,0,11],[92,1,1,5,0,2,2,6,0,4,4,7,0,1,1,8,3,5,0,12,17,1,1,43,0,5,5,44,0,30,1,45,6,41,1,11,0,1,1,71,1,1,1,73,0,6,0,45,0,2,2,74,0,3,0,75,0,2,0,86,3,7,0,90,0,1,1,95,0,2,0,45,0,5,0,96,0,1,1,76,0,3,3,99,0,1,1,6,1,1,0,103,0,4,0,107,0,1,1,109,1,13,0,58],[103,5,0,13,24,1,1,46,0,3,3,47,0,5,5,43,0,16,0,44,0,1,1,55,0,1,1,56,0,2,2,6,7,39,1,58,0,1,1,36,3,3,0,44,0,1,1,6,0,2,2,51,2,1,1,76,0,2,0,77,0,1,0,87,0,1,1,6,3,7,1,91,1,2,0,44,0,3,3,97,0,2,0,98,6,1,0,104,0,2,0,108,0,2,0,109,2,2,2,59,0,11,0,61],[103,2,0,14,0,1,0,28,0,1,1,36,0,1,0,37,33,1,1,43,0,2,2,48,0,2,2,49,0,2,2,6,0,2,2,50,0,7,0,51,12,4,2,59,0,1,1,60,0,33,1,61,4,1,1,49,0,1,1,50,0,1,0,51,6,1,0,78,0,1,0,83,0,1,0,88,5,1,1,92,0,1,1,6,0,1,1,93,0,3,3,94,1,1,0,51,0,1,1,48,3,1,1,55,0,1,1,6,6,1,0,105,0,2,2,19,0,2,2,110,4,11,0,63],[103,2,0,15,0,1,0,14,1,1,0,14,42,6,3,52,0,1,1,6,14,2,2,60,2,2,2,62,0,30,0,63,6,1,1,52,6,1,0,79,0,1,0,84,0,1,1,9,12,1,1,52,12,1,1,106,8,5,1,64,0,6,0,68],[103,1,0,16,0,1,0,20,0,1,0,29,1,1,0,38,45,2,2,53,0,1,1,54,21,15,0,64,0,15,0,68,13,1,0,80,0,1,1,85,36,4,0,65,0,6,6,19],[103,1,0,17,0,1,0,21,0,1,0,30,1,1,1,39,69,15,0,65,0,1,0,69,0,14,14,19,13,1,0,81,37,4,4,67],[103,1,0,18,0,1,0,22,0,1,0,31,71,2,2,66,0,13,13,67,0,1,1,70,27,1,1,82],[103,1,1,19,0,1,0,23,0,1,0,32],[104,1,0,24,0,1,0,33],[104,1,0,25,0,1,0,34],[104,1,0,26,0,1,1,35],[104,1,1,27]]},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sampleRate\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"spyName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cprof\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"units\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"maxNodes\\\\\\\\\\\\\\":1024,\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace.profiling\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"single\\\\\\\\\\\\\\"}}\\\\\\"\\\\n\\"\\n ]\\n ]\\n }\\n }\\n}","type":"json"}]', - ], - 'GetHotspotPidList' => [ - 'summary' => '获取某个实例的pid列表', - 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_pid_list', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete an alert contact', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sysom:DeleteAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": \\"{}\\"\\n}","type":"json"}]', + ], + 'DeleteAlertStrategy' => [ + 'summary' => 'Deletes an alert policy for push notifications.', + 'path' => '/api/v1/alertPusher/alert/deleteStrategy', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'table' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'prof_on', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze5ru5rjurix7f71sxv', - ], - 'beg_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725413647000', - ], - 'beg_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725413947000', - ], - ], - 'required' => false, - ], + 'name' => 'id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert policy.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.InvalidParameter', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"time", "pid", "comm"', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"2024-09-04T01:04:30Z"，"6890"，"coredns"', - ], - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '{'."\n" + .' "uid": "1808078950770264",'."\n" + .' "name": "test",'."\n" + .' "strategy": {'."\n" + .' "items": ['."\n" + .' "节点CPU使用率检测"'."\n" + .' ],'."\n" + .' "clusters": ['."\n" + .' "1"'."\n" + .' ]'."\n" + .' },'."\n" + .' "enabled": false,'."\n" + .' "id": 1,'."\n" + .' "created_at": 1753170771,'."\n" + .' "updated_at": 1753170811'."\n" + .' }', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"Success\\",\\n \\"data\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"pid\\\\\\", \\\\\\"comm\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T01:04:30Z\\\\\\"，\\\\\\"6890\\\\\\"，\\\\\\"coredns\\\\\\"\\"\\n ]\\n ]\\n }\\n}","type":"json"}]', - ], - 'GetHotspotInstanceList' => [ - 'summary' => '获取热点实例列表', - 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_instance_list', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"1808078950770264\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"items\\\\\\": [\\\\n \\\\\\"节点CPU使用率检测\\\\\\"\\\\n ],\\\\n \\\\\\"clusters\\\\\\": [\\\\n \\\\\\"1\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"enabled\\\\\\": false,\\\\n \\\\\\"id\\\\\\": 1,\\\\n \\\\\\"created_at\\\\\\": 1753170771,\\\\n \\\\\\"updated_at\\\\\\": 1753170811\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'Delete alert policy', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sysom:DeleteAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DescribeMetricList' => [ + 'summary' => 'Queries metric data.', + 'path' => '/api/v1/openapi/proxy/get/describeMetricList', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'table' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'prof_on', - ], - 'beg_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725413647000', - ], - 'beg_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725413947000', - ], - ], - 'required' => false, - ], + 'name' => 'instance', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'required' => false], + ], + [ + 'name' => 'metricName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'sysom_cpu_graph', 'required' => false], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start time as a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1709740800000', 'required' => false], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time as a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683618245000', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['title' => '', 'description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success'], + 'message' => ['title' => '', 'description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => '分析ID: 56dae746-ef55-4f77-8373-cb3594c41457'."\n" + .'机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!'], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'column', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-2ze5ru5rjurix7f71sxv', + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'metricName' => ['title' => '', 'description' => 'The metric name.', 'type' => 'string', 'example' => 'sysom_cpu_usage_idle'], + 'labels' => ['title' => '', 'description' => 'The metric labels.', 'type' => 'string', 'example' => '{\'taskExecName\': \'build-and-deploy\', \'pipelineName\': \'pipeline-run-1722909642357\'}'], + 'values' => [ + 'description' => 'The metric data.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A data point in the format of [<timestamp>, <value>].', + 'type' => 'array', + 'items' => ['description' => '时间/数值', 'type' => 'string', 'example' => '1743036429.0', 'title' => ''], + 'example' => '["1743036429.0", "10489572.0"]', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"分析ID: 56dae746-ef55-4f77-8373-cb3594c41457\\\\n机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!\\",\\n \\"data\\": [\\n {\\n \\"metricName\\": \\"sysom_cpu_usage_idle\\",\\n \\"labels\\": \\"{\'taskExecName\': \'build-and-deploy\', \'pipelineName\': \'pipeline-run-1722909642357\'}\\",\\n \\"values\\": [\\n [\\n \\"1743036429.0\\"\\n ]\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query metric data', + 'description' => 'The instance list returned by this operation contains only instances that are managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:DescribeMetricList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": {\\n \\"columns\\": [\\n \\"column\\"\\n ],\\n \\"values\\": [\\n \\"i-2ze5ru5rjurix7f71sxv\\"\\n ]\\n }\\n}","type":"json"}]', ], - 'GetHotspotCompare' => [ - 'summary' => '热点对比', - 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_compare', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GenerateCopilotResponse' => [ + 'summary' => 'Get the response result of the copilot service', + 'path' => '/api/v1/copilot/generate_copilot_response', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '231282', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -1957,233 +1175,76 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'table' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'prof_on', - ], - 'instance1' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-2zei55fwj8nnu31h3z46"', - ], - 'pid1' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'beg1_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725415474000', - ], - 'beg1_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725415774000', - ], - 'instance2' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0', - ], - 'pid2' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'i-2zei55fwj8nnu31h3z46', - ], - 'beg2_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725415474000', - ], - 'beg2_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725415774000', - ], - 'hot_type' => [ - 'type' => 'string', - ], + 'llmParamString' => ['title' => '', 'description' => 'Input parameters for the copilot LLM service. Refer to the standard LLM API input parameter dict, which needs to be converted to a string and passed into llmParamString', 'type' => 'string', 'required' => false, 'example' => '"{\\"model\\":\\"Qwen-7B-Chat\\",\\"temperature\\":0.9,\\"max_tokens\\":1000,\\"top_p\\":1,\\"frequency_penalty\\":0.0,\\"presence_penalty\\":0.6,\\"messages\\":[{\\"role\\":\\"user\\",\\"content\\":\\"我是os工程师\\"},{\\"role\\":\\"assistant\\",\\"content\\":\\"您好。我是AI语言模型，很高兴为您服 务。有什么我能帮助您的呢\\"},{\\"role\\":\\"user\\",\\"content\\":\\"你知道什么是alinux吗\\"}]}"'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError'."\n", - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'flame' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"sample", "time"', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"metadata\\":{\\"spyName\\":\\"cprof\\",\\"leftTicks\\":38,\\"name\\":\\"liveTrace\\",\\"rightTicks\\":38,\\"format\\":\\"double\\",\\"units\\":\\"samples\\",\\"appName\\":\\"liveTrace.profiling\\",\\"sampleRate\\":100},\\"version\\":1,\\"other\\":{\\"Table\\":\\"prof_on\\",\\"leftInstance\\":\\"i-2zei55fwj8nnu31h3z46\\",\\"rightInstance\\":\\"i-2zei55fwj8nnu31h3z46\\",\\"leftPid\\":0,\\"rightPid\\":0},\\"flamebearer\\":{\\"maxSelf\\":7,\\"names\\":[\\"total\\",\\"host\\",\\"idle:0\\",\\"default_enter_idle\\",\\"default_idle\\",\\"asm_common_interrupt\\",\\"common_interrupt\\",\\"irq_exit_rcu\\",\\"do_softirq_own_stack\\",\\"asm_call_irq_on_stack\\",\\"__do_softirq\\",\\"net_rx_action\\",\\"napi_poll\\",\\"nsh_cleanup_module\\",\\"napi_complete_done\\",\\"netif_receive_skb_list_internal\\",\\"__netif_receive_skb_list\\",\\"__netif_receive_skb_list_core\\",\\"__netif_receive_skb_core\\",\\"ip_local_deliver_finish\\",\\"ip_protocol_deliver_rcu\\",\\"tcp_v4_rcv\\",\\"__xfrm_policy_check2.constprop.0\\",\\"ip_local_deliver\\",\\"nf_hook_slow\\",\\"secondary_startup_64_no_verify\\",\\"cpu_startup_entry\\",\\"do_idle\\",\\"cpuidle_idle_call\\",\\"haltpoll_reflect\\",\\"cpuidle_enter\\",\\"cpuidle_enter_state\\",\\"sched_clock_cpu\\",\\"sched_clock\\",\\"kvm_sched_clock_read\\",\\"pvclock_clocksource_read\\",\\"asm_sysvec_call_function_single\\",\\"sysvec_call_function_single\\",\\"_nohz_idle_balance\\",\\"rebalance_domains\\",\\"load_balance\\",\\"cpumask_next_and\\",\\"_find_next_bit.constprop.0\\",\\"update_blocked_averages\\",\\"asm_sysvec_apic_timer_interrupt\\",\\"sysvec_apic_timer_interrupt\\",\\"rcu_core\\",\\"rcu_report_qs_rdp\\",\\"_raw_spin_unlock_irqrestore\\",\\"rcu_do_batch\\",\\"__put_task_struct\\",\\"rcu_cblist_dequeue\\",\\"run_timer_softirq\\",\\"__run_timers.part.0\\",\\"run_rebalance_domains\\",\\"start_kernel\\",\\"call_timer_fn\\",\\"process_timeout\\",\\"note_gp_changes\\",\\"schedule_idle\\",\\"__schedule\\"],\\"numTicks\\":76,\\"levels\\":[[0,38,0,0,38,0,0],[0,38,0,0,38,0,1],[0,38,0,0,38,0,2],[0,2,0,0,2,0,3,0,1,0,0,1,0,4,0,35,0,0,35,0,25],[0,2,0,0,2,0,4,0,1,0,0,1,0,5,0,27,3,0,27,3,26,0,8,0,0,8,0,55],[0,2,0,0,2,0,5,0,1,0,0,1,0,6,3,24,0,3,24,0,27,0,8,0,0,8,0,26],[0,2,0,0,2,0,6,0,1,0,0,1,0,7,3,24,0,3,24,0,28,0,8,0,0,8,0,27],[0,2,0,0,2,0,7,0,1,0,0,1,0,8,3,1,1,3,1,1,29,0,23,0,0,23,0,30,0,7,0,0,7,0,28,0,1,0,0,1,0,59],[0,2,0,0,2,0,8,0,1,0,0,1,0,9,4,23,0,4,23,0,31,0,6,0,0,6,0,30,0,1,1,0,1,1,29,0,1,1,0,1,1,60],[0,2,0,0,2,0,9,0,1,0,0,1,0,10,4,4,1,4,4,1,32,0,19,0,0,19,0,3,0,6,0,0,6,0,31],[0,2,0,0,2,0,10,0,1,0,0,1,0,11,5,3,0,5,3,0,33,0,19,0,0,19,0,4,0,1,0,0,1,0,32,0,5,0,0,5,0,3],[0,2,0,0,2,0,11,0,1,0,0,1,0,12,5,3,0,5,3,0,34,0,2,0,0,2,0,36,0,17,0,0,17,0,44,0,1,0,0,1,0,33,0,5,0,0,5,0,4],[0,2,0,0,2,0,12,0,1,0,0,1,0,13,5,3,3,5,3,3,35,0,2,0,0,2,0,37,0,17,0,0,17,0,45,0,1,0,0,1,0,34,0,1,0,0,1,0,36,0,4,0,0,4,0,44],[0,2,0,0,2,0,13,0,1,0,0,1,0,14,8,2,0,8,2,0,7,0,17,0,0,17,0,7,0,1,1,0,1,1,35,0,1,0,0,1,0,37,0,4,0,0,4,0,45],[0,2,0,0,2,0,14,0,1,0,0,1,0,15,8,2,0,8,2,0,8,0,17,0,0,17,0,8,1,1,0,1,1,0,7,0,4,0,0,4,0,7],[0,2,0,0,2,0,15,0,1,0,0,1,0,16,8,2,0,8,2,0,9,0,17,0,0,17,0,9,1,1,0,1,1,0,8,0,4,0,0,4,0,8],[0,2,0,0,2,0,16,0,1,0,0,1,0,17,8,2,0,8,2,0,10,0,17,0,0,17,0,10,1,1,0,1,1,0,9,0,4,0,0,4,0,9],[0,2,0,0,2,0,17,0,1,0,0,1,0,18,8,2,0,8,2,0,38,0,4,0,0,4,0,46,0,3,0,0,3,0,39,0,2,0,0,2,0,52,0,1,1,0,1,1,53,0,7,0,0,7,0,54,1,1,0,1,1,0,10,0,4,1,0,4,1,10],[0,2,0,0,2,0,18,0,1,0,0,1,0,23,8,1,0,8,1,0,39,0,1,1,0,1,1,43,0,2,0,0,2,0,47,0,2,0,0,2,0,49,0,3,2,0,3,2,40,0,2,2,0,2,2,53,1,7,7,1,7,7,43,1,1,0,1,1,0,38,1,1,0,1,1,0,52,0,1,0,0,1,0,54,0,1,0,0,1,0,46],[0,1,0,0,1,0,19,0,1,0,0,1,0,23,0,1,0,0,1,0,24,8,1,0,8,1,0,40,1,2,2,1,2,2,48,0,1,1,0,1,1,50,0,1,1,0,1,1,51,2,1,0,2,1,0,41,11,1,1,11,1,1,43,1,1,0,1,1,0,53,0,1,1,0,1,1,43,0,1,0,0,1,0,58],[0,1,0,0,1,0,20,0,1,0,0,1,0,24,0,1,0,0,1,0,13,8,1,0,8,1,0,41,7,1,1,7,1,1,42,13,1,0,13,1,0,56,1,1,1,1,1,1,48],[0,1,0,0,1,0,21,0,1,0,0,1,0,13,0,1,0,0,1,0,13,8,1,1,8,1,1,42,21,1,1,21,1,1,57],[0,1,1,0,1,1,22,0,1,1,0,1,1,13,0,1,1,0,1,1,13]]},\\"timeLine\\":{\\"left\\":{\\"durationDelta\\":10,\\"startTime\\":1725415480,\\"samples\\":[3,2,5,5,7,8,7,1]},\\"right\\":{\\"durationDelta\\":10,\\"startTime\\":1725415480,\\"samples\\":[3,2,5,5,7,8,7,1]}}}"'."\n", - ], - ], - ], - ], - ], - 'series_instance1' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"time", "EXPR$1"', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"2024-09-04T02:04:40Z", "3"', - ], - ], - ], - ], - ], - 'series_instance2' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"time", "EXPR$1"', - ], - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"2024-09-04T02:04:40Z", "3"', - ], - ], - ], - ], - ], - ], - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError'], + 'massage' => ['title' => '', 'description' => 'Error code description, empty if no error occurs', 'type' => 'string', 'example' => 'Requests for llm service failed'], + 'data' => ['title' => '', 'description' => 'Data returned by the LLM service, in string type. If it is a dict, you need to convert and parse it yourself', 'type' => 'string', 'example' => '{\'choices\': [{\'finish_reason\': \'stop\', \'index\': 0, \'message\': {\'content\': \'Alinux是一个基于Linux的开源操作系统，它主要由阿里巴巴集团开发和维护，专为大规模云计算和大数据处理环境设计。这个系统针对高并发、低延迟以及资源利用率优化进行了深度定制和改良，以适应阿里内部复杂且庞大的业务需求。由于其在性能和稳定性方面的优秀表现，Alinux也在逐渐被外部的一些企业和研究机构采用，特别是在需要处理高负载场景的领域。与标准Linux发行版相比，Alinux可能包含特定的内核补丁、优化工具集以及其他阿里巴巴内部研发的特性。然而，值得注意的是，尽管名称中的“Ali”可能让人联想到与阿里巴巴的紧密关系，但Alinux作为一个项目，已经于2021年成为开放原子开源基金会（OpenAtom Foundation）下的一个子项目，即 OpenAnolis，这标志着它的社区化和广泛化的进程。\', \'role\': \'assistant\'}}], \'model\': \'Qwen1.5\', \'sentiment\': [], \'status_code\': 200, \'time\': 6.836989402770996, \'usage\': {\'completion_tokens\': 180, \'prompt_tokens\': 176, \'time_dict\': {\'auto_regression_time\': 0.03798324399524265, \'speed\': 26.327398474054736, \'total_generate_time\': 6.836983919143677}, \'total_tokens\': 356}}'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": {\\n \\"flame\\": {\\n \\"columns\\": [\\n \\"\\\\\\"sample\\\\\\", \\\\\\"time\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"{\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"spyName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cprof\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"leftTicks\\\\\\\\\\\\\\":38,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rightTicks\\\\\\\\\\\\\\":38,\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"double\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"units\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace.profiling\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sampleRate\\\\\\\\\\\\\\":100},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"other\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"prof_on\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"leftInstance\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2zei55fwj8nnu31h3z46\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rightInstance\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2zei55fwj8nnu31h3z46\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"leftPid\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"rightPid\\\\\\\\\\\\\\":0},\\\\\\\\\\\\\\"flamebearer\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"maxSelf\\\\\\\\\\\\\\":7,\\\\\\\\\\\\\\"names\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"total\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"idle:0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"default_enter_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"default_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_common_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"common_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"irq_exit_rcu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_softirq_own_stack\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_call_irq_on_stack\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__do_softirq\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"net_rx_action\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"napi_poll\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nsh_cleanup_module\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"napi_complete_done\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"netif_receive_skb_list_internal\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__netif_receive_skb_list\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__netif_receive_skb_list_core\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__netif_receive_skb_core\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip_local_deliver_finish\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip_protocol_deliver_rcu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tcp_v4_rcv\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__xfrm_policy_check2.constprop.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip_local_deliver\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nf_hook_slow\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"secondary_startup_64_no_verify\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpu_startup_entry\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpuidle_idle_call\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"haltpoll_reflect\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpuidle_enter\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpuidle_enter_state\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sched_clock_cpu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sched_clock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"kvm_sched_clock_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pvclock_clocksource_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_sysvec_call_function_single\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sysvec_call_function_single\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_nohz_idle_balance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rebalance_domains\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"load_balance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpumask_next_and\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_find_next_bit.constprop.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"update_blocked_averages\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_sysvec_apic_timer_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sysvec_apic_timer_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_core\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_report_qs_rdp\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_raw_spin_unlock_irqrestore\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_do_batch\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__put_task_struct\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_cblist_dequeue\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"run_timer_softirq\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__run_timers.part.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"run_rebalance_domains\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"start_kernel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"call_timer_fn\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"process_timeout\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"note_gp_changes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"schedule_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__schedule\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"numTicks\\\\\\\\\\\\\\":76,\\\\\\\\\\\\\\"levels\\\\\\\\\\\\\\":[[0,38,0,0,38,0,0],[0,38,0,0,38,0,1],[0,38,0,0,38,0,2],[0,2,0,0,2,0,3,0,1,0,0,1,0,4,0,35,0,0,35,0,25],[0,2,0,0,2,0,4,0,1,0,0,1,0,5,0,27,3,0,27,3,26,0,8,0,0,8,0,55],[0,2,0,0,2,0,5,0,1,0,0,1,0,6,3,24,0,3,24,0,27,0,8,0,0,8,0,26],[0,2,0,0,2,0,6,0,1,0,0,1,0,7,3,24,0,3,24,0,28,0,8,0,0,8,0,27],[0,2,0,0,2,0,7,0,1,0,0,1,0,8,3,1,1,3,1,1,29,0,23,0,0,23,0,30,0,7,0,0,7,0,28,0,1,0,0,1,0,59],[0,2,0,0,2,0,8,0,1,0,0,1,0,9,4,23,0,4,23,0,31,0,6,0,0,6,0,30,0,1,1,0,1,1,29,0,1,1,0,1,1,60],[0,2,0,0,2,0,9,0,1,0,0,1,0,10,4,4,1,4,4,1,32,0,19,0,0,19,0,3,0,6,0,0,6,0,31],[0,2,0,0,2,0,10,0,1,0,0,1,0,11,5,3,0,5,3,0,33,0,19,0,0,19,0,4,0,1,0,0,1,0,32,0,5,0,0,5,0,3],[0,2,0,0,2,0,11,0,1,0,0,1,0,12,5,3,0,5,3,0,34,0,2,0,0,2,0,36,0,17,0,0,17,0,44,0,1,0,0,1,0,33,0,5,0,0,5,0,4],[0,2,0,0,2,0,12,0,1,0,0,1,0,13,5,3,3,5,3,3,35,0,2,0,0,2,0,37,0,17,0,0,17,0,45,0,1,0,0,1,0,34,0,1,0,0,1,0,36,0,4,0,0,4,0,44],[0,2,0,0,2,0,13,0,1,0,0,1,0,14,8,2,0,8,2,0,7,0,17,0,0,17,0,7,0,1,1,0,1,1,35,0,1,0,0,1,0,37,0,4,0,0,4,0,45],[0,2,0,0,2,0,14,0,1,0,0,1,0,15,8,2,0,8,2,0,8,0,17,0,0,17,0,8,1,1,0,1,1,0,7,0,4,0,0,4,0,7],[0,2,0,0,2,0,15,0,1,0,0,1,0,16,8,2,0,8,2,0,9,0,17,0,0,17,0,9,1,1,0,1,1,0,8,0,4,0,0,4,0,8],[0,2,0,0,2,0,16,0,1,0,0,1,0,17,8,2,0,8,2,0,10,0,17,0,0,17,0,10,1,1,0,1,1,0,9,0,4,0,0,4,0,9],[0,2,0,0,2,0,17,0,1,0,0,1,0,18,8,2,0,8,2,0,38,0,4,0,0,4,0,46,0,3,0,0,3,0,39,0,2,0,0,2,0,52,0,1,1,0,1,1,53,0,7,0,0,7,0,54,1,1,0,1,1,0,10,0,4,1,0,4,1,10],[0,2,0,0,2,0,18,0,1,0,0,1,0,23,8,1,0,8,1,0,39,0,1,1,0,1,1,43,0,2,0,0,2,0,47,0,2,0,0,2,0,49,0,3,2,0,3,2,40,0,2,2,0,2,2,53,1,7,7,1,7,7,43,1,1,0,1,1,0,38,1,1,0,1,1,0,52,0,1,0,0,1,0,54,0,1,0,0,1,0,46],[0,1,0,0,1,0,19,0,1,0,0,1,0,23,0,1,0,0,1,0,24,8,1,0,8,1,0,40,1,2,2,1,2,2,48,0,1,1,0,1,1,50,0,1,1,0,1,1,51,2,1,0,2,1,0,41,11,1,1,11,1,1,43,1,1,0,1,1,0,53,0,1,1,0,1,1,43,0,1,0,0,1,0,58],[0,1,0,0,1,0,20,0,1,0,0,1,0,24,0,1,0,0,1,0,13,8,1,0,8,1,0,41,7,1,1,7,1,1,42,13,1,0,13,1,0,56,1,1,1,1,1,1,48],[0,1,0,0,1,0,21,0,1,0,0,1,0,13,0,1,0,0,1,0,13,8,1,1,8,1,1,42,21,1,1,21,1,1,57],[0,1,1,0,1,1,22,0,1,1,0,1,1,13,0,1,1,0,1,1,13]]},\\\\\\\\\\\\\\"timeLine\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"left\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"durationDelta\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1725415480,\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":[3,2,5,5,7,8,7,1]},\\\\\\\\\\\\\\"right\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"durationDelta\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1725415480,\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":[3,2,5,5,7,8,7,1]}}}\\\\\\"\\\\n\\"\\n ]\\n ]\\n },\\n \\"series_instance1\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"EXPR$1\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T02:04:40Z\\\\\\", \\\\\\"3\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"series_instance2\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"EXPR$1\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T02:04:40Z\\\\\\", \\\\\\"3\\\\\\"\\"\\n ]\\n ]\\n }\\n },\\n \\"success\\": true\\n}","type":"json"}]', - ], - 'GetHotspotAnalysis' => [ - 'summary' => '获取热定分析结果', - 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_analysis', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"massage\\": \\"Requests for llm service failed\\",\\n \\"data\\": \\"{\'choices\': [{\'finish_reason\': \'stop\', \'index\': 0, \'message\': {\'content\': \'Alinux是一个基于Linux的开源操作系统，它主要由阿里巴巴集团开发和维护，专为大规模云计算和大数据处理环境设计。这个系统针对高并发、低延迟以及资源利用率优化进行了深度定制和改良，以适应阿里内部复杂且庞大的业务需求。由于其在性能和稳定性方面的优秀表现，Alinux也在逐渐被外部的一些企业和研究机构采用，特别是在需要处理高负载场景的领域。与标准Linux发行版相比，Alinux可能包含特定的内核补丁、优化工具集以及其他阿里巴巴内部研发的特性。然而，值得注意的是，尽管名称中的“Ali”可能让人联想到与阿里巴巴的紧密关系，但Alinux作为一个项目，已经于2021年成为开放原子开源基金会（OpenAtom Foundation）下的一个子项目，即 OpenAnolis，这标志着它的社区化和广泛化的进程。\', \'role\': \'assistant\'}}], \'model\': \'Qwen1.5\', \'sentiment\': [], \'status_code\': 200, \'time\': 6.836989402770996, \'usage\': {\'completion_tokens\': 180, \'prompt_tokens\': 176, \'time_dict\': {\'auto_regression_time\': 0.03798324399524265, \'speed\': 26.327398474054736, \'total_generate_time\': 6.836983919143677}, \'total_tokens\': 356}}\\"\\n}","type":"json"}]', + 'title' => 'Request copilot service', + 'description' => '- Parameters need to be filled in according to the standard LLM service input parameters, converted to a string, and assigned to llmParamString'."\n" + .'- The returned data needs to be converted from string to dict before use. Refer to the standard LLM service response format', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GenerateCopilotResponse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GenerateCopilotStreamResponse' => [ + 'summary' => 'Calls the streaming SSE endpoint of the OS Copilot service.', + 'path' => '/api/v1/copilot/generate_copilot_stream_response', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => [], + 'produces' => [], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxJZOVCX', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -2191,130 +1252,77 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'appType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'GR', - ], - 'pid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1657494', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-2ze5ru5rjurix7f71sxv', - ], - 'beg_start' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725410348000', - ], - 'beg_end' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1725413948000', - ], - 'table' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'prof_on', - ], + 'llmParamString' => ['title' => '', 'description' => 'The input parameter for the Copilot LLM service. Refer to the standard LLM operation input parameter dictionary. Convert the dictionary to a string and pass it in llmParamString.', 'type' => 'string', 'required' => false, 'example' => '"{\\"model\\":\\"Qwen-7B-Chat\\",\\"temperature\\":0.9,\\"max_tokens\\":1000,\\"top_p\\":1,\\"frequency_penalty\\":0.0,\\"presence_penalty\\":0.6,\\"messages\\":[{\\"role\\":\\"user\\",\\"content\\":\\"我是os工程师\\"},{\\"role\\":\\"assistant\\",\\"content\\":\\"您好。我是AI语言模型，很高兴为您服 务。有什么我能帮助您的呢\\"},{\\"role\\":\\"user\\",\\"content\\":\\"你知道什么是alinux吗\\"}]}"'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => "\n" - .'success', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError'."\n"], + 'message' => ['title' => '', 'description' => 'The description of the error code. This value is empty if no error occurs.', 'type' => 'string', 'example' => 'Requests for llm service failed'."\n"], + 'data' => ['title' => '', 'description' => 'The data returned by the LLM service. The value is of the string type. Convert and parse it yourself if the value is a dictionary.', 'type' => 'string', 'example' => '{\'choices\': [{\'finish_reason\': \'stop\', \'index\': 0, \'message\': {\'content\': \'Alinux是一个基于Linux的开源操作系统，它主要由阿里巴巴集团开发和维护，专为大规模云计算和大数据处理环境设计。这个系统针对高并发、低延迟以及资源利用率优化进行了深度定制和改良，以适应阿里内部复杂且庞大的业务需求。由于其在性能和稳定性方面的优秀表现，Alinux也在逐渐被外部的一些企业和研究机构采用，特别是在需要处理高负载场景的领域。与标准Linux发行版相比，Alinux可能包含特定的内核补丁、优化工具集以及其他阿里巴巴内部研发的特性。然而，值得注意的是，尽管名称中的“Ali”可能让人联想到与阿里巴巴的紧密关系，但Alinux作为一个项目，已经于2021年成为开放原子开源基金会（OpenAtom Foundation）下的一个子项目，即 OpenAnolis，这标志着它的社区化和广泛化的进程。\', \'role\': \'assistant\'}}], \'model\': \'Qwen1.5\', \'sentiment\': [], \'status_code\': 200, \'time\': 6.836989402770996, \'usage\': {\'completion_tokens\': 180, \'prompt_tokens\': 176, \'time_dict\': {\'auto_regression_time\': 0.03798324399524265, \'speed\': 26.327398474054736, \'total_generate_time\': 6.836983919143677}, \'total_tokens\': 356}}'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"Requests for llm service failed\\\\n\\",\\n \\"data\\": \\"{\'choices\': [{\'finish_reason\': \'stop\', \'index\': 0, \'message\': {\'content\': \'Alinux是一个基于Linux的开源操作系统，它主要由阿里巴巴集团开发和维护，专为大规模云计算和大数据处理环境设计。这个系统针对高并发、低延迟以及资源利用率优化进行了深度定制和改良，以适应阿里内部复杂且庞大的业务需求。由于其在性能和稳定性方面的优秀表现，Alinux也在逐渐被外部的一些企业和研究机构采用，特别是在需要处理高负载场景的领域。与标准Linux发行版相比，Alinux可能包含特定的内核补丁、优化工具集以及其他阿里巴巴内部研发的特性。然而，值得注意的是，尽管名称中的“Ali”可能让人联想到与阿里巴巴的紧密关系，但Alinux作为一个项目，已经于2021年成为开放原子开源基金会（OpenAtom Foundation）下的一个子项目，即 OpenAnolis，这标志着它的社区化和广泛化的进程。\', \'role\': \'assistant\'}}], \'model\': \'Qwen1.5\', \'sentiment\': [], \'status_code\': 200, \'time\': 6.836989402770996, \'usage\': {\'completion_tokens\': 180, \'prompt_tokens\': 176, \'time_dict\': {\'auto_regression_time\': 0.03798324399524265, \'speed\': 26.327398474054736, \'total_generate_time\': 6.836983919143677}, \'total_tokens\': 356}}\\"\\n}","type":"json"}]', + 'title' => 'Call the OS copilot streaming SSE endpoint', + 'description' => '- Use this operation together with the call_sseapi operation in the aliyun-tea-openapi-inner package.'."\n" + .'- Populate the parameters based on the standard LLM service input parameters, convert them to a string, and assign the string to llmParamString.'."\n" + .'- Convert the returned string to a dictionary before use. Refer to the standard LLM service response format.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GenerateCopilotStreamResponse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"data\\": \\"\\\\\\"AliYunDun:1657494进程(1657494):根据提供的热点调用栈信息，热点主要集中在`__nanosleep_nocancel`以及相关的系统调用`SyS_nanosleep`上，这表明进程在等待特定的时间间隔。通常这是由于应用中存在长时间的睡眠或高频率的定时操作导致的，比如定时任务、心跳检测等。\\\\\\\\n\\\\\\\\n应用代码在需要定期执行某些检查或等待外部事件时会使用`nanosleep`来实现精确的延时控制。为了优化这种情况，可以考虑以下方案：\\\\\\\\n- 评估是否可以减少定时任务的频率。\\\\\\\\n- 使用条件变量替代单纯的睡眠等待，以响应更快的事件触发。\\\\\\\\n- 如果是I/O密集型操作等待，考虑优化I/O路径或提升I/O效率。建议使用SysOM平台的IO诊断工具来进一步定位具体的I/O瓶颈。\\\\\\"\\",\\n \\"success\\": true,\\n \\"message\\": \\"\\\\nsuccess\\"\\n}","type":"json"}]', ], - 'StartAIAnalysis' => [ - 'summary' => '启动AI作业分析', - 'path' => '/api/v1/openapi/proxy/post/start_ai_analysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetAIQueryResult' => [ + 'summary' => 'Queries the AI Infra analysis results.', + 'path' => '/api/v1/app_observ/aiAnalysis/query_result', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '255600', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeCode' => '255605', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ @@ -2322,638 +1330,689 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9dej066kii4goqxxxx', - ], - 'timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000', - ], - 'pids' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2421,36547,10043', - ], - 'comms' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'python_test', - ], - 'channel' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs_sysom', - ], - 'iteration_mod' => [ - 'type' => 'string', - ], - 'iteration_func' => [ - 'type' => 'string', - ], - 'uid' => [ - 'type' => 'string', - ], - 'created_by' => [ - 'type' => 'string', - ], - 'instance_type' => [ - 'type' => 'string', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', - ], - 'iteration_range' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - 'analysis_params' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'analysisTool' => [ - 'type' => 'string', - 'required' => false, - ], + 'analysisId' => ['description' => 'The AI analysis ID.', 'type' => 'string', 'required' => false, 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426'."\n", 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'analysis_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '分析ID: 56dae746-ef55-4f77-8373-cb3594c41457'."\n" + .'机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!', 'title' => ''], + 'data' => ['description' => 'The returned results. The data volume can be large.', 'type' => 'string', 'example' => '{\'task_id\': \'y4ba8uRV\'}', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"analysis_id\\": \\"16896fa8-37f6-4c70-bb32-67fa9817d426\\"\\n }\\n}","type":"json"}]', - ], - 'GetListRecord' => [ - 'summary' => 'AI Infra获取分析记录列表', - 'path' => '/api/v1/app_observ/aiAnalysis/list_record', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"分析ID: 56dae746-ef55-4f77-8373-cb3594c41457\\\\n机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!\\",\\n \\"data\\": \\"{\'task_id\': \'y4ba8uRV\'}\\"\\n}","type":"json"}]', + 'title' => 'Retrieve AI infra observation results', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAIQueryResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetAbnormalEventsCount' => [ + 'summary' => 'Get the count of unhandled (undiagnosed) abnormal events of different levels for nodes/Pods', + 'path' => '/api/v1/openapi/cluster_health/range/abnormaly_events_count', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '255604', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '237718', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'current', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2ijff4be-bf24-4070-89ca-c47c879b0g32', 'title' => ''], ], [ - 'name' => 'pageSize', + 'name' => 'instance', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], + ], + [ + 'name' => 'pod', + 'in' => 'query', + 'schema' => ['description' => 'Pod name.', 'type' => 'string', 'required' => false, 'example' => 'test-pod', 'title' => ''], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace where the Pod resides.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'start', + 'in' => 'query', + 'schema' => ['description' => 'Start time.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1725797727754', 'title' => ''], + ], + [ + 'name' => 'end', + 'in' => 'query', + 'schema' => ['description' => 'End time.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1725801327754', 'title' => ''], + ], + [ + 'name' => 'showPod', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Whether to display Pod abnormal events.', + 'enumValueTitles' => ['Do not display' => '0', 'Display' => '1'], 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => false, - 'example' => '10', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'region', + 'name' => 'level', 'in' => 'query', 'schema' => [ + 'description' => 'Level of abnormal events.', + 'enumValueTitles' => ['warning' => 'warning', 'error' => 'error', 'potential' => 'potential'], 'type' => 'string', 'required' => false, + 'example' => 'potential', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'When success is false, this value is not empty, indicating a business error message.', 'type' => 'string', 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'analysisId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', - ], - 'analysisTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-24 12:02:05'."\n", - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'arguments' => [ - 'description' => '', + 'type' => [ + 'description' => 'Abnormal event type.', + 'enumValueTitles' => ['"potential"' => 'potential', '"error"' => 'error', '"warning"' => 'warning'], 'type' => 'string', - 'example' => 'timeout=2000 ms', + 'example' => 'health', + 'title' => '', ], - 'failedLog' => [ - 'description' => '', - 'type' => 'string', + 'value' => ['description' => 'Count of abnormal event type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'eventList' => [ + 'description' => 'List of abnormal events.', + 'type' => 'array', + 'items' => ['description' => 'Abnormal event name.', 'type' => 'string', 'example' => '节点根文件系统使用检测', 'title' => ''], + 'title' => '', 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"analysisId\\": \\"16896fa8-37f6-4c70-bb32-67fa9817d426\\",\\n \\"analysisTime\\": \\"2024-12-24 12:02:05\\\\n\\",\\n \\"status\\": \\"已完成/分析失败\\",\\n \\"arguments\\": \\"timeout=2000 ms\\",\\n \\"failedLog\\": \\"机器i-wz9dej066kii4goqpnze分析失败, 失败原因: Not get GPU trace data for \'e59ce870-dbd4-4c44-a814-174ac6ab5bcf\' \'[\'118534\']\'!\\"\\n }\\n ],\\n \\"total\\": 19\\n}","type":"json"}]', - ], - 'GetAIQueryResult' => [ - 'summary' => '查看AI Infra分析结果', - 'path' => '/api/v1/app_observ/aiAnalysis/query_result', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"health\\",\\n \\"value\\": 1,\\n \\"eventList\\": [\\n \\"节点根文件系统使用检测\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get the count of abnormal events', + 'changeSet' => [ + ['createdAt' => '2025-08-03T12:17:50.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-12-24T14:08:33.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAbnormalEventsCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'translator' => 'machine', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetAgent' => [ + 'summary' => 'Get details of a specific agent', + 'path' => '/api/v1/am/agent/get_agent', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '255605', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'analysisId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426'."\n", - ], - ], - 'required' => false, - ], + 'name' => 'agent_id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'code' => ['title' => '', 'description' => 'Status code'."\n" + .'- `code == Success` indicates the authorization is successful;'."\n" + .'- Other status codes indicate authorization failure. Check the `message` field for detailed error information when authorization fails;', 'type' => 'string', 'example' => 'Success'], + 'message' => ['description' => 'Error message'."\n" + .'- If `code == Success`, this field is empty;'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\'task_id\': \'y4ba8uRV\'}', + 'description' => 'Response data.', + 'type' => 'object', + 'properties' => [ + 'id' => ['title' => '', 'description' => 'Agent ID', 'type' => 'string', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9'], + 'name' => ['title' => '', 'description' => 'Agent name', 'type' => 'string', 'example' => 'SysOM'], + 'support_arch' => ['title' => '', 'description' => 'Supported architectures', 'type' => 'string', 'example' => 'x86'], + 'type' => ['title' => '', 'description' => 'Agent type', 'type' => 'string', 'example' => 'control'], + 'description' => ['title' => '', 'description' => 'Agent description', 'type' => 'string', 'example' => 'SysOM Agent'], + 'versions' => [ + 'description' => 'Agent version information', + 'type' => 'array', + 'items' => [ + 'description' => 'Agent version information', + 'type' => 'object', + 'properties' => [ + 'version' => ['title' => '', 'description' => 'Agent version number', 'type' => 'string', 'example' => '3.4.0-1'], + 'install_script' => ['title' => '', 'description' => 'Installation script for this agent version', 'type' => 'string', 'example' => 'sysom.sh install'], + 'uninstall_script' => ['title' => '', 'description' => 'Uninstallation script for this agent version', 'type' => 'string', 'example' => 'sysom.sh uninstall'], + 'upgrade_script' => ['title' => '', 'description' => 'Upgrade script for this agent version', 'type' => 'string', 'example' => 'sysom.sh upgrade'], + 'created_at' => ['title' => '', 'description' => 'Agent version creation time', 'type' => 'string', 'example' => '2024-09-14T20:46:08'], + 'updated_at' => ['title' => '', 'description' => 'Agent version update time', 'type' => 'string', 'example' => '2024-09-14T20:46:08'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'created_at' => ['title' => '', 'description' => 'Agent creation time', 'type' => 'string', 'example' => '2024-09-14T20:46:08'], + 'updated_at' => ['title' => '', 'description' => 'Update time', 'type' => 'string', 'example' => '2024-09-14T20:46:08'], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID, which can be used for end-to-end diagnostics', 'type' => 'string', 'example' => '2024-09-14T20:46:08', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"name\\": \\"SysOM\\",\\n \\"support_arch\\": \\"x86\\",\\n \\"type\\": \\"control\\",\\n \\"description\\": \\"SysOM Agent\\",\\n \\"versions\\": [\\n {\\n \\"version\\": \\"3.4.0-1\\",\\n \\"install_script\\": \\"sysom.sh install\\",\\n \\"uninstall_script\\": \\"sysom.sh uninstall\\",\\n \\"upgrade_script\\": \\"sysom.sh upgrade\\",\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n },\\n \\"RequestId\\": \\"2024-09-14T20:46:08\\"\\n}","type":"json"}]', + 'title' => 'Get Agent Details', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"分析ID: 56dae746-ef55-4f77-8373-cb3594c41457\\\\n机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!\\",\\n \\"data\\": \\"{\'task_id\': \'y4ba8uRV\'}\\"\\n}","type":"json"}]', ], - 'GetResources' => [ - 'summary' => '获取集群/节点资源实时使用情况', - 'path' => '/api/v1/openapi/cluster_health/instant/resource', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAgentTask' => [ + 'summary' => 'Retrieves the execution status of an Agent installation task.', + 'path' => '/api/v1/am/agent/get_agent_task', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'cluster', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], - ], - [ - 'name' => 'instance', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], - ], - [ - 'name' => 'type', + 'name' => 'task_id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '上行速率' => 'network_input', - '下行速率' => 'network_output', - '磁盘' => 'disk', - '内存' => 'mem', - 'CPU' => 'cpu', - ], - 'example' => 'mem', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '42172120177e4b3abd6fabb3a6b5e2dd', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '2354', - ], - 'usage' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'unit' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Kbytes', + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'c41d8e3506224184a714682fea86d22d', 'title' => ''], + 'jobs' => [ + 'description' => 'The list of subtasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The subtask details.', + 'type' => 'object', + 'properties' => [ + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-2zehme0rs1tc090fdl3n', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'params' => ['description' => 'The subtask parameters.', 'type' => 'any', 'example' => '{'."\n" + .' "agent_version": "3.5.0-beta",'."\n" + .' "opt": "install",'."\n" + .' "agent_id": "74a86327-3170-412c-8fd67-da3389ec56a9",'."\n" + .' "install_type": "InstallAndUpgrade"'."\n" + .'}', 'title' => ''], + 'status' => [ + 'description' => 'The subtask status. Valid values:'."\n" + .'- Created: Created.'."\n" + .'- Running: Running.'."\n" + .'- Success: The task succeeded.'."\n" + .'- Fail: The task failed.', + 'type' => 'string', + 'enum' => ['Created', 'Running', 'Success', 'Failed', 'Canceled'], + 'example' => 'Running', + 'title' => '', + ], + 'result' => ['description' => 'The subtask execution result.', 'type' => 'string', 'example' => '已废弃（误用）', 'title' => ''], + 'error' => ['description' => 'The cause of the task failure. This field is returned only when the task fails.', 'type' => 'string', 'example' => '已废弃（误用）', 'title' => ''], + 'errorCode' => ['description' => 'The error code of the subtask failure. Valid values:'."\n" + .'* Empty: The task is executed normally.'."\n" + .'* INSTANCE_NOT_SUPPORTED: The instance type is not supported.'."\n" + .'* INSTANCE_NOT_EXISTS: The instance does not exist.'."\n" + .'* INSTANCE_RELEASED: The instance has been released.'."\n" + .'* INSTANCE_NOT_RUNNING: The instance is not running.'."\n" + .'* INSTANCE_NOT_OWNED: The instance does not belong to the current account.'."\n" + .'* AGENT_ALREADY_INSTALLED: The Agent is already installed.'."\n" + .'* AGENT_NOT_INSTALLED: The Agent is not installed.'."\n" + .'* AGENT_SAME_VERSION: The version is the same.'."\n" + .'* HAS_RUNNING_JOB: A running task exists.'."\n" + .'* RPM_LOCK_HELD: The RPM lock is held.'."\n" + .'* DISK_SPACE_INSUFFICIENT: Insufficient disk space.'."\n" + .'* NODE_LOAD_HIGH: The node load is high.'."\n" + .'* COMMAND_FAILED: Command execution failed.'."\n" + .'* CLIENT_NOT_RUNNING: The Cloud Assistant Agent is not running.'."\n" + .'* CLIENT_NOT_RESPONSE: The Cloud Assistant Agent is not responding.'."\n" + .'* DELIVERY_TIMEOUT: Command delivery timed out.'."\n" + .'* EXECUTION_TIMEOUT: Command execution timed out.'."\n" + .'* TASK_CONCURRENCY_LIMIT: The task concurrency limit is reached.', 'type' => 'string', 'example' => 'DISK_SPACE_INSUFFICIENT', 'title' => ''], + 'errorMessage' => ['description' => 'The detailed description of the subtask failure. Valid values:'."\n" + .'* The instance type is not supported.'."\n" + .'* The instance does not exist.'."\n" + .'* The instance has been released.'."\n" + .'* The instance is not running.'."\n" + .'* The instance does not belong to the current account.'."\n" + .'* The Agent is already installed.'."\n" + .'* The Agent is not installed.'."\n" + .'* The Agent version is the same. No upgrade is required.'."\n" + .'* A running task exists. Try again later.'."\n" + .'* The RPM lock is held. Try again later.'."\n" + .'* Insufficient disk space.'."\n" + .'* The node load is too high. Try again later.'."\n" + .'* Command execution failed. Try again later.'."\n" + .'* The Cloud Assistant Agent is not running.'."\n" + .'* The Cloud Assistant Agent is not responding.'."\n" + .'* Command delivery timed out.'."\n" + .'* Command execution timed out.'."\n" + .'* The task concurrency limit is reached.', 'type' => 'string', 'example' => '磁盘空间不足', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', - ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '2E75336A-0DB2-5263-B201-A6488EC97B50', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.AgentNotExists', 'errorMessage' => 'Agent not exists.', 'description' => 'Agent does not exist.'], + ['errorCode' => 'SysomOpenAPI.AgentTaskNotFound', 'errorMessage' => 'Agent task not found.', 'description' => 'Component task does not exist.'], + ['errorCode' => 'SysomOpenAPI.AgentVersionNotExists', 'errorMessage' => 'Agent version not exists.', 'description' => 'Agent version does not exist.'], + ['errorCode' => 'SysomOpenAPI.InstanceNotExists', 'errorMessage' => 'Instance not exists.', 'description' => 'Instance does not exist'], + ['errorCode' => 'SysomOpenAPI.InvalidParameter', 'errorMessage' => 'Invalid parameters passed when calling the interface.', 'description' => 'Invalid parameter passed when calling interface'], + ['errorCode' => 'SysomOpenAPI.MissingParameter', 'errorMessage' => 'Missing parameters.', 'description' => 'Missing parameter'], + ['errorCode' => 'SysomOpenAPI.NoAgentInstalled', 'errorMessage' => 'No SysOM Agent version available.', 'description' => 'No SysOM Agent is available.'], + ['errorCode' => 'SysomOpenAPI.NotAuthorizedInstance', 'errorMessage' => 'Instance not authorized.', 'description' => 'The instance is not authorized.'], + ['errorCode' => 'SysomOpenAPI.NotOwnInstance', 'errorMessage' => 'Not own current instance.', 'description' => 'The specified instance does not belong to the current user.'], + ['errorCode' => 'SysomOpenAPI.NotOwnTask', 'errorMessage' => 'Diagnosis result does not belong to the current account.', 'description' => 'Diagnosis result does not belong to the current account'], + ['errorCode' => 'SysomOpenAPI.NotSupportedAgentVersion', 'errorMessage' => 'Unsupported sysom agent version.', 'description' => 'Unsupported SysOM client version.'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"task_id\\": \\"c41d8e3506224184a714682fea86d22d\\",\\n \\"jobs\\": [\\n {\\n \\"instance\\": \\"i-2zehme0rs1tc090fdl3n\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"params\\": \\"{\\\\n \\\\\\"agent_version\\\\\\": \\\\\\"3.5.0-beta\\\\\\",\\\\n \\\\\\"opt\\\\\\": \\\\\\"install\\\\\\",\\\\n \\\\\\"agent_id\\\\\\": \\\\\\"74a86327-3170-412c-8fd67-da3389ec56a9\\\\\\",\\\\n \\\\\\"install_type\\\\\\": \\\\\\"InstallAndUpgrade\\\\\\"\\\\n}\\",\\n \\"status\\": \\"Running\\",\\n \\"result\\": \\"已废弃（误用）\\",\\n \\"error\\": \\"已废弃（误用）\\",\\n \\"errorCode\\": \\"DISK_SPACE_INSUFFICIENT\\",\\n \\"errorMessage\\": \\"磁盘空间不足\\"\\n }\\n ],\\n \\"status\\": \\"\\"\\n },\\n \\"RequestId\\": \\"2E75336A-0DB2-5263-B201-A6488EC97B50\\"\\n}","type":"json"}]', + 'title' => 'Retrieve the execution status of a component task', + 'changeSet' => [ + ['createdAt' => '2025-11-03T02:41:39.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAgentTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": {\\n \\"total\\": 2354,\\n \\"usage\\": 100,\\n \\"unit\\": \\"Kbytes\\"\\n },\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', ], - 'GetHostCount' => [ - 'summary' => '获取集群节点数量', - 'path' => '/api/v1/openapi/cluster_health/range/host_count', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAlertDestination' => [ + 'path' => '/api/v1/alertPusher/alert/getDestination', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], ], 'parameters' => [ [ - 'name' => 'cluster', + 'name' => 'id', 'in' => 'query', + 'schema' => ['description' => 'The alert contact ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success or Sysom.ServerError', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'uid' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1234123412352311', 'title' => ''], + 'target' => ['description' => 'The alert notification target. Currently, only DingTalk chatbots are supported.', 'type' => 'string', 'example' => 'dingtalk', 'title' => ''], + 'name' => ['description' => 'The alert contact name.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'source' => ['description' => 'The configuration source.', 'type' => 'string', 'example' => 'console', 'title' => ''], + 'id' => ['description' => 'The alert contact ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1751520976660', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'string', 'example' => '1751254826285', 'title' => ''], + 'params' => ['description' => 'The configuration parameters.', 'type' => 'any', 'example' => '{'."\n" + .' "webhook":"",'."\n" + .' "sec":"",'."\n" + .'}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'instance', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', 'description' => 'Server error, please correct the code according to the error message'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get alert contact', + 'summary' => 'Retrieves the information of a specified alert contact.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success or Sysom.ServerError\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": {\\n \\"uid\\": \\"1234123412352311\\",\\n \\"target\\": \\"dingtalk\\",\\n \\"name\\": \\"name1\\",\\n \\"source\\": \\"console\\",\\n \\"id\\": 1,\\n \\"createdAt\\": \\"1751520976660\\",\\n \\"updatedAt\\": \\"1751254826285\\",\\n \\"params\\": \\"{\\\\n \\\\\\"webhook\\\\\\":\\\\\\"\\\\\\",\\\\n \\\\\\"sec\\\\\\":\\\\\\"\\\\\\",\\\\n}\\"\\n }\\n}","type":"json"}]', + ], + 'GetAlertStrategy' => [ + 'summary' => 'Retrieves an alert for a user based on the policy ID.', + 'path' => '/api/v1/alertPusher/alert/getStrategy', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'start', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1725797727754', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], + ], + 'parameters' => [ [ - 'name' => 'end', + 'name' => 'id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1725801327754', - ], + 'schema' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '“”', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'time' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1725797727754', - ], - 'value' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The alert policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'strategy1', 'title' => ''], + 'uid' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1222933234714935', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1751254826285', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1751520976660', 'title' => ''], + 'strategy' => [ + 'description' => 'The alert policy details.', + 'type' => 'object', + 'properties' => [ + 'items' => ['description' => '接收告警的异常项列表', 'type' => 'any', 'example' => '节点CPU使用率检测', 'title' => ''], + 'clusters' => [ + 'description' => 'The collection of clusters for which alerts are received.', + 'type' => 'array', + 'items' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cluster1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'destinations' => ['title' => '', 'type' => 'any', 'description' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'enabled' => ['description' => 'Indicates whether the alert policy is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'k8sLabel' => ['title' => '', 'description' => 'The Kubernetes label.', 'type' => 'boolean', 'example' => ''], ], - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '43A910E9-A739-525E-855D-A32C257F1826', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve alert policy', + 'changeSet' => [ + ['createdAt' => '2025-11-03T02:34:05.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"“”\\",\\n \\"data\\": [\\n {\\n \\"time\\": 1725797727754,\\n \\"value\\": 5\\n }\\n ],\\n \\"total\\": 3,\\n \\"request_id\\": \\"43A910E9-A739-525E-855D-A32C257F1826\\"\\n}","type":"json"}]', - ], - 'InitialSysom' => [ - 'summary' => '初始化SysOM，确保角色存在', - 'path' => '/api/v1/openapi/initial', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GetAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"strategy1\\",\\n \\"uid\\": \\"1222933234714935\\",\\n \\"updatedAt\\": 1751254826285,\\n \\"createdAt\\": 1751520976660,\\n \\"strategy\\": {\\n \\"items\\": \\"节点CPU使用率检测\\",\\n \\"clusters\\": [\\n \\"cluster1\\"\\n ],\\n \\"destinations\\": \\"\\"\\n },\\n \\"enabled\\": false,\\n \\"k8sLabel\\": false\\n }\\n}","type":"json"}]', + ], + 'GetCopilotHistory' => [ + 'summary' => 'Retrieves the chat history of Copilot.', + 'path' => '/api/v1/copilot/get_copilot_history', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux33ME7W', - ], + 'abilityTreeNodes' => ['FEATUREalinuxGP5QJE'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -2961,859 +2020,831 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'check_only' => [ - 'title' => '是否只检查服务角色是否存在', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - ], - 'source' => [ - 'title' => '初始化来源', - 'type' => 'string', - ], + 'count' => ['title' => '', 'description' => 'The number of historical chat records to retrieve. The value is generally less than 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'type' => 'string', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SysomOpenAPI.InvalidParameter', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error message of the request.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'role_exist' => [ - 'description' => '', - 'type' => 'boolean', + 'title' => '', + 'description' => 'The list of chat records. The length equals the requested count. If the actual number of chat records is less than the requested count, the actual number is returned. Format: [{"user":"","content":"".question,"time":""},{...}].', + 'type' => 'array', + 'items' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'user' => ['title' => '', 'description' => 'The role of the message sender. Valid values:'."\n" + .'- user: the user.'."\n" + .'- copilot: the bot.', 'type' => 'string', 'example' => 'user'."\n" + .'copilot'], + 'content' => ['title' => '', 'description' => 'The text content of the chat message.', 'type' => 'string', 'example' => 'copilot回复的具体内容'], + 'time' => ['title' => '', 'description' => 'The time of the chat record. The value is of the STRING type.', 'type' => 'string', 'example' => '2024-09-02 10:02:39'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3FCA2E38-2A8E-5501-93BD-5CE1BA58F2EF\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"role_exist\\": true\\n }\\n}","type":"json"}]', - ], - 'ListClusters' => [ - 'summary' => '获取当前用户的所有集群', - 'path' => '/api/v1/am/cluster/list_clusters', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n {\\n \\"user\\": \\"user\\\\ncopilot\\",\\n \\"content\\": \\"copilot回复的具体内容\\",\\n \\"time\\": \\"2024-09-02 10:02:39\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve chat history of the copilot streaming interface', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:GetCopilotHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetDiagnosisResult' => [ + 'path' => '/api/v1/openapi/diagnosis/get_diagnosis_results', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '253340', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinuxV02H6G'], ], 'parameters' => [ [ - 'name' => 'current', + 'name' => 'task_id', 'in' => 'query', + 'schema' => ['description' => 'The diagnostic task ID.', 'type' => 'string', 'required' => true, 'example' => 'quzuYl23', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'title' => '', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization was successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'grcuU21a', 'title' => ''], + 'status' => [ + 'description' => 'The execution status of the diagnostic task.'."\n" + .'Valid values:'."\n" + .'- **Ready**: ready'."\n" + .'- **Running**: running'."\n" + .'- **Success**: succeeded'."\n" + .'- **Fail**: failed.', + 'type' => 'string', + 'enum' => ['Success', 'Fail', 'Ready', 'Running'], + 'example' => 'Running', + 'title' => '', + ], + 'service_name' => ['description' => 'The diagnostic type.', 'type' => 'string', 'example' => 'memgraph', 'title' => ''], + 'command' => ['description' => 'The diagnostic command.', 'type' => 'any', 'example' => '{'."\n" + .' "jobs":['."\n" + .' {'."\n" + .' "cmd":"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json",'."\n" + .' "instance":"172.20.12.174",'."\n" + .' "fetch_file_list":['."\n" + ."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "in_order":true,'."\n" + .' "offline_mode":false,'."\n" + .' "offline_results":['."\n" + ."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'params' => ['description' => 'The diagnostic parameters.', 'type' => 'any', 'example' => '{'."\n" + .' "type":"all",'."\n" + .' "value":"",'."\n" + .' "channel":"ssh",'."\n" + .' "instance":"172.1.2.174",'."\n" + .' "service_name":"filecache"'."\n" + .'}', 'title' => ''], + 'code' => ['description' => 'The error code. A value of 0 indicates no error.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'err_msg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Diagnosis failed', 'title' => ''], + 'result' => ['description' => 'The diagnostic result.', 'type' => 'any', 'example' => '{'."\n" + .' "summary":" memory cgroup leak",'."\n" + .' "dataMemEvent":{'."\n" + .' "data":['."\n" + .' {'."\n" + .' "key":"Util",'."\n" + .' "value":20'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"MemLeak",'."\n" + .' "value":"OK"'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"MemcgLeak",'."\n" + .' "value":"NG"'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"MemFrag",'."\n" + .' "value":"OK"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dataMemOverView":{'."\n" + .' "data":['."\n" + .' {'."\n" + .' "key":"app",'."\n" + .' "value":10937332'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"free",'."\n" + .' "value":806800'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"kernel",'."\n" + .' "value":4527660'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dataKerMem":{'."\n" + .' "data":['."\n" + .' {'."\n" + .' "key":"SReclaimable",'."\n" + .' "value":3411292'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"VmallocUsed",'."\n" + .' "value":30980'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"allocPage",'."\n" + .' "value":177732'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"KernelStack",'."\n" + .' "value":9280'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"PageTables",'."\n" + .' "value":38056'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"SUnreclaim",'."\n" + .' "value":170248'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"reserved",'."\n" + .' "value":690072'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dataUserMem":{'."\n" + .' "data":['."\n" + .' {'."\n" + .' "key":"filecache",'."\n" + .' "value":8010008'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"anon",'."\n" + .' "value":2468608'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"mlock",'."\n" + .' "value":0'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"huge1G",'."\n" + .' "value":0'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"huge2M",'."\n" + .' "value":0'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"buffers",'."\n" + .' "value":458608'."\n" + .' },'."\n" + .' {'."\n" + .' "key":"shmem",'."\n" + .' "value":2284'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dataCacheList":{'."\n" + .' "data":['."\n" + .' {'."\n" + .' "key":0,'."\n" + .' "Name":"/var/lib/mysql/sysom/sys_handler_log.ibd",'."\n" + .' "cached":576764,'."\n" + .' "Task":"mysqld_78575 "'."\n" + .' },'."\n" + .' {'."\n" + .' "key":1,'."\n" + .' "Name":"/var/log/sysom/sysom-migration-access.log",'."\n" + .' "cached":276688,'."\n" + .' "Task":"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 "'."\n" + .' },'."\n" + .' {'."\n" + .' "key":2,'."\n" + .' "Name":"/var/log/sysom/sysom-rtdemo-access.log",'."\n" + .' "cached":229404,'."\n" + .' "Task":"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 "'."\n" + .' },'."\n" + .' {'."\n" + .' "key":3,'."\n" + .' "Name":"/var/log/sysom/sysom-monitor-server-access.log",'."\n" + .' "cached":197368,'."\n" + .' "Task":"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 "'."\n" + .' },'."\n" + .' {'."\n" + .' "key":4,'."\n" + .' "Name":"/var/log/sysom/sysom-channel-access.log",'."\n" + .' "cached":180276,'."\n" + .' "Task":"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 "'."\n" + .' },'."\n" + .' {'."\n" + .' "key":5,'."\n" + .' "Name":"total cached of close file",'."\n" + .' "cached":3729668,'."\n" + .' "Task":""'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dataProcMemList":{'."\n" + .' "data":['."\n" + .' {'."\n" + .' "key":0,'."\n" + .' "task":"mysqld",'."\n" + .' "MemTotal":240856,'."\n" + .' "RssAnon":218248,'."\n" + .' "RssFile":22608'."\n" + .' },'."\n" + .' {'."\n" + .' "key":1,'."\n" + .' "task":"systemd-journal",'."\n" + .' "MemTotal":150248,'."\n" + .' "RssAnon":74300,'."\n" + .' "RssFile":75944'."\n" + .' },'."\n" + .' {'."\n" + .' "key":2,'."\n" + .' "task":"gunicorn",'."\n" + .' "MemTotal":144640,'."\n" + .' "RssAnon":114200,'."\n" + .' "RssFile":30440'."\n" + .' },'."\n" + .' {'."\n" + .' "key":3,'."\n" + .' "task":"gunicorn",'."\n" + .' "MemTotal":141480,'."\n" + .' "RssAnon":111040,'."\n" + .' "RssFile":30440'."\n" + .' },'."\n" + .' {'."\n" + .' "key":4,'."\n" + .' "task":"grafana-server",'."\n" + .' "MemTotal":103660,'."\n" + .' "RssAnon":42732,'."\n" + .' "RssFile":60928'."\n" + .' },'."\n" + .' {'."\n" + .' "key":5,'."\n" + .' "task":"gunicorn",'."\n" + .' "MemTotal":97444,'."\n" + .' "RssAnon":76256,'."\n" + .' "RssFile":21188'."\n" + .' },'."\n" + .' {'."\n" + .' "key":6,'."\n" + .' "task":"gunicorn",'."\n" + .' "MemTotal":97260,'."\n" + .' "RssAnon":76072,'."\n" + .' "RssFile":21188'."\n" + .' },'."\n" + .' {'."\n" + .' "key":7,'."\n" + .' "task":"prometheus",'."\n" + .' "MemTotal":95356,'."\n" + .' "RssAnon":45376,'."\n" + .' "RssFile":49980'."\n" + .' },'."\n" + .' {'."\n" + .' "key":8,'."\n" + .' "task":"gunicorn",'."\n" + .' "MemTotal":90144,'."\n" + .' "RssAnon":76456,'."\n" + .' "RssFile":13688'."\n" + .' },'."\n" + .' {'."\n" + .' "key":9,'."\n" + .' "task":"gunicorn",'."\n" + .' "MemTotal":89796,'."\n" + .' "RssAnon":76108,'."\n" + .' "RssFile":13688'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'url' => ['description' => 'The URL of the diagnostic details.', 'type' => 'string', 'example' => '/diagnose/detail/qe3Z34sa', 'title' => ''], + 'created_at' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-12-03 16:30:28', 'title' => ''], + 'updated_at' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2025-12-03 16:30:28', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9515E5A0-8905-59B0-9BBF-5F0BE568C3A0', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.TaskNotFound', 'errorMessage' => 'The specified task was not found.', 'description' => 'The specified task was not found.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve diagnostic result', + 'summary' => 'Retrieves the diagnostic result.', + 'description' => 'The diagnostic process is asynchronous. When you call this operation, the diagnosis may still be in progress. You can check the `data.status` field in the response to determine the status. When `data.status == Success`, the diagnosis is complete and you can read the diagnostic result from `data.result`.', + 'changeSet' => [ + ['createdAt' => '2024-09-18T03:31:12.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetDiagnosisResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'Diagnosis', 'arn' => 'acs:sysom::{#accountId}:diagnosis/{#DiagnosisId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"task_id\\": \\"grcuU21a\\",\\n \\"status\\": \\"Running\\",\\n \\"service_name\\": \\"memgraph\\",\\n \\"command\\": \\"{\\\\n \\\\\\"jobs\\\\\\":[\\\\n {\\\\n \\\\\\"cmd\\\\\\":\\\\\\"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.20.12.174\\\\\\",\\\\n \\\\\\"fetch_file_list\\\\\\":[\\\\n\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"in_order\\\\\\":true,\\\\n \\\\\\"offline_mode\\\\\\":false,\\\\n \\\\\\"offline_results\\\\\\":[\\\\n\\\\n ]\\\\n}\\",\\n \\"params\\": \\"{\\\\n \\\\\\"type\\\\\\":\\\\\\"all\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"\\\\\\",\\\\n \\\\\\"channel\\\\\\":\\\\\\"ssh\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.1.2.174\\\\\\",\\\\n \\\\\\"service_name\\\\\\":\\\\\\"filecache\\\\\\"\\\\n}\\",\\n \\"code\\": 0,\\n \\"err_msg\\": \\"Diagnosis failed\\",\\n \\"result\\": \\"{\\\\n \\\\\\"summary\\\\\\":\\\\\\" memory cgroup leak\\\\\\",\\\\n \\\\\\"dataMemEvent\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"Util\\\\\\",\\\\n \\\\\\"value\\\\\\":20\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemcgLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"NG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemFrag\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataMemOverView\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"app\\\\\\",\\\\n \\\\\\"value\\\\\\":10937332\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"free\\\\\\",\\\\n \\\\\\"value\\\\\\":806800\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"kernel\\\\\\",\\\\n \\\\\\"value\\\\\\":4527660\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataKerMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SReclaimable\\\\\\",\\\\n \\\\\\"value\\\\\\":3411292\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"VmallocUsed\\\\\\",\\\\n \\\\\\"value\\\\\\":30980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"allocPage\\\\\\",\\\\n \\\\\\"value\\\\\\":177732\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"KernelStack\\\\\\",\\\\n \\\\\\"value\\\\\\":9280\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"PageTables\\\\\\",\\\\n \\\\\\"value\\\\\\":38056\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SUnreclaim\\\\\\",\\\\n \\\\\\"value\\\\\\":170248\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"reserved\\\\\\",\\\\n \\\\\\"value\\\\\\":690072\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataUserMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"filecache\\\\\\",\\\\n \\\\\\"value\\\\\\":8010008\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"anon\\\\\\",\\\\n \\\\\\"value\\\\\\":2468608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"mlock\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge1G\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge2M\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"buffers\\\\\\",\\\\n \\\\\\"value\\\\\\":458608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"shmem\\\\\\",\\\\n \\\\\\"value\\\\\\":2284\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataCacheList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/lib/mysql/sysom/sys_handler_log.ibd\\\\\\",\\\\n \\\\\\"cached\\\\\\":576764,\\\\n \\\\\\"Task\\\\\\":\\\\\\"mysqld_78575 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-migration-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":276688,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-rtdemo-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":229404,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-monitor-server-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":197368,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-channel-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":180276,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"Name\\\\\\":\\\\\\"total cached of close file\\\\\\",\\\\n \\\\\\"cached\\\\\\":3729668,\\\\n \\\\\\"Task\\\\\\":\\\\\\"\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataProcMemList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"task\\\\\\":\\\\\\"mysqld\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":240856,\\\\n \\\\\\"RssAnon\\\\\\":218248,\\\\n \\\\\\"RssFile\\\\\\":22608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"task\\\\\\":\\\\\\"systemd-journal\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":150248,\\\\n \\\\\\"RssAnon\\\\\\":74300,\\\\n \\\\\\"RssFile\\\\\\":75944\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":144640,\\\\n \\\\\\"RssAnon\\\\\\":114200,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":141480,\\\\n \\\\\\"RssAnon\\\\\\":111040,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"task\\\\\\":\\\\\\"grafana-server\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":103660,\\\\n \\\\\\"RssAnon\\\\\\":42732,\\\\n \\\\\\"RssFile\\\\\\":60928\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97444,\\\\n \\\\\\"RssAnon\\\\\\":76256,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":6,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97260,\\\\n \\\\\\"RssAnon\\\\\\":76072,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":7,\\\\n \\\\\\"task\\\\\\":\\\\\\"prometheus\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":95356,\\\\n \\\\\\"RssAnon\\\\\\":45376,\\\\n \\\\\\"RssFile\\\\\\":49980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":8,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":90144,\\\\n \\\\\\"RssAnon\\\\\\":76456,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":9,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":89796,\\\\n \\\\\\"RssAnon\\\\\\":76108,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"url\\": \\"/diagnose/detail/qe3Z34sa\\",\\n \\"created_at\\": \\"2025-12-03 16:30:28\\",\\n \\"updated_at\\": \\"2025-12-03 16:30:28\\"\\n },\\n \\"request_id\\": \\"9515E5A0-8905-59B0-9BBF-5F0BE568C3A0\\"\\n}","type":"json"}]', + ], + 'GetHealthPercentage' => [ + 'summary' => 'Retrieves the health status distribution of nodes or pods over a specified time period.', + 'path' => '/api/v1/openapi/cluster_health/range/health_percentage', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'proxy-next-upstream', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '230371', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + ], + 'parameters' => [ [ - 'name' => 'cluster_id', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cb7d4cc26c8f845fb8a8255ffd394820e', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2ijff4be-bf24-4070-89ca-c47c879b0g32', 'title' => ''], ], [ - 'name' => 'cluster_status', + 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - 'enum' => [ - 'Running', - 'Installing', - 'Uninstalling', - 'Upgrading', - 'Offline', - ], - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], [ - 'name' => 'cluster_type', + 'name' => 'start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ACK', - 'enum' => [ - 'ACK', - 'CUSTOM', - ], - ], + 'schema' => ['description' => 'The start time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725797727754', 'title' => ''], ], [ - 'name' => 'id', + 'name' => 'end', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cb7d4cc26c8f845fb8a8255ffd394820e', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725801327754', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '64', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization was successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault message.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError'."\n", 'title' => ''], + 'message' => ['description' => 'The error details.', 'type' => 'string', 'example' => '""', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5389fba5-92a1-4ff4-9b26-773b97828144', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'auto-name-sbvCT', - ], - 'cluster_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c666d4774f0e2440b979bf917bf100e40', - ], - 'cluster_type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ACK', - 'enum' => [ - 'ACK', - 'CUSTOM', - ], - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'cluster_status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'created_at' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-25T15:08:19', - ], - 'updated_at' => [ - 'description' => '', + 'type' => [ + 'description' => 'The health level of the node or pod.', + 'enumValueTitles' => ['不健康' => 'warning', '健康' => 'health', '亚健康' => 'potential', '严重不健康' => 'error'], 'type' => 'string', - 'example' => '2024-12-25T15:08:19', + 'example' => 'health', + 'title' => '', ], + 'value' => ['description' => 'The quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"total\\": 64,\\n \\"data\\": [\\n {\\n \\"id\\": \\"5389fba5-92a1-4ff4-9b26-773b97828144\\",\\n \\"name\\": \\"auto-name-sbvCT\\",\\n \\"cluster_id\\": \\"c666d4774f0e2440b979bf917bf100e40\\",\\n \\"cluster_type\\": \\"ACK\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"cluster_status\\": \\"Running\\",\\n \\"created_at\\": \\"2024-12-25T15:08:19\\",\\n \\"updated_at\\": \\"2024-12-25T15:08:19\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ListInstances' => [ - 'summary' => '获取实例列表', - 'path' => '/api/v1/am/instance/list_instances', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"health\\",\\n \\"value\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve node/pod health status distribution', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHealthPercentage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetHostCount' => [ + 'summary' => 'Retrieves the number of nodes or the number of Pods on nodes in a cluster.', + 'path' => '/api/v1/openapi/cluster_health/range/host_count', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236493', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => '1808078950770264', 'title' => ''], ], [ 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], [ - 'name' => 'status', + 'name' => 'start', 'in' => 'query', - 'schema' => [ - 'title' => '通过状态过滤实例', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1725797727754', 'title' => ''], ], [ - 'name' => 'region', - 'in' => 'query', - 'schema' => [ - 'title' => '通过区域过滤实例'."\n", - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'cluster_id', + 'name' => 'end', 'in' => 'query', - 'schema' => [ - 'title' => '集群ID', - 'type' => 'string', - 'example' => 'xxxxx', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1725801327754', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError'."\n", - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Requests for llm service failed'."\n", - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => '“”', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'instance' => [ - 'title' => 'ECS实例ID', - 'description' => '', - 'type' => 'string', - ], - 'region' => [ - 'title' => '实例所在区域', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'kernel_version' => [ - 'title' => '实例当前的内核版本', - 'description' => '', - 'type' => 'string', - ], - 'os_arch' => [ - 'title' => 'ECS实例的架构', - 'description' => '', - 'type' => 'string', - ], - 'os_name' => [ - 'title' => '实例的操作系统名称（取自 /etc/os-release）', - 'description' => '', - 'type' => 'string', - ], - 'os_version' => [ - 'title' => '实例的操作系统版本（取自 /etc/os-release）', - 'description' => '', - 'type' => 'string', - ], - 'os_name_id' => [ - 'title' => '实例的操作系统名称ID（取自 /etc/os-release）', - 'description' => '', - 'type' => 'string', - ], - 'os_version_id' => [ - 'title' => '实例操作系统版本ID（取自 /etc/os-release）', - 'description' => '', - 'type' => 'string', - ], - 'os_health_score' => [ - 'title' => '实例的健康分', - 'description' => '', - 'type' => 'string', - ], - 'status' => [ - 'title' => '实例的状态', - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'meta' => [ - 'title' => '实例的元数据信息', - 'description' => '', - 'type' => 'any', - ], - 'cluster_id' => [ - 'type' => 'string', - ], + 'time' => ['description' => 'The point in time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725797727754', 'title' => ''], + 'value' => ['description' => 'The count.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9515E5A0-8905-59B0-9BBF-5F0BE568C3A0', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '623', - ], + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '43A910E9-A739-525E-855D-A32C257F1826', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"Requests for llm service failed\\\\n\\",\\n \\"data\\": [\\n {\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"kernel_version\\": \\"5.10.134-16.1.an8.x86_64\\",\\n \\"os_arch\\": \\"x86\\",\\n \\"os_name\\": \\"Anolis OS\\",\\n \\"os_version\\": \\"8.9\\",\\n \\"os_name_id\\": \\"anolis\\",\\n \\"os_version_id\\": \\"rhel fedora centos\\",\\n \\"os_health_score\\": \\"100\\",\\n \\"status\\": \\"Running\\",\\n \\"meta\\": \\"{\\\\n \\\\\\"uname\\\\\\": \\\\\\"Linux\\\\\\",\\\\n \\\\\\"oncpu\\\\\\": \\\\\\"off\\\\\\",\\\\n \\\\\\"release\\\\\\": \\\\\\"5.10.134-16.3.al8.aarch64\\\\\\",\\\\n \\\\\\"monitor\\\\\\": \\\\\\"on\\\\\\",\\\\n \\\\\\"version_id\\\\\\": \\\\\\"3\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"3 (Soaring Falcon)\\\\\\",\\\\n \\\\\\"podNs\\\\\\": [\\\\n\\\\n ],\\\\n \\\\\\"machine\\\\\\": \\\\\\"aarch64\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Alibaba Cloud Linux\\\\\\",\\\\n \\\\\\"sysak\\\\\\": \\\\\\"3.4.0-1\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"alinux\\\\\\",\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"centos-release\\\\\\": \\\\\\"Alibaba Cloud Linux release 3 (Soaring Falcon)\\\\\\"\\\\n}\\",\\n \\"cluster_id\\": \\"c2218ca2b76ec45e7b7ee1693f6fcd374\\"\\n }\\n ],\\n \\"request_id\\": \\"9515E5A0-8905-59B0-9BBF-5F0BE568C3A0\\",\\n \\"total\\": 623\\n}","type":"json"}]', - ], - 'ListPluginsInstances' => [ - 'summary' => '获取插件的安装/更新/卸载实例列表', - 'path' => '/api/v1/am/agent/listPluginsInstances', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"“”\\",\\n \\"data\\": [\\n {\\n \\"time\\": 1725797727754,\\n \\"value\\": 5\\n }\\n ],\\n \\"total\\": 3,\\n \\"request_id\\": \\"43A910E9-A739-525E-855D-A32C257F1826\\"\\n}","type":"json"}]', + 'title' => 'Retrieve cluster node count or node pod count', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHostCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetHotSpotUniqList' => [ + 'summary' => 'Get the list of a specific field under an instance.', + 'path' => '/api/v1/livetrace_proxy/hotspot_uniq_list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '254533', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ - 'name' => 'operation_type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'install', - ], - ], - [ - 'name' => 'plugin_id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], - ], - [ - 'name' => 'region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'instance_id_name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bpxx', - ], - ], - [ - 'name' => 'instance_tag', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"key":"app","value":"sysom-aliyun-com"}', - ], - ], - [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Request body parameters', + 'type' => 'object', + 'properties' => [ + 'uniq' => ['description' => 'Identifier flag', 'type' => 'string', 'required' => true, 'example' => '默认需要为"flag"，待查询的字段', 'title' => ''], + 'instance' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'i-bp1g2i0siirefgwnnnvy', 'title' => ''], + 'pid' => ['description' => 'Process ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], + 'table' => ['description' => 'Table name', 'type' => 'string', 'required' => false, 'example' => 'prof_on', 'title' => ''], + 'beg_start' => ['description' => 'Start time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1735008551000', 'title' => ''], + 'beg_end' => ['description' => 'End time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1735010351000', 'title' => ''], + ], 'required' => false, - 'example' => '20', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'Status code'."\n" + .'- `code == Success` indicates that the authorization is successful;'."\n" + .'- Other status codes indicate that the authorization has failed. When authorization fails, check the `message` field for detailed error information;', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'success' => ['description' => 'true indicates the API call succeeded, false indicates the API call failed', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'message' => ['description' => 'Response message', 'type' => 'string', 'example' => "\n" + .'success', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instance_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-bp118piqcio9tiwgh84b', - ], - 'instance_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'allowed-repos-qmf8w', - ], - 'instance_tag' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'tag_key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_tag_key', - ], - 'tag_value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_tag_value', - ], - ], - ], - ], - 'public_ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'private_ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'resource_group_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default resource group', - ], - 'resource_group_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rg-xxxx', - ], - 'os_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64 bit', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'description' => 'List of data column names', + 'type' => 'array', + 'items' => ['description' => 'Data column name', 'type' => 'string', 'example' => 'column', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'List of data values', + 'type' => 'array', + 'items' => ['description' => 'Data value', 'type' => 'string', 'example' => 'ml', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": [\\n {\\n \\"instance_id\\": \\"i-bp118piqcio9tiwgh84b\\",\\n \\"instance_name\\": \\"allowed-repos-qmf8w\\",\\n \\"instance_tag\\": [\\n {\\n \\"tag_key\\": \\"test_tag_key\\",\\n \\"tag_value\\": \\"test_tag_value\\"\\n }\\n ],\\n \\"public_ip\\": \\"1.1.1.1\\",\\n \\"private_ip\\": \\"1.1.1.1\\",\\n \\"resource_group_name\\": \\"default resource group\\",\\n \\"resource_group_id\\": \\"rg-xxxx\\",\\n \\"os_name\\": \\"Alibaba Cloud Linux 3.2104 LTS 64 bit\\",\\n \\"region\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\",\\n \\"total\\": 42\\n}","type":"json"}]', - ], - 'ListPodsOfInstance' => [ - 'summary' => '获取实例中的pod列表', - 'path' => '/api/v1/am/instance/list_pod_of_instance', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"success\\": \\"true\\",\\n \\"message\\": \\"\\\\nsuccess\\",\\n \\"data\\": {\\n \\"columns\\": [\\n \\"column\\"\\n ],\\n \\"values\\": [\\n \\"ml\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Get Hotspot Type List', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:hotSpotUniqList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetHotspotAnalysis' => [ + 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_analysis', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '256739', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], ], 'parameters' => [ [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'cluster_id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c96e34d74eb6748f3b2a46552d5d653f6', - ], - ], - [ - 'name' => 'instance', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'appType' => ['description' => 'The application type.', 'type' => 'string', 'required' => true, 'example' => 'GR', 'title' => ''], + 'pid' => ['description' => 'The process ID (PID).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1657494', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze5ru5rjurix7f71sxv', 'title' => ''], + 'beg_start' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725410348000', 'title' => ''], + 'beg_end' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725413948000', 'title' => ''], + 'table' => ['description' => 'The name of the table to query.', 'type' => 'string', 'required' => false, 'example' => 'prof_on', 'title' => ''], + ], 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'instance not exists', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'pod' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-pod', - ], - 'namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', - ], - 'total' => [ - 'title' => 'MaxResults本次请求所返回的最大记录条数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError', 'title' => ''], + 'data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '"AliYunDun:1657494进程(1657494):根据提供的热点调用栈信息，热点主要集中在`__nanosleep_nocancel`以及相关的系统调用`SyS_nanosleep`上，这表明进程在等待特定的时间间隔。通常这是由于应用中存在长时间的睡眠或高频率的定时操作导致的，比如定时任务、心跳检测等。\\n\\n应用代码在需要定期执行某些检查或等待外部事件时会使用`nanosleep`来实现精确的延时控制。为了优化这种情况，可以考虑以下方案：\\n- 评估是否可以减少定时任务的频率。\\n- 使用条件变量替代单纯的睡眠等待，以响应更快的事件触发。\\n- 如果是I/O密集型操作等待，考虑优化I/O路径或提升I/O效率。建议使用SysOM平台的IO诊断工具来进一步定位具体的I/O瓶颈。"', 'title' => ''], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => "\n" + .'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"instance not exists\\",\\n \\"data\\": [\\n {\\n \\"pod\\": \\"test-pod\\",\\n \\"namespace\\": \\"default\\"\\n }\\n ],\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"total\\": 42\\n}","type":"json"}]', - ], - 'UpgradeAgentForCluster' => [ - 'summary' => '给集群更新组件', - 'path' => '/api/v1/am/agent/upgrade_agent_by_cluster', - 'methods' => [ - 'post', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Retrieve hot spot analysis results', + 'summary' => 'Retrieves hot spot analysis results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"data\\": \\"\\\\\\"AliYunDun:1657494进程(1657494):根据提供的热点调用栈信息，热点主要集中在`__nanosleep_nocancel`以及相关的系统调用`SyS_nanosleep`上，这表明进程在等待特定的时间间隔。通常这是由于应用中存在长时间的睡眠或高频率的定时操作导致的，比如定时任务、心跳检测等。\\\\\\\\n\\\\\\\\n应用代码在需要定期执行某些检查或等待外部事件时会使用`nanosleep`来实现精确的延时控制。为了优化这种情况，可以考虑以下方案：\\\\\\\\n- 评估是否可以减少定时任务的频率。\\\\\\\\n- 使用条件变量替代单纯的睡眠等待，以响应更快的事件触发。\\\\\\\\n- 如果是I/O密集型操作等待，考虑优化I/O路径或提升I/O效率。建议使用SysOM平台的IO诊断工具来进一步定位具体的I/O瓶颈。\\\\\\"\\",\\n \\"success\\": true,\\n \\"message\\": \\"\\\\nsuccess\\"\\n}","type":"json"}]', + ], + 'GetHotspotCompare' => [ + 'summary' => 'Get Hotspot Comparison Tracing Results', + 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_compare', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '253539', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '231282', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ @@ -3821,106 +2852,174 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body', 'type' => 'object', 'properties' => [ - 'cluster_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c1c187fd513cb41a19876bac0e6b05212', - ], - 'agent_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], - 'agent_version' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3.4.0-1', - ], + 'table' => ['description' => 'Query table name', 'type' => 'string', 'required' => true, 'example' => 'prof_on', 'title' => ''], + 'instance1' => ['description' => 'Instance 1', 'type' => 'string', 'required' => true, 'example' => 'i-2zei55fwj8nnu31h3z46"', 'title' => ''], + 'pid1' => ['description' => 'Instance 1 process', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'beg1_start' => ['description' => 'Start time 1', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725415474000', 'title' => ''], + 'beg1_end' => ['description' => 'End time 1', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725415774000', 'title' => ''], + 'instance2' => ['description' => 'Instance 2', 'type' => 'string', 'required' => true, 'example' => '0', 'title' => ''], + 'pid2' => ['description' => 'Instance 2 process', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'i-2zei55fwj8nnu31h3z46', 'title' => ''], + 'beg2_start' => ['description' => 'Start time 2', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725415474000', 'title' => ''], + 'beg2_end' => ['description' => 'End time 2', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725415774000', 'title' => ''], + 'hot_type' => ['description' => 'Hotspot type', 'type' => 'string', 'required' => false, 'example' => 'alloc', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => "\n" - .'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError'."\n", 'title' => ''], + 'message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response data', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7523e9e0ddc74d99a5236f4f4d5056e6', + 'flame' => [ + 'description' => 'Differential flame graph data', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'description' => 'Field name list', + 'type' => 'array', + 'items' => ['description' => 'Field name', 'type' => 'string', 'example' => '"sample", "time"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'Flame graph data list', + 'type' => 'array', + 'items' => [ + 'description' => 'Flame graph data', + 'type' => 'array', + 'items' => ['description' => 'Time or sampling data', 'type' => 'string', 'example' => '"{\\"metadata\\":{\\"spyName\\":\\"cprof\\",\\"leftTicks\\":38,\\"name\\":\\"liveTrace\\",\\"rightTicks\\":38,\\"format\\":\\"double\\",\\"units\\":\\"samples\\",\\"appName\\":\\"liveTrace.profiling\\",\\"sampleRate\\":100},\\"version\\":1,\\"other\\":{\\"Table\\":\\"prof_on\\",\\"leftInstance\\":\\"i-2zei55fwj8nnu31h3z46\\",\\"rightInstance\\":\\"i-2zei55fwj8nnu31h3z46\\",\\"leftPid\\":0,\\"rightPid\\":0},\\"flamebearer\\":{\\"maxSelf\\":7,\\"names\\":[\\"total\\",\\"host\\",\\"idle:0\\",\\"default_enter_idle\\",\\"default_idle\\",\\"asm_common_interrupt\\",\\"common_interrupt\\",\\"irq_exit_rcu\\",\\"do_softirq_own_stack\\",\\"asm_call_irq_on_stack\\",\\"__do_softirq\\",\\"net_rx_action\\",\\"napi_poll\\",\\"nsh_cleanup_module\\",\\"napi_complete_done\\",\\"netif_receive_skb_list_internal\\",\\"__netif_receive_skb_list\\",\\"__netif_receive_skb_list_core\\",\\"__netif_receive_skb_core\\",\\"ip_local_deliver_finish\\",\\"ip_protocol_deliver_rcu\\",\\"tcp_v4_rcv\\",\\"__xfrm_policy_check2.constprop.0\\",\\"ip_local_deliver\\",\\"nf_hook_slow\\",\\"secondary_startup_64_no_verify\\",\\"cpu_startup_entry\\",\\"do_idle\\",\\"cpuidle_idle_call\\",\\"haltpoll_reflect\\",\\"cpuidle_enter\\",\\"cpuidle_enter_state\\",\\"sched_clock_cpu\\",\\"sched_clock\\",\\"kvm_sched_clock_read\\",\\"pvclock_clocksource_read\\",\\"asm_sysvec_call_function_single\\",\\"sysvec_call_function_single\\",\\"_nohz_idle_balance\\",\\"rebalance_domains\\",\\"load_balance\\",\\"cpumask_next_and\\",\\"_find_next_bit.constprop.0\\",\\"update_blocked_averages\\",\\"asm_sysvec_apic_timer_interrupt\\",\\"sysvec_apic_timer_interrupt\\",\\"rcu_core\\",\\"rcu_report_qs_rdp\\",\\"_raw_spin_unlock_irqrestore\\",\\"rcu_do_batch\\",\\"__put_task_struct\\",\\"rcu_cblist_dequeue\\",\\"run_timer_softirq\\",\\"__run_timers.part.0\\",\\"run_rebalance_domains\\",\\"start_kernel\\",\\"call_timer_fn\\",\\"process_timeout\\",\\"note_gp_changes\\",\\"schedule_idle\\",\\"__schedule\\"],\\"numTicks\\":76,\\"levels\\":[[0,38,0,0,38,0,0],[0,38,0,0,38,0,1],[0,38,0,0,38,0,2],[0,2,0,0,2,0,3,0,1,0,0,1,0,4,0,35,0,0,35,0,25],[0,2,0,0,2,0,4,0,1,0,0,1,0,5,0,27,3,0,27,3,26,0,8,0,0,8,0,55],[0,2,0,0,2,0,5,0,1,0,0,1,0,6,3,24,0,3,24,0,27,0,8,0,0,8,0,26],[0,2,0,0,2,0,6,0,1,0,0,1,0,7,3,24,0,3,24,0,28,0,8,0,0,8,0,27],[0,2,0,0,2,0,7,0,1,0,0,1,0,8,3,1,1,3,1,1,29,0,23,0,0,23,0,30,0,7,0,0,7,0,28,0,1,0,0,1,0,59],[0,2,0,0,2,0,8,0,1,0,0,1,0,9,4,23,0,4,23,0,31,0,6,0,0,6,0,30,0,1,1,0,1,1,29,0,1,1,0,1,1,60],[0,2,0,0,2,0,9,0,1,0,0,1,0,10,4,4,1,4,4,1,32,0,19,0,0,19,0,3,0,6,0,0,6,0,31],[0,2,0,0,2,0,10,0,1,0,0,1,0,11,5,3,0,5,3,0,33,0,19,0,0,19,0,4,0,1,0,0,1,0,32,0,5,0,0,5,0,3],[0,2,0,0,2,0,11,0,1,0,0,1,0,12,5,3,0,5,3,0,34,0,2,0,0,2,0,36,0,17,0,0,17,0,44,0,1,0,0,1,0,33,0,5,0,0,5,0,4],[0,2,0,0,2,0,12,0,1,0,0,1,0,13,5,3,3,5,3,3,35,0,2,0,0,2,0,37,0,17,0,0,17,0,45,0,1,0,0,1,0,34,0,1,0,0,1,0,36,0,4,0,0,4,0,44],[0,2,0,0,2,0,13,0,1,0,0,1,0,14,8,2,0,8,2,0,7,0,17,0,0,17,0,7,0,1,1,0,1,1,35,0,1,0,0,1,0,37,0,4,0,0,4,0,45],[0,2,0,0,2,0,14,0,1,0,0,1,0,15,8,2,0,8,2,0,8,0,17,0,0,17,0,8,1,1,0,1,1,0,7,0,4,0,0,4,0,7],[0,2,0,0,2,0,15,0,1,0,0,1,0,16,8,2,0,8,2,0,9,0,17,0,0,17,0,9,1,1,0,1,1,0,8,0,4,0,0,4,0,8],[0,2,0,0,2,0,16,0,1,0,0,1,0,17,8,2,0,8,2,0,10,0,17,0,0,17,0,10,1,1,0,1,1,0,9,0,4,0,0,4,0,9],[0,2,0,0,2,0,17,0,1,0,0,1,0,18,8,2,0,8,2,0,38,0,4,0,0,4,0,46,0,3,0,0,3,0,39,0,2,0,0,2,0,52,0,1,1,0,1,1,53,0,7,0,0,7,0,54,1,1,0,1,1,0,10,0,4,1,0,4,1,10],[0,2,0,0,2,0,18,0,1,0,0,1,0,23,8,1,0,8,1,0,39,0,1,1,0,1,1,43,0,2,0,0,2,0,47,0,2,0,0,2,0,49,0,3,2,0,3,2,40,0,2,2,0,2,2,53,1,7,7,1,7,7,43,1,1,0,1,1,0,38,1,1,0,1,1,0,52,0,1,0,0,1,0,54,0,1,0,0,1,0,46],[0,1,0,0,1,0,19,0,1,0,0,1,0,23,0,1,0,0,1,0,24,8,1,0,8,1,0,40,1,2,2,1,2,2,48,0,1,1,0,1,1,50,0,1,1,0,1,1,51,2,1,0,2,1,0,41,11,1,1,11,1,1,43,1,1,0,1,1,0,53,0,1,1,0,1,1,43,0,1,0,0,1,0,58],[0,1,0,0,1,0,20,0,1,0,0,1,0,24,0,1,0,0,1,0,13,8,1,0,8,1,0,41,7,1,1,7,1,1,42,13,1,0,13,1,0,56,1,1,1,1,1,1,48],[0,1,0,0,1,0,21,0,1,0,0,1,0,13,0,1,0,0,1,0,13,8,1,1,8,1,1,42,21,1,1,21,1,1,57],[0,1,1,0,1,1,22,0,1,1,0,1,1,13,0,1,1,0,1,1,13]]},\\"timeLine\\":{\\"left\\":{\\"durationDelta\\":10,\\"startTime\\":1725415480,\\"samples\\":[3,2,5,5,7,8,7,1]},\\"right\\":{\\"durationDelta\\":10,\\"startTime\\":1725415480,\\"samples\\":[3,2,5,5,7,8,7,1]}}}"'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'series_instance1' => [ + 'description' => 'Hotspot time series 1', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'description' => 'Field name list', + 'type' => 'array', + 'items' => ['description' => 'Field name', 'type' => 'string', 'example' => '"time", "EXPR$1"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'Hotspot time series data list', + 'type' => 'array', + 'items' => [ + 'description' => 'Hotspot time series data', + 'type' => 'array', + 'items' => ['description' => 'Time or hotspot sampling value', 'type' => 'string', 'example' => '"2024-09-04T02:04:40Z", "3"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'series_instance2' => [ + 'description' => 'Hotspot time series 2', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'description' => 'Field name list', + 'type' => 'array', + 'items' => ['description' => 'Field name', 'type' => 'string', 'example' => '"time", "EXPR$1"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'Hotspot time series data list', + 'type' => 'array', + 'items' => [ + 'description' => 'Hotspot time series data', + 'type' => 'array', + 'items' => ['description' => 'Time or hotspot sampling value', 'type' => 'string', 'example' => '"2024-09-04T02:04:40Z", "3"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'success' => ['description' => 'true: API call succeeded; false: API call failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\nsuccess\\",\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"data\\": {\\n \\"task_id\\": \\"7523e9e0ddc74d99a5236f4f4d5056e6\\"\\n }\\n}","type":"json"}]', - ], - 'UpgradeAgent' => [ - 'summary' => '更新 SysOM Agent', - 'path' => '/api/v1/am/agent/upgrade_agent', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": {\\n \\"flame\\": {\\n \\"columns\\": [\\n \\"\\\\\\"sample\\\\\\", \\\\\\"time\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"{\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"spyName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cprof\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"leftTicks\\\\\\\\\\\\\\":38,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rightTicks\\\\\\\\\\\\\\":38,\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"double\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"units\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace.profiling\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sampleRate\\\\\\\\\\\\\\":100},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"other\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"prof_on\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"leftInstance\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2zei55fwj8nnu31h3z46\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rightInstance\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2zei55fwj8nnu31h3z46\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"leftPid\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"rightPid\\\\\\\\\\\\\\":0},\\\\\\\\\\\\\\"flamebearer\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"maxSelf\\\\\\\\\\\\\\":7,\\\\\\\\\\\\\\"names\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"total\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"idle:0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"default_enter_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"default_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_common_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"common_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"irq_exit_rcu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_softirq_own_stack\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_call_irq_on_stack\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__do_softirq\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"net_rx_action\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"napi_poll\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nsh_cleanup_module\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"napi_complete_done\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"netif_receive_skb_list_internal\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__netif_receive_skb_list\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__netif_receive_skb_list_core\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__netif_receive_skb_core\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip_local_deliver_finish\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip_protocol_deliver_rcu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tcp_v4_rcv\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__xfrm_policy_check2.constprop.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip_local_deliver\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nf_hook_slow\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"secondary_startup_64_no_verify\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpu_startup_entry\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpuidle_idle_call\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"haltpoll_reflect\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpuidle_enter\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpuidle_enter_state\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sched_clock_cpu\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sched_clock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"kvm_sched_clock_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pvclock_clocksource_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_sysvec_call_function_single\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sysvec_call_function_single\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_nohz_idle_balance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rebalance_domains\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"load_balance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cpumask_next_and\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_find_next_bit.constprop.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"update_blocked_averages\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"asm_sysvec_apic_timer_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sysvec_apic_timer_interrupt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_core\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_report_qs_rdp\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_raw_spin_unlock_irqrestore\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_do_batch\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__put_task_struct\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_cblist_dequeue\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"run_timer_softirq\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__run_timers.part.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"run_rebalance_domains\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"start_kernel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"call_timer_fn\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"process_timeout\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"note_gp_changes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"schedule_idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__schedule\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"numTicks\\\\\\\\\\\\\\":76,\\\\\\\\\\\\\\"levels\\\\\\\\\\\\\\":[[0,38,0,0,38,0,0],[0,38,0,0,38,0,1],[0,38,0,0,38,0,2],[0,2,0,0,2,0,3,0,1,0,0,1,0,4,0,35,0,0,35,0,25],[0,2,0,0,2,0,4,0,1,0,0,1,0,5,0,27,3,0,27,3,26,0,8,0,0,8,0,55],[0,2,0,0,2,0,5,0,1,0,0,1,0,6,3,24,0,3,24,0,27,0,8,0,0,8,0,26],[0,2,0,0,2,0,6,0,1,0,0,1,0,7,3,24,0,3,24,0,28,0,8,0,0,8,0,27],[0,2,0,0,2,0,7,0,1,0,0,1,0,8,3,1,1,3,1,1,29,0,23,0,0,23,0,30,0,7,0,0,7,0,28,0,1,0,0,1,0,59],[0,2,0,0,2,0,8,0,1,0,0,1,0,9,4,23,0,4,23,0,31,0,6,0,0,6,0,30,0,1,1,0,1,1,29,0,1,1,0,1,1,60],[0,2,0,0,2,0,9,0,1,0,0,1,0,10,4,4,1,4,4,1,32,0,19,0,0,19,0,3,0,6,0,0,6,0,31],[0,2,0,0,2,0,10,0,1,0,0,1,0,11,5,3,0,5,3,0,33,0,19,0,0,19,0,4,0,1,0,0,1,0,32,0,5,0,0,5,0,3],[0,2,0,0,2,0,11,0,1,0,0,1,0,12,5,3,0,5,3,0,34,0,2,0,0,2,0,36,0,17,0,0,17,0,44,0,1,0,0,1,0,33,0,5,0,0,5,0,4],[0,2,0,0,2,0,12,0,1,0,0,1,0,13,5,3,3,5,3,3,35,0,2,0,0,2,0,37,0,17,0,0,17,0,45,0,1,0,0,1,0,34,0,1,0,0,1,0,36,0,4,0,0,4,0,44],[0,2,0,0,2,0,13,0,1,0,0,1,0,14,8,2,0,8,2,0,7,0,17,0,0,17,0,7,0,1,1,0,1,1,35,0,1,0,0,1,0,37,0,4,0,0,4,0,45],[0,2,0,0,2,0,14,0,1,0,0,1,0,15,8,2,0,8,2,0,8,0,17,0,0,17,0,8,1,1,0,1,1,0,7,0,4,0,0,4,0,7],[0,2,0,0,2,0,15,0,1,0,0,1,0,16,8,2,0,8,2,0,9,0,17,0,0,17,0,9,1,1,0,1,1,0,8,0,4,0,0,4,0,8],[0,2,0,0,2,0,16,0,1,0,0,1,0,17,8,2,0,8,2,0,10,0,17,0,0,17,0,10,1,1,0,1,1,0,9,0,4,0,0,4,0,9],[0,2,0,0,2,0,17,0,1,0,0,1,0,18,8,2,0,8,2,0,38,0,4,0,0,4,0,46,0,3,0,0,3,0,39,0,2,0,0,2,0,52,0,1,1,0,1,1,53,0,7,0,0,7,0,54,1,1,0,1,1,0,10,0,4,1,0,4,1,10],[0,2,0,0,2,0,18,0,1,0,0,1,0,23,8,1,0,8,1,0,39,0,1,1,0,1,1,43,0,2,0,0,2,0,47,0,2,0,0,2,0,49,0,3,2,0,3,2,40,0,2,2,0,2,2,53,1,7,7,1,7,7,43,1,1,0,1,1,0,38,1,1,0,1,1,0,52,0,1,0,0,1,0,54,0,1,0,0,1,0,46],[0,1,0,0,1,0,19,0,1,0,0,1,0,23,0,1,0,0,1,0,24,8,1,0,8,1,0,40,1,2,2,1,2,2,48,0,1,1,0,1,1,50,0,1,1,0,1,1,51,2,1,0,2,1,0,41,11,1,1,11,1,1,43,1,1,0,1,1,0,53,0,1,1,0,1,1,43,0,1,0,0,1,0,58],[0,1,0,0,1,0,20,0,1,0,0,1,0,24,0,1,0,0,1,0,13,8,1,0,8,1,0,41,7,1,1,7,1,1,42,13,1,0,13,1,0,56,1,1,1,1,1,1,48],[0,1,0,0,1,0,21,0,1,0,0,1,0,13,0,1,0,0,1,0,13,8,1,1,8,1,1,42,21,1,1,21,1,1,57],[0,1,1,0,1,1,22,0,1,1,0,1,1,13,0,1,1,0,1,1,13]]},\\\\\\\\\\\\\\"timeLine\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"left\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"durationDelta\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1725415480,\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":[3,2,5,5,7,8,7,1]},\\\\\\\\\\\\\\"right\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"durationDelta\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1725415480,\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\":[3,2,5,5,7,8,7,1]}}}\\\\\\"\\\\n\\"\\n ]\\n ]\\n },\\n \\"series_instance1\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"EXPR$1\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T02:04:40Z\\\\\\", \\\\\\"3\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"series_instance2\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"EXPR$1\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T02:04:40Z\\\\\\", \\\\\\"3\\\\\\"\\"\\n ]\\n ]\\n }\\n },\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Get Hotspot Comparison Tracing Results', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotCompare', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetHotspotInstanceList' => [ + 'summary' => 'Get Hotspot Instance List', + 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_instance_list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], ], 'parameters' => [ [ @@ -3928,119 +3027,96 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Body', 'type' => 'object', 'properties' => [ - 'instances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-wz9b9vucz1iubsz8sjqo', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'agent_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'agent_version' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], + 'table' => ['description' => 'Query table name', 'type' => 'string', 'required' => true, 'example' => 'prof_on', 'title' => ''], + 'beg_start' => ['description' => 'Start time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725413647000', 'title' => ''], + 'beg_end' => ['description' => 'End time', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725413947000', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'Error code', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError', 'title' => ''], + 'message' => ['description' => 'Description', 'type' => 'string', 'example' => 'success', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', + 'columns' => [ + 'description' => 'Field names', + 'type' => 'array', + 'items' => ['description' => 'Query field', 'type' => 'string', 'example' => 'column', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'Instance list', + 'type' => 'array', + 'items' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'i-2ze5ru5rjurix7f71sxv', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'RequestId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": {\\n \\"columns\\": [\\n \\"column\\"\\n ],\\n \\"values\\": [\\n \\"i-2ze5ru5rjurix7f71sxv\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Get Instance List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotInstanceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"task_id\\": \\"391f5aeba2054f66b3aaef0136142fe2\\"\\n },\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\"\\n}","type":"json"}]', ], - 'UninstallAgentForCluster' => [ - 'summary' => '给集群卸载组件', - 'path' => '/api/v1/am/agent/uninstall_agent_by_cluster', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetHotspotPidList' => [ + 'summary' => 'Retrieves the PID list of a specified instance.', + 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_pid_list', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '253536', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], ], 'parameters' => [ [ @@ -4048,105 +3124,104 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'cluster_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c822f83bb45994ddbac9326b4c2f04f35', - ], - 'agent_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], - 'agent_version' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3.4.0-1', - ], + 'table' => ['description' => 'The name of the table to query.', 'type' => 'string', 'required' => true, 'example' => 'prof_on', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze5ru5rjurix7f71sxv', 'title' => ''], + 'beg_start' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725413647000', 'title' => ''], + 'beg_end' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725413947000', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.NotAuthorizedInstance Instance 21 is not authorized', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '44841312-7227-55C9-AE03-D59729BFAE38', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SysomOpenAPI.InvalidParameter', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '049ea0609515414b9e19c3389d7ba638', + 'columns' => [ + 'description' => 'The list of field names.', + 'type' => 'array', + 'items' => ['description' => 'The field name.', 'type' => 'string', 'example' => '"time", "pid", "comm"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'The list of process information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The process information.', + 'type' => 'array', + 'items' => ['description' => '进程信息详情', 'type' => 'string', 'example' => '"2024-09-04T01:04:30Z"，"6890"，"coredns"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"Success\\",\\n \\"data\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"pid\\\\\\", \\\\\\"comm\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T01:04:30Z\\\\\\"，\\\\\\"6890\\\\\\"，\\\\\\"coredns\\\\\\"\\"\\n ]\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve PID list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotPidList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.NotAuthorizedInstance Instance 21 is not authorized\\",\\n \\"RequestId\\": \\"44841312-7227-55C9-AE03-D59729BFAE38\\",\\n \\"data\\": {\\n \\"task_id\\": \\"049ea0609515414b9e19c3389d7ba638\\"\\n }\\n}","type":"json"}]', ], - 'UninstallAgent' => [ - 'summary' => '卸载 SysOM Agent', - 'path' => '/api/v1/am/agent/uninstall_agent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetHotspotTracking' => [ + 'summary' => 'Retrieves hot spot tracking results.', + 'path' => '/api/v1/openapi/proxy/post/livetrace_hotspot_tracking', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '230069', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ @@ -4154,1154 +3229,934 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'instances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-wz9b9vucz1iubsz8sjqo', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'agent_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'agent_version' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], + 'table' => ['description' => 'The name of the table to query.', 'type' => 'string', 'required' => true, 'example' => 'prof_on', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-2ze5ru5rjurix7f71sxv', 'title' => ''], + 'beg_start' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725410348000', 'title' => ''], + 'beg_end' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1725413948000', 'title' => ''], + 'pid' => ['description' => 'The process PID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1657494', 'title' => ''], + 'hot_type' => ['description' => 'The hot spot type.', 'type' => 'string', 'required' => true, 'example' => 'alloc', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', 'title' => ''], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError', 'title' => ''], + 'message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', + 'series' => [ + 'description' => 'The data list.', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'description' => 'The list of field names.', + 'type' => 'array', + 'items' => ['description' => 'The field name.', 'type' => 'string', 'example' => '"time", "EXPR$1"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'The list of hot spot time series data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hot spot time series data.', + 'type' => 'array', + 'items' => ['description' => '热点采样值', 'type' => 'string', 'example' => '"2024-09-04T00:39:50Z", "1"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'flame' => [ + 'description' => 'The flame graph data.', + 'type' => 'object', + 'properties' => [ + 'columns' => [ + 'description' => 'The list of field names.', + 'type' => 'array', + 'items' => ['description' => 'The field name.', 'type' => 'string', 'example' => '"sample"，"time"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'values' => [ + 'description' => 'The list of flame graph data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The flame graph data.', + 'type' => 'array', + 'items' => ['description' => '时间戳，图数据', 'type' => 'string', 'example' => '"{\\"flamebearer\\":{\\"names\\":[\\"total\\",\\"host\\",\\"AliYunDun:1657494\\",\\"?5043000000000000\\",\\"std::basic_string::basic_string\\",\\"__memmove_ssse3_back\\",\\"_init\\",\\"std::string::_Rep::_M_set_length_and_sharable\\",\\"std::string::_S_copy_chars\\",\\"__strlen_sse2_pminub\\",\\"__read_nocancel\\",\\"system_call_fastpath\\",\\"SyS_read\\",\\"vfs_read\\",\\"seq_read\\",\\"proc_single_show\\",\\"proc_tgid_stat\\",\\"do_task_stat\\",\\"__delayacct_blkio_ticks\\",\\"_raw_spin_unlock_irqrestore\\",\\"proc_pid_status\\",\\"seq_bitmap\\",\\"bitmap_scnprintf\\",\\"bitmap_scnprintf.part.0\\",\\"scnprintf\\",\\"vscnprintf\\",\\"vsnprintf\\",\\"format_decode\\",\\"kernfs_fop_read\\",\\"kernfs_seq_show\\",\\"sysfs_kf_seq_show\\",\\"dev_attr_show\\",\\"part_stat_show\\",\\"part_in_flight\\",\\"blk_mq_in_flight\\",\\"blk_mq_queue_tag_busy_iter\\",\\"copy_user_enhanced_fast_string\\",\\"proc_reg_read\\",\\"meminfo_proc_show\\",\\"get_vmalloc_info\\",\\"aqs::CThreadUtil::ThreadFunc\\",\\"operatordelete\\",\\"CProtocolHandlerThread::run\\",\\"CSingleton::GetInstance\\",\\"CResourceMonitor::SetThreadHeartbeat\\",\\"CMonitor::SetThreadHeartbeat\\",\\"aqs::CMutexLockUtil::CMutexLockUtil\\",\\"aqs::CGetTickClock::GetClock\\",\\"__pthread_rwlock_rdlock\\",\\"pthread_rwlock_rdlock\\",\\"aqs::CReadLockUtil::CReadLockUtil\\",\\"std::map::find\\",\\"std::_Rb_tree\\",\\"std::less::operator\\",\\"std::_Rb_tree_iterator::_Rb_tree_iterator\\",\\"__GI___pthread_mutex_lock\\",\\"pthread_mutex_lock\\",\\"__nanosleep_nocancel\\",\\"SyS_nanosleep\\",\\"__check_object_size\\",\\"__virt_addr_valid\\",\\"hrtimer_nanosleep\\",\\"hrtimer_init\\",\\"do_nanosleep\\",\\"schedule\\",\\"__schedule\\",\\"rcu_note_context_switch\\",\\"finish_task_switch\\",\\"hrtimer_start_range_ns\\",\\"lock_hrtimer_base.isra.20\\",\\"_raw_spin_lock_irqsave\\",\\"__audit_syscall_entry\\",\\"CIpcPrivate::run\\",\\"std::list::empty\\",\\"stIpcRawMsg::stIpcRawMsg\\",\\"CIpcPrivate::HandleRecvRawMsg\\",\\"std::basic_string::~basic_string\\",\\"CIpcPrivate::OnRecvClientData\\",\\"CIpcPrivate::InsertMsg\\",\\"std::list::push_back\\",\\"std::list::_M_insert\\",\\"std::list::_M_create_node\\",\\"__gnu_cxx::new_allocator::allocate\\",\\"ParseIpcDataEx\\",\\"boolCSimpleSerialization::GetInt\\",\\"CSimpleSerialization::GetMemberForInteger\\",\\"CIpcPrivate::HandleSendMsg\\",\\"CIpcPrivate::SendIpcMsgPri\\",\\"CSelfGuardIpc::IpcRecvMsg\\",\\"CNetWork::run\\",\\"CNetWork::PeekRecvMessage\\",\\"CNetWork::ReadOneMessage\\",\\"evthread_use_pthreads\\",\\"pthread_self\\",\\"bufferevent_get_input\\",\\"CAtomicInt64::Get\\",\\"CNetWork::PeekSendMessage\\",\\"CTcpMessageBuffer::MarkSendMessage\\",\\"CNetWork::GetSendMessage\\",\\"__SendMessage::__SendMessage\\",\\"__epoll_wait_nocancel\\",\\"system_call_after_swapgs\\",\\"!48c69361\\",\\"!48c672e9\\",\\"!48c20f45\\",\\"!48c2106d\\",\\"!48c2eca3\\",\\"SyS_epoll_wait\\",\\"ep_poll\\",\\"__fdget\\",\\"__fget_light\\"],\\"maxSelf\\":92,\\"numTicks\\":268,\\"levels\\":[[0,268,0,0],[0,268,0,1],[0,268,92,2],[92,10,0,3,0,6,1,10,0,139,14,40,0,7,0,100,0,14,0,57],[92,8,0,4,0,2,2,9,1,5,0,11,14,3,3,41,0,36,0,42,0,3,3,6,0,45,3,57,0,15,1,72,0,3,3,43,0,20,0,89,0,1,1,101,0,1,0,102,0,5,0,11,0,1,1,101,0,13,0,11],[92,1,1,5,0,2,2,6,0,4,4,7,0,1,1,8,3,5,0,12,17,1,1,43,0,5,5,44,0,30,1,45,6,41,1,11,0,1,1,71,1,1,1,73,0,6,0,45,0,2,2,74,0,3,0,75,0,2,0,86,3,7,0,90,0,1,1,95,0,2,0,45,0,5,0,96,0,1,1,76,0,3,3,99,0,1,1,6,1,1,0,103,0,4,0,107,0,1,1,109,1,13,0,58],[103,5,0,13,24,1,1,46,0,3,3,47,0,5,5,43,0,16,0,44,0,1,1,55,0,1,1,56,0,2,2,6,7,39,1,58,0,1,1,36,3,3,0,44,0,1,1,6,0,2,2,51,2,1,1,76,0,2,0,77,0,1,0,87,0,1,1,6,3,7,1,91,1,2,0,44,0,3,3,97,0,2,0,98,6,1,0,104,0,2,0,108,0,2,0,109,2,2,2,59,0,11,0,61],[103,2,0,14,0,1,0,28,0,1,1,36,0,1,0,37,33,1,1,43,0,2,2,48,0,2,2,49,0,2,2,6,0,2,2,50,0,7,0,51,12,4,2,59,0,1,1,60,0,33,1,61,4,1,1,49,0,1,1,50,0,1,0,51,6,1,0,78,0,1,0,83,0,1,0,88,5,1,1,92,0,1,1,6,0,1,1,93,0,3,3,94,1,1,0,51,0,1,1,48,3,1,1,55,0,1,1,6,6,1,0,105,0,2,2,19,0,2,2,110,4,11,0,63],[103,2,0,15,0,1,0,14,1,1,0,14,42,6,3,52,0,1,1,6,14,2,2,60,2,2,2,62,0,30,0,63,6,1,1,52,6,1,0,79,0,1,0,84,0,1,1,9,12,1,1,52,12,1,1,106,8,5,1,64,0,6,0,68],[103,1,0,16,0,1,0,20,0,1,0,29,1,1,0,38,45,2,2,53,0,1,1,54,21,15,0,64,0,15,0,68,13,1,0,80,0,1,1,85,36,4,0,65,0,6,6,19],[103,1,0,17,0,1,0,21,0,1,0,30,1,1,1,39,69,15,0,65,0,1,0,69,0,14,14,19,13,1,0,81,37,4,4,67],[103,1,0,18,0,1,0,22,0,1,0,31,71,2,2,66,0,13,13,67,0,1,1,70,27,1,1,82],[103,1,1,19,0,1,0,23,0,1,0,32],[104,1,0,24,0,1,0,33],[104,1,0,25,0,1,0,34],[104,1,0,26,0,1,1,35],[104,1,1,27]]},\\"version\\":1,\\"metadata\\":{\\"name\\":\\"liveTrace\\",\\"sampleRate\\":100,\\"spyName\\":\\"cprof\\",\\"units\\":\\"samples\\",\\"maxNodes\\":1024,\\"appName\\":\\"liveTrace.profiling\\",\\"format\\":\\"single\\"}}"'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - ], - 'RequestId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"Success\\",\\n \\"data\\": {\\n \\"series\\": {\\n \\"columns\\": [\\n \\"\\\\\\"time\\\\\\", \\\\\\"EXPR$1\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"2024-09-04T00:39:50Z\\\\\\", \\\\\\"1\\\\\\"\\"\\n ]\\n ]\\n },\\n \\"flame\\": {\\n \\"columns\\": [\\n \\"\\\\\\"sample\\\\\\"，\\\\\\"time\\\\\\"\\"\\n ],\\n \\"values\\": [\\n [\\n \\"\\\\\\"{\\\\\\\\\\\\\\"flamebearer\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"names\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"total\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AliYunDun:1657494\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"?5043000000000000\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::basic_string::basic_string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__memmove_ssse3_back\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_init\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::string::_Rep::_M_set_length_and_sharable\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::string::_S_copy_chars\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__strlen_sse2_pminub\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__read_nocancel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"system_call_fastpath\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SyS_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vfs_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"seq_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_single_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_tgid_stat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_task_stat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__delayacct_blkio_ticks\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_raw_spin_unlock_irqrestore\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_pid_status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"seq_bitmap\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bitmap_scnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bitmap_scnprintf.part.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"scnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vscnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"vsnprintf\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format_decode\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"kernfs_fop_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"kernfs_seq_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sysfs_kf_seq_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dev_attr_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"part_stat_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"part_in_flight\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"blk_mq_in_flight\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"blk_mq_queue_tag_busy_iter\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"copy_user_enhanced_fast_string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"proc_reg_read\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"meminfo_proc_show\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"get_vmalloc_info\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CThreadUtil::ThreadFunc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"operatordelete\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CProtocolHandlerThread::run\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CSingleton::GetInstance\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CResourceMonitor::SetThreadHeartbeat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CMonitor::SetThreadHeartbeat\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CMutexLockUtil::CMutexLockUtil\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CGetTickClock::GetClock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__pthread_rwlock_rdlock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pthread_rwlock_rdlock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"aqs::CReadLockUtil::CReadLockUtil\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::map::find\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::_Rb_tree\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::less::operator\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::_Rb_tree_iterator::_Rb_tree_iterator\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__GI___pthread_mutex_lock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pthread_mutex_lock\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__nanosleep_nocancel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SyS_nanosleep\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__check_object_size\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__virt_addr_valid\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hrtimer_nanosleep\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hrtimer_init\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"do_nanosleep\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"schedule\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__schedule\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rcu_note_context_switch\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"finish_task_switch\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hrtimer_start_range_ns\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"lock_hrtimer_base.isra.20\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"_raw_spin_lock_irqsave\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__audit_syscall_entry\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::run\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::empty\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stIpcRawMsg::stIpcRawMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::HandleRecvRawMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::basic_string::~basic_string\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::OnRecvClientData\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::InsertMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::push_back\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::_M_insert\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"std::list::_M_create_node\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__gnu_cxx::new_allocator::allocate\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ParseIpcDataEx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"boolCSimpleSerialization::GetInt\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CSimpleSerialization::GetMemberForInteger\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::HandleSendMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CIpcPrivate::SendIpcMsgPri\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CSelfGuardIpc::IpcRecvMsg\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::run\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::PeekRecvMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::ReadOneMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"evthread_use_pthreads\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pthread_self\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bufferevent_get_input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CAtomicInt64::Get\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::PeekSendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CTcpMessageBuffer::MarkSendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNetWork::GetSendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__SendMessage::__SendMessage\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__epoll_wait_nocancel\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"system_call_after_swapgs\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c69361\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c672e9\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c20f45\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c2106d\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"!48c2eca3\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SyS_epoll_wait\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ep_poll\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__fdget\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"__fget_light\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"maxSelf\\\\\\\\\\\\\\":92,\\\\\\\\\\\\\\"numTicks\\\\\\\\\\\\\\":268,\\\\\\\\\\\\\\"levels\\\\\\\\\\\\\\":[[0,268,0,0],[0,268,0,1],[0,268,92,2],[92,10,0,3,0,6,1,10,0,139,14,40,0,7,0,100,0,14,0,57],[92,8,0,4,0,2,2,9,1,5,0,11,14,3,3,41,0,36,0,42,0,3,3,6,0,45,3,57,0,15,1,72,0,3,3,43,0,20,0,89,0,1,1,101,0,1,0,102,0,5,0,11,0,1,1,101,0,13,0,11],[92,1,1,5,0,2,2,6,0,4,4,7,0,1,1,8,3,5,0,12,17,1,1,43,0,5,5,44,0,30,1,45,6,41,1,11,0,1,1,71,1,1,1,73,0,6,0,45,0,2,2,74,0,3,0,75,0,2,0,86,3,7,0,90,0,1,1,95,0,2,0,45,0,5,0,96,0,1,1,76,0,3,3,99,0,1,1,6,1,1,0,103,0,4,0,107,0,1,1,109,1,13,0,58],[103,5,0,13,24,1,1,46,0,3,3,47,0,5,5,43,0,16,0,44,0,1,1,55,0,1,1,56,0,2,2,6,7,39,1,58,0,1,1,36,3,3,0,44,0,1,1,6,0,2,2,51,2,1,1,76,0,2,0,77,0,1,0,87,0,1,1,6,3,7,1,91,1,2,0,44,0,3,3,97,0,2,0,98,6,1,0,104,0,2,0,108,0,2,0,109,2,2,2,59,0,11,0,61],[103,2,0,14,0,1,0,28,0,1,1,36,0,1,0,37,33,1,1,43,0,2,2,48,0,2,2,49,0,2,2,6,0,2,2,50,0,7,0,51,12,4,2,59,0,1,1,60,0,33,1,61,4,1,1,49,0,1,1,50,0,1,0,51,6,1,0,78,0,1,0,83,0,1,0,88,5,1,1,92,0,1,1,6,0,1,1,93,0,3,3,94,1,1,0,51,0,1,1,48,3,1,1,55,0,1,1,6,6,1,0,105,0,2,2,19,0,2,2,110,4,11,0,63],[103,2,0,15,0,1,0,14,1,1,0,14,42,6,3,52,0,1,1,6,14,2,2,60,2,2,2,62,0,30,0,63,6,1,1,52,6,1,0,79,0,1,0,84,0,1,1,9,12,1,1,52,12,1,1,106,8,5,1,64,0,6,0,68],[103,1,0,16,0,1,0,20,0,1,0,29,1,1,0,38,45,2,2,53,0,1,1,54,21,15,0,64,0,15,0,68,13,1,0,80,0,1,1,85,36,4,0,65,0,6,6,19],[103,1,0,17,0,1,0,21,0,1,0,30,1,1,1,39,69,15,0,65,0,1,0,69,0,14,14,19,13,1,0,81,37,4,4,67],[103,1,0,18,0,1,0,22,0,1,0,31,71,2,2,66,0,13,13,67,0,1,1,70,27,1,1,82],[103,1,1,19,0,1,0,23,0,1,0,32],[104,1,0,24,0,1,0,33],[104,1,0,25,0,1,0,34],[104,1,0,26,0,1,1,35],[104,1,1,27]]},\\\\\\\\\\\\\\"version\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"metadata\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sampleRate\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"spyName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cprof\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"units\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"samples\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"maxNodes\\\\\\\\\\\\\\":1024,\\\\\\\\\\\\\\"appName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"liveTrace.profiling\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"single\\\\\\\\\\\\\\"}}\\\\\\"\\\\n\\"\\n ]\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve hot spot tracking results', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotTracking', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": {\\n \\"task_id\\": \\"63fc5acb99e642d793f42912612e8001\\"\\n },\\n \\"RequestId\\": \\"13772206-1162-5A0F-81F0-79A10C249A5E\\"\\n}","type":"json"}]', ], - 'ListRegions' => [ - 'summary' => '列出所有纳管了机器的区域', - 'path' => '/api/v1/am/instance/list_regions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetInspectionReport' => [ + 'path' => '/api/v1/inspection/getInspectionReport', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], + ], + 'parameters' => [ + [ + 'name' => 'reportId', + 'in' => 'query', + 'schema' => ['description' => 'The inspection report ID.', 'type' => 'string', 'required' => false, 'example' => '91bec4c5a168494e8128468e3995df87', 'title' => ''], ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'example' => '["cn-hangzhou", "cn-shengzhen"]', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'SysomOpenAPI.InvalidParameter', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve an inspection report', + 'summary' => 'Retrieves a SysOM inspection report.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\"\\n}","type":"json"}]', - ], - 'ListInstancesWithEcsInfo' => [ - 'summary' => '获取已纳管/未纳管实例信息，信息中包含ECS信息', - 'path' => '/api/v1/am/instance/listInstancesWithEcsInfo', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetInspectionReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": \\"{}\\"\\n}","type":"json"}]', + ], + 'GetInstantScore' => [ + 'summary' => 'Get real-time cluster/node health score', + 'path' => '/api/v1/openapi/cluster_health/instant/score', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '230346', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ - 'name' => 'region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'instance_id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp118piqcio9tiwgh84b', - ], - ], - [ - 'name' => 'instance_name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'block-load-balancer-hjdm9', - ], - ], - [ - 'name' => 'instance_id_name', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '84b', - ], + 'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2ijff4be-bf24-4070-89ca-c47c879b0g32', 'title' => ''], ], [ - 'name' => 'is_managed', + 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], - [ - 'name' => 'instance_tag', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'feature_dim_radar_chart', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'code' => ['title' => '', 'description' => 'Status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. Check the `message` field for detailed error information when authorization fails.', 'type' => 'string', 'required' => false, 'pattern' => '^[a-zA-Z._-]+$', 'default' => '', 'example' => 'Success'], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'Query no data', 'title' => ''], + 'data' => [ + 'description' => 'Response data.', + 'type' => 'object', + 'properties' => [ + 'saturation' => ['description' => 'Saturation score.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'latency' => ['description' => 'Latency score.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'load' => ['description' => 'Load score.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'error' => ['description' => 'Error score.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'total' => ['description' => 'Total score.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], ], - 'required' => false, - ], - ], - [ - 'name' => 'public_ip', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1', - ], - ], - [ - 'name' => 'private_ip', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.1.1.1', + 'example' => '', ], ], - [ - 'name' => 'resource_group_name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default resource group', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"Query no data\\",\\n \\"data\\": {\\n \\"saturation\\": 100,\\n \\"latency\\": 100,\\n \\"load\\": 100,\\n \\"error\\": 100,\\n \\"total\\": 100\\n },\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Get real-time cluster/node health score', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetInstantScore', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetListRecord' => [ + 'summary' => 'Retrieves a list of AI Infra analysis records.', + 'path' => '/api/v1/app_observ/aiAnalysis/list_record', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'resource_group_id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-xxxxxxx', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '255604', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'resource_group_id_name', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'health_status', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'healthy', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'os_name', + 'name' => 'region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64bit', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'current', + 'name' => 'customId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'pageSize', + 'name' => 'analysisId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the analysis record to query the status of.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx-f37b-478d-87f6-2259ed8766bf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '""', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned object of an analysis record.', 'type' => 'object', 'properties' => [ - 'instance_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-bp118piqcio9tiwgh84b', - ], - 'instance_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'allowed-repos-r2tzl', - ], - 'instance_tag' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'tag_key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_tag_key', - ], - 'tag_value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test_tag_value', - ], - ], - ], - ], - 'public_ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'private_ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.1', - ], - 'resource_group_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default resource group', - ], - 'resource_group_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rg-xxxxxx', - ], - 'os_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64bit', - ], - 'os_health_score' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'cluster_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cbf7a37bc905d4682a3338b3744810269', - ], - 'os_arch' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x86', - ], - 'kernel_version' => [ - 'type' => 'string', - ], + 'analysisId' => ['description' => 'The AI analysis ID.', 'type' => 'string', 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', 'title' => ''], + 'analysisTime' => ['description' => 'The analysis time.', 'type' => 'string', 'example' => '2024-12-24 12:02:05'."\n", 'title' => ''], + 'status' => ['description' => 'The analysis status.', 'type' => 'string', 'example' => '已完成/分析失败', 'title' => ''], + 'arguments' => ['description' => 'The analysis parameters of the AI job analysis.', 'type' => 'string', 'example' => 'timeout=2000 ms', 'title' => ''], + 'failedLog' => ['description' => 'The failure log of the analysis.', 'type' => 'string', 'example' => '机器i-wz9dej066kii4goqpnze分析失败, 失败原因: Not get GPU trace data for \'e59ce870-dbd4-4c44-a814-174ac6ab5bcf\' \'[\'118534\']\'!', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '319', - ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"analysisId\\": \\"16896fa8-37f6-4c70-bb32-67fa9817d426\\",\\n \\"analysisTime\\": \\"2024-12-24 12:02:05\\\\n\\",\\n \\"status\\": \\"已完成/分析失败\\",\\n \\"arguments\\": \\"timeout=2000 ms\\",\\n \\"failedLog\\": \\"机器i-wz9dej066kii4goqpnze分析失败, 失败原因: Not get GPU trace data for \'e59ce870-dbd4-4c44-a814-174ac6ab5bcf\' \'[\'118534\']\'!\\"\\n }\\n ],\\n \\"total\\": 19\\n}","type":"json"}]', + 'title' => 'Retrieve AI infra analysis records', + 'changeSet' => [ + ['createdAt' => '2025-09-01T12:08:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetListRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": [\\n {\\n \\"instance_id\\": \\"i-bp118piqcio9tiwgh84b\\",\\n \\"instance_name\\": \\"allowed-repos-r2tzl\\",\\n \\"instance_tag\\": [\\n {\\n \\"tag_key\\": \\"test_tag_key\\",\\n \\"tag_value\\": \\"test_tag_value\\"\\n }\\n ],\\n \\"public_ip\\": \\"1.1.1.1\\",\\n \\"private_ip\\": \\"1.1.1.1\\",\\n \\"resource_group_name\\": \\"default resource group\\",\\n \\"resource_group_id\\": \\"rg-xxxxxx\\",\\n \\"os_name\\": \\"Alibaba Cloud Linux 3.2104 LTS 64bit\\",\\n \\"os_health_score\\": \\"100\\",\\n \\"status\\": \\"Running\\",\\n \\"cluster_id\\": \\"cbf7a37bc905d4682a3338b3744810269\\",\\n \\"os_arch\\": \\"x86\\",\\n \\"kernel_version\\": \\"5.10.134-14.an8.x86_64\\"\\n }\\n ],\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\",\\n \\"total\\": 319\\n}","type":"json"}]', ], - 'ListInstanceStatus' => [ - 'summary' => '获取实例状态', - 'path' => '/api/v1/am/instance/list_instance_status', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetProblemPercentage' => [ + 'summary' => 'Get the proportion of abnormal issues in cluster nodes/pods within a specified time range', + 'path' => '/api/v1/openapi/cluster_health/range/problem_percentage', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2ijff4be-bf24-4070-89ca-c47c879b0g32', 'title' => ''], ], [ 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9b9vucz1iubsz355rh', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], [ - 'name' => 'status', + 'name' => 'start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Running' => 'Running', - 'Offline' => 'Offline', - ], - 'example' => 'Running', - ], + 'schema' => ['description' => 'Start time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725797727754', 'title' => ''], ], [ - 'name' => 'region', + 'name' => 'end', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => 'End time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725801327754', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'code' => ['description' => 'Status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. Check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'instance' => [ - 'description' => '', - 'type' => 'string', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - ], - 'status' => [ - 'description' => '', + 'type' => [ + 'description' => 'Abnormal item type.', + 'enumValueTitles' => ['Saturation' => 'saturation', 'Error' => 'error', 'Latency' => 'latency', 'Load' => 'load'], 'type' => 'string', - 'example' => 'Running', + 'example' => 'saturation', + 'title' => '', ], + 'value' => ['description' => 'Number of abnormal items.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'type' => 'string', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '218', - ], + 'total' => ['description' => 'Total number of data entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], + 'request_id' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"saturation\\",\\n \\"value\\": 5\\n }\\n ],\\n \\"total\\": 19,\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', + 'title' => 'Get Abnormal Problem Percentage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetProblemPercentage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n {\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"Running\\"\\n }\\n ],\\n \\"RequestId\\": \\"5BC79EF5-798B-5499-9683-4E14EBBBF712\\",\\n \\"total\\": 218\\n}","type":"json"}]', ], - 'ListInstancesEcsInfoList' => [ - 'summary' => '获取ecs信息的列表，如标签列表，公网ip列表等', - 'path' => '/api/v1/am/instance/listInstancesEcsInfoList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetRangeScore' => [ + 'summary' => 'Retrieves the health score trend.', + 'path' => '/api/v1/openapi/cluster_health/range/score', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ - 'name' => 'region', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2ijff4be-bf24-4070-89ca-c47c879b0g32', 'title' => ''], ], [ - 'name' => 'info_type', + 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ip', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], [ - 'name' => 'managed_type', + 'name' => 'start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'managed', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725797727754', 'title' => ''], ], [ - 'name' => 'instance_id', + 'name' => 'end', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp118piqcio9tiwgh84b', - ], - ], - [ - 'name' => 'plugin_id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725801327754', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.InvalidParameter', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'code' => ['title' => '', 'description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization has failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'required' => false, 'pattern' => '^[a-zA-Z._-]+$', 'default' => '', 'example' => 'Success'], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => '""', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.193.52.91', - ], 'type' => [ - 'description' => '', + 'description' => 'The metric type.', + 'enumValueTitles' => ['总分' => 'total', '饱和度' => 'saturation', '错误' => 'error', '延时' => 'latency', '负载' => 'load'], 'type' => 'string', - 'example' => 'public', - ], - 'tag_key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sysom', - ], - 'tag_value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'diagnosis', + 'example' => 'saturation', + 'title' => '', ], + 'value' => ['description' => 'The score.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'time' => ['description' => 'The point in time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725797727754', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'total' => ['description' => 'The total amount of data.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"saturation\\",\\n \\"value\\": 100,\\n \\"time\\": 1725797727754\\n }\\n ],\\n \\"total\\": 2,\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', + 'title' => 'Retrieve health score trend', + 'changeSet' => [ + ['createdAt' => '2025-04-30T16:02:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-28T12:44:50.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetRangeScore', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"ip\\": \\"11.193.52.91\\",\\n \\"type\\": \\"public\\",\\n \\"tag_key\\": \\"sysom\\",\\n \\"tag_value\\": \\"diagnosis\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListClusterAgentInstallRecords' => [ - 'summary' => '获取集群组件安装记录', - 'path' => '/api/v1/am/agent/list_cluster_agent_install_list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetResources' => [ + 'summary' => 'Retrieves the real-time resource usage of a cluster or node.', + 'path' => '/api/v1/openapi/cluster_health/instant/resource', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '253443', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'cluster_id', + 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cbd80af02b9d6454ebdc579c5e022d0c8', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => '1808078950770264', 'title' => ''], ], [ - 'name' => 'plugin_id', + 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], [ - 'name' => 'plugin_version', + 'name' => 'type', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The resource type.', + 'enumValueTitles' => ['上行速率' => 'network_input', '下行速率' => 'network_output', '磁盘' => 'disk', '内存' => 'mem', 'CPU' => 'cpu'], 'type' => 'string', 'required' => false, - 'example' => '3.4.0-1', - ], - ], - [ - 'name' => 'agent_config_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'example' => 'mem', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => "\n" - .'success', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'cluster_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cbf7a37bc905d4682a3338b3744810269', - ], - 'plugin_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], - 'plugin_version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3.4.0-1', - ], - 'created_at' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-25T15:08:19', - ], - 'updated_at' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-25T15:08:19', - ], - 'grayscale_config' => [ - 'title' => '灰度配置', - 'type' => 'string', - ], - 'agent_config_id' => [ - 'type' => 'string', - ], - 'agent_config_name' => [ - 'type' => 'string', - ], - ], + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'The total number of resources.', 'type' => 'number', 'format' => 'float', 'example' => '2354', 'title' => ''], + 'usage' => ['description' => 'The resource usage.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'Kbytes', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": {\\n \\"total\\": 2354,\\n \\"usage\\": 100,\\n \\"unit\\": \\"Kbytes\\"\\n },\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', + 'title' => 'Retrieve real-time resource usage of a cluster or node', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetBasicResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\nsuccess\\",\\n \\"total\\": 42,\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"data\\": [\\n {\\n \\"cluster_id\\": \\"cbf7a37bc905d4682a3338b3744810269\\",\\n \\"plugin_id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"plugin_version\\": \\"3.4.0-1\\",\\n \\"created_at\\": \\"2024-12-25T15:08:19\\",\\n \\"updated_at\\": \\"2024-12-25T15:08:19\\",\\n \\"grayscale_config\\": \\"{}\\",\\n \\"agent_config_id\\": \\"\\",\\n \\"agent_config_name\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListAgentInstallRecords' => [ - 'summary' => '列出 Agent 的安装记录', - 'path' => '/api/v1/am/agent/list_agent_install_list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetServiceFuncStatus' => [ + 'summary' => 'Retrieves the configuration of a feature module.', + 'path' => '/api/v1/func-switch/get-service-func-status', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'current', + 'name' => 'params', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '当前页码（从1开始）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'description' => 'The diagnostic parameters. Different types of diagnostics require different diagnostic parameters. You can use this field to filter records whose parameters match the specified values.', + 'type' => 'object', + 'properties' => [ + 'function_name' => ['description' => 'The feature name.', 'type' => 'string', 'required' => true, 'example' => 'mullprof', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-2zei55fwj8nnu31h3z46', 'title' => ''], + 'uid' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '1338904783509062', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'pageSize', + 'name' => 'service_name', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The service name.', 'type' => 'string', 'required' => true, 'example' => 'livetrace', 'title' => ''], ], [ - 'name' => 'instance_id', + 'name' => 'channel', 'in' => 'query', - 'schema' => [ - 'title' => '指定本字段，则过滤出指定实例的Agent安装情况', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The channel name.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], ], - [ - 'name' => 'plugin_id', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '指定本参数则过滤出指定Agent的安装列表，可以搭配 plugin_version 参数使用', - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => "\n", 'title' => ''], + 'data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'args' => [ + 'description' => 'The configuration parameters.', + 'type' => 'object', + 'properties' => [ + 'add_cmd' => ['description' => 'The configuration process.', 'type' => 'string', 'example' => 'java', 'title' => ''], + 'mem' => ['description' => 'The memory tracing switch.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'locks' => ['description' => 'The lock tracing switch.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'java_store_path' => ['description' => 'The storage path.', 'type' => 'string', 'example' => '/tmp/sysom/java-profiler', 'title' => ''], + 'cpu' => ['description' => 'The ONCPU tracing switch.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'system_profiling' => ['description' => 'The system profiling switch.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'loop' => ['description' => 'The tracing cycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'plugin_version', - 'in' => 'query', - 'schema' => [ - 'title' => '不可单独使用，搭配 plugin_id 使用，用于过滤出指定Agent指定版本的安装列表', - 'description' => '', - 'type' => 'string', - 'required' => false, + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\n\\",\\n \\"data\\": {\\n \\"args\\": {\\n \\"add_cmd\\": \\"java\\",\\n \\"mem\\": \\"true\\",\\n \\"locks\\": \\"true\\",\\n \\"java_store_path\\": \\"/tmp/sysom/java-profiler\\",\\n \\"cpu\\": \\"true\\",\\n \\"system_profiling\\": \\"true\\",\\n \\"loop\\": -1\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve service configuration status', + 'description' => 'Retrieves the service configuration status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetServiceFuncStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetVmcoreDiagnosisTask' => [ + 'summary' => 'Queries the execution status and diagnostic result of a diagnostic task by task ID.', + 'path' => '/api/v1/crashAgent/diagnosis/queryTask', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'region', + 'name' => 'taskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '64', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instance_id' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - ], - 'plugin_id' => [ - 'title' => '组件ID'."\n", - 'description' => '', - 'type' => 'string', - ], - 'plugin_version' => [ - 'title' => '插件版本'."\n", - 'description' => '', - 'type' => 'string', - ], - 'status' => [ - 'title' => '组件状态', - 'description' => '', - 'type' => 'string', - ], - 'created_at' => [ - 'description' => '', - 'type' => 'string', - ], - 'updated_at' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7'], + 'createdAt' => ['title' => '', 'description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2025-12-02T17:36:12'], + 'diagnoseResult' => ['title' => '', 'description' => 'The diagnostic result.', 'type' => 'string', 'example' => 'result'], + 'errorMsg' => ['title' => '', 'description' => 'The diagnostic error message.', 'type' => 'string', 'example' => 'error message'], + 'taskType' => [ + 'title' => '', + 'description' => 'The task type.', + 'enumValueTitles' => ['dmesg' => 'dmesg', 'vmcore' => 'vmcore'], + 'type' => 'string', + 'example' => 'vmcore', + ], + 'taskStatus' => [ + 'title' => '', + 'description' => 'The task status.', + 'enumValueTitles' => ['running' => 'running', 'queuing' => 'queuing', 'created' => 'created', 'success' => 'success', 'error' => 'error'], + 'type' => 'string', + 'example' => 'running', + ], + 'urls' => [ + 'title' => '', + 'description' => 'The download URLs of related files associated with the task.', + 'type' => 'object', + 'properties' => [ + 'debuginfoCommonUrl' => ['title' => '', 'description' => 'The download URL of the debuginfo-common RPM package.', 'type' => 'string', 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path'], + 'debuginfoUrl' => ['title' => '', 'description' => 'The download URL of the debuginfo RPM package.', 'type' => 'string', 'example' => ' '."\n" + .'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path'], + 'dmesgUrl' => ['title' => '', 'description' => 'The download URL of the dmesg log.', 'type' => 'string', 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path'], + 'vmcoreUrl' => ['title' => '', 'description' => 'The download URL of the vmcore file.', 'type' => 'string', 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path'], ], + 'example' => '', ], ], - ], - 'RequestId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"taskId\\": \\"bbe94a98-4192-4172-b856-95777e0a55d7\\",\\n \\"createdAt\\": \\"2025-12-02T17:36:12\\",\\n \\"diagnoseResult\\": \\"result\\",\\n \\"errorMsg\\": \\"error message\\",\\n \\"taskType\\": \\"vmcore\\",\\n \\"taskStatus\\": \\"running\\",\\n \\"urls\\": {\\n \\"debuginfoCommonUrl\\": \\"https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path\\",\\n \\"debuginfoUrl\\": \\"\\\\t\\\\nhttps://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path\\",\\n \\"dmesgUrl\\": \\"https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path\\",\\n \\"vmcoreUrl\\": \\"https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query a diagnostic task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GetVmcoreDiagnosisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"total\\": 64,\\n \\"data\\": [\\n {\\n \\"instance_id\\": \\"i-bp118piqcio9tiwgh84b\\",\\n \\"plugin_id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"plugin_version\\": \\"3.4.0-1\\",\\n \\"status\\": \\"Installed\\",\\n \\"created_at\\": \\"2024-11-27T16:37:53\\",\\n \\"updated_at\\": \\"2024-11-27T16:37:53\\"\\n }\\n ],\\n \\"RequestId\\": \\"E8CDFBA1-0564-5897-B070-D3C85002AF2F\\"\\n}","type":"json"}]', ], - 'InstallAgentForCluster' => [ - 'summary' => '给集群安装组件', - 'path' => '/api/v1/am/agent/install_agent_by_cluster', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'InitialSysom' => [ + 'summary' => 'Initializes SysOM to ensure that the service-linked role exists.', + 'path' => '/api/v1/openapi/initial', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '253444', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -5309,110 +4164,92 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'cluster_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'c9d7f3fc3d42942afbcb65c1100ffb19d', - ], - 'agent_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', - ], - 'agent_version' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3.4.0-1', - ], - 'grayscale_config' => [ - 'title' => '灰度配置', - 'type' => 'string', - ], - 'config_id' => [ - 'type' => 'string', - ], + 'check_only' => ['title' => '', 'description' => 'Specifies whether to only check whether the service-linked role exists.', 'type' => 'boolean', 'required' => false, 'example' => ''], + 'source' => ['title' => '', 'description' => 'The source. Set this parameter to console.', 'type' => 'string', 'required' => false, 'example' => 'console'], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', - ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'title' => '', 'example' => '3FCA2E38-2A8E-5501-93BD-5CE1BA58F2EF'], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success`: The authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '049ea0609515414b9e19c3389d7ba638', - ], + 'role_exist' => ['description' => 'Indicates whether the service-linked role exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3FCA2E38-2A8E-5501-93BD-5CE1BA58F2EF\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"role_exist\\": true\\n }\\n}","type":"json"}]', + 'title' => 'Activate the alinux console', + 'description' => 'Some SysOM API operations require role assumption based on the `AliyunServiceRoleForSysom` service-linked role. Before using SysOM features, invoke this operation to perform initialization and ensure that the service-linked role has been created.'."\n" + .'- `check_only`: If this parameter is set to True, the operation only checks whether the service-linked role exists and does not create it. If this parameter is set to False or left empty, the operation performs automatic creation of the service-linked role if it does not exist.'."\n" + ."\n" + .'> '."\n" + .'> Note: When you call this operation to initialize the role through the API, you agree to the user agreement of the operating system console by default. For more information, see [Operating system console overview](https://www.alibabacloud.com/help/en/alinux/product-overview/os-console-overview) and [Alibaba Cloud Service Trial Terms](https://terms.aliyun.com/legal-agreement/terms/suit_bu1_ali_cloud/suit_bu1_ali_cloud202001091714_51956.html).', + 'changeSet' => [ + ['createdAt' => '2025-08-01T01:58:08.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InitialSysom', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"success\\",\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"data\\": {\\n \\"task_id\\": \\"049ea0609515414b9e19c3389d7ba638\\"\\n }\\n}","type":"json"}]', ], 'InstallAgent' => [ - 'summary' => '在指定的实例上安装 Agent', 'path' => '/api/v1/am/agent/install_agent', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxV02H6G', - ], + 'abilityTreeNodes' => ['FEATUREalinuxV02H6G'], ], 'parameters' => [ [ @@ -5420,1035 +4257,428 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'instances' => [ - 'description' => '', + 'description' => 'The list of instances on which to install the component.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The instance information.', 'type' => 'object', 'properties' => [ - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'i-wz9b9vucz1iubsz8sjqo', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], 'required' => true, + 'title' => '', + 'example' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], 'install_type' => [ - 'description' => '', + 'description' => 'The installation type. Valid values:'."\n" + .'- InstallAndUpgrade: installs the component if it does not exist, or updates it if it exists.'."\n" + .'- OnlyInstallNotHasAgent: installs the component if it does not exist, or takes no action if it exists.'."\n" + .'- OnlyUpgradeHasAgent: takes no action if the component does not exist, or updates it if it exists.'."\n" + .'- OnlyInstallWithoutStart: installs the component only without starting the service.', 'type' => 'string', 'required' => true, + 'enum' => ['InstallAndUpgrade', 'OnlyInstallNotHasAgent', 'OnlyUpgradeHasAgent', 'OnlyInstallWithoutStart'], 'example' => 'InstallAndUpgrade', - 'enum' => [ - 'InstallAndUpgrade', - 'OnlyInstallNotHasAgent', - 'OnlyUpgradeHasAgent', - ], - ], - 'agent_id' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - ], - 'agent_version' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', ], + 'agent_id' => ['description' => 'The ID of the component to install.', 'type' => 'string', 'required' => true, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agent_version' => ['description' => 'The version of the component to install.', 'type' => 'string', 'required' => true, 'example' => '3.4.0-1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['title' => '', 'description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => '""'], 'data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - ], + 'task_id' => ['description' => 'The task ID.'."\n" + ."\n" + .'You can use this task ID to call the GetAgentTask operation to retrieve the task execution status.', 'type' => 'string', 'example' => '26b3cd97389c43dcad6bc4901c36fcec', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '1D8887FC-4BDB-5A1C-AB19-135C29A9E481', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'SysomOpenAPI.AgentNotExists', - 'errorMessage' => 'Agent not exists.', - ], - [ - 'errorCode' => 'SysomOpenAPI.AgentTaskNotFound', - 'errorMessage' => 'Agent task not found.', - ], - [ - 'errorCode' => 'SysomOpenAPI.AgentVersionNotExists', - 'errorMessage' => 'Agent version not exists.', - ], - [ - 'errorCode' => 'SysomOpenAPI.InstanceNotExists', - 'errorMessage' => 'Instance not exists.', - ], - [ - 'errorCode' => 'SysomOpenAPI.InvalidParameter', - 'errorMessage' => 'Invalid parameters passed when calling the interface.', - ], - [ - 'errorCode' => 'SysomOpenAPI.MissingParameter', - 'errorMessage' => 'Missing parameters.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NoAgentInstalled', - 'errorMessage' => 'No SysOM Agent version available.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotAuthorizedInstance', - 'errorMessage' => 'Instance not authorized.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotOwnInstance', - 'errorMessage' => 'Not own current instance.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotOwnTask', - 'errorMessage' => 'Diagnosis result does not belong to the current account.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotSupportedAgentVersion', - 'errorMessage' => 'Unsupported sysom agent version.', - ], - [ - 'errorCode' => 'SysomOpenAPI.ServerError', - 'errorMessage' => 'Server error, please correct the code according to the error message.', + ['errorCode' => 'SysomOpenAPI.AgentNotExists', 'errorMessage' => 'Agent not exists.', 'description' => 'Agent does not exist.'], + ['errorCode' => 'SysomOpenAPI.AgentTaskNotFound', 'errorMessage' => 'Agent task not found.', 'description' => 'Component task does not exist.'], + ['errorCode' => 'SysomOpenAPI.AgentVersionNotExists', 'errorMessage' => 'Agent version not exists.', 'description' => 'Agent version does not exist.'], + ['errorCode' => 'SysomOpenAPI.InstanceNotExists', 'errorMessage' => 'Instance not exists.', 'description' => 'Instance does not exist'], + ['errorCode' => 'SysomOpenAPI.InvalidParameter', 'errorMessage' => 'Invalid parameters passed when calling the interface.', 'description' => 'Invalid parameter passed when calling interface'], + ['errorCode' => 'SysomOpenAPI.MissingParameter', 'errorMessage' => 'Missing parameters.', 'description' => 'Missing parameter'], + ['errorCode' => 'SysomOpenAPI.NoAgentInstalled', 'errorMessage' => 'No SysOM Agent version available.', 'description' => 'No SysOM Agent is available.'], + ['errorCode' => 'SysomOpenAPI.NotAuthorizedInstance', 'errorMessage' => 'Instance not authorized.', 'description' => 'The instance is not authorized.'], + ['errorCode' => 'SysomOpenAPI.NotOwnInstance', 'errorMessage' => 'Not own current instance.', 'description' => 'The specified instance does not belong to the current user.'], + ['errorCode' => 'SysomOpenAPI.NotOwnTask', 'errorMessage' => 'Diagnosis result does not belong to the current account.', 'description' => 'Diagnosis result does not belong to the current account'], + ['errorCode' => 'SysomOpenAPI.NotSupportedAgentVersion', 'errorMessage' => 'Unsupported sysom agent version.', 'description' => 'Unsupported SysOM client version.'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ['errorCode' => 'SysomOpenAPI.ServiceRoleNotExists', 'errorMessage' => 'Service role does not exist, please init the sysom service first.', 'description' => 'The service role does not exist. Activate the Alinux console first.'], + ['errorCode' => 'SysomOpenAPI.RegionNotSupport', 'errorMessage' => 'Region not supported.', 'description' => 'Region is not supported.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Install component', + 'summary' => 'Installs an Agent on a specified instance.', + 'description' => 'Calling this operation to install an Agent is asynchronous. After the call, a task_id is returned. You can use this ID to call the GetAgentTask operation to retrieve the task execution status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:InstallAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"task_id\\": \\"26b3cd97389c43dcad6bc4901c36fcec\\"\\n },\\n \\"RequestId\\": \\"1D8887FC-4BDB-5A1C-AB19-135C29A9E481\\"\\n}","type":"json"}]', ], - 'ListAgents' => [ - 'summary' => '获取 Agent 列表', - 'path' => '/api/v1/am/agent/list_agents', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'InstallAgentForCluster' => [ + 'summary' => 'Install component for cluster', + 'path' => '/api/v1/am/agent/install_agent_by_cluster', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeCode' => '253444', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页数（从第1页开始）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'title' => '通过插件的名字过滤插件', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'title' => '根据 Agent 类型来获取列表，比如传递 control 表示获取所有管控类型的 Agent', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Request body.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysOM Agent', - ], - 'support_arch' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x86', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Control', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - ], - 'id' => [ - 'description' => '', - 'type' => 'string', - ], - 'versions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'description' => '', - 'type' => 'string', - ], - 'install_script' => [ - 'description' => '', - 'type' => 'string', - ], - 'uninstall_script' => [ - 'description' => '', - 'type' => 'string', - ], - 'upgrade_script' => [ - 'description' => '', - 'type' => 'string', - ], - 'created_at' => [ - 'description' => '', - 'type' => 'string', - ], - 'updated_at' => [ - 'description' => '', - 'type' => 'string', - ], - ], - ], - ], - 'created_at' => [ - 'description' => '', - 'type' => 'string', - ], - 'updated_at' => [ - 'description' => '', - 'type' => 'string', - ], - ], - ], - ], + 'cluster_id' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> The cluster ID here must be an ACK cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'c9d7f3fc3d42942afbcb65c1100ffb19d', 'title' => ''], + 'agent_id' => ['description' => 'The component ID.', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agent_version' => ['description' => 'The component version.', 'type' => 'string', 'required' => false, 'example' => '3.4.0-1', 'title' => ''], + 'grayscale_config' => ['title' => '', 'description' => 'The canary release configuration.', 'type' => 'string', 'required' => false, 'example' => '{"type":"numeric","config":{"value":2}}'], + 'config_id' => ['description' => 'The component configuration ID.', 'type' => 'string', 'required' => false, 'example' => '8gj86wrt7-3170-412c-8e67-da3389ecg6a9', 'title' => ''], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"RequestId\\": \\"66EAED72-542B-583B-BCED-64433DC27AD7\\",\\n \\"total\\": 2,\\n \\"data\\": [\\n {\\n \\"name\\": \\"SysOM Agent\\",\\n \\"support_arch\\": \\"x86\\",\\n \\"type\\": \\"Control\\",\\n \\"description\\": \\"SysOM Agent\\",\\n \\"id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"versions\\": [\\n {\\n \\"version\\": \\"3.4.0-1\\",\\n \\"install_script\\": \\"sysom.sh install\\",\\n \\"uninstall_script\\": \\"sysom.sh uninstall\\",\\n \\"upgrade_script\\": \\"sysom.sh upgrade\\",\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetAgentTask' => [ - 'summary' => '获取Agent安装任务执行状态', - 'path' => '/api/v1/am/agent/get_agent_task', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'task_id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Any other status code indicates authorization failure. Check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - ], - 'jobs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instance' => [ - 'description' => '', - 'type' => 'string', - ], - 'region' => [ - 'description' => '', - 'type' => 'string', - ], - 'params' => [ - 'description' => '', - 'type' => 'any', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - 'enum' => [ - 'Created', - 'Running', - 'Success', - 'Failed', - 'Canceled', - ], - ], - 'result' => [ - 'description' => '', - 'type' => 'string', - ], - 'error' => [ - 'description' => '', - 'type' => 'string', - ], - 'errorCode' => [ - 'type' => 'string', - ], - 'errorMessage' => [ - 'type' => 'string', - ], - ], - ], - ], - 'status' => [ - 'type' => 'string', - ], + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '049ea0609515414b9e19c3389d7ba638', 'title' => ''], ], - ], - 'RequestId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'SysomOpenAPI.AgentNotExists', - 'errorMessage' => 'Agent not exists.', - ], - [ - 'errorCode' => 'SysomOpenAPI.AgentTaskNotFound', - 'errorMessage' => 'Agent task not found.', - ], - [ - 'errorCode' => 'SysomOpenAPI.AgentVersionNotExists', - 'errorMessage' => 'Agent version not exists.', - ], - [ - 'errorCode' => 'SysomOpenAPI.InstanceNotExists', - 'errorMessage' => 'Instance not exists.', - ], - [ - 'errorCode' => 'SysomOpenAPI.InvalidParameter', - 'errorMessage' => 'Invalid parameters passed when calling the interface.', - ], - [ - 'errorCode' => 'SysomOpenAPI.MissingParameter', - 'errorMessage' => 'Missing parameters.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NoAgentInstalled', - 'errorMessage' => 'No SysOM Agent version available.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotAuthorizedInstance', - 'errorMessage' => 'Instance not authorized.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotOwnInstance', - 'errorMessage' => 'Not own current instance.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotOwnTask', - 'errorMessage' => 'Diagnosis result does not belong to the current account.', - ], - [ - 'errorCode' => 'SysomOpenAPI.NotSupportedAgentVersion', - 'errorMessage' => 'Unsupported sysom agent version.', - ], - [ - 'errorCode' => 'SysomOpenAPI.ServerError', - 'errorMessage' => 'Server error, please correct the code according to the error message.', + ['errorCode' => 'SysomOpenAPI.RegionNotSupport', 'errorMessage' => 'Region not supported.', 'description' => 'Region is not supported.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Install Component for ACK Cluster', + 'description' => 'After installing a component for the target ACK cluster:'."\n" + .'1. First, when the cluster is managed for the first time, the component will be installed on all ECS instances currently in the cluster. If the cluster has more than 50 nodes, only 50 instances will be covered in the first batch.'."\n" + .'2. Then, the SysOM console periodically checks the scaling status of the managed cluster. Once a new ECS instance is added to the cluster, the SysOM console automatically installs the component on it without user intervention.', + 'changeSet' => [ + ['createdAt' => '2025-06-30T14:50:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-10T13:58:04.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InstallAgentForCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"task_id\\": \\"c41d8e3506224184a714682fea86d22d\\",\\n \\"jobs\\": [\\n {\\n \\"instance\\": \\"i-2zehme0rs1tc090fdl3n\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"params\\": \\"{\\\\n \\\\\\"agent_version\\\\\\": \\\\\\"3.5.0-beta\\\\\\",\\\\n \\\\\\"opt\\\\\\": \\\\\\"install\\\\\\",\\\\n \\\\\\"agent_id\\\\\\": \\\\\\"74a86327-3170-412c-8fd67-da3389ec56a9\\\\\\",\\\\n \\\\\\"install_type\\\\\\": \\\\\\"InstallAndUpgrade\\\\\\"\\\\n}\\",\\n \\"status\\": \\"Running\\",\\n \\"result\\": \\"已废弃（误用）\\",\\n \\"error\\": \\"已废弃（误用）\\",\\n \\"errorCode\\": \\"DISK_SPACE_INSUFFICIENT\\",\\n \\"errorMessage\\": \\"磁盘空间不足\\"\\n }\\n ],\\n \\"status\\": \\"\\"\\n },\\n \\"RequestId\\": \\"2E75336A-0DB2-5263-B201-A6488EC97B50\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"success\\",\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"data\\": {\\n \\"task_id\\": \\"049ea0609515414b9e19c3389d7ba638\\"\\n }\\n}","type":"json"}]', ], - 'GetAgent' => [ - 'summary' => '获取某个组件的详情', - 'path' => '/api/v1/am/agent/get_agent', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'InstallAgentWithType' => [ + 'summary' => '', + 'path' => '/api/v1/am/agent/installAgent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux33ME7W', - ], + 'abilityTreeNodes' => ['FEATUREalinuxV02H6G'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'agent_id', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '组件ID', + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instance' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'instanceType' => [ + 'title' => '', + 'type' => 'string', + 'required' => true, + 'enum' => ['ecs', 'eflo'], + 'description' => '', + 'example' => 'ecs', + ], + 'agentId' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agentVersion' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '3.4.0-1', 'title' => ''], + 'configId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'f0078fbb-4213-11f0-a19b-00163e4ae208', 'title' => ''], + ], 'description' => '', - 'type' => 'string', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', - ], + 'code' => ['type' => 'string', 'description' => '', 'example' => 'Success', 'title' => ''], + 'message' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '""'], 'data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '组件ID', - 'description' => '', - 'type' => 'string', - ], - 'name' => [ - 'title' => '组件名称', - 'description' => '', - 'type' => 'string', - ], - 'support_arch' => [ - 'title' => '支持的架构'."\n", - 'description' => '', - 'type' => 'string', - ], - 'type' => [ - 'title' => 'Agent类型', - 'description' => '', - 'type' => 'string', - ], - 'description' => [ - 'title' => '组件描述', - 'description' => '', - 'type' => 'string', - ], - 'versions' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'title' => 'Agent 版本号', - 'description' => '', - 'type' => 'string', - ], - 'install_script' => [ - 'title' => 'Agent 该版本的安装脚本', - 'description' => '', - 'type' => 'string', - ], - 'uninstall_script' => [ - 'title' => 'Agent 该版本的卸载脚本', - 'description' => '', - 'type' => 'string', - ], - 'upgrade_script' => [ - 'title' => 'Agent该版本的更新脚本', - 'description' => '', - 'type' => 'string', - ], - 'created_at' => [ - 'title' => 'Agent版本创建时间', - 'description' => '', - 'type' => 'string', - ], - 'updated_at' => [ - 'title' => 'Agent版本的更新时间', - 'description' => '', - 'type' => 'string', - ], - ], - ], - ], - 'created_at' => [ - 'title' => '组件创建时间', - 'description' => '', - 'type' => 'string', - ], - 'updated_at' => [ - 'title' => '更新时间', - 'description' => '', - 'type' => 'string', - ], + 'taskId' => ['type' => 'string', 'description' => '', 'example' => '26b3cd97389c43dcad6bc4901c36fcec', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'type' => 'string', - ], + 'requestId' => ['type' => 'string', 'description' => '', 'example' => '1D8887FC-4BDB-5A1C-AB19-135C29A9E481'."\n", 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"name\\": \\"SysOM\\",\\n \\"support_arch\\": \\"x86\\",\\n \\"type\\": \\"control\\",\\n \\"description\\": \\"SysOM Agent\\",\\n \\"versions\\": [\\n {\\n \\"version\\": \\"3.4.0-1\\",\\n \\"install_script\\": \\"sysom.sh install\\",\\n \\"uninstall_script\\": \\"sysom.sh uninstall\\",\\n \\"upgrade_script\\": \\"sysom.sh upgrade\\",\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n },\\n \\"RequestId\\": \\"2024-09-14T20:46:08\\"\\n}","type":"json"}]', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.AgentNotExists', 'errorMessage' => 'Agent not exists.', 'description' => 'Agent does not exist.'], + ['errorCode' => 'SysomOpenAPI.AgentTaskNotFound', 'errorMessage' => 'Agent task not found.', 'description' => 'Component task does not exist.'], + ['errorCode' => 'SysomOpenAPI.AgentVersionNotExists', 'errorMessage' => 'Agent version not exists.', 'description' => 'Agent version does not exist.'], + ['errorCode' => 'SysomOpenAPI.InstanceNotExists', 'errorMessage' => 'Instance not exists.', 'description' => 'Instance does not exist'], + ['errorCode' => 'SysomOpenAPI.InvalidParameter', 'errorMessage' => 'Invalid parameters passed when calling the interface.', 'description' => 'Invalid parameter passed when calling interface'], + ['errorCode' => 'SysomOpenAPI.MissingParameter', 'errorMessage' => 'Missing parameters.', 'description' => 'Missing parameter'], + ['errorCode' => 'SysomOpenAPI.NoAgentInstalled', 'errorMessage' => 'No SysOM Agent version available.', 'description' => 'No SysOM Agent is available.'], + ['errorCode' => 'SysomOpenAPI.NotAuthorizedInstance', 'errorMessage' => 'Instance not authorized.', 'description' => 'The instance is not authorized.'], + ['errorCode' => 'SysomOpenAPI.NotOwnInstance', 'errorMessage' => 'Not own current instance.', 'description' => 'The specified instance does not belong to the current user.'], + ['errorCode' => 'SysomOpenAPI.NotOwnTask', 'errorMessage' => 'Diagnosis result does not belong to the current account.', 'description' => 'Diagnosis result does not belong to the current account'], + ['errorCode' => 'SysomOpenAPI.NotSupportedAgentVersion', 'errorMessage' => 'Unsupported sysom agent version.', 'description' => 'Unsupported SysOM client version.'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '调用本接口安装 Agent 是异步的，调用接口后会返回一个 task_id，可以凭借该 ID 调用 GetAgentTask 接口获取任务的执行情况。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"taskId\\": \\"26b3cd97389c43dcad6bc4901c36fcec\\"\\n },\\n \\"requestId\\": \\"1D8887FC-4BDB-5A1C-AB19-135C29A9E481\\\\n\\"\\n}","type":"json"}]', ], - 'ListAllInstances' => [ - 'summary' => '此接口用于获取已纳管/未纳管实例列表并带有实例信息', - 'path' => '/api/v1/am/instance/listAllInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'InvokeAnomalyDiagnosis' => [ + 'summary' => 'Initiates an anomaly diagnostics task.', + 'path' => '/api/v1/openapi/cluster_health/diagnosis/invoke_anomaly_diagnose', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', + 'operationType' => 'create', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'instanceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - 'default' => 'all', - 'enum' => [ - 'ecs', - 'eflo', - 'all', - ], - ], - ], - [ - 'name' => 'managedType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'managed', - 'enum' => [ - 'managed', - 'unmanaged', - 'install', - 'uninstall', - 'upgrade', - ], - ], - ], - [ - 'name' => 'filters', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], - ], - [ - 'name' => 'current', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'pluginId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '01fc4a0b-f199-4885-9861-b4054a310fe7', - ], - ], - [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'nextToken', + 'name' => 'uuid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'U+w1wv2R4ZWR5oZLXD0+Dp4dD+2BRJj42DLT6GrZysw=', - ], + 'schema' => ['description' => 'The UUID of the anomaly event.', 'type' => 'string', 'required' => false, 'example' => '8047d763-5465-4a8c-b1cd-23f5a8ba2594', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'instance not exists', - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-bp17uabeke9v7n30abm2', - ], - 'osHealthScore' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'resourceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'instanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'installType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'console', - ], - 'instanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs', - ], - 'installLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Cluster', - ], - 'attributes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'infoValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'diagnosis', - ], - 'infoType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'instance_tag', - ], - 'infoKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sysom', - ], - ], - ], - ], - 'resourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3b24a621-acb3-11ef-8c90-00163e1029af', - ], - 'osName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'alios', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'clusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3b24a621-acb3-11ef-8c90-00163e1029af', - ], - 'osArch' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x86_64', - ], - 'kernelVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.10.134-18.al8.x86_64', - ], - 'imageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliyun_3_x64_20G_alibase_20250117.vhd', - ], - 'manageType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'managed', - ], - 'manageLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cluster', - ], - 'clusterName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zjk_vpc_domain_1', - ], - 'publicIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '47.98.215.58', - ], - 'privateIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '172.21.172.7', - ], - 'agentConfigId' => [ - 'type' => 'string', - ], - 'agentConfigName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'maxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c2f78a783f49457caba6bace6f6f79e4', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Sysom.ServerError', - 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\"\\n}","type":"json"}]', + 'title' => 'Initiate anomaly diagnostics', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InvokeAnomalyDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"instance not exists\\",\\n \\"total\\": 2,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"i-bp17uabeke9v7n30abm2\\",\\n \\"osHealthScore\\": 100,\\n \\"resourceGroupName\\": \\"xxxx\\",\\n \\"instanceName\\": \\"test\\",\\n \\"installType\\": \\"console\\",\\n \\"instanceType\\": \\"ecs\\",\\n \\"installLevel\\": \\"Cluster\\",\\n \\"attributes\\": [\\n {\\n \\"infoValue\\": \\"diagnosis\\",\\n \\"infoType\\": \\"instance_tag\\",\\n \\"infoKey\\": \\"sysom\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"3b24a621-acb3-11ef-8c90-00163e1029af\\",\\n \\"osName\\": \\"alios\\",\\n \\"status\\": \\"Running\\",\\n \\"clusterId\\": \\"3b24a621-acb3-11ef-8c90-00163e1029af\\",\\n \\"osArch\\": \\"x86_64\\",\\n \\"kernelVersion\\": \\"5.10.134-18.al8.x86_64\\",\\n \\"imageId\\": \\"aliyun_3_x64_20G_alibase_20250117.vhd\\",\\n \\"manageType\\": \\"managed\\",\\n \\"manageLevel\\": \\"cluster\\",\\n \\"clusterName\\": \\"zjk_vpc_domain_1\\",\\n \\"publicIp\\": \\"47.98.215.58\\",\\n \\"privateIp\\": \\"172.21.172.7\\",\\n \\"agentConfigId\\": \\"test_id\\",\\n \\"agentConfigName\\": \\"test_name\\"\\n }\\n ],\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"c2f78a783f49457caba6bace6f6f79e4\\"\\n}","type":"json"}]', ], - 'UpdateEventsAttention' => [ - 'summary' => '异常项关注度更新', - 'path' => '/api/v1/openapi/proxy/post/cluster_update_events_attention', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'InvokeDiagnosis' => [ + 'summary' => 'Initiate Diagnosis.', + 'path' => '/api/v1/openapi/diagnosis/invoke_diagnosis', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', + 'operationType' => 'create', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '256747', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinuxV02H6G'], ], 'parameters' => [ [ @@ -6456,1675 +4686,1582 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request body parameters', 'type' => 'object', 'properties' => [ - 'uuid' => [ - 'description' => '', + 'service_name' => [ + 'title' => '', + 'description' => 'Diagnosis type, used to distinguish different types of diagnoses.', + 'enumValueTitles' => [ + 'iofsstat' => 'IO Traffic Analysis', 'iodiagnose' => 'IO One-Click Diagnosis', 'oomcheck' => 'OOM Diagnosis', 'diskanalysis' => 'Disk Analysis Diagnosis', 'javamem' => 'Java Memory Diagnosis', 'iolatency' => 'IO Latency Analysis', 'netjitter' => 'Network Jitter Diagnosis', 'loadtask' => 'System Load Diagnosis', 'vmcore' => 'Crash Diagnosis', 'packetdrop' => 'Network Packet Loss Diagnosis', + 'memgraph' => 'Memory Overview Diagnosis', + ], 'type' => 'string', 'required' => true, - 'example' => '03de78af-f49f-433d-b5b1-0f6a70c493ba', + 'docRequired' => true, + 'example' => 'memgraph', ], - 'range' => [ - 'description' => '', + 'channel' => [ + 'title' => '', + 'description' => 'Diagnosis channel (currently fixed as the ECS channel).', + 'enumValueTitles' => ['ecs' => 'ECS Channel'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cluster' => 'cluster', - 'uid' => 'uid', - 'instance' => 'instance', - ], - 'example' => 'cluster', - ], - 'mode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '0', - '1', - '2', - '3', - -1 => '-1', - ], - 'example' => '0', - ], + 'required' => true, + 'example' => 'ecs', + ], + 'params' => ['description' => 'Diagnosis parameters. Different types of diagnoses require different diagnosis parameters. For the parameters required by each diagnosis type, refer to the supplementary request parameter description below.'."\n" + ."\n" + .'><notice>Please pass a JSON-formatted string.</notice>', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "instance": "i-wz9gdv7qmdhusamc4dl01",'."\n" + .' "uid": "xxxxxxxxxxxxxx",'."\n" + .' "region": "cn-shenzhen"'."\n" + .'}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'Instance not belong to current user', - ], + 'code' => ['description' => 'Status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. When authorization fails, check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response result.', 'type' => 'object', 'properties' => [ - 'mode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'task_id' => ['description' => 'Diagnosis task ID. You can use this ID to call the `GetDiagnosisResult` API to query the diagnosis result.', 'type' => 'string', 'example' => 'ihqhAcrt', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '44841312-7227-55C9-AE03-D59729BFAE38', - ], + 'request_id' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '43A910E9-A739-525E-855D-A32C257F1826', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Initiate Diagnosis', + 'description' => 'The following requirements must be met to diagnose a target ECS instance:'."\n" + .'- The target ECS instance must be in the Running state.'."\n" + .'- The Cloud Assistant must be installed on the target ECS instance. If it is not installed, refer to [Install the Cloud Assistant Agent](https://help.aliyun.com/zh/ecs/user-guide/install-the-cloud-assistant-agent) for installation.'."\n" + .'- You must call the AuthDiagnosis API to authorize SysOM to diagnose the target ECS instance. If authorization is not granted, this API will fail directly.'."\n" + .'- This API requires that the SysOM service-linked role (AliyunServiceRoleForSysom) has been created. This API does not automatically create the service role. If the service role does not exist, you must first call AuthDiagnosis for authorization, which will create the aforementioned service role.', + 'requestParamsDescription' => '## Diagnosis Parameter Description'."\n" + ."\n" + .'### Memory Overview Diagnosis (memgraph) Parameters'."\n" + .'The memgraph (Memory Panorama Analysis) tool is applicable to scenarios where memory usage is high but the specific memory consumption cannot be clearly identified. By using the Memory Panorama Analysis diagnosis feature, you can scan the current system memory usage status, break down memory usage in detail, analyze the distribution of system memory and application memory, and list the top 30 application memory usage, file cache, and shared memory cache usage rankings.'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + .'| pod | string | Pod name | No | | Pod name |'."\n" + ."\n\n" + .'### Java Memory Diagnosis (javamem) Parameters'."\n" + .'The javamem (Java Memory Diagnosis) tool is mainly used to diagnose the memory usage of Java applications, helping users understand the distribution and composition of Java heap memory and non-heap memory, identify potential memory leaks and memory overflow issues, and achieve maintainable, measurable, and traceable Java memory management.'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ---------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + .'| Pid | string | Java process PID | No | | Java process PID. At least one of pid or pod must be provided. |'."\n" + .'| pod | string | Pod name | No | | Pod name. At least one of pid or pod must be provided. |'."\n" + .'| duration | string | JNI memory allocation profiling duration | No | | JNI memory allocation profiling duration. To perform JNI diagnosis, a non-zero value must be provided; otherwise, JNI diagnosis is not performed by default. |'."\n" + ."\n" + .'### OOM Diagnosis (oomcheck) Parameters'."\n" + ."\n" + .'The oomcheck (OOM Diagnosis) tool is mainly used to analyze and identify OOM (Out of Memory) issues, find the main causes of OOM, and provide corresponding handling suggestions to help users resolve OOM issues and improve system availability and performance.'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + .'| pod | string | Pod name | No | | Pod name |'."\n" + .'| time | string | Diagnosis time | No | | Enter the time point for OOM diagnosis. Defaults to the most recent occurrence. |'."\n" + ."\n" + .'### System Load Diagnosis (loadtask) Parameters'."\n" + ."\n" + .'The loadtask (System Load Diagnosis) tool mainly analyzes the root causes of abnormal one-minute average load (load1 metric) and provides detailed machine information.'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + ."\n" + .'### Scheduling Jitter Diagnosis (delay) Parameters'."\n" + .'The delay (Scheduling Jitter Diagnosis) tool mainly analyzes issues caused by CPUs not performing task switches for extended periods, resulting in user-space business processes not being scheduled for a long time (e.g., memory reclamation scenarios).'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| --------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + .'| duration | string | Diagnosis duration | No | 20 | Diagnosis duration in seconds (optional). Defaults to 20 seconds. |'."\n" + .'| threshold | string | Diagnosis threshold | No | 20 | Latency threshold. Delays exceeding this threshold will be recorded. Defaults to 20ms. |'."\n" + ."\n\n" + ."\n" + .'### IO Traffic Analysis Diagnosis (iofsstat) Parameters'."\n" + ."\n" + .'The iofsstat (IO Traffic Analysis) tool mainly analyzes the attribution of IO traffic in the system. The results include IO traffic statistics for each disk/partition and IO traffic statistics for each process.'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------------ |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. IO traffic statistics will be collected on this machine. |'."\n" + .'| timeout | string | Diagnosis duration | No | 15 | Diagnosis duration, also the IO traffic statistics period, in seconds. Recommended not to exceed 60 seconds. |'."\n" + .'| disk | string | Target disk | No | "" | Enter the disk you want to diagnose, e.g., vda or sda. Defaults to all disks. |'."\n" + ."\n" + .'### IO One-Click Diagnosis (iodiagnose) Parameters'."\n" + .'The iodiagnose (IO One-Click Diagnosis) tool focuses on frequently occurring issues such as high IO latency, IO burst, and IO wait. It supports identification of various IO issue types and calls corresponding sub-tools to analyze IO data, thereby providing conclusions and recommendations.'."\n" + ."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| --------- | -------- | -------- | -------- | ------ | ------------------------------------------------------------ |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. IO hang diagnosis will be initiated on this machine. |'."\n" + .'| timeout | string | Diagnosis duration | No | 30 | Diagnosis duration (optional). Defaults to 30 seconds. Not recommended to be less than 30 seconds. Unit: seconds. |'."\n" + ."\n\n" + .'### Network Packet Loss Diagnosis (packetdrop) Parameters'."\n" + .'The packetdrop (Network Packet Loss Diagnosis) tool mainly analyzes packet loss issues that occur at the operating system kernel level due to various reasons during network transmission.'."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + ."\n\n" + .'### Network Jitter Diagnosis (netjitter) Parameters'."\n" + .'The netjitter (Network Jitter Diagnosis) tool mainly analyzes instability at the operating system kernel level caused by various factors during network data transmission.'."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + .'| duration | string | Diagnosis duration | No | 20 | Diagnosis duration in seconds (optional). Defaults to 20 seconds. |'."\n" + .'| threshold | string | Jitter detection threshold | No | 10 | Threshold for determining jitter occurrence in milliseconds (optional). Defaults to 10ms. |'."\n" + ."\n" + .'### Crash Diagnosis (vmcore) Parameters'."\n" + .'The vmcore (Crash Diagnosis) tool mainly analyzes the causes of operating system crashes by examining the core dump files generated by kernel panics, combined with dmesg logs, to determine the root cause of the crash.'."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |'."\n" + ."\n" + .'### Disk Analysis Diagnosis (diskanalysis) Parameters'."\n" + .'The diskanalysis (Disk Analysis Diagnosis) tool mainly analyzes the disk usage in the system.'."\n" + .'| Parameter | Type | Description | Required | Default | Remarks |'."\n" + .'| -------- | -------- | -------- | -------- | ------ | ------------------------------------------------------- |'."\n" + .'| uid | string | User UID | Yes | | User UID |'."\n" + .'| region | string | Instance region | Yes | | Instance region |'."\n" + .'| instance | string | Instance ID | Yes | | Enter the instance ID you want to diagnose. The diagnosis will be initiated on this machine. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InvokeDiagnosis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'Diagnosis', 'arn' => 'acs:sysom::{#accountId}:diagnosis/*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"Instance not belong to current user\\",\\n \\"data\\": {\\n \\"mode\\": 1\\n },\\n \\"RequestId\\": \\"44841312-7227-55C9-AE03-D59729BFAE38\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": {\\n \\"task_id\\": \\"ihqhAcrt\\"\\n },\\n \\"request_id\\": \\"43A910E9-A739-525E-855D-A32C257F1826\\"\\n}","type":"json"}]', ], 'ListAbnormalyEvents' => [ - 'summary' => '获取一定时间段内的异常事件', + 'summary' => 'Retrieves anomaly event information for a cluster, node, or pod within a specified time range.', 'path' => '/api/v1/openapi/cluster_health/range/abnormaly_events', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ 'name' => 'cluster', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2d33d4be-bf54-4070-82ca-c1dc2d8b1562', 'title' => ''], ], [ 'name' => 'instance', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], ], [ 'name' => 'start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1725797727754', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1725797727754', 'title' => ''], ], [ 'name' => 'pod', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-pod', - ], + 'schema' => ['description' => 'The pod name.', 'type' => 'string', 'required' => false, 'example' => 'test-pod', 'title' => ''], ], [ 'name' => 'namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The namespace of the pod.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ 'name' => 'end', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1725801327754', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1725801327754', 'title' => ''], ], [ 'name' => 'level', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The level of the anomaly event.', + 'enumValueTitles' => ['warning' => 'warning', 'error' => 'error', 'potential' => 'potential'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'warning' => 'warning', - 'error' => 'error', - ], 'example' => 'potential', + 'title' => '', ], ], [ 'name' => 'showPod', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Specifies whether to display pod anomaly events.', + 'enumValueTitles' => ['0'], 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'enumValueTitles' => [ - '0', - ], 'example' => '1', + 'title' => '', ], ], [ 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The current page number. This parameter is present during paginated queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 5. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'event', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the anomaly event.', 'type' => 'string', 'required' => false, 'example' => '节点根文件系统使用检测', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => "\n", - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization was successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error code description. This value is empty if no error occurred.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'end_at' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'item' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'instance' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'end_at' => ['description' => 'The end time of the anomaly event.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725797727754', 'title' => ''], + 'item' => ['description' => 'The name of the anomaly item.', 'type' => 'string', 'example' => '节点CPU使用率检测', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], 'opts' => [ - 'description' => '', + 'description' => 'The list of operations for the anomaly item.', 'type' => 'array', - 'properties' => [ - 'label' => [ - 'name' => 'label', - 'description' => '', - 'type' => 'string', - 'example' => 'diagnose', - 'backendName' => 'label', - ], - 'type' => [ - 'name' => 'type', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'result' => 'result', - 'realtime' => 'realtime', - 'history' => 'history', - ], - 'example' => 'realtime', - 'backendName' => 'type', - ], - 'params' => [ - 'name' => 'params', - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"service_name\\": \\"oomcheck\\", \\"params\\": {\\"auto_initial\\": true, \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6i\\", \\"region\\": \\"cn-shenzhen\\", \\"uuid\\": \\"24576d0c-a19d-49dd-8a64-3867440fd7a6\\", \\"is_history\\": 1}}"', - 'backendName' => 'params', - ], - ], 'items' => [ + 'description' => 'The operation entry for the anomaly item.', 'type' => 'object', 'properties' => [ 'result' => [ + 'description' => 'The diagnostic result of the anomaly item.', 'type' => 'object', 'properties' => [ - 'url' => [ - 'type' => 'string', - ], - 'status' => [ - 'type' => 'string', - ], + 'url' => ['description' => 'The URL of the diagnostic details.', 'type' => 'string', 'example' => '/diagnose/result/PhfFg456', 'title' => ''], + 'status' => ['description' => 'The diagnostic status.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'label' => [ - 'type' => 'string', - ], - 'type' => [ - 'type' => 'string', - ], + 'label' => ['description' => 'The operation type.', 'type' => 'string', 'example' => 'diagnose', 'title' => ''], + 'type' => ['description' => 'The diagnostic type.', 'type' => 'string', 'example' => 'auto', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'level' => [ + 'description' => 'The level of the anomaly item.', + 'enumValueTitles' => ['warning' => 'warning', 'error' => 'error', 'potential' => 'potential'], 'type' => 'string', + 'example' => 'potential', + 'title' => '', ], - 'region_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'created_at' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1725801090000', - ], + 'region_id' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'description' => ['description' => 'The detailed description of the anomaly item.', 'type' => 'string', 'example' => '节点发生OOM, 可查看OOM发生原因', 'title' => ''], + 'created_at' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725801090000', 'title' => ''], 'type' => [ - 'description' => '', + 'description' => 'The type of the anomaly item.', + 'enumValueTitles' => ['saturation' => 'saturation', 'load' => 'load', 'latency' => 'latency', 'error' => 'error'], 'type' => 'string', - 'enumValueTitles' => [ - 'saturation' => 'saturation', - 'load' => 'load', - 'latency' => 'latency', - 'error' => 'error', - ], 'example' => 'saturation', + 'title' => '', ], 'diag_status' => [ + 'description' => 'The diagnostic status. Valid values:'."\n" + .'- 1: diagnosis ready.'."\n" + .'- 2: diagnosis in progress.'."\n" + .'- 3: diagnosis completed.'."\n" + .'- 4: not diagnosable.'."\n" + .'- 5: diagnosis failed.', + 'enumValueTitles' => ['不可诊断' => '4', '诊断完成' => '3', '诊断失败' => '5', '诊断运行中' => '2', '诊断已就绪' => '1'], 'type' => 'integer', 'format' => 'int32', + 'example' => '3', + 'title' => '', ], - 'uuid' => [ - 'type' => 'string', - ], - 'pod' => [ - 'type' => 'string', - ], - 'namespace' => [ - 'type' => 'string', - ], + 'uuid' => ['description' => 'The UUID of the anomaly event.', 'type' => 'string', 'example' => '43f05b46-1034-42e8-a528-6e5ca1108277', 'title' => ''], + 'pod' => ['description' => 'The pod name.', 'type' => 'string', 'example' => 'test-pod', 'title' => ''], + 'namespace' => ['description' => 'The namespace of the pod.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'raw_metrics' => [ + 'description' => 'The raw metrics.', 'type' => 'object', 'properties' => [ 'metrics' => [ + 'description' => 'The list of metric values.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'start_time' => [ - 'type' => 'number', - 'format' => 'float', - ], - 'end_time' => [ - 'type' => 'number', - 'format' => 'float', + 'items' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'sys_cpu_total', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'start_time' => ['description' => 'The start time.', 'type' => 'number', 'format' => 'float', 'example' => '1761814928', 'title' => ''], + 'end_time' => ['description' => 'The end time.', 'type' => 'number', 'format' => 'float', 'example' => '1761814928', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'total' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"Success\\",\\n \\"data\\": [\\n {\\n \\"end_at\\": 1725797727754,\\n \\"item\\": \\"节点CPU使用率检测\\",\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"opts\\": [\\n {\\n \\"result\\": {\\n \\"url\\": \\"/diagnose/result/PhfFg456\\",\\n \\"status\\": \\"success\\"\\n },\\n \\"label\\": \\"diagnose\\",\\n \\"type\\": \\"auto\\"\\n }\\n ],\\n \\"level\\": \\"potential\\",\\n \\"region_id\\": \\"cn-shanghai\\",\\n \\"description\\": \\"节点发生OOM, 可查看OOM发生原因\\",\\n \\"created_at\\": 1725801090000,\\n \\"type\\": \\"saturation\\",\\n \\"diag_status\\": 3,\\n \\"uuid\\": \\"43f05b46-1034-42e8-a528-6e5ca1108277\\",\\n \\"pod\\": \\"test-pod\\",\\n \\"namespace\\": \\"default\\",\\n \\"raw_metrics\\": {\\n \\"metrics\\": [\\n \\"sys_cpu_total\\"\\n ],\\n \\"start_time\\": 1761814928,\\n \\"end_time\\": 1761814928\\n }\\n }\\n ],\\n \\"total\\": 4\\n}","type":"json"}]', + 'title' => 'Retrieve anomaly event details', + 'changeSet' => [ + ['createdAt' => '2025-09-19T08:38:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-08-03T12:17:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-24T02:34:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-12T11:06:37.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\n\\",\\n \\"data\\": [\\n {\\n \\"end_at\\": 1725797727754,\\n \\"item\\": \\"节点CPU使用率检测\\",\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"opts\\": [\\n {\\n \\"result\\": {\\n \\"url\\": \\"/diagnose/result/PhfFg456\\",\\n \\"status\\": \\"success\\"\\n },\\n \\"label\\": \\"diagnose\\",\\n \\"type\\": \\"auto\\"\\n }\\n ],\\n \\"level\\": \\"potential\\",\\n \\"region_id\\": \\"cn-shanghai\\",\\n \\"description\\": \\"节点发生OOM, 可查看OOM发生原因\\",\\n \\"created_at\\": 1725801090000,\\n \\"type\\": \\"saturation\\",\\n \\"diag_status\\": 3,\\n \\"uuid\\": \\"43f05b46-1034-42e8-a528-6e5ca1108277\\",\\n \\"pod\\": \\"test-pod\\",\\n \\"namespace\\": \\"default\\",\\n \\"raw_metrics\\": {\\n \\"metrics\\": [\\n \\"\\"\\n ],\\n \\"start_time\\": 0,\\n \\"end_time\\": 0\\n }\\n }\\n ],\\n \\"total\\": 4\\n}","type":"json"}]', - ], - 'ListInstanceHealth' => [ - 'summary' => '获取一定时间内集群节点/Pod健康度列表', - 'path' => '/api/v1/openapi/cluster_health/range/instance_health_list', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAbnormalyEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAgentInstallRecords' => [ + 'summary' => 'Lists the installation records of an Agent.', + 'path' => '/api/v1/am/agent/list_agent_install_list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'cluster', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], + 'schema' => ['title' => '', 'description' => 'The current page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'instance', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], [ - 'name' => 'start', + 'name' => 'instance_id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725797727754', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the instance. If you specify this parameter, only the Agent installation records for the specified instance are returned.', 'type' => 'string', 'required' => false, 'example' => 'i-bp118piqcio9tiwgh84b'], ], [ - 'name' => 'end', + 'name' => 'plugin_id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725801327754', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the Agent. If you specify this parameter, only the installation records for the specified Agent are returned. You can use this parameter together with the plugin_version parameter.', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9'], ], [ - 'name' => 'current', + 'name' => 'plugin_version', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The version of the Agent. This parameter cannot be used alone. Use this parameter together with the plugin_id parameter to filter installation records for a specific version of the specified Agent.', 'type' => 'string', 'required' => false, 'example' => '3.4.0-1'], ], [ - 'name' => 'pageSize', + 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Filters component installation records by status.', 'type' => 'string', 'required' => false, 'example' => 'Installed', 'title' => ''], + ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Query no data', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization has failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error message for the request.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', - 'properties' => [ - 'score' => [ - 'name' => 'score', - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - 'backendName' => 'score', - ], - 'instance' => [ - 'name' => 'instance', - 'description' => '', - 'type' => 'string', - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - 'backendName' => 'instance', - ], - 'region_id' => [ - 'name' => 'region_id', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'status' => [ - 'name' => 'status', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'Running' => '', - 'Offline' => '', - ], - 'example' => 'Running', - ], - 'pod' => [ - 'name' => 'pod', - 'description' => '', - 'type' => 'string', - 'example' => 'test-pod', - ], - 'namespace' => [ - 'name' => 'namespace', - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'images' => [ - 'name' => 'images', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'nginx:1.14.1-8.6', - 'extendType' => 'true', - ], - 'itemName' => '', - ], - ], 'items' => [ + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'score' => [ - 'type' => 'number', - 'format' => 'float', - ], - 'instance' => [ - 'type' => 'string', - ], - 'region_id' => [ - 'type' => 'string', - ], - 'status' => [ - 'type' => 'string', - ], - 'pod' => [ - 'type' => 'string', - ], - 'namespace' => [ - 'type' => 'string', - ], - 'images' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'instance_id' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-bp118piqcio9tiwgh84b'], + 'plugin_id' => ['title' => '', 'description' => 'The component ID.', 'type' => 'string', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9'], + 'plugin_version' => ['title' => '', 'description' => 'The plug-in version.', 'type' => 'string', 'example' => '3.4.0-1'], + 'status' => ['title' => '', 'description' => 'The component status.', 'type' => 'string', 'example' => 'Installed'], + 'created_at' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-27T16:37:53', 'title' => ''], + 'updated_at' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-11-27T16:37:53', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '42', - ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', - ], + 'RequestId' => ['description' => 'The request ID, which is active for end-to-end diagnostics.', 'type' => 'string', 'example' => 'E8CDFBA1-0564-5897-B070-D3C85002AF2F', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"Query no data\\",\\n \\"data\\": [\\n {\\n \\"score\\": 100,\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"region_id\\": \\"cn-shanghai\\",\\n \\"status\\": \\"Running\\",\\n \\"pod\\": \\"test-pod\\",\\n \\"namespace\\": \\"default\\",\\n \\"images\\": [\\n \\"alinux3:latest\\"\\n ]\\n }\\n ],\\n \\"total\\": 42,\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', - ], - 'InvokeAnomalyDiagnosis' => [ - 'summary' => '异常项诊断跳转', - 'path' => '/api/v1/openapi/cluster_health/diagnosis/invoke_anomaly_diagnose', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - ], - 'parameters' => [ - [ - 'name' => 'uuid', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8047d763-5465-4a8c-b1cd-23f5a8ba2594', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'requestId' => [ - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"total\\": 64,\\n \\"data\\": [\\n {\\n \\"instance_id\\": \\"i-bp118piqcio9tiwgh84b\\",\\n \\"plugin_id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"plugin_version\\": \\"3.4.0-1\\",\\n \\"status\\": \\"Installed\\",\\n \\"created_at\\": \\"2024-11-27T16:37:53\\",\\n \\"updated_at\\": \\"2024-11-27T16:37:53\\"\\n }\\n ],\\n \\"RequestId\\": \\"E8CDFBA1-0564-5897-B070-D3C85002AF2F\\"\\n}","type":"json"}]', + 'title' => 'List component installation records', + 'changeSet' => [ + ['createdAt' => '2025-06-30T14:50:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAgentInstallRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\"\\n}","type":"json"}]', ], - 'GetRangeScore' => [ - 'summary' => '获取健康分趋势', - 'path' => '/api/v1/openapi/cluster_health/range/score', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAgents' => [ + 'summary' => 'Retrieves a list of agents.', + 'path' => '/api/v1/am/agent/list_agents', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'cluster', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], + 'schema' => ['title' => '', 'description' => 'The current page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'instance', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'start', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725797727754', - ], + 'schema' => ['title' => '', 'description' => 'Filters plug-ins by plug-in name.', 'type' => 'string', 'required' => false, 'example' => 'SysOM'], ], [ - 'name' => 'end', + 'name' => 'type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725801327754', - ], + 'schema' => ['title' => '', 'description' => 'The agent type used to filter the list. For example, set this parameter to control to retrieve all agents of the control type.', 'type' => 'string', 'required' => false, 'example' => 'control'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'title' => '资源一级ID', - 'description' => '代表资源一级ID的资源属性字段', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - 'pattern' => '^[a-zA-Z._-]+$', - 'default' => '', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- If code is Success, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the message field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If code is Success, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '66EAED72-542B-583B-BCED-64433DC27AD7', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '总分' => 'total', - '饱和度' => 'saturation', - '错误' => 'error', - '延时' => 'latency', - '负载' => 'load', + 'name' => ['description' => 'The component name.', 'type' => 'string', 'example' => 'SysOM Agent', 'title' => ''], + 'support_arch' => ['description' => 'The supported architectures. Multiple architectures are separated by commas.', 'type' => 'string', 'example' => 'x86', 'title' => ''], + 'type' => ['description' => 'The type of the component. Valid values:'."\n" + .'- Control: control-type component.'."\n" + .'- AI: AI component.', 'type' => 'string', 'example' => 'Control', 'title' => ''], + 'description' => ['description' => 'The component description.', 'type' => 'string', 'example' => 'SysOM Agent', 'title' => ''], + 'id' => ['description' => 'The component ID.', 'type' => 'string', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'versions' => [ + 'description' => 'The list of component versions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The component version information.', + 'type' => 'object', + 'properties' => [ + 'version' => ['description' => 'The component version number.', 'type' => 'string', 'example' => '3.4.0-1', 'title' => ''], + 'install_script' => ['description' => 'The installation script of the component.', 'type' => 'string', 'example' => 'sysom.sh install', 'title' => ''], + 'uninstall_script' => ['description' => 'The uninstallation script of the component.', 'type' => 'string', 'example' => 'sysom.sh uninstall', 'title' => ''], + 'upgrade_script' => ['description' => 'The update script of the component.', 'type' => 'string', 'example' => 'sysom.sh upgrade', 'title' => ''], + 'created_at' => ['description' => 'The time when the component version was created.', 'type' => 'string', 'example' => '2024-09-14T20:46:08', 'title' => ''], + 'updated_at' => ['description' => 'The time when the component version was last updated.', 'type' => 'string', 'example' => '2024-09-14T20:46:08', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'saturation', - ], - 'value' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'time' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1725797727754', + 'title' => '', + 'example' => '', ], + 'created_at' => ['description' => 'The time when the component was created.', 'type' => 'string', 'example' => '2024-09-14T20:46:08', 'title' => ''], + 'updated_at' => ['description' => 'The time when the component was last updated.', 'type' => 'string', 'example' => '2024-09-14T20:46:08', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'total' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"RequestId\\": \\"66EAED72-542B-583B-BCED-64433DC27AD7\\",\\n \\"total\\": 2,\\n \\"data\\": [\\n {\\n \\"name\\": \\"SysOM Agent\\",\\n \\"support_arch\\": \\"x86\\",\\n \\"type\\": \\"Control\\",\\n \\"description\\": \\"SysOM Agent\\",\\n \\"id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"versions\\": [\\n {\\n \\"version\\": \\"3.4.0-1\\",\\n \\"install_script\\": \\"sysom.sh install\\",\\n \\"uninstall_script\\": \\"sysom.sh uninstall\\",\\n \\"upgrade_script\\": \\"sysom.sh upgrade\\",\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n }\\n ],\\n \\"created_at\\": \\"2024-09-14T20:46:08\\",\\n \\"updated_at\\": \\"2024-09-14T20:46:08\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve component list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAgents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"saturation\\",\\n \\"value\\": 100,\\n \\"time\\": 1725797727754\\n }\\n ],\\n \\"total\\": 2,\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', ], - 'GetProblemPercentage' => [ - 'summary' => '获取一定时间内集群中节点/节点中pod异常问题占比', - 'path' => '/api/v1/openapi/cluster_health/range/problem_percentage', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAlertDestinations' => [ + 'summary' => 'This API is used to get the list of alert contacts', + 'path' => '/api/v1/alertPusher/alert/listDestinations', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], ], 'parameters' => [ [ - 'name' => 'cluster', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], + 'schema' => ['description' => 'Alert contact name', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], ], [ - 'name' => 'instance', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'schema' => ['description' => 'Maximum number of records to retrieve at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'start', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725797727754', - ], + 'schema' => ['description' => 'Pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => 'c2f78a783f49457caba6bace6f6f79e4', 'title' => ''], ], [ - 'name' => 'end', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725801327754', - ], + 'schema' => ['description' => 'Current page number (starting from 1)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '饱和度' => 'saturation', - '错误' => 'error', - '延时' => 'latency', - '负载' => 'load', - ], - 'example' => 'saturation', - ], - 'value' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - ], - 'total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', - ], + 'requestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'Status code'."\n" + .'- `code == Success` indicates that the authorization was successful;'."\n" + .'- Other status codes indicate authorization failure. When authorization fails, check the `message` field for detailed error information;', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message'."\n" + .'- If `code == Success`, this field is empty;'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'server error', 'title' => ''], + 'data' => ['description' => 'Response data.', 'type' => 'any', 'example' => '{}', 'title' => ''], + 'nextToken' => ['description' => 'Pagination token for the next request.', 'type' => 'string', 'example' => 'c2f78a783f49457caba6bace6f6f79e4', 'title' => ''], + 'maxResults' => ['description' => 'Maximum number of records to retrieve at a time.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'total' => ['description' => 'Maximum number of records returned by this request', 'type' => 'integer', 'format' => 'int32', 'example' => '623', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', 'description' => 'Server error, please correct the code according to the error message'], + ['errorCode' => 'SysomOpenAPI.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message.', 'description' => 'Server error, please correct the code according to the error message'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"saturation\\",\\n \\"value\\": 5\\n }\\n ],\\n \\"total\\": 19,\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', - ], - 'GetInstantScore' => [ - 'summary' => '获取实时集群/节点健康度分数', - 'path' => '/api/v1/openapi/cluster_health/instant/score', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Alert Contact List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAlertDestinations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"server error\\",\\n \\"data\\": \\"{}\\",\\n \\"nextToken\\": \\"c2f78a783f49457caba6bace6f6f79e4\\",\\n \\"maxResults\\": 10,\\n \\"total\\": 623\\n}","type":"json"}]', + ], + 'ListAlertItems' => [ + 'summary' => 'Retrieves all alert metrics.', + 'path' => '/api/v1/alertPusher/alert/listItems', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '{'."\n" + .' "NODE": {'."\n" + .' "饱和度": ['."\n" + .' "节点CPU使用率检测",'."\n" + .' "节点内核态CPU使用检测",'."\n" + .' "节点软中断CPU使用检测",'."\n" + .' "节点内存使用检测",'."\n" + .' "节点内核内存使用检测",'."\n" + .' "节点文件描述符使用检测",'."\n" + .' "节点根文件系统使用检测",'."\n" + .' "节点cgroup泄漏检测",'."\n" + .' "节点Sockets使用检测",'."\n" + .' "节点TCP内存使用检测"'."\n" + .' ],'."\n" + .' "延时": ['."\n" + .' "节点调度延时检测",'."\n" + .' "节点网络延时检测",'."\n" + .' "节点磁盘写入延迟检测",'."\n" + .' "节点磁盘读取延迟检测"'."\n" + .' ],'."\n" + .' "负载": ['."\n" + .' "节点磁盘IO流量检测",'."\n" + .' "节点load average检测"'."\n" + .' ],'."\n" + .' "错误": ['."\n" + .' "节点网络丢包检测",'."\n" + .' "节点OOM夯机预测及检测"'."\n" + .' ]'."\n" + .' },'."\n" + .' "POD": {'."\n" + .' "饱和度": ['."\n" + .' "Pod内存使用检测",'."\n" + .' "Pod CPU使用率检测"'."\n" + .' ],'."\n" + .' "错误": ['."\n" + .' "Pod CPU限流检测",'."\n" + .' "Pod OOM事件检测"'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"{\\\\n \\\\\\"NODE\\\\\\": {\\\\n \\\\\\"饱和度\\\\\\": [\\\\n \\\\\\"节点CPU使用率检测\\\\\\",\\\\n \\\\\\"节点内核态CPU使用检测\\\\\\",\\\\n \\\\\\"节点软中断CPU使用检测\\\\\\",\\\\n \\\\\\"节点内存使用检测\\\\\\",\\\\n \\\\\\"节点内核内存使用检测\\\\\\",\\\\n \\\\\\"节点文件描述符使用检测\\\\\\",\\\\n \\\\\\"节点根文件系统使用检测\\\\\\",\\\\n \\\\\\"节点cgroup泄漏检测\\\\\\",\\\\n \\\\\\"节点Sockets使用检测\\\\\\",\\\\n \\\\\\"节点TCP内存使用检测\\\\\\"\\\\n ],\\\\n \\\\\\"延时\\\\\\": [\\\\n \\\\\\"节点调度延时检测\\\\\\",\\\\n \\\\\\"节点网络延时检测\\\\\\",\\\\n \\\\\\"节点磁盘写入延迟检测\\\\\\",\\\\n \\\\\\"节点磁盘读取延迟检测\\\\\\"\\\\n ],\\\\n \\\\\\"负载\\\\\\": [\\\\n \\\\\\"节点磁盘IO流量检测\\\\\\",\\\\n \\\\\\"节点load average检测\\\\\\"\\\\n ],\\\\n \\\\\\"错误\\\\\\": [\\\\n \\\\\\"节点网络丢包检测\\\\\\",\\\\n \\\\\\"节点OOM夯机预测及检测\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"POD\\\\\\": {\\\\n \\\\\\"饱和度\\\\\\": [\\\\n \\\\\\"Pod内存使用检测\\\\\\",\\\\n \\\\\\"Pod CPU使用率检测\\\\\\"\\\\n ],\\\\n \\\\\\"错误\\\\\\": [\\\\n \\\\\\"Pod CPU限流检测\\\\\\",\\\\n \\\\\\"Pod OOM事件检测\\\\\\"\\\\n ]\\\\n }\\\\n}\\"\\n}","type":"json"}]', + 'title' => 'Retrieve alert metric list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:ListAlertItems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'produces' => [ - 'application/json', + ], + 'ListAlertStrategies' => [ + 'path' => '/api/v1/alertPusher/alert/listStrategies', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '230346', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'cluster', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], + 'schema' => ['description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'instance', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => 'c2f78a783f49457caba6bace6f6f79e4', 'title' => ''], + ], + [ + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The current page number (starting from 1).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The policy name of the alerting policy.', 'type' => 'string', 'required' => false, 'example' => 'strategy1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'title' => '资源一级ID', - 'description' => '集群ID', - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - 'pattern' => '^[a-zA-Z._-]+$', - 'default' => '', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Query no data', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization has failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error information for the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'saturation' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'latency' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'load' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'error' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'total' => [ - 'type' => 'number', - 'format' => 'float', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of alert policies.', + 'type' => 'object', + 'properties' => [ + 'uid' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '1880327028143673', 'title' => ''], + 'createdAt' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1753669116286', 'title' => ''], + 'name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'strategy1', 'title' => ''], + 'id' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'strategy' => [ + 'description' => 'The alert policy details.', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '接收告警的异常项列表', + 'type' => 'array', + 'items' => ['description' => '异常项名称', 'type' => 'string', 'example' => 'Pod OOM事件检测', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'clusters' => [ + 'description' => 'The collection of clusters for which alerts are received.', + 'type' => 'array', + 'items' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'cluster1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'destinations' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'enabled' => ['description' => 'Indicates whether the alert policy is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'updatedAt' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1753237017710', 'title' => ''], + 'k8sLabel' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '92', 'title' => ''], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => 'c2f78a783f49457caba6bace6f6f79e4', 'title' => ''], + 'maxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get alert policy list', + 'summary' => 'Retrieves all push alert policies for the current user.', + 'changeSet' => [ + ['createdAt' => '2025-11-03T02:34:05.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"Query no data\\",\\n \\"data\\": {\\n \\"saturation\\": 100,\\n \\"latency\\": 100,\\n \\"load\\": 100,\\n \\"error\\": 100,\\n \\"total\\": 100\\n },\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\"\\n}","type":"json"}]', - ], - 'GetHealthPercentage' => [ - 'summary' => '获取一段时间的节点/pod健康度比例', - 'path' => '/api/v1/openapi/cluster_health/range/health_percentage', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAlertStrategies', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": [\\n {\\n \\"uid\\": \\"1880327028143673\\",\\n \\"createdAt\\": \\"1753669116286\\",\\n \\"name\\": \\"strategy1\\",\\n \\"id\\": 1,\\n \\"strategy\\": {\\n \\"items\\": [\\n \\"Pod OOM事件检测\\"\\n ],\\n \\"clusters\\": [\\n \\"cluster1\\"\\n ],\\n \\"destinations\\": [\\n 0\\n ]\\n },\\n \\"enabled\\": false,\\n \\"updatedAt\\": 1753237017710,\\n \\"k8sLabel\\": false\\n }\\n ],\\n \\"total\\": 92,\\n \\"nextToken\\": \\"c2f78a783f49457caba6bace6f6f79e4\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + ], + 'ListAllInstances' => [ + 'summary' => 'This API is used to retrieve a list of managed/unmanaged instances along with their instance information.', + 'path' => '/api/v1/am/instance/listAllInstances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '230371', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'cluster', + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'instanceType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Instance type.', 'type' => 'string', + 'default' => 'all', + 'enum' => ['ecs', 'eflo', 'all'], 'required' => false, - 'example' => '1808078950770264', + 'example' => 'ecs', + 'title' => '', ], ], [ - 'name' => 'instance', + 'name' => 'managedType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Management type.', 'type' => 'string', + 'enum' => ['managed', 'unmanaged', 'install', 'uninstall', 'upgrade', 'all'], 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', + 'example' => 'managed', + 'title' => '', ], ], [ - 'name' => 'start', + 'name' => 'filters', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725797727754', - ], + 'schema' => ['description' => 'List of filter information.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ - 'name' => 'end', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '1725801327754', - ], + 'schema' => ['description' => 'Current page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of entries returned per page. Default value: pageSize=10.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'pluginId', + 'in' => 'query', + 'schema' => ['description' => 'Plugin ID.', 'type' => 'string', 'required' => false, 'example' => '01fc4a0b-f199-4885-9861-b4054a310fe7', 'title' => ''], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'Maximum number of records to retrieve at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'Pagination token.'."\n" + .'> If this parameter is not empty, more data is available.', 'type' => 'string', 'required' => false, 'example' => 'U+w1wv2R4ZWR5oZLXD0+Dp4dD+2BRJj42DLT6GrZysw=', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError'."\n", - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'instance not exists', 'title' => ''], + 'total' => ['description' => 'Total number of query results.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Returned results.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '不健康' => 'warning', - '健康' => 'health', - '亚健康' => 'potential', - '严重不健康' => 'error', + 'instanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'i-bp17uabeke9v7n30abm2', 'title' => ''], + 'osHealthScore' => ['description' => 'Operating system health score.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'resourceGroupName' => ['description' => 'Resource group name.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'instanceName' => ['description' => 'Instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'installType' => ['description' => 'Installation type.', 'type' => 'string', 'example' => 'console', 'title' => ''], + 'instanceType' => ['description' => 'Instance type.', 'type' => 'string', 'example' => 'ecs', 'title' => ''], + 'installLevel' => ['description' => 'Installation level.', 'type' => 'string', 'example' => 'Cluster', 'title' => ''], + 'attributes' => [ + 'description' => 'Extended information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Extended information.', + 'type' => 'object', + 'properties' => [ + 'infoValue' => ['description' => 'Information value.', 'type' => 'string', 'example' => 'diagnosis', 'title' => ''], + 'infoType' => ['description' => 'Information type.', 'type' => 'string', 'example' => 'instance_tag', 'title' => ''], + 'infoKey' => ['description' => 'Information key.', 'type' => 'string', 'example' => 'sysom', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'health', - ], - 'value' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'resourceGroupId' => ['description' => 'Resource group ID.', 'type' => 'string', 'example' => '3b24a621-acb3-11ef-8c90-00163e1029af', 'title' => ''], + 'osName' => ['description' => 'Operating system name.', 'type' => 'string', 'example' => 'alios', 'title' => ''], + 'status' => ['description' => 'Running status of the instance. Valid values:'."\n" + .'- **Running**: The instance is running.'."\n" + .'- **Offline**: The instance is offline.'."\n" + ."\n\n" + ."\n" + .'> An instance in the Offline status indicates that the heartbeat from the node to the SysOM server is lost. It does not necessarily mean that the corresponding ECS instance is not running.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'clusterId' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => '3b24a621-acb3-11ef-8c90-00163e1029af', 'title' => ''], + 'osArch' => ['description' => 'Operating system architecture.', 'type' => 'string', 'example' => 'x86_64', 'title' => ''], + 'kernelVersion' => ['description' => 'Kernel version.', 'type' => 'string', 'example' => '5.10.134-18.al8.x86_64', 'title' => ''], + 'imageId' => ['description' => 'Image ID.', 'type' => 'string', 'example' => 'aliyun_3_x64_20G_alibase_20250117.vhd', 'title' => ''], + 'manageType' => ['description' => 'Management type.', 'type' => 'string', 'example' => 'managed', 'title' => ''], + 'manageLevel' => ['description' => 'Management level.', 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'clusterName' => ['description' => 'Cluster name.', 'type' => 'string', 'example' => 'zjk_vpc_domain_1', 'title' => ''], + 'publicIp' => ['description' => 'Public IP address.', 'type' => 'string', 'example' => '47.98.215.58', 'title' => ''], + 'privateIp' => ['description' => 'Private IP address.', 'type' => 'string', 'example' => '172.21.172.7', 'title' => ''], + 'agentConfigId' => ['description' => 'Agent configuration ID.', 'type' => 'string', 'example' => 'test_id', 'title' => ''], + 'agentConfigName' => ['description' => 'Agent configuration name.', 'type' => 'string', 'example' => 'test_name', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'maxResults' => ['description' => 'Maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'nextToken' => ['description' => 'Pagination token.'."\n" + ."\n" + .'> A non-empty value indicates that more data is available.', 'type' => 'string', 'example' => 'c2f78a783f49457caba6bace6f6f79e4', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"health\\",\\n \\"value\\": 1\\n }\\n ]\\n}","type":"json"}]', - ], - 'GetAbnormalEventsCount' => [ - 'summary' => '获取节点/Pod不同等级异常事件的数量', - 'path' => '/api/v1/openapi/cluster_health/range/abnormaly_events_count', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', 'description' => 'Server error, please correct the code according to the error message'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"instance not exists\\",\\n \\"total\\": 2,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"i-bp17uabeke9v7n30abm2\\",\\n \\"osHealthScore\\": 100,\\n \\"resourceGroupName\\": \\"xxxx\\",\\n \\"instanceName\\": \\"test\\",\\n \\"installType\\": \\"console\\",\\n \\"instanceType\\": \\"ecs\\",\\n \\"installLevel\\": \\"Cluster\\",\\n \\"attributes\\": [\\n {\\n \\"infoValue\\": \\"diagnosis\\",\\n \\"infoType\\": \\"instance_tag\\",\\n \\"infoKey\\": \\"sysom\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"3b24a621-acb3-11ef-8c90-00163e1029af\\",\\n \\"osName\\": \\"alios\\",\\n \\"status\\": \\"Running\\",\\n \\"clusterId\\": \\"3b24a621-acb3-11ef-8c90-00163e1029af\\",\\n \\"osArch\\": \\"x86_64\\",\\n \\"kernelVersion\\": \\"5.10.134-18.al8.x86_64\\",\\n \\"imageId\\": \\"aliyun_3_x64_20G_alibase_20250117.vhd\\",\\n \\"manageType\\": \\"managed\\",\\n \\"manageLevel\\": \\"cluster\\",\\n \\"clusterName\\": \\"zjk_vpc_domain_1\\",\\n \\"publicIp\\": \\"47.98.215.58\\",\\n \\"privateIp\\": \\"172.21.172.7\\",\\n \\"agentConfigId\\": \\"test_id\\",\\n \\"agentConfigName\\": \\"test_name\\"\\n }\\n ],\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"c2f78a783f49457caba6bace6f6f79e4\\"\\n}","type":"json"}]', + 'title' => 'Get all instances and their complete information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAllInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListClusterAgentInstallRecords' => [ + 'summary' => 'Get cluster component installation records', + 'path' => '/api/v1/am/agent/list_cluster_agent_install_list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '237718', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeCode' => '253443', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'cluster', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1808078950770264', - ], - ], - [ - 'name' => 'instance', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], + 'schema' => ['description' => 'Current page number (starting from 1)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'pod', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-pod', - ], + 'schema' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - ], - [ - 'name' => 'start', + 'name' => 'cluster_id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1725797727754', - ], + 'schema' => ['description' => 'Filter by cluster ID.'."\n" + ."\n" + .'> This cluster ID is not the ACK cluster ID, but the `cluster_id` field in the data returned by this API, or the `id` field in the data returned by the ListCluster API.', 'type' => 'string', 'required' => false, 'example' => 'cbd80af02b9d6454ebdc579c5e022d0c8', 'title' => ''], ], [ - 'name' => 'end', + 'name' => 'plugin_id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1725801327754', - ], + 'schema' => ['description' => 'Specify this parameter to filter the installation list for a specific agent. Can be used in combination with the plugin_version parameter.', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], ], [ - 'name' => 'showPod', + 'name' => 'plugin_version', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'Cannot be used alone. Use in combination with plugin_id to filter the installation list for a specific agent version.', 'type' => 'string', 'required' => false, 'example' => '3.4.0-1', 'title' => ''], ], [ - 'name' => 'level', + 'name' => 'agent_config_id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', - ], + 'code' => ['description' => 'Status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. When authorization fails, check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => "\n" + .'success', 'title' => ''], + 'total' => ['description' => 'Total number of query results.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - '"potential"' => 'potential', - '"error"' => 'error', - '"warning"' => 'warning', - ], - 'example' => 'health', - ], - 'value' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'eventList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'cluster_id' => ['description' => 'Cluster ID.'."\n" + ."\n" + .'> This cluster ID is not the ACK cluster ID.', 'type' => 'string', 'example' => 'cbf7a37bc905d4682a3338b3744810269', 'title' => ''], + 'plugin_id' => ['description' => 'Component ID.', 'type' => 'string', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'plugin_version' => ['description' => 'Plugin version.', 'type' => 'string', 'example' => '3.4.0-1', 'title' => ''], + 'created_at' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2024-12-25T15:08:19', 'title' => ''], + 'updated_at' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '2024-12-25T15:08:19', 'title' => ''], + 'grayscale_config' => ['title' => '', 'description' => 'Canary release configuration.', 'type' => 'string', 'example' => '{}'], + 'agent_config_id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'agent_config_name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\nsuccess\\",\\n \\"total\\": 42,\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"data\\": [\\n {\\n \\"cluster_id\\": \\"cbf7a37bc905d4682a3338b3744810269\\",\\n \\"plugin_id\\": \\"74a86327-3170-412c-8e67-da3389ec56a9\\",\\n \\"plugin_version\\": \\"3.4.0-1\\",\\n \\"created_at\\": \\"2024-12-25T15:08:19\\",\\n \\"updated_at\\": \\"2024-12-25T15:08:19\\",\\n \\"grayscale_config\\": \\"{}\\",\\n \\"agent_config_id\\": \\"\\",\\n \\"agent_config_name\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get ACK cluster component installation records', + 'changeSet' => [ + ['createdAt' => '2025-06-30T14:50:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-02-11T02:32:57.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListClusterAgentInstallRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": [\\n {\\n \\"type\\": \\"health\\",\\n \\"value\\": 1,\\n \\"eventList\\": [\\n \\"节点根文件系统使用检测\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'ListDiagnosis' => [ - 'summary' => '获取诊断历史记录列表', - 'path' => '/api/v1/openapi/diagnosis/list_diagnosis', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListClusters' => [ + 'summary' => 'Retrieve all managed clusters of the current user', + 'path' => '/api/v1/am/cluster/list_clusters', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeCode' => '253340', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'title' => '当前页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'Current page number (starting from page 1)', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'service_name', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'title' => '诊断类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Filter by plugin name', 'type' => 'string', 'required' => false, 'example' => 'proxy-next-upstream', 'title' => ''], ], [ - 'name' => 'params', + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => ['description' => 'Filter by cluster ID.'."\n" + ."\n" + .'> This cluster ID is not the ACK cluster ID, but the `id` field in the data returned by this API.', 'type' => 'string', 'required' => false, 'example' => 'cb7d4cc26c8f845fb8a8255ffd394820e', 'title' => ''], + ], + [ + 'name' => 'cluster_status', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => '- `Running`: The cluster is managed normally.'."\n" + .'- `Installing`: The cluster has an installation task in progress.'."\n" + .'- `Uninstalling`: The cluster has an uninstallation task in progress.'."\n" + .'- `Upgrading`: The cluster has an upgrade task in progress.'."\n" + .'- `Offline`: The cluster is offline and management is abnormal.', 'type' => 'string', + 'enum' => ['Running', 'Installing', 'Uninstalling', 'Upgrading', 'Offline'], 'required' => false, + 'example' => 'Running', + 'title' => '', ], ], [ - 'name' => 'status', + 'name' => 'cluster_type', 'in' => 'query', 'schema' => [ - 'title' => '诊断状态'."\n", - 'description' => '', + 'description' => '- `ACK`: ACK cluster.'."\n" + .'- `CUSTOM`: Custom cluster (the default cluster belongs to custom clusters).', 'type' => 'string', + 'enum' => ['ACK', 'CUSTOM'], 'required' => false, + 'example' => 'ACK', + 'title' => '', ], ], + [ + 'name' => 'id', + 'in' => 'query', + 'schema' => ['description' => 'This field is deprecated. Use the cluster_id field to filter instead.', 'type' => 'string', 'required' => false, 'example' => 'cb7d4cc26c8f845fb8a8255ffd394820e', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应数据', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'title' => '状态码'."\n", - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'code' => ['description' => 'Status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. Check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', 'title' => ''], + 'total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'Response data.', 'type' => 'array', 'items' => [ + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - ], - 'service_name' => [ - 'description' => '', - 'type' => 'string', - ], - 'command' => [ - 'description' => '', - 'type' => 'any', - ], - 'params' => [ - 'description' => '', - 'type' => 'any', - ], - 'code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - ], - 'err_msg' => [ - 'description' => '', - 'type' => 'string', - ], - 'result' => [ - 'description' => '', - 'type' => 'any', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - ], - 'created_at' => [ - 'type' => 'string', - ], - 'updated_at' => [ + 'id' => ['description' => 'Cluster ID.', 'type' => 'string', 'example' => '5389fba5-92a1-4ff4-9b26-773b97828144', 'title' => ''], + 'name' => ['description' => 'Cluster name.', 'type' => 'string', 'example' => 'auto-name-sbvCT', 'title' => ''], + 'cluster_id' => ['description' => 'Actual cluster ID.'."\n" + ."\n" + .'> - For `ACK` type clusters, this cluster ID is the ACK cluster ID.'."\n" + .'> - For `CUSTOM` type clusters, this cluster ID serves as a unique identifier with no additional meaning.', 'type' => 'string', 'example' => 'c666d4774f0e2440b979bf917bf100e40', 'title' => ''], + 'cluster_type' => [ + 'description' => '- `ACK`: ACK cluster.'."\n" + .'- `CUSTOM`: Custom cluster (the default cluster belongs to custom clusters).', 'type' => 'string', - ], + 'enum' => ['ACK', 'CUSTOM'], + 'example' => 'ACK', + 'title' => '', + ], + 'region' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'cluster_status' => ['description' => '- `Running`: The cluster is managed normally.'."\n" + .'- `Installing`: The cluster has an installation task in progress.'."\n" + .'- `Uninstalling`: The cluster has an uninstallation task in progress.'."\n" + .'- `Upgrading`: The cluster has an upgrade task in progress.'."\n" + .'- `Offline`: The cluster is offline and management is abnormal.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'created_at' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2024-12-25T15:08:19', 'title' => ''], + 'updated_at' => ['description' => 'Update time.', 'type' => 'string', 'example' => '2024-12-25T15:08:19', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'total' => [ - 'title' => '总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n {\\n \\"task_id\\": \\"grcuU21a\\",\\n \\"status\\": \\"Running\\",\\n \\"service_name\\": \\"memgraph\\",\\n \\"command\\": \\"{\\\\n \\\\\\"jobs\\\\\\":[\\\\n {\\\\n \\\\\\"cmd\\\\\\":\\\\\\"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.20.12.174\\\\\\",\\\\n \\\\\\"fetch_file_list\\\\\\":[\\\\n\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"in_order\\\\\\":true,\\\\n \\\\\\"offline_mode\\\\\\":false,\\\\n \\\\\\"offline_results\\\\\\":[\\\\n\\\\n ]\\\\n}\\",\\n \\"params\\": \\"{\\\\n \\\\\\"type\\\\\\":\\\\\\"all\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"\\\\\\",\\\\n \\\\\\"channel\\\\\\":\\\\\\"ssh\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.1.2.174\\\\\\",\\\\n \\\\\\"service_name\\\\\\":\\\\\\"filecache\\\\\\"\\\\n}\\",\\n \\"code\\": 0,\\n \\"err_msg\\": \\"Diagnosis failed\\",\\n \\"result\\": \\"{\\\\n \\\\\\"summary\\\\\\":\\\\\\" memory cgroup leak\\\\\\",\\\\n \\\\\\"dataMemEvent\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"Util\\\\\\",\\\\n \\\\\\"value\\\\\\":20\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemcgLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"NG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemFrag\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataMemOverView\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"app\\\\\\",\\\\n \\\\\\"value\\\\\\":10937332\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"free\\\\\\",\\\\n \\\\\\"value\\\\\\":806800\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"kernel\\\\\\",\\\\n \\\\\\"value\\\\\\":4527660\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataKerMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SReclaimable\\\\\\",\\\\n \\\\\\"value\\\\\\":3411292\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"VmallocUsed\\\\\\",\\\\n \\\\\\"value\\\\\\":30980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"allocPage\\\\\\",\\\\n \\\\\\"value\\\\\\":177732\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"KernelStack\\\\\\",\\\\n \\\\\\"value\\\\\\":9280\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"PageTables\\\\\\",\\\\n \\\\\\"value\\\\\\":38056\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SUnreclaim\\\\\\",\\\\n \\\\\\"value\\\\\\":170248\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"reserved\\\\\\",\\\\n \\\\\\"value\\\\\\":690072\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataUserMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"filecache\\\\\\",\\\\n \\\\\\"value\\\\\\":8010008\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"anon\\\\\\",\\\\n \\\\\\"value\\\\\\":2468608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"mlock\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge1G\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge2M\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"buffers\\\\\\",\\\\n \\\\\\"value\\\\\\":458608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"shmem\\\\\\",\\\\n \\\\\\"value\\\\\\":2284\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataCacheList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/lib/mysql/sysom/sys_handler_log.ibd\\\\\\",\\\\n \\\\\\"cached\\\\\\":576764,\\\\n \\\\\\"Task\\\\\\":\\\\\\"mysqld_78575 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-migration-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":276688,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-rtdemo-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":229404,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-monitor-server-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":197368,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-channel-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":180276,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"Name\\\\\\":\\\\\\"total cached of close file\\\\\\",\\\\n \\\\\\"cached\\\\\\":3729668,\\\\n \\\\\\"Task\\\\\\":\\\\\\"\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataProcMemList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"task\\\\\\":\\\\\\"mysqld\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":240856,\\\\n \\\\\\"RssAnon\\\\\\":218248,\\\\n \\\\\\"RssFile\\\\\\":22608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"task\\\\\\":\\\\\\"systemd-journal\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":150248,\\\\n \\\\\\"RssAnon\\\\\\":74300,\\\\n \\\\\\"RssFile\\\\\\":75944\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":144640,\\\\n \\\\\\"RssAnon\\\\\\":114200,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":141480,\\\\n \\\\\\"RssAnon\\\\\\":111040,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"task\\\\\\":\\\\\\"grafana-server\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":103660,\\\\n \\\\\\"RssAnon\\\\\\":42732,\\\\n \\\\\\"RssFile\\\\\\":60928\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97444,\\\\n \\\\\\"RssAnon\\\\\\":76256,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":6,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97260,\\\\n \\\\\\"RssAnon\\\\\\":76072,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":7,\\\\n \\\\\\"task\\\\\\":\\\\\\"prometheus\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":95356,\\\\n \\\\\\"RssAnon\\\\\\":45376,\\\\n \\\\\\"RssFile\\\\\\":49980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":8,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":90144,\\\\n \\\\\\"RssAnon\\\\\\":76456,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":9,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":89796,\\\\n \\\\\\"RssAnon\\\\\\":76108,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"url\\": \\"/diagnose/detail/qe3Z34sa\\",\\n \\"created_at\\": \\"2024-12-25T15:08:19\\",\\n \\"updated_at\\": \\"2024-12-25T15:08:19\\"\\n }\\n ],\\n \\"total\\": 319,\\n \\"RequestId\\": \\"44841312-7227-55C9-AE03-D59729BFAE38\\"\\n}","type":"json"}]', - ], - 'GetDiagnosisResult' => [ - 'summary' => '获取诊断结果', - 'path' => '/api/v1/openapi/diagnosis/get_diagnosis_results', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"total\\": 64,\\n \\"data\\": [\\n {\\n \\"id\\": \\"5389fba5-92a1-4ff4-9b26-773b97828144\\",\\n \\"name\\": \\"auto-name-sbvCT\\",\\n \\"cluster_id\\": \\"c666d4774f0e2440b979bf917bf100e40\\",\\n \\"cluster_type\\": \\"ACK\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"cluster_status\\": \\"Running\\",\\n \\"created_at\\": \\"2024-12-25T15:08:19\\",\\n \\"updated_at\\": \\"2024-12-25T15:08:19\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve the managed cluster list of the current user', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListClusters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListDiagnosis' => [ + 'summary' => 'Obtain the list of diagnostic history.', + 'path' => '/api/v1/openapi/diagnosis/list_diagnosis', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxV02H6G', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'task_id', + 'name' => 'current', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'quzuYl23', - ], + 'schema' => ['title' => '', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'service_name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Diagnostic type', 'type' => 'string', 'required' => false, 'example' => 'memgraph'], + ], + [ + 'name' => 'params', + 'in' => 'query', + 'schema' => ['description' => 'Diagnostic parameters. Different types of diagnostics require different diagnostic parameters. You can use this field to filter records whose parameters match the specified values.', 'type' => 'string', 'required' => false, 'example' => '[{\\"key\\":\\"region\\",\\"value\\":\\"cn-beijing\\"}]', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Execution status of the diagnostic task.'."\n" + .'Valid values:'."\n" + .'- **Ready**: Ready'."\n" + .'- **Running**: Running'."\n" + .'- **Success**: Execution succeeded'."\n" + .'- **Fail**: Execution failed', 'type' => 'string', 'required' => false, 'example' => 'Running'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'Response data', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'code' => ['title' => '', 'description' => 'Status code'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. When authorization fails, check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success'], + 'message' => ['title' => '', 'description' => 'Error message'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'required' => true, 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom'], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'grcuU21a', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - 'enum' => [ - 'Success', - 'Fail', - 'Ready', - 'Running', - ], - ], - 'service_name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'memgraph', - ], - 'command' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{'."\n" + 'description' => 'Returned data', + 'type' => 'array', + 'items' => [ + 'description' => 'Return object of a single analysis record', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'Task ID.', 'type' => 'string', 'example' => 'grcuU21a', 'title' => ''], + 'status' => ['description' => 'Execution status of the diagnostic task.'."\n" + .'Valid values:'."\n" + .'- **Ready**: Ready'."\n" + .'- **Running**: Running'."\n" + .'- **Success**: Execution succeeded'."\n" + .'- **Fail**: Execution failed', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'service_name' => ['description' => 'Diagnostic type', 'type' => 'string', 'example' => 'memgraph', 'title' => ''], + 'command' => ['description' => 'Diagnostic command', 'type' => 'any', 'example' => '{'."\n" .' "jobs":['."\n" .' {'."\n" .' "cmd":"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json",'."\n" @@ -8139,34 +6276,17 @@ .' "offline_results":['."\n" ."\n" .' ]'."\n" - .'}', - ], - 'params' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{'."\n" + .'}', 'title' => ''], + 'params' => ['description' => 'Diagnostic parameters', 'type' => 'any', 'example' => '{'."\n" .' "type":"all",'."\n" .' "value":"",'."\n" .' "channel":"ssh",'."\n" .' "instance":"172.1.2.174",'."\n" .' "service_name":"filecache"'."\n" - .'}', - ], - 'code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'err_msg' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Diagnosis failed', - ], - 'result' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{'."\n" + .'}', 'title' => ''], + 'code' => ['description' => 'Diagnostic error code. 0 indicates no error.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'err_msg' => ['description' => 'Error message', 'type' => 'string', 'example' => 'Diagnosis failed', 'title' => ''], + 'result' => ['description' => 'Diagnostic result', 'type' => 'any', 'example' => '{'."\n" .' "summary":" memory cgroup leak",'."\n" .' "dataMemEvent":{'."\n" .' "data":['."\n" @@ -8382,598 +6502,1159 @@ .' }'."\n" .' ]'."\n" .' }'."\n" - .'}', - ], - 'url' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/diagnose/detail/qe3Z34sa', - ], - 'created_at' => [ - 'type' => 'string', - ], - 'updated_at' => [ - 'type' => 'string', + .'}', 'title' => ''], + 'url' => ['description' => 'URL for diagnostic details', 'type' => 'string', 'example' => '/diagnose/detail/qe3Z34sa', 'title' => ''], + 'created_at' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2024-12-25T15:08:19', 'title' => ''], + 'updated_at' => ['description' => 'Update time', 'type' => 'string', 'example' => '2024-12-25T15:08:19', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'request_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9515E5A0-8905-59B0-9BBF-5F0BE568C3A0', - ], + 'total' => ['title' => '', 'description' => 'Total', 'type' => 'integer', 'format' => 'int64', 'example' => '319'], + 'RequestId' => ['description' => 'Request ID, which can be used for full-link diagnostics', 'type' => 'string', 'example' => '44841312-7227-55C9-AE03-D59729BFAE38', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n {\\n \\"task_id\\": \\"grcuU21a\\",\\n \\"status\\": \\"Running\\",\\n \\"service_name\\": \\"memgraph\\",\\n \\"command\\": \\"{\\\\n \\\\\\"jobs\\\\\\":[\\\\n {\\\\n \\\\\\"cmd\\\\\\":\\\\\\"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.20.12.174\\\\\\",\\\\n \\\\\\"fetch_file_list\\\\\\":[\\\\n\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"in_order\\\\\\":true,\\\\n \\\\\\"offline_mode\\\\\\":false,\\\\n \\\\\\"offline_results\\\\\\":[\\\\n\\\\n ]\\\\n}\\",\\n \\"params\\": \\"{\\\\n \\\\\\"type\\\\\\":\\\\\\"all\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"\\\\\\",\\\\n \\\\\\"channel\\\\\\":\\\\\\"ssh\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.1.2.174\\\\\\",\\\\n \\\\\\"service_name\\\\\\":\\\\\\"filecache\\\\\\"\\\\n}\\",\\n \\"code\\": 0,\\n \\"err_msg\\": \\"Diagnosis failed\\",\\n \\"result\\": \\"{\\\\n \\\\\\"summary\\\\\\":\\\\\\" memory cgroup leak\\\\\\",\\\\n \\\\\\"dataMemEvent\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"Util\\\\\\",\\\\n \\\\\\"value\\\\\\":20\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemcgLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"NG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemFrag\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataMemOverView\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"app\\\\\\",\\\\n \\\\\\"value\\\\\\":10937332\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"free\\\\\\",\\\\n \\\\\\"value\\\\\\":806800\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"kernel\\\\\\",\\\\n \\\\\\"value\\\\\\":4527660\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataKerMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SReclaimable\\\\\\",\\\\n \\\\\\"value\\\\\\":3411292\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"VmallocUsed\\\\\\",\\\\n \\\\\\"value\\\\\\":30980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"allocPage\\\\\\",\\\\n \\\\\\"value\\\\\\":177732\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"KernelStack\\\\\\",\\\\n \\\\\\"value\\\\\\":9280\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"PageTables\\\\\\",\\\\n \\\\\\"value\\\\\\":38056\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SUnreclaim\\\\\\",\\\\n \\\\\\"value\\\\\\":170248\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"reserved\\\\\\",\\\\n \\\\\\"value\\\\\\":690072\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataUserMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"filecache\\\\\\",\\\\n \\\\\\"value\\\\\\":8010008\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"anon\\\\\\",\\\\n \\\\\\"value\\\\\\":2468608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"mlock\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge1G\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge2M\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"buffers\\\\\\",\\\\n \\\\\\"value\\\\\\":458608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"shmem\\\\\\",\\\\n \\\\\\"value\\\\\\":2284\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataCacheList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/lib/mysql/sysom/sys_handler_log.ibd\\\\\\",\\\\n \\\\\\"cached\\\\\\":576764,\\\\n \\\\\\"Task\\\\\\":\\\\\\"mysqld_78575 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-migration-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":276688,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-rtdemo-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":229404,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-monitor-server-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":197368,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-channel-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":180276,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"Name\\\\\\":\\\\\\"total cached of close file\\\\\\",\\\\n \\\\\\"cached\\\\\\":3729668,\\\\n \\\\\\"Task\\\\\\":\\\\\\"\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataProcMemList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"task\\\\\\":\\\\\\"mysqld\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":240856,\\\\n \\\\\\"RssAnon\\\\\\":218248,\\\\n \\\\\\"RssFile\\\\\\":22608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"task\\\\\\":\\\\\\"systemd-journal\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":150248,\\\\n \\\\\\"RssAnon\\\\\\":74300,\\\\n \\\\\\"RssFile\\\\\\":75944\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":144640,\\\\n \\\\\\"RssAnon\\\\\\":114200,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":141480,\\\\n \\\\\\"RssAnon\\\\\\":111040,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"task\\\\\\":\\\\\\"grafana-server\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":103660,\\\\n \\\\\\"RssAnon\\\\\\":42732,\\\\n \\\\\\"RssFile\\\\\\":60928\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97444,\\\\n \\\\\\"RssAnon\\\\\\":76256,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":6,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97260,\\\\n \\\\\\"RssAnon\\\\\\":76072,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":7,\\\\n \\\\\\"task\\\\\\":\\\\\\"prometheus\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":95356,\\\\n \\\\\\"RssAnon\\\\\\":45376,\\\\n \\\\\\"RssFile\\\\\\":49980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":8,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":90144,\\\\n \\\\\\"RssAnon\\\\\\":76456,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":9,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":89796,\\\\n \\\\\\"RssAnon\\\\\\":76108,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"url\\": \\"/diagnose/detail/qe3Z34sa\\",\\n \\"created_at\\": \\"2024-12-25T15:08:19\\",\\n \\"updated_at\\": \\"2024-12-25T15:08:19\\"\\n }\\n ],\\n \\"total\\": 319,\\n \\"RequestId\\": \\"44841312-7227-55C9-AE03-D59729BFAE38\\"\\n}","type":"json"}]', + 'title' => 'Get Diagnostic List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"task_id\\": \\"grcuU21a\\",\\n \\"status\\": \\"Running\\",\\n \\"service_name\\": \\"memgraph\\",\\n \\"command\\": \\"{\\\\n \\\\\\"jobs\\\\\\":[\\\\n {\\\\n \\\\\\"cmd\\\\\\":\\\\\\"mkdir -p /var/log/sysak && sysak podmem -r 100 -a -j /var/log/sysak/podmem.json > /dev/null 2>&1 && cat /var/log/sysak/podmem.json\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.20.12.174\\\\\\",\\\\n \\\\\\"fetch_file_list\\\\\\":[\\\\n\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"in_order\\\\\\":true,\\\\n \\\\\\"offline_mode\\\\\\":false,\\\\n \\\\\\"offline_results\\\\\\":[\\\\n\\\\n ]\\\\n}\\",\\n \\"params\\": \\"{\\\\n \\\\\\"type\\\\\\":\\\\\\"all\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"\\\\\\",\\\\n \\\\\\"channel\\\\\\":\\\\\\"ssh\\\\\\",\\\\n \\\\\\"instance\\\\\\":\\\\\\"172.1.2.174\\\\\\",\\\\n \\\\\\"service_name\\\\\\":\\\\\\"filecache\\\\\\"\\\\n}\\",\\n \\"code\\": 0,\\n \\"err_msg\\": \\"Diagnosis failed\\",\\n \\"result\\": \\"{\\\\n \\\\\\"summary\\\\\\":\\\\\\" memory cgroup leak\\\\\\",\\\\n \\\\\\"dataMemEvent\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"Util\\\\\\",\\\\n \\\\\\"value\\\\\\":20\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemcgLeak\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"NG\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"MemFrag\\\\\\",\\\\n \\\\\\"value\\\\\\":\\\\\\"OK\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataMemOverView\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"app\\\\\\",\\\\n \\\\\\"value\\\\\\":10937332\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"free\\\\\\",\\\\n \\\\\\"value\\\\\\":806800\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"kernel\\\\\\",\\\\n \\\\\\"value\\\\\\":4527660\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataKerMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SReclaimable\\\\\\",\\\\n \\\\\\"value\\\\\\":3411292\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"VmallocUsed\\\\\\",\\\\n \\\\\\"value\\\\\\":30980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"allocPage\\\\\\",\\\\n \\\\\\"value\\\\\\":177732\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"KernelStack\\\\\\",\\\\n \\\\\\"value\\\\\\":9280\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"PageTables\\\\\\",\\\\n \\\\\\"value\\\\\\":38056\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"SUnreclaim\\\\\\",\\\\n \\\\\\"value\\\\\\":170248\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"reserved\\\\\\",\\\\n \\\\\\"value\\\\\\":690072\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataUserMem\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"filecache\\\\\\",\\\\n \\\\\\"value\\\\\\":8010008\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"anon\\\\\\",\\\\n \\\\\\"value\\\\\\":2468608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"mlock\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge1G\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"huge2M\\\\\\",\\\\n \\\\\\"value\\\\\\":0\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"buffers\\\\\\",\\\\n \\\\\\"value\\\\\\":458608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":\\\\\\"shmem\\\\\\",\\\\n \\\\\\"value\\\\\\":2284\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataCacheList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/lib/mysql/sysom/sys_handler_log.ibd\\\\\\",\\\\n \\\\\\"cached\\\\\\":576764,\\\\n \\\\\\"Task\\\\\\":\\\\\\"mysqld_78575 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-migration-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":276688,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33647 ,gunicorn_460836 ,gunicorn_559934 ,gunicorn_731758 ,gunicorn_2362682 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-rtdemo-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":229404,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_60718 ,gunicorn_720734 ,gunicorn_722168 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-monitor-server-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":197368,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33682 ,gunicorn_671155 ,gunicorn_714998 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"Name\\\\\\":\\\\\\"/var/log/sysom/sysom-channel-access.log\\\\\\",\\\\n \\\\\\"cached\\\\\\":180276,\\\\n \\\\\\"Task\\\\\\":\\\\\\"gunicorn_33233 ,gunicorn_499735 ,gunicorn_725497 \\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"Name\\\\\\":\\\\\\"total cached of close file\\\\\\",\\\\n \\\\\\"cached\\\\\\":3729668,\\\\n \\\\\\"Task\\\\\\":\\\\\\"\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"dataProcMemList\\\\\\":{\\\\n \\\\\\"data\\\\\\":[\\\\n {\\\\n \\\\\\"key\\\\\\":0,\\\\n \\\\\\"task\\\\\\":\\\\\\"mysqld\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":240856,\\\\n \\\\\\"RssAnon\\\\\\":218248,\\\\n \\\\\\"RssFile\\\\\\":22608\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":1,\\\\n \\\\\\"task\\\\\\":\\\\\\"systemd-journal\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":150248,\\\\n \\\\\\"RssAnon\\\\\\":74300,\\\\n \\\\\\"RssFile\\\\\\":75944\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":2,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":144640,\\\\n \\\\\\"RssAnon\\\\\\":114200,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":3,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":141480,\\\\n \\\\\\"RssAnon\\\\\\":111040,\\\\n \\\\\\"RssFile\\\\\\":30440\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":4,\\\\n \\\\\\"task\\\\\\":\\\\\\"grafana-server\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":103660,\\\\n \\\\\\"RssAnon\\\\\\":42732,\\\\n \\\\\\"RssFile\\\\\\":60928\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":5,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97444,\\\\n \\\\\\"RssAnon\\\\\\":76256,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":6,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":97260,\\\\n \\\\\\"RssAnon\\\\\\":76072,\\\\n \\\\\\"RssFile\\\\\\":21188\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":7,\\\\n \\\\\\"task\\\\\\":\\\\\\"prometheus\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":95356,\\\\n \\\\\\"RssAnon\\\\\\":45376,\\\\n \\\\\\"RssFile\\\\\\":49980\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":8,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":90144,\\\\n \\\\\\"RssAnon\\\\\\":76456,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n },\\\\n {\\\\n \\\\\\"key\\\\\\":9,\\\\n \\\\\\"task\\\\\\":\\\\\\"gunicorn\\\\\\",\\\\n \\\\\\"MemTotal\\\\\\":89796,\\\\n \\\\\\"RssAnon\\\\\\":76108,\\\\n \\\\\\"RssFile\\\\\\":13688\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"url\\": \\"/diagnose/detail/qe3Z34sa\\",\\n \\"created_at\\": \\"2025-12-03 16:30:28\\",\\n \\"updated_at\\": \\"2025-12-03 16:30:28\\"\\n },\\n \\"request_id\\": \\"9515E5A0-8905-59B0-9BBF-5F0BE568C3A0\\"\\n}","type":"json"}]', ], - 'InvokeDiagnosis' => [ - 'summary' => '发起诊断', - 'path' => '/api/v1/openapi/diagnosis/invoke_diagnosis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListInstanceHealth' => [ + 'summary' => 'Retrieves the health status list of cluster nodes or Pods within a specified time range.', + 'path' => '/api/v1/openapi/cluster_health/range/instance_health_list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', + 'operationType' => 'list', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxV02H6G', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'cluster', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => '2dc6f3be-bf24-4070-8d3a-c03c26850532', 'title' => ''], + ], + [ + 'name' => 'instance', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], + ], + [ + 'name' => 'start', + 'in' => 'query', + 'schema' => ['description' => 'The start time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725797727754', 'title' => ''], + ], + [ + 'name' => 'end', + 'in' => 'query', + 'schema' => ['description' => 'The end time.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '1725801327754', 'title' => ''], + ], + [ + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 5. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'service_name' => [ - 'title' => '诊断类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'iofsstat' => '', - 'jruntime' => '', - 'oomcheck' => '', - 'iohang' => '', - 'pingtrace' => '', - 'rtdelay' => '', - 'memgraph' => '', - 'retran' => '', - 'jitter' => '', - 'iolatency' => '', - 'procdiag' => '', - 'loadtask' => '', - 'filecache' => '', - 'schedmoni' => '', - 'packetdrop' => '', - ], - 'example' => 'memgraph', - ], - 'channel' => [ - 'title' => '诊断通道，固定为 openapi_cloud_assist', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'cloud_assist' => '', + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'Query no data', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'score' => ['description' => 'The health score.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], + 'region_id' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'status' => ['description' => 'The running status of the instance. Valid values:'."\n" + .'- **Running**: running.'."\n" + .'- **Offline**: offline.'."\n" + ."\n\n" + ."\n" + .'> An instance in the Offline status indicates that the heartbeat between the node and the SysOM server is lost. It does not mean that the corresponding ECS instance is not running.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'pod' => ['description' => 'The Pod name.', 'type' => 'string', 'example' => 'test-pod', 'title' => ''], + 'namespace' => ['description' => 'The namespace of the Pod.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'images' => [ + 'description' => 'The list of container image names in the Pod.', + 'type' => 'array', + 'items' => ['description' => 'The container image name.', 'type' => 'string', 'example' => 'alinux3:latest', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'cloud_assist', - ], - 'params' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "instance": "i-wz9gdv7qmdhusamc4dl01",'."\n" - .' "uid": "xxxxxxxxxxxxxx",'."\n" - .' "region": "cn-shenzhen"'."\n" - .'}', + 'title' => '', + 'example' => '', ], + 'total' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '42', 'title' => ''], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"message\\": \\"Query no data\\",\\n \\"data\\": [\\n {\\n \\"score\\": 100,\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"region_id\\": \\"cn-shanghai\\",\\n \\"status\\": \\"Running\\",\\n \\"pod\\": \\"test-pod\\",\\n \\"namespace\\": \\"default\\",\\n \\"images\\": [\\n \\"alinux3:latest\\"\\n ]\\n }\\n ],\\n \\"total\\": 42,\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', + 'title' => 'Retrieve health status list of nodes or pods in a cluster', + 'changeSet' => [ + ['createdAt' => '2025-03-12T11:06:37.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListInstanceHealth', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], ], + ], + ], + ], + ], + 'ListInstanceStatus' => [ + 'summary' => 'Retrieves instance statuses.', + 'path' => '/api/v1/am/instance/list_instance_status', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The current page number (starting from 1). This field is present when pagination is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'instance', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9b9vucz1iubsz355rh', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filters the instance list by status. If this field is specified, only instances with the corresponding status are returned.', + 'enumValueTitles' => ['Running' => 'Running', 'Offline' => 'Offline'], + 'type' => 'string', 'required' => false, + 'example' => 'Running', + 'title' => '', ], ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed error message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'task_id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ihqhAcrt', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'status' => ['description' => 'The running status of the instance. Valid values:'."\n" + .'- **Running**: running.'."\n" + .'- **Offline**: offline.'."\n" + ."\n\n" + ."\n" + .'> An instance in the Offline status indicates that the heartbeat between the node and the SysOM server is lost. It does not mean that the corresponding ECS instance is not running.', 'type' => 'string', 'example' => 'Running', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'request_id' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '5BC79EF5-798B-5499-9683-4E14EBBBF712', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '218', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n {\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"Running\\"\\n }\\n ],\\n \\"RequestId\\": \\"5BC79EF5-798B-5499-9683-4E14EBBBF712\\",\\n \\"total\\": 218\\n}","type":"json"}]', + 'title' => 'Retrieve managed instance status', + 'description' => 'Retrieves the list of machines managed by SysOM.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListInstanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": {\\n \\"task_id\\": \\"ihqhAcrt\\"\\n },\\n \\"request_id\\": \\"43A910E9-A739-525E-855D-A32C257F1826\\"\\n}","type":"json"}]', ], - 'AuthDiagnosis' => [ - 'summary' => '授权 SysOM 对某个机器进行诊断', - 'path' => '/api/v1/openapi/diagnosis/auth', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListInstances' => [ + 'summary' => 'Retrieves a list of instances.', + 'path' => '/api/v1/am/instance/list_instances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeCode' => '236493', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], + 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. This field exists when pagination is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'instance', + 'in' => 'query', + 'schema' => ['description' => 'The ECS instance ID used to filter results.', 'type' => 'string', 'required' => false, 'example' => 'i-8vbfd3g9vs32sfuvv38h', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Filters instances by status.', 'type' => 'string', 'required' => false, 'example' => 'Running'], + ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Filters instances by region.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'example' => 'xxxxx', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'instances' => [ - 'title' => '授权诊断的机器列表', - 'description' => '', + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'SysomOpenAPI.ServerError'."\n", 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'Requests for llm service failed'."\n", 'title' => ''], + 'data' => [ + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ + 'description' => 'The returned result.', 'type' => 'object', - 'required' => false, - 'example' => 'i-wz9gdv7qmdhntqmc4rjd', 'properties' => [ - 'instance' => [ - 'type' => 'string', - ], - 'region' => [ - 'type' => 'string', - ], + 'instance' => ['title' => '', 'description' => 'The ECS instance ID.', 'type' => 'string', 'example' => 'i-wz9d00ut2ska3mlyhn6j'], + 'region' => ['title' => '', 'description' => 'The region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'kernel_version' => ['title' => '', 'description' => 'The current kernel version of the instance.', 'type' => 'string', 'example' => '5.10.134-16.1.an8.x86_64'], + 'os_arch' => ['title' => '', 'description' => 'The architecture of the ECS instance.', 'type' => 'string', 'example' => 'x86'], + 'os_name' => ['title' => '', 'description' => 'The operating system name of the instance (obtained from /etc/os-release).', 'type' => 'string', 'example' => 'Anolis OS'], + 'os_version' => ['title' => '', 'description' => 'The operating system version of the instance (obtained from /etc/os-release).', 'type' => 'string', 'example' => '8.9'], + 'os_name_id' => ['title' => '', 'description' => 'The operating system name ID of the instance (obtained from /etc/os-release).', 'type' => 'string', 'example' => 'anolis'], + 'os_version_id' => ['title' => '', 'description' => 'The operating system version ID of the instance (obtained from /etc/os-release).', 'type' => 'string', 'example' => 'rhel fedora centos'], + 'os_health_score' => ['title' => '', 'description' => 'The health score of the instance.', 'type' => 'string', 'example' => '100'], + 'status' => ['title' => '', 'description' => 'The status of the instance.', 'type' => 'string', 'example' => 'Running'], + 'meta' => ['title' => '', 'description' => 'The metadata of the instance.', 'type' => 'any', 'example' => '{'."\n" + .' "uname": "Linux",'."\n" + .' "oncpu": "off",'."\n" + .' "release": "5.10.134-16.3.al8.aarch64",'."\n" + .' "monitor": "on",'."\n" + .' "version_id": "3",'."\n" + .' "version": "3 (Soaring Falcon)",'."\n" + .' "podNs": ['."\n" + ."\n" + .' ],'."\n" + .' "machine": "aarch64",'."\n" + .' "name": "Alibaba Cloud Linux",'."\n" + .' "sysak": "3.4.0-1",'."\n" + .' "id": "alinux",'."\n" + .' "region": "cn-hangzhou",'."\n" + .' "centos-release": "Alibaba Cloud Linux release 3 (Soaring Falcon)"'."\n" + .'}'], + 'cluster_id' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'c2218ca2b76ec45e7b7ee1693f6fcd374', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => true, - 'docRequired' => true, - ], - 'autoCreateRole' => [ - 'title' => '是否自动创建服务角色', - 'type' => 'boolean', - ], - 'autoInstallAgent' => [ - 'title' => '如果没有安装Agent，是否自动安装最新版本的 Agent', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9515E5A0-8905-59B0-9BBF-5F0BE568C3A0', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '623', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"Requests for llm service failed\\\\n\\",\\n \\"data\\": [\\n {\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"kernel_version\\": \\"5.10.134-16.1.an8.x86_64\\",\\n \\"os_arch\\": \\"x86\\",\\n \\"os_name\\": \\"Anolis OS\\",\\n \\"os_version\\": \\"8.9\\",\\n \\"os_name_id\\": \\"anolis\\",\\n \\"os_version_id\\": \\"rhel fedora centos\\",\\n \\"os_health_score\\": \\"100\\",\\n \\"status\\": \\"Running\\",\\n \\"meta\\": \\"{\\\\n \\\\\\"uname\\\\\\": \\\\\\"Linux\\\\\\",\\\\n \\\\\\"oncpu\\\\\\": \\\\\\"off\\\\\\",\\\\n \\\\\\"release\\\\\\": \\\\\\"5.10.134-16.3.al8.aarch64\\\\\\",\\\\n \\\\\\"monitor\\\\\\": \\\\\\"on\\\\\\",\\\\n \\\\\\"version_id\\\\\\": \\\\\\"3\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"3 (Soaring Falcon)\\\\\\",\\\\n \\\\\\"podNs\\\\\\": [\\\\n\\\\n ],\\\\n \\\\\\"machine\\\\\\": \\\\\\"aarch64\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Alibaba Cloud Linux\\\\\\",\\\\n \\\\\\"sysak\\\\\\": \\\\\\"3.4.0-1\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"alinux\\\\\\",\\\\n \\\\\\"region\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"centos-release\\\\\\": \\\\\\"Alibaba Cloud Linux release 3 (Soaring Falcon)\\\\\\"\\\\n}\\",\\n \\"cluster_id\\": \\"c2218ca2b76ec45e7b7ee1693f6fcd374\\"\\n }\\n ],\\n \\"request_id\\": \\"9515E5A0-8905-59B0-9BBF-5F0BE568C3A0\\",\\n \\"total\\": 623\\n}","type":"json"}]', + 'title' => 'Retrieve managed instance list', + 'description' => 'This operation retrieves the list of instances that are already managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.', + 'changeSet' => [ + ['createdAt' => '2025-02-07T11:56:05.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListInstancesEcsInfoList' => [ + 'summary' => 'Retrieves lists of ECS information for instances, such as tag lists and public IP address lists.', + 'path' => '/api/v1/am/instance/listInstancesEcsInfoList', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'The region used to filter instances.', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'info_type', + 'in' => 'query', + 'schema' => ['description' => 'The type of information to retrieve.', 'type' => 'string', 'required' => true, 'example' => 'ip', 'title' => ''], + ], + [ + 'name' => 'managed_type', + 'in' => 'query', + 'schema' => ['description' => 'The management status of the instance.', 'type' => 'string', 'required' => false, 'example' => 'managed', 'title' => ''], + ], + [ + 'name' => 'instance_id', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the instance ID to filter and return the Agent installation status of the specified instance.', 'type' => 'string', 'required' => false, 'example' => 'i-bp118piqcio9tiwgh84b', 'title' => ''], + ], + [ + 'name' => 'plugin_id', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the component ID to filter and return the instance information list for the corresponding component.', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'code' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'SysomOpenAPI.InvalidParameter', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => '""', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'any', - 'example' => '{}', - ], - 'request_id' => [ - 'type' => 'string', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'ip' => ['description' => 'The IP address of the machine.', 'type' => 'string', 'example' => '11.193.52.91', 'title' => ''], + 'type' => ['description' => 'The IP address type.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'tag_key' => ['description' => 'The tag name.', 'type' => 'string', 'example' => 'sysom', 'title' => ''], + 'tag_value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'diagnosis', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": [\\n {\\n \\"ip\\": \\"11.193.52.91\\",\\n \\"type\\": \\"public\\",\\n \\"tag_key\\": \\"sysom\\",\\n \\"tag_value\\": \\"diagnosis\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve ECS information lists for instances', + 'description' => 'The instance list retrieved by this operation contains only machines that are managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:ListInstancesEcsInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": \\"{}\\",\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\"\\n}","type":"json"}]', ], - 'GetCopilotHistory' => [ - 'summary' => '获取copilot历史聊天记录', - 'path' => '/api/v1/copilot/get_copilot_history', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListInstancesWithEcsInfo' => [ + 'summary' => 'Retrieves information about managed and unmanaged instances, including ECS information.', + 'path' => '/api/v1/am/instance/listInstancesWithEcsInfo', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxGP5QJE', - ], + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by region.', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'instance_id', + 'in' => 'query', + 'schema' => ['description' => 'Specifies an instance ID to filter the Agent installation status of the specified instance.', 'type' => 'string', 'required' => false, 'example' => 'i-bp118piqcio9tiwgh84b', 'title' => ''], + ], + [ + 'name' => 'instance_name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the component instance.', 'type' => 'string', 'required' => false, 'example' => 'block-load-balancer-hjdm9', 'title' => ''], + ], + [ + 'name' => 'instance_id_name', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by instance name or instance ID. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => '84b', 'title' => ''], + ], + [ + 'name' => 'is_managed', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by management status.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'instance_tag', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Filters instances by instance tag.', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '请求历史聊天记录的数量，一般小于100条', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'feature_dim_radar_chart', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'public_ip', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by public IP address.', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1', 'title' => ''], + ], + [ + 'name' => 'private_ip', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by private IP address.', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1', 'title' => ''], + ], + [ + 'name' => 'resource_group_name', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by resource group name.', 'type' => 'string', 'required' => false, 'example' => 'default resource group', 'title' => ''], + ], + [ + 'name' => 'resource_group_id', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxxxx', 'title' => ''], + ], + [ + 'name' => 'resource_group_id_name', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by resource group name or resource group ID. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'health_status', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by health status.', 'type' => 'string', 'required' => false, 'example' => 'healthy', 'title' => ''], + ], + [ + 'name' => 'os_name', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by operating system name.', 'type' => 'string', 'required' => false, 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64bit', 'title' => ''], + ], + [ + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The page number for pagination. This parameter specifies the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.InvalidParameter', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message. An empty value indicates that all data has been read.', 'type' => 'string', 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', 'title' => ''], 'data' => [ - 'title' => '聊天记录列表，长度为请求数量，若聊天记录小于请求数量，则为实际的聊天记录数量，格式：[{"user":“”,"content":“”.question,"time":"“},{...}]', - 'description' => '', + 'description' => 'The returned data.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'user' => [ - 'title' => 'user/copilot，user为用户，copilot为机器人', - 'description' => '', - 'type' => 'string', - 'example' => 'user'."\n" - .'copilot', - ], - 'content' => [ - 'title' => '聊天内容文本', - 'description' => '', - 'type' => 'string', + 'instance_id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-bp118piqcio9tiwgh84b', 'title' => ''], + 'instance_name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'allowed-repos-r2tzl', 'title' => ''], + 'instance_tag' => [ + 'description' => 'The instance tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tag_key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test_tag_key', 'title' => ''], + 'tag_value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test_tag_value', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'time' => [ - 'title' => '聊天记录时间，string类型', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-02 10:02:39', - ], + 'public_ip' => ['description' => 'The public IP address of the instance.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'private_ip' => ['description' => 'The private IP address of the instance.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'resource_group_name' => ['description' => 'The resource group name.', 'type' => 'string', 'example' => 'default resource group', 'title' => ''], + 'resource_group_id' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxxxx', 'title' => ''], + 'os_name' => ['description' => 'The operating system name of the instance.', 'type' => 'string', 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64bit', 'title' => ''], + 'os_health_score' => ['description' => 'The health score of the instance.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'status' => ['description' => 'The running status of the instance. Valid values:'."\n" + .'- **Running**: The instance is running.'."\n" + .'- **Offline**: The instance is offline.'."\n" + ."\n\n" + ."\n" + .'> An instance in the Offline state indicates that the heartbeat between the node and the SysOM server is lost. It does not mean that the corresponding ECS instance has stopped running.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'cluster_id' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cbf7a37bc905d4682a3338b3744810269', 'title' => ''], + 'os_arch' => ['description' => 'The architecture of the ECS instance.', 'type' => 'string', 'example' => 'x86', 'title' => ''], + 'kernel_version' => ['description' => 'The kernel version.', 'type' => 'string', 'example' => '5.10.134-14.an8.x86_64', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '319', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": [\\n {\\n \\"instance_id\\": \\"i-bp118piqcio9tiwgh84b\\",\\n \\"instance_name\\": \\"allowed-repos-r2tzl\\",\\n \\"instance_tag\\": [\\n {\\n \\"tag_key\\": \\"test_tag_key\\",\\n \\"tag_value\\": \\"test_tag_value\\"\\n }\\n ],\\n \\"public_ip\\": \\"1.1.1.1\\",\\n \\"private_ip\\": \\"1.1.1.1\\",\\n \\"resource_group_name\\": \\"default resource group\\",\\n \\"resource_group_id\\": \\"rg-xxxxxx\\",\\n \\"os_name\\": \\"Alibaba Cloud Linux 3.2104 LTS 64bit\\",\\n \\"os_health_score\\": \\"100\\",\\n \\"status\\": \\"Running\\",\\n \\"cluster_id\\": \\"cbf7a37bc905d4682a3338b3744810269\\",\\n \\"os_arch\\": \\"x86\\",\\n \\"kernel_version\\": \\"5.10.134-14.an8.x86_64\\"\\n }\\n ],\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\",\\n \\"total\\": 319\\n}","type":"json"}]', + 'title' => 'Retrieve instance list with ECS information', + 'description' => 'The instance list returned by this operation contains only machines that are managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.', + 'changeSet' => [ + ['createdAt' => '2025-03-12T11:13:16.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:ListInstancesWithEcsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n {\\n \\"user\\": \\"user\\\\ncopilot\\",\\n \\"content\\": \\"copilot回复的具体内容\\",\\n \\"time\\": \\"2024-09-02 10:02:39\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GenerateCopilotStreamResponse' => [ - 'summary' => '流式copilot服务接口', - 'path' => '/api/v1/copilot/generate_copilot_stream_response', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'ListPluginsInstances' => [ + 'summary' => 'Retrieves the list of instances for plug-in installation, update, or uninstallation.', + 'path' => '/api/v1/am/agent/listPluginsInstances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'name' => 'operation_type', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by plug-in installation status.', 'type' => 'string', 'required' => true, 'example' => 'install', 'title' => ''], + ], + [ + 'name' => 'plugin_id', + 'in' => 'query', + 'schema' => ['description' => 'Filters the instance list by the specified agent. If this parameter is specified, only instances associated with the specified agent are returned.', 'type' => 'string', 'required' => true, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by region.', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'instance_id_name', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by instance ID or instance name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'i-bpxx', 'title' => ''], + ], + [ + 'name' => 'instance_tag', + 'in' => 'query', + 'schema' => ['description' => 'Filters instances by instance tag.', 'type' => 'string', 'required' => false, 'example' => '{"key":"app","value":"sysom-aliyun-com"}', 'title' => ''], + ], + [ + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. This field is present when pagination is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'llmParamString' => [ - 'title' => '对接copilot llm服务的入参，参考标准LLM接口入参dict，需要转化成string并传入llmParamString中', - 'description' => '', - 'type' => 'string', - 'required' => false, + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], + 'data' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'instance_id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'i-bp118piqcio9tiwgh84b', 'title' => ''], + 'instance_name' => ['description' => 'The component instance name.', 'type' => 'string', 'example' => 'allowed-repos-qmf8w', 'title' => ''], + 'instance_tag' => [ + 'description' => 'The instance tag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance tag.', + 'type' => 'object', + 'properties' => [ + 'tag_key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'test_tag_key', 'title' => ''], + 'tag_value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test_tag_value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'public_ip' => ['description' => 'The public IP address.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'private_ip' => ['description' => 'The private IP address.', 'type' => 'string', 'example' => '1.1.1.1', 'title' => ''], + 'resource_group_name' => ['description' => 'The resource group name.', 'type' => 'string', 'example' => 'default resource group', 'title' => ''], + 'resource_group_id' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-xxxx', 'title' => ''], + 'os_name' => ['description' => 'The operating system name of the instance.', 'type' => 'string', 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64 bit', 'title' => ''], + 'region' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], + 'request_id' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '35F91AAB-5FDF-5A22-B211-C7C6B00817D0', 'title' => ''], + 'total' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": [\\n {\\n \\"instance_id\\": \\"i-bp118piqcio9tiwgh84b\\",\\n \\"instance_name\\": \\"allowed-repos-qmf8w\\",\\n \\"instance_tag\\": [\\n {\\n \\"tag_key\\": \\"test_tag_key\\",\\n \\"tag_value\\": \\"test_tag_value\\"\\n }\\n ],\\n \\"public_ip\\": \\"1.1.1.1\\",\\n \\"private_ip\\": \\"1.1.1.1\\",\\n \\"resource_group_name\\": \\"default resource group\\",\\n \\"resource_group_id\\": \\"rg-xxxx\\",\\n \\"os_name\\": \\"Alibaba Cloud Linux 3.2104 LTS 64 bit\\",\\n \\"region\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"request_id\\": \\"35F91AAB-5FDF-5A22-B211-C7C6B00817D0\\",\\n \\"total\\": 42\\n}","type":"json"}]', + 'title' => 'Retrieve instance list of a component', + 'description' => 'The instance list retrieved by this operation contains only machines that are managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:ListPluginsInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + ], + 'ListPodsOfInstance' => [ + 'summary' => 'Retrieves the list of pods in a cluster or instance.', + 'path' => '/api/v1/am/instance/list_pod_of_instance', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '256739', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'current', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'c96e34d74eb6748f3b2a46552d5d653f6', 'title' => ''], + ], + [ + 'name' => 'instance', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-wz9d00ut2ska3mlyhn6j', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError'."\n", - ], - 'message' => [ - 'title' => '错误码描述，若无错误则为空', - 'description' => '', - 'type' => 'string', - 'example' => 'Requests for llm service failed'."\n", - ], + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['title' => '', 'description' => 'The error message. An empty value indicates that all data has been read.', 'type' => 'string', 'required' => true, 'example' => 'instance not exists'], 'data' => [ - 'title' => 'llm服务返回的data，字符串类型，如为dict需自行转换解析', - 'description' => '', - 'type' => 'string', + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'pod' => ['description' => 'The pod name.', 'type' => 'string', 'example' => 'test-pod', 'title' => ''], + 'namespace' => ['description' => 'The namespace in which the pod resides.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7'], + 'total' => ['title' => '', 'description' => 'The maximum number of entries returned for this request.', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"instance not exists\\",\\n \\"data\\": [\\n {\\n \\"pod\\": \\"test-pod\\",\\n \\"namespace\\": \\"default\\"\\n }\\n ],\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"total\\": 42\\n}","type":"json"}]', + 'title' => 'Retrieve pod list in a cluster or instance', + 'requestParamsDescription' => 'If only cluster_id is specified, all pod information in the cluster is queried. If instance is specified, all pod information in the instance is queried.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListPodsOfInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\\\n\\",\\n \\"message\\": \\"Requests for llm service failed\\\\n\\",\\n \\"data\\": \\"{\'choices\': [{\'finish_reason\': \'stop\', \'index\': 0, \'message\': {\'content\': \'Alinux是一个基于Linux的开源操作系统，它主要由阿里巴巴集团开发和维护，专为大规模云计算和大数据处理环境设计。这个系统针对高并发、低延迟以及资源利用率优化进行了深度定制和改良，以适应阿里内部复杂且庞大的业务需求。由于其在性能和稳定性方面的优秀表现，Alinux也在逐渐被外部的一些企业和研究机构采用，特别是在需要处理高负载场景的领域。与标准Linux发行版相比，Alinux可能包含特定的内核补丁、优化工具集以及其他阿里巴巴内部研发的特性。然而，值得注意的是，尽管名称中的“Ali”可能让人联想到与阿里巴巴的紧密关系，但Alinux作为一个项目，已经于2021年成为开放原子开源基金会（OpenAtom Foundation）下的一个子项目，即 OpenAnolis，这标志着它的社区化和广泛化的进程。\', \'role\': \'assistant\'}}], \'model\': \'Qwen1.5\', \'sentiment\': [], \'status_code\': 200, \'time\': 6.836989402770996, \'usage\': {\'completion_tokens\': 180, \'prompt_tokens\': 176, \'time_dict\': {\'auto_regression_time\': 0.03798324399524265, \'speed\': 26.327398474054736, \'total_generate_time\': 6.836983919143677}, \'total_tokens\': 356}}\\"\\n}","type":"json"}]', ], - 'GenerateCopilotResponse' => [ - 'summary' => '获取copilot服务的返回结果', - 'path' => '/api/v1/copilot/generate_copilot_response', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListRegions' => [ + 'summary' => 'Lists all regions that contain managed instances.', + 'path' => '/api/v1/am/instance/list_regions', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'llmParamString' => [ - 'title' => '对接copilot llm服务的入参，参考标准LLM接口入参dict，需要转化成string并传入llmParamString中', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + 'code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error code description. This value is empty if no error occurs.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'data' => [ + 'description' => 'The list of regions.', + 'type' => 'array', + 'items' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'example' => '["cn-hangzhou", "cn-shengzhen"]', + 'title' => '', ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\"\\n}","type":"json"}]', + 'title' => 'List regions of managed instances', + 'description' => 'This operation retrieves the list of regions where the current user has instances managed by SysOM. If a user has ECS instances in a region but none of them are managed by SysOM, that region is not included in the response.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], ], + ], + 'ListVmcoreDiagnosisTask' => [ + 'summary' => 'Query the historical crash diagnosis task list.', + 'path' => '/api/v1/crashAgent/diagnosis/queryTaskList', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'days', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies the tasks from the past number of days, up to a maximum of 30 days', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPI.ServerError', - ], - 'massage' => [ - 'title' => '错误码描述，若无错误则为空', - 'description' => '', - 'type' => 'string', - 'example' => 'Requests for llm service failed', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'message' => ['description' => 'Error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], + 'code' => ['description' => 'Status code.'."\n" + .'- `code == Success` indicates the authorization was successful.'."\n" + .'- Other status codes indicate authorization failure. When authorization fails, check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'data' => [ - 'title' => 'llm服务返回的data，字符串类型，如为dict需自行转换解析', - 'description' => '', - 'type' => 'string', + 'description' => 'Response data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Response data.', + 'type' => 'object', + 'properties' => [ + 'taskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7'."\n"], + 'taskType' => [ + 'title' => '', + 'description' => 'Task type', + 'enumValueTitles' => ['dmesg' => 'dmesg', 'vmcore' => 'vmcore'], + 'type' => 'string', + 'example' => 'vmcore', + ], + 'taskStatus' => [ + 'title' => '', + 'description' => 'Task status', + 'enumValueTitles' => ['running' => 'running', 'queuing' => 'queuing', 'created' => 'created', 'success' => 'success', 'error' => 'error'], + 'type' => 'string', + 'example' => 'running', + ], + 'createdAt' => ['title' => '', 'description' => 'Task creation time', 'type' => 'string', 'example' => '2025-12-02T17:36:12'."\n"], + 'errorMsg' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'error message'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], + 'total' => ['title' => '', 'description' => 'Total number of tasks', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"code\\": \\"Success\\",\\n \\"data\\": [\\n {\\n \\"taskId\\": \\"bbe94a98-4192-4172-b856-95777e0a55d7\\\\n\\",\\n \\"taskType\\": \\"vmcore\\",\\n \\"taskStatus\\": \\"running\\",\\n \\"createdAt\\": \\"2025-12-02T17:36:12\\\\n\\",\\n \\"errorMsg\\": \\"error message\\"\\n }\\n ],\\n \\"total\\": 2\\n}","type":"json"}]', + 'title' => 'Query crash diagnosis task list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:ListVmcoreDiagnosisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"SysomOpenAPI.ServerError\\",\\n \\"massage\\": \\"Requests for llm service failed\\",\\n \\"data\\": \\"{\'choices\': [{\'finish_reason\': \'stop\', \'index\': 0, \'message\': {\'content\': \'Alinux是一个基于Linux的开源操作系统，它主要由阿里巴巴集团开发和维护，专为大规模云计算和大数据处理环境设计。这个系统针对高并发、低延迟以及资源利用率优化进行了深度定制和改良，以适应阿里内部复杂且庞大的业务需求。由于其在性能和稳定性方面的优秀表现，Alinux也在逐渐被外部的一些企业和研究机构采用，特别是在需要处理高负载场景的领域。与标准Linux发行版相比，Alinux可能包含特定的内核补丁、优化工具集以及其他阿里巴巴内部研发的特性。然而，值得注意的是，尽管名称中的“Ali”可能让人联想到与阿里巴巴的紧密关系，但Alinux作为一个项目，已经于2021年成为开放原子开源基金会（OpenAtom Foundation）下的一个子项目，即 OpenAnolis，这标志着它的社区化和广泛化的进程。\', \'role\': \'assistant\'}}], \'model\': \'Qwen1.5\', \'sentiment\': [], \'status_code\': 200, \'time\': 6.836989402770996, \'usage\': {\'completion_tokens\': 180, \'prompt_tokens\': 176, \'time_dict\': {\'auto_regression_time\': 0.03798324399524265, \'speed\': 26.327398474054736, \'total_generate_time\': 6.836983919143677}, \'total_tokens\': 356}}\\"\\n}","type":"json"}]', ], - 'CheckInstanceSupport' => [ - 'summary' => '检查目标实例是否被 SysOM 支持', - 'path' => '/api/v1/am/supportInstanceList/checkInstanceSupport', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'StartAIAnalysis' => [ + 'summary' => 'Start AI job analysis.', + 'path' => '/api/v1/openapi/proxy/post/start_ai_analysis', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '255600', + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ @@ -8981,134 +7662,124 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Request Body', 'type' => 'object', 'properties' => [ - 'region' => [ - 'title' => '实例所属 Region，务必保证 instances 中传递的所有实例ID都属于同一个 region', - 'description' => '', - 'type' => 'string', + 'instance' => ['description' => 'Instance ID', 'type' => 'string', 'required' => false, 'example' => 'i-wz9dej066kii4goqxxxx', 'title' => ''], + 'timeout' => ['description' => 'AI Infra analysis time;'."\n" + .'Unit: milliseconds;'."\n" + .'Default value: 2000;', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], + 'pids' => ['description' => 'AI job process PIDs. Supports batch input, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '2421,36547,10043', 'title' => ''], + 'comms' => ['description' => 'Process name, optional parameter', 'type' => 'string', 'required' => false, 'example' => 'python_test', 'title' => ''], + 'channel' => ['description' => 'Channel name', 'type' => 'string', 'required' => false, 'example' => 'ecs_sysom', 'title' => ''], + 'iteration_mod' => ['description' => 'Iteration entry module. Required only in iteration mode. Can be left blank.', 'type' => 'string', 'required' => false, 'example' => 'a.b.module', 'title' => ''], + 'iteration_func' => ['description' => 'Iteration entry function. Required only in iteration mode. Can be left blank.', 'type' => 'string', 'required' => false, 'example' => 'Class.function', 'title' => ''], + 'uid' => ['description' => 'Alibaba Cloud user ID. Not required for OpenAPI access.', 'type' => 'string', 'required' => false, 'example' => '123423414', 'title' => ''], + 'created_by' => ['description' => 'Creator. Not required for OpenAPI access.', 'type' => 'string', 'required' => false, 'example' => '445333', 'title' => ''], + 'instance_type' => ['description' => 'Instance type. Not required for OpenAPI access.', 'type' => 'string', 'required' => false, 'example' => 'ip/sn/hostname', 'title' => ''], + 'region' => ['description' => 'Region ID', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + 'iteration_range' => [ + 'description' => 'Iteration range (iteration count: refers to the number of iterations when the data collection module is activated, independent of the AI job\'s iteration count)', + 'type' => 'array', + 'items' => ['description' => '[Start iteration count, end iteration count]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[5,14]', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], - 'instances' => [ - 'title' => '需要检查的实例ID列表', - 'description' => '', + 'analysis_params' => [ + 'description' => 'Data richness', 'type' => 'array', 'items' => [ - 'title' => '实例ID', - 'description' => '', + 'description' => 'gpu: GPU operators'."\n" + .'python: Python call stack'."\n" + .'cPU: CPU information'."\n" + .'torch: Torch GPU memory information'."\n" + .'flops: Floating-point operations count', + 'enumValueTitles' => ['python' => 'Python call stack', 'memory' => 'Torch GPU memory information', 'cpu' => 'CPU information', 'flops' => 'Floating-point operations count', 'gpu' => 'GPU operators'], 'type' => 'string', 'required' => false, - 'example' => 'i-2zxxxxxx', + 'example' => '[gpu,cpu,torch]', + 'title' => '', ], 'required' => false, - 'example' => '["i-2zxxxxxx"]', + 'title' => '', + 'example' => '', ], + 'analysisTool' => ['description' => 'Analysis tool. Not required for OpenAPI access.', 'type' => 'string', 'required' => false, 'example' => 'gp/pyki/analysis', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'title' => '状态码'."\n" - .'- `code == Success` 则代表授权成功；'."\n" - .'- 其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '""', 'title' => ''], 'data' => [ - 'title' => '返回数据。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '返回结果。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'support' => [ - 'title' => '是否支持被 SysOM 纳管'."\n" - ."\n" - .'- **true**：支持被 SysOM 纳管'."\n" - ."\n" - .'- **false**：不支持被 SysOM 纳管', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'reason' => [ - 'title' => '当success为false时，该值不为空，表示不支持被纳管的原因', - 'description' => '', - 'type' => 'string', - 'example' => 'instance not found in ecs', - ], - 'instance' => [ - 'title' => 'ECS实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'i-wz9d00ut2ska3mlyhn6j', - ], - ], + 'description' => 'Response data', + 'type' => 'object', + 'properties' => [ + 'analysis_id' => ['description' => 'AI analysis ID', 'type' => 'string', 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', 'title' => ''], ], - ], - 'message' => [ - 'title' => '错误信息，code != Success 时，在此处存放错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"analysis_id\\": \\"16896fa8-37f6-4c70-bb32-67fa9817d426\\"\\n }\\n}","type":"json"}]', + 'title' => 'Start AI Infra Observation', + 'changeSet' => [ + ['createdAt' => '2025-07-08T06:22:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-26T08:32:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:StartAIAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"data\\": [\\n {\\n \\"support\\": true,\\n \\"reason\\": \\"instance not found in ecs\\",\\n \\"instance\\": \\"i-wz9d00ut2ska3mlyhn6j\\"\\n }\\n ],\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\"\\n}","type":"json"}]', ], 'StartAIDiffAnalysis' => [ - 'summary' => '查看AI Infra差分分析结果', + 'summary' => 'Starts an AI Infra differential analysis.', 'path' => '/api/v1/appObserv/aiAnalysis/diffAnalysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxFVZ8GD', - ], + 'abilityTreeNodes' => ['FEATUREalinuxFVZ8GD'], ], 'parameters' => [ [ @@ -9116,318 +7787,345 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'task1' => [ - 'description' => '', + 'description' => 'The task1 parameters.', 'type' => 'object', 'properties' => [ - 'analysisId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', - ], + 'analysisId' => ['description' => 'The AI analysis ID.', 'type' => 'string', 'required' => false, 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', 'title' => ''], 'pids' => [ - 'description' => '', + 'description' => 'The pids of AI job processes. Batch input is supported. Separate multiple pids with commas.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '452651:python3 ./test.py', - ], - 'required' => false, - ], - 'step_start' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', + 'items' => ['description' => 'The pid of the AI job process.', 'type' => 'string', 'required' => false, 'example' => '452651:python3 ./test.py', 'title' => ''], 'required' => false, - 'example' => '4660550379415.497', - ], - 'step_end' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '4660551334179.955', + 'title' => '', + 'example' => '', ], + 'step_start' => ['description' => 'The step start time, calculated based on the selected step number.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '4660550379415.497', 'title' => ''], + 'step_end' => ['description' => 'The step end time, calculated based on the selected step number.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '4660551334179.955', 'title' => ''], ], 'required' => true, - 'example' => '', + 'example' => 'task1参数', + 'title' => '', ], 'task2' => [ - 'description' => '', + 'description' => 'The task2 parameters.', 'type' => 'object', 'properties' => [ - 'analysisId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', - ], + 'analysisId' => ['description' => 'The AI analysis ID.', 'type' => 'string', 'required' => true, 'example' => '16896fa8-37f6-4c70-bb32-67fa9817d426', 'title' => ''], 'pids' => [ - 'description' => '', + 'description' => 'The pids of AI job processes. Batch input is supported. Separate multiple pids with commas.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '452651:python3 ./test.py', - ], + 'items' => ['description' => 'The pid of the AI job process.', 'type' => 'string', 'required' => false, 'example' => '452651:python3 ./test.py', 'title' => ''], 'required' => true, 'example' => '452651:python3 ./test.py', + 'title' => '', ], - 'step_start' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '4660550379415.497', - ], - 'step_end' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '4660551334179.955', - ], + 'step_start' => ['description' => 'The step start time, calculated based on the selected step number.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '4660550379415.497', 'title' => ''], + 'step_end' => ['description' => 'The step end time, calculated based on the selected step number.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '4660551334179.955', 'title' => ''], ], 'required' => true, - 'example' => '', + 'example' => 'task2参数，目前只支持相同analysisId和pid的对比', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error code description. This field is empty if no error occurs.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'data' => ['description' => 'The AI differential analysis result data.', 'type' => 'string', 'example' => '"['."\n" + .' {'."\n" + .' name: "xxx", #算子名称'."\n" + .' before_time: 2, # 前者总耗时'."\n" + .' after_time: 4, # 后者总耗时'."\n" + .' time_diff: 2, # 耗时差异'."\n" + .' before_time_perc: "80%", # 前者总耗时百分比'."\n" + .' after_time_perc: "23%", # 后者总耗时百分比'."\n" + .' time_perc_diff: "-54%", # 耗时差异'."\n" + .' before_count: 1, # 前者总调用差异'."\n" + .' after_count: 2, # 后者总调用差异'."\n" + .' count_diff: 1, # 调用差异'."\n" + .' before_count_perc: "56%", # 前者总调用差异'."\n" + .' after_count_perc: "32%", # 后者总调用差异'."\n" + .' count_perc_diff: "44%", # 调用差异'."\n" + .' },'."\n" + .' {...}'."\n" + .']"', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": \\"\\\\\\"[\\\\n {\\\\n name: \\\\\\"xxx\\\\\\", #算子名称\\\\n before_time: 2, # 前者总耗时\\\\n after_time: 4, # 后者总耗时\\\\n time_diff: 2, # 耗时差异\\\\n before_time_perc: \\\\\\"80%\\\\\\", # 前者总耗时百分比\\\\n after_time_perc: \\\\\\"23%\\\\\\", # 后者总耗时百分比\\\\n time_perc_diff: \\\\\\"-54%\\\\\\", # 耗时差异\\\\n before_count: 1, # 前者总调用差异\\\\n after_count: 2, # 后者总调用差异\\\\n count_diff: 1, # 调用差异\\\\n before_count_perc: \\\\\\"56%\\\\\\", # 前者总调用差异\\\\n after_count_perc: \\\\\\"32%\\\\\\", # 后者总调用差异\\\\n count_perc_diff: \\\\\\"44%\\\\\\", # 调用差异\\\\n },\\\\n {...}\\\\n]\\\\\\"\\"\\n}","type":"json"}]', - ], - 'DescribeMetricList' => [ - 'summary' => '查询指标', - 'path' => '/api/v1/openapi/proxy/get/describeMetricList', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'Start AI infra differential analysis', + 'description' => 'Currently, only comparative analysis of the same pid across different steps within the same AI Infra analysis record is supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:StartAIDiffAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UninstallAgent' => [ + 'summary' => 'Uninstalls a specified version of a component.', + 'path' => '/api/v1/am/agent/uninstall_agent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'instance', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '实例ID。', - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'description' => 'The list of instances from which to uninstall the component.', + 'type' => 'array', + 'items' => [ + 'description' => 'The instance information.', + 'type' => 'object', + 'properties' => [ + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'agent_id' => ['description' => 'The ID of the component to uninstall.', 'type' => 'string', 'required' => true, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agent_version' => ['description' => 'The version of the component to uninstall.', 'type' => 'string', 'required' => true, 'example' => '3.4.0-1', 'title' => ''], + ], 'required' => false, - 'example' => 'i-wz9d00ut2ska3mlyhn6j', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'metricName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '监控项名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sysom_cpu_graph', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.'."\n" + .'- If code is Success, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization has failed. Check the message field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If code is Success, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', 'title' => ''], + 'data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '63fc5acb99e642d793f42912612e8001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '13772206-1162-5A0F-81F0-79A10C249A5E', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.RegionNotSupport', 'errorMessage' => 'Region not supported.', 'description' => 'Region is not supported.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Uninstall a component', + 'description' => 'Calling this operation to uninstall an Agent is asynchronous. After the call, a task_id is returned. Use this ID to call the GetAgentTask operation to retrieve the execution status of the task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'title' => '起始时间，秒级时间戳'."\n", - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1709740800000', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sysom:UninstallAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": {\\n \\"task_id\\": \\"63fc5acb99e642d793f42912612e8001\\"\\n },\\n \\"RequestId\\": \\"13772206-1162-5A0F-81F0-79A10C249A5E\\"\\n}","type":"json"}]', + ], + 'UninstallAgentForCluster' => [ + 'summary' => 'Uninstalls a component from a cluster.', + 'path' => '/api/v1/am/agent/uninstall_agent_by_cluster', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'endTime', - 'in' => 'query', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253536', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '截止时间，秒级时间戳', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> This parameter must be set to the ID of an ACK cluster.', 'type' => 'string', 'required' => false, 'example' => 'c822f83bb45994ddbac9326b4c2f04f35', 'title' => ''], + 'agent_id' => ['description' => 'The component ID.', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agent_version' => ['description' => 'The component version.', 'type' => 'string', 'required' => false, 'example' => '3.4.0-1', 'title' => ''], + ], 'required' => false, - 'example' => '1683618245000', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '响应参数：'."\n", - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'title' => '状态码'."\n" - .'- `code == Success` 则代表授权成功；'."\n" - .'- 其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'title' => '错误信息'."\n" - .'- 如果 `code == Success`，则本字段为空；'."\n" - .'- 否则本字段包含请求错误信息。', - 'description' => '', - 'type' => 'string', - 'example' => '分析ID: 56dae746-ef55-4f77-8373-cb3594c41457'."\n" - .'机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!', - ], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error information of the request.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.NotAuthorizedInstance Instance 21 is not authorized', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '44841312-7227-55C9-AE03-D59729BFAE38', 'title' => ''], 'data' => [ - 'title' => '返回数据。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '返回数据。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'metricName' => [ - 'title' => '监控项名称', - 'description' => '', - 'type' => 'string', - 'example' => 'sysom_cpu_usage_idle', - ], - 'labels' => [ - 'title' => '监控项标签', - 'description' => '', - 'type' => 'string', - 'example' => '{\'taskExecName\': \'build-and-deploy\', \'pipelineName\': \'pipeline-run-1722909642357\'}', - ], - 'values' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '监控数据', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1743036429.0', - ], - 'example' => '["1743036429.0", "10489572.0"]', - ], - ], - ], + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'The task ID. You can use this task ID to call GetAgentTasK to query the execution status of the task.', 'type' => 'string', 'example' => '049ea0609515414b9e19c3389d7ba638', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.RegionNotSupport', 'errorMessage' => 'Region not supported.', 'description' => 'Region is not supported.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"分析ID: 56dae746-ef55-4f77-8373-cb3594c41457\\\\n机器i-bp164ns76pzirbwv0snt分析失败, 失败原因: Not get GPU trace data for \'56dae746-ef55-4f77-8373-cb3594c41457\' \'[\'93811\']\'!\\",\\n \\"data\\": [\\n {\\n \\"metricName\\": \\"sysom_cpu_usage_idle\\",\\n \\"labels\\": \\"{\'taskExecName\': \'build-and-deploy\', \'pipelineName\': \'pipeline-run-1722909642357\'}\\",\\n \\"values\\": [\\n [\\n \\"1743036429.0\\"\\n ]\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'CreateVmcoreDiagnosisTask' => [ - 'summary' => '创建宕机诊断任务', - 'path' => '/api/v1/crashAgent/diagnosis/createDiagnosisTask', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Uninstall a component from an ACK cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:UninstallAgentForCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.NotAuthorizedInstance Instance 21 is not authorized\\",\\n \\"RequestId\\": \\"44841312-7227-55C9-AE03-D59729BFAE38\\",\\n \\"data\\": {\\n \\"task_id\\": \\"049ea0609515414b9e19c3389d7ba638\\"\\n }\\n}","type":"json"}]', + ], + 'UninstallAgentWithType' => [ + 'summary' => '', + 'path' => '/api/v1/am/agent/uninstallAgent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -9435,426 +8133,863 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'taskType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'dmesg' => 'dmesg', - 'vmcore' => 'vmcore', + 'instances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instance' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'vmcore', - 'title' => '任务类型', - ], - 'vmcoreUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path', - 'title' => 'vmcore下载链接', - ], - 'debuginfoUrl' => [ + 'required' => true, 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path', - 'title' => 'debuginfo下载链接', + 'title' => '', + 'example' => '', ], - 'debuginfoCommonUrl' => [ - 'description' => '', + 'agentId' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9'."\n", 'title' => ''], + 'agentVersion' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '3.4.0-1'."\n", 'title' => ''], + 'instanceType' => [ 'type' => 'string', - 'required' => false, - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path', - 'title' => 'debuginfo-common rpm包下载链接', - ], - 'dmesgUrl' => [ + 'enum' => ['ecs', 'eflo'], 'description' => '', - 'type' => 'string', 'required' => false, - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path', - 'title' => 'dmesg下载链接', + 'example' => 'ecs', + 'title' => '', ], ], + 'description' => '', 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], + 'code' => ['type' => 'string', 'description' => '', 'example' => 'Success', 'title' => ''], + 'message' => ['type' => 'string', 'description' => '', 'example' => "\n" + .'“”', 'title' => ''], 'data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7', - 'title' => '任务ID', - ], + 'taskId' => ['type' => 'string', 'description' => '', 'example' => '63fc5acb99e642d793f42912612e8001'."\n", 'title' => ''], ], - ], - 'code' => [ 'description' => '', - 'type' => 'string', - 'example' => 'Success', + 'title' => '', + 'example' => '', ], + 'requestId' => ['type' => 'string', 'description' => '', 'example' => '13772206-1162-5A0F-81F0-79A10C249A5E'."\n", 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '调用本接口卸载 Agent 是异步的，调用接口后会返回一个 task_id，可以凭借该 ID 调用 GetAgentTask 接口获取任务的执行情况。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"data\\": {\\n \\"taskId\\": \\"bbe94a98-4192-4172-b856-95777e0a55d7\\"\\n },\\n \\"code\\": \\"Success\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\n“”\\",\\n \\"data\\": {\\n \\"taskId\\": \\"63fc5acb99e642d793f42912612e8001\\\\n\\"\\n },\\n \\"requestId\\": \\"13772206-1162-5A0F-81F0-79A10C249A5E\\\\n\\"\\n}","type":"json"}]', ], - 'GetVmcoreDiagnosisTask' => [ - 'summary' => '查询宕机诊断任务结果', - 'path' => '/api/v1/crashAgent/diagnosis/queryTask', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAlertDestination' => [ + 'path' => '/api/v1/alertPusher/alert/updateDestination', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinux33ME7W'], ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The HTTP request body.', + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the alert contact.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'target' => ['description' => 'The alert notification target. Currently, only DingTalk contacts are supported.', 'type' => 'string', 'required' => false, 'example' => 'dingtalk', 'title' => ''], + 'params' => [ + 'description' => 'The configuration parameters.', + 'type' => 'object', + 'properties' => [ + 'webhook' => ['description' => 'The webhook URL of the chatbot.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx'."\n", 'title' => ''], + 'sec' => ['description' => 'The secret key of the chatbot.', 'type' => 'string', 'required' => false, 'example' => 'SECxxx', 'title' => ''], + 'phone' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '1xxx', 'title' => ''], + 'email' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'xxx@email.com'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the alert contact.', 'type' => 'string', 'required' => false, 'example' => 'name1', 'title' => ''], + 'source' => ['description' => 'The configuration source.', 'type' => 'string', 'required' => false, 'example' => 'console', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], - 'operationType' => 'read', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization has failed. Check the `message` field for the detailed error message.', 'type' => 'string', 'example' => 'SysomOpenAPI.InvalidParameter', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => "\n" + .'Success', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '{'."\n" + .'"webhook":"",'."\n" + .'"sec":""'."\n" + .'}', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Sysom.ServerError', 'errorMessage' => 'Server error, please correct the code according to the error message. %s.', 'description' => 'Server error, please correct the code according to the error message'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update an alert contact', + 'summary' => 'Updates an alert contact.', + 'description' => '.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpdateAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"SysomOpenAPI.InvalidParameter\\",\\n \\"message\\": \\"\\\\nSuccess\\",\\n \\"data\\": \\"{\\\\n\\\\\\"webhook\\\\\\":\\\\\\"\\\\\\",\\\\n\\\\\\"sec\\\\\\":\\\\\\"\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + ], + 'UpdateAlertEnabled' => [ + 'summary' => 'Updates the status of a push alert policy.', + 'path' => '/api/v1/alertPusher/alert/updateEnabled', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], ], 'parameters' => [ [ - 'name' => 'taskId', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '任务ID'."\n", - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Specifies whether the alert policy is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'id' => ['description' => 'The ID of the alert policy.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', - ], - 'data' => [ - 'description' => '', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n"], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the error information of the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => '{'."\n" + .' "uid": "1808078950770264",'."\n" + .' "name": "test-name",'."\n" + .' "strategy": {'."\n" + .' "items": ['."\n" + .' "节点CPU使用率检测"'."\n" + .' ],'."\n" + .' "clusters": ['."\n" + .' "cluster1"'."\n" + .' ]'."\n" + .' },'."\n" + .' "enabled": true,'."\n" + .' "id": 1,'."\n" + .' "created_at": 1753172727,'."\n" + .' "updated_at": 1753172727'."\n" + .' }', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"success\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"1808078950770264\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"items\\\\\\": [\\\\n \\\\\\"节点CPU使用率检测\\\\\\"\\\\n ],\\\\n \\\\\\"clusters\\\\\\": [\\\\n \\\\\\"cluster1\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"enabled\\\\\\": true,\\\\n \\\\\\"id\\\\\\": 1,\\\\n \\\\\\"created_at\\\\\\": 1753172727,\\\\n \\\\\\"updated_at\\\\\\": 1753172727\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'Update alert policy status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:UpdateAlertEnabled', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateAlertStrategy' => [ + 'path' => '/api/v1/alertPusher/alert/updateStrategy', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinuxJZOVCX'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The HTTP request body.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The Policy Name of the alerting policy.', 'type' => 'string', 'required' => true, 'example' => 'strategy1', 'title' => ''], + 'id' => ['description' => 'The ID of the alert policy.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether the alert policy is enabled.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + 'strategy' => [ + 'description' => 'The details of the alert policy.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'title' => '任务ID', - 'description' => '', - 'type' => 'string', - 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7', - ], - 'createdAt' => [ - 'title' => '任务创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-12-02T17:36:12', - ], - 'diagnoseResult' => [ - 'title' => '诊断结果', - 'description' => '', - 'type' => 'string', - 'example' => 'result', - ], - 'errorMsg' => [ - 'title' => '诊断错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'error message', + 'items' => [ + 'description' => '接收告警的异常项合计', + 'type' => 'array', + 'items' => ['description' => '异常项名称', 'type' => 'string', 'required' => false, 'example' => '节点CPU使用率检测', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'taskType' => [ - 'title' => '任务类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'dmesg' => 'dmesg', - 'vmcore' => 'vmcore', - ], - 'example' => 'vmcore', + 'clusters' => [ + 'description' => 'The collection of clusters for which alerts are received.', + 'type' => 'array', + 'items' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'cluster1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'taskStatus' => [ - 'title' => '任务状态', + 'destinations' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'running' => 'running', - 'queuing' => 'queuing', - 'created' => 'created', - 'success' => 'success', - 'error' => 'error', - ], - 'example' => 'running', - ], - 'urls' => [ - 'title' => '任务携带的相关文件下载链接', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'debuginfoCommonUrl' => [ - 'title' => 'debuginfo-common rpm包下载链接', - 'description' => '', - 'type' => 'string', - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path', - ], - 'debuginfoUrl' => [ - 'title' => 'debuginfo rpm包下载链接', - 'description' => '', - 'type' => 'string', - 'example' => ' '."\n" - .'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path', - ], - 'dmesgUrl' => [ - 'title' => 'dmesg日志下载链接', - 'description' => '', - 'type' => 'string', - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path', - ], - 'vmcoreUrl' => [ - 'title' => 'vmcore文件下载链接', - 'description' => '', - 'type' => 'string', - 'example' => 'https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path', - ], - ], + 'title' => '', + 'example' => '', ], ], + 'required' => true, + 'title' => '', + 'example' => '', ], + 'k8sLabel' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization is failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => '更新告警策略失败', 'title' => ''], + 'data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '{'."\n" + .' "uid": "uid-1",'."\n" + .' "name": "test-name",'."\n" + .' "strategy": {'."\n" + .' "clusters": ["test-cluster-1","test-cluster-2"],'."\n" + .' "items": ["test-item1","test-item2"]'."\n" + .' },'."\n" + .' "enabled": True'."\n" + .'}', 'title' => ''], + ], + 'example' => '', + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"taskId\\": \\"bbe94a98-4192-4172-b856-95777e0a55d7\\",\\n \\"createdAt\\": \\"2025-12-02T17:36:12\\",\\n \\"diagnoseResult\\": \\"result\\",\\n \\"errorMsg\\": \\"error message\\",\\n \\"taskType\\": \\"vmcore\\",\\n \\"taskStatus\\": \\"running\\",\\n \\"urls\\": {\\n \\"debuginfoCommonUrl\\": \\"https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo-common/file/path\\",\\n \\"debuginfoUrl\\": \\"\\\\t\\\\nhttps://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/debuginfo/file/path\\",\\n \\"dmesgUrl\\": \\"https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/dmesg/file/path\\",\\n \\"vmcoreUrl\\": \\"https://bucket-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/vmcore/file/path\\"\\n }\\n }\\n}","type":"json"}]', - ], - 'ListVmcoreDiagnosisTask' => [ - 'summary' => '查询历史宕机诊断任务', - 'path' => '/api/v1/crashAgent/diagnosis/queryTaskList', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update alert policy', + 'summary' => 'Updates a push alert policy.', + 'changeSet' => [ + ['createdAt' => '2025-11-03T02:34:05.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:UpdateAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"更新告警策略失败\\",\\n \\"data\\": \\"{\\\\n \\\\\\"uid\\\\\\": \\\\\\"uid-1\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"test-name\\\\\\",\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"clusters\\\\\\": [\\\\\\"test-cluster-1\\\\\\",\\\\\\"test-cluster-2\\\\\\"],\\\\n \\\\\\"items\\\\\\": [\\\\\\"test-item1\\\\\\",\\\\\\"test-item2\\\\\\"]\\\\n },\\\\n \\\\\\"enabled\\\\\\": True\\\\n}\\"\\n}","type":"json"}]', + ], + 'UpdateEventsAttention' => [ + 'summary' => 'Updates the attention level of an anomaly item. Adjusting the attention level affects the sensitivity of the anomaly detection algorithm.', + 'path' => '/api/v1/openapi/proxy/post/cluster_update_events_attention', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '256747', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], - 'produces' => [ - 'application/json', + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'uuid' => ['description' => 'The UUID of the anomaly event.', 'type' => 'string', 'required' => true, 'example' => '03de78af-f49f-433d-b5b1-0f6a70c493ba', 'title' => ''], + 'range' => [ + 'description' => 'The scope in which the update takes effect. Valid values: cluster and node.', + 'enumValueTitles' => ['node' => 'node', 'cluster' => 'cluster'], + 'type' => 'string', + 'required' => false, + 'example' => 'cluster', + 'title' => '', + ], + 'mode' => [ + 'description' => 'The sensitivity of the anomaly event. Valid values: -1 to 3. A value of -1 indicates that the sensitivity is decreased by 1. A value of 0 indicates that the sensitivity is increased by 1.', + 'enumValueTitles' => ['0', '1', '2', '3', -1 => '-1'], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '-1', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code. Valid values:'."\n" + .'- Success: The authorization is successful.'."\n" + .'- Other values: The authorization failed. Check the message field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'Instance not belong to current user'], + 'data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'mode' => ['description' => 'The updated attention level value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => '44841312-7227-55C9-AE03-D59729BFAE38', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"Instance not belong to current user\\",\\n \\"data\\": {\\n \\"mode\\": 1\\n },\\n \\"RequestId\\": \\"44841312-7227-55C9-AE03-D59729BFAE38\\"\\n}","type":"json"}]', + 'title' => 'Update anomaly item attention level', + 'changeSet' => [ + ['createdAt' => '2025-03-12T10:58:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpdateEventsAttention', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateFuncSwitchRecord' => [ + 'summary' => 'Updates the configuration of a service feature module.', + 'path' => '/api/v1/func-switch/update-service-func-switch', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinux586OFI', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], ], 'parameters' => [ [ - 'name' => 'days', + 'name' => 'params', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '表示过去days天的任务，最多不超过30天', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The diagnostic parameters. Different types of diagnostics require different diagnostic parameters. You can use this field to filter records whose parameters match the specified values.', + 'type' => 'object', + 'properties' => [ + 'function_name' => ['description' => 'The feature name.', 'type' => 'string', 'required' => true, 'example' => 'mullprof', 'title' => ''], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'i-2zei55fwj8nnu31h3z46', 'title' => ''], + 'uid' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '1664516888213680', 'title' => ''], + 'op' => ['description' => 'The operation type.', 'type' => 'string', 'required' => false, 'example' => 'restart', 'title' => ''], + 'args' => [ + 'description' => 'The configuration parameters.', + 'type' => 'object', + 'properties' => [ + 'add_cmd' => ['description' => 'The configuration process.', 'type' => 'string', 'required' => false, 'example' => 'java', 'title' => ''], + 'mem' => ['description' => 'The memory tracing switch.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'locks' => ['description' => 'The lock tracing switch.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'java_store_path' => ['description' => 'The storage path.', 'type' => 'string', 'required' => false, 'example' => '/tmp/sysom/java-profiler', 'title' => ''], + 'system_profiling' => ['description' => 'The system tracing switch.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'cpu' => ['description' => 'The ONCPU tracing switch.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + 'loop' => ['description' => 'The tracing cycle.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', 'title' => ''], + 'pid' => ['description' => 'The process PID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1243', 'title' => ''], + 'duration' => ['description' => 'The start duration, in seconds (s).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'region' => ['description' => 'The region to which the instance belongs. All instance IDs passed in instances must belong to the same region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], 'required' => true, - 'example' => '3', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'service_name', + 'in' => 'query', + 'schema' => ['description' => 'The service name.', 'type' => 'string', 'required' => true, 'example' => 'livetrace', 'title' => ''], + ], + [ + 'name' => 'channel', + 'in' => 'query', + 'schema' => ['description' => 'The diagnostic channel. Currently, this parameter is fixed to the ECS channel.', 'type' => 'string', 'required' => true, 'example' => 'ecs', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2D693121-C925-5154-8DF6-C09A8B369822'], + 'code' => ['description' => 'The status code.'."\n" + .'- `code == Success` indicates that the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'result: code=1 msg=(Request failed, status_code != 200)', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '63fc5acb99e642d793f42912612e8001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"result: code=1 msg=(Request failed, status_code != 200)\\",\\n \\"data\\": {\\n \\"task_id\\": \\"63fc5acb99e642d793f42912612e8001\\"\\n }\\n}","type":"json"}]', + 'title' => 'Update service feature module configuration', + 'description' => '- Populate parameters according to the general LLM service input parameters, convert them to a string, and assign the string to llmParamString.'."\n" + .'- Convert the returned data from a string to a dict before use. Refer to the general LLM service response format.', + 'changeSet' => [ + ['createdAt' => '2025-03-12T06:46:08.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:UpdateFuncSwitchRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpgradeAgent' => [ + 'path' => '/api/v1/am/agent/upgrade_agent', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'description' => 'The list of instances for which you want to update the component.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The instance information.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'title' => '任务ID', - 'description' => '', - 'type' => 'string', - 'example' => 'bbe94a98-4192-4172-b856-95777e0a55d7'."\n", - ], - 'taskType' => [ - 'title' => '任务类型', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'dmesg' => 'dmesg', - 'vmcore' => 'vmcore', - ], - 'example' => 'vmcore', - ], - 'taskStatus' => [ - 'title' => '任务状态', - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'running' => 'running', - 'queuing' => 'queuing', - 'created' => 'created', - 'success' => 'success', - 'error' => 'error', - ], - 'example' => 'running', - ], - 'createdAt' => [ - 'title' => '任务创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-12-02T17:36:12'."\n", - ], - 'errorMsg' => [ - 'title' => '错误信息', - 'description' => '', - 'type' => 'string', - 'example' => 'error message', - ], + 'instance' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], + 'required' => true, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'total' => [ - 'title' => '任务总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', + 'agent_id' => ['description' => 'The ID of the component to update.', 'type' => 'string', 'required' => true, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agent_version' => ['description' => 'The version to which the component is updated.', 'type' => 'string', 'required' => true, 'example' => '3.4.0-1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate that the authorization has failed. Check the `message` field for the detailed fault information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error information.', 'type' => 'string', 'example' => 'SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict', 'title' => ''], + 'data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '391f5aeba2054f66b3aaef0136142fe2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.RegionNotSupport', 'errorMessage' => 'Region not supported.', 'description' => 'Region is not supported.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update a component', + 'summary' => 'Updates an installed component to a specified version.', + 'description' => 'Updating the Agent by calling this operation is asynchronous. After you call this operation, a task_id is returned. You can use this ID to call the GetAgentTask operation to query the execution status of the task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpgradeAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"code\\": \\"Success\\",\\n \\"data\\": [\\n {\\n \\"taskId\\": \\"bbe94a98-4192-4172-b856-95777e0a55d7\\\\n\\",\\n \\"taskType\\": \\"vmcore\\",\\n \\"taskStatus\\": \\"running\\",\\n \\"createdAt\\": \\"2025-12-02T17:36:12\\\\n\\",\\n \\"errorMsg\\": \\"error message\\"\\n }\\n ],\\n \\"total\\": 2\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict\\",\\n \\"data\\": {\\n \\"task_id\\": \\"391f5aeba2054f66b3aaef0136142fe2\\"\\n },\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\"\\n}","type":"json"}]', ], - 'CpuHighAgentStreamResponse' => [ - 'summary' => 'cpu高agent流式接口', - 'path' => '/api/v1/highCpuAgent/streamResponse', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'sse', - ], + 'UpgradeAgentForCluster' => [ + 'path' => '/api/v1/am/agent/upgrade_agent_by_cluster', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253539', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body.', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => ['description' => 'The cluster ID.'."\n" + ."\n" + .'> The cluster ID must be the ID of an ACK cluster.', 'type' => 'string', 'required' => false, 'example' => 'c1c187fd513cb41a19876bac0e6b05212', 'title' => ''], + 'agent_id' => ['description' => 'The component ID.', 'type' => 'string', 'required' => false, 'example' => '74a86327-3170-412c-8e67-da3389ec56a9', 'title' => ''], + 'agent_version' => ['description' => 'The component version.', 'type' => 'string', 'required' => false, 'example' => '3.4.0-1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The status code.'."\n" + .'- If `code == Success`, the authorization is successful.'."\n" + .'- Other status codes indicate authorization failure. In this case, check the `message` field for detailed error information.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'message' => ['description' => 'The error message.'."\n" + .'- If `code == Success`, this field is empty.'."\n" + .'- Otherwise, this field contains the request error message.', 'type' => 'string', 'example' => "\n" + .'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which can be used for end-to-end diagnostics.', 'type' => 'string', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7', 'title' => ''], + 'data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'task_id' => ['description' => 'The task ID.'."\n" + ."\n" + .'You can use this task ID to call the GetAgentTask operation to query the task execution status.', 'type' => 'string', 'example' => '7523e9e0ddc74d99a5236f4f4d5056e6', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'SysomOpenAPI.RegionNotSupport', 'errorMessage' => 'Region not supported.', 'description' => 'Region is not supported.'], + ], ], - 'produces' => [ - 'application/octet-stream', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update components for an ACK cluster', + 'summary' => 'Updates components for a cluster.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpgradeAgentForCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"\\\\nsuccess\\",\\n \\"RequestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\",\\n \\"data\\": {\\n \\"task_id\\": \\"7523e9e0ddc74d99a5236f4f4d5056e6\\"\\n }\\n}","type":"json"}]', + ], + 'UpgradeAgentWithType' => [ + 'summary' => '', + 'path' => '/api/v1/am/agent/upgradeAgent', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREalinuxGP5QJE', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREalinux586OFI'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ @@ -9862,62 +8997,1115 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'llmParamString' => [ + 'instances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instance' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'i-wz9b9vucz1iubsz8sjqo', 'title' => ''], + 'region' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => true, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, 'description' => '', + 'title' => '', + 'example' => '', + ], + 'agentId' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '74a86327-3170-412c-8e67-da3389ec56a9'."\n", 'title' => ''], + 'agentVersion' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '3.4.0-1', 'title' => ''], + 'instanceType' => [ 'type' => 'string', + 'enum' => ['ecs', 'eflo'], + 'description' => '', 'required' => false, - 'example' => '', + 'example' => 'ecs', + 'title' => '', ], ], + 'description' => '', 'required' => false, + 'title' => '', + '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' => '2D693121-C925-5154-8DF6-C09A8B369822'."\n", - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom', - ], + 'code' => ['type' => 'string', 'description' => '', 'example' => 'Success', 'title' => ''], + 'message' => ['type' => 'string', 'description' => '', 'example' => '“”', 'title' => ''], 'data' => [ + 'type' => 'object', + 'properties' => [ + 'taskId' => ['type' => 'string', 'description' => '', 'example' => '391f5aeba2054f66b3aaef0136142fe2'."\n", 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '<SSEResponse>', + 'title' => '', + 'example' => '', ], + 'requestId' => ['type' => 'string', 'description' => '', 'example' => 'B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7'."\n", 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '调用本接口更新 Agent 是异步的，调用接口后会返回一个 task_id，可以凭借该 ID 调用 GetAgentTask 接口获取任务的执行情况。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2D693121-C925-5154-8DF6-C09A8B369822\\\\n\\",\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom\\",\\n \\"data\\": \\"<SSEResponse>\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": \\"Success\\",\\n \\"message\\": \\"“”\\",\\n \\"data\\": {\\n \\"taskId\\": \\"391f5aeba2054f66b3aaef0136142fe2\\\\n\\"\\n },\\n \\"requestId\\": \\"B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7\\\\n\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sysom.cn-hangzhou.aliyuncs.com', 'endpoint' => 'sysom.cn-hangzhou.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'AgentConfigNotExists', 'message' => 'Agent config does not exist.', 'http_code' => 400, 'description' => 'Agent configuration does not exist'], + ['code' => 'PageInfoCreateFailed', 'message' => 'The page visited information record insert failed.', 'http_code' => 400, 'description' => 'Failed to add page access information.'], + ['code' => 'Sysom.ACKClusterNotFound', 'message' => 'The specified ACK cluster was not found. %s.', 'http_code' => 400, 'description' => 'The specified ACK cluster was not found'], + ['code' => 'Sysom.AIRecordStatusError', 'message' => 'This analysis records an incorrect status.%s.', 'http_code' => 400, 'description' => 'The analysis records a state error.'], + ['code' => 'Sysom.ClusterIsNotRunning', 'message' => 'The cluster status is not Running and may be in operation. %s.', 'http_code' => 400, 'description' => 'The cluster status is not Running and may be in operation. Please try again later.'], + ['code' => 'Sysom.ClusterNotFound', 'message' => 'The specified ACK cluster was not found.', 'http_code' => 200, 'description' => 'The specified ACK cluster was not found'], + ['code' => 'Sysom.ClusterRegionNotMatch', 'message' => 'Cluster region not match. %s.', 'http_code' => 400, 'description' => 'the region passed when calling the api is not the same as the region where the cluster is located.'], + ['code' => 'Sysom.EndpointConnectionNotExists', 'message' => 'The endpoint connection does not exist, and the cluster does not authorize SysOM to read cluster information. %s.', 'http_code' => 400, 'description' => 'The endpoint connection does not exist, and the cluster does not authorize SysOM to read cluster information.'], + ['code' => 'Sysom.EndpointConnectTimeout', 'message' => 'Connect VpcEndpoint timeout. %s.', 'http_code' => 400, 'description' => 'Connection endpoint timed out.'], + ['code' => 'Sysom.GetClusterConfigFailed', 'message' => 'Get cluster config failed. %s.', 'http_code' => 400, 'description' => 'Failed to get ACK cluster configuration.'], + ['code' => 'Sysom.InvalidParameter', 'message' => 'Invalid parameters passed when calling the interface. %s.', 'http_code' => 400, 'description' => 'Invalid parameter passed when calling interface'], + ['code' => 'Sysom.InvalidParameter', 'message' => 'Invalid parameters passed when calling the interface. %s', 'http_code' => 400, 'description' => 'Invalid parameter passed when calling interface'."\n"], + ['code' => 'Sysom.MissingParameter', 'message' => 'Missing parameters. %s.', 'http_code' => 400, 'description' => 'Missing parameter'], + ['code' => 'Sysom.ServerError', 'message' => 'Server error, please correct the code according to the error message. %s.', 'http_code' => 400, 'description' => 'Server error, please correct the code according to the error message'], + ['code' => 'Sysom.VpcEndpointServiceNotSupport', 'message' => 'SysOM has not launched VpcEndpointService in this region. %s.', 'http_code' => 400, 'description' => 'SysOM is not VpcEndpointService in the region.'], + ['code' => 'Sysom.VpcNatNotSupport', 'message' => 'SysOM has not launched VpcNat in this region. %s.', 'http_code' => 400, 'description' => 'VpcNat is not enabled for SysOM in the region.'], + ['code' => 'SysomOpenAPI.AgentConfigDuplicate', 'message' => 'Agent config already exists, please change the name. %s.', 'http_code' => 400, 'description' => 'Configuration name conflict. You are not allowed to create a configuration with the same name.'], + ['code' => 'SysomOpenAPI.AgentConfigNotExists', 'message' => 'Agent config does not exists.', 'http_code' => 400, 'description' => 'Agent configuration does not exist'], + ['code' => 'SysomOpenAPI.AgentNotExists', 'message' => 'Agent not exists.', 'http_code' => 400, 'description' => 'Agent does not exist.'], + ['code' => 'SysomOpenAPI.AgentTaskJobNotFinish', 'message' => 'Agent Task Job is already running on instances.', 'http_code' => 400, 'description' => 'An installation task is already running'], + ['code' => 'SysomOpenAPI.AgentTaskNotFound', 'message' => 'Agent task not found.', 'http_code' => 400, 'description' => 'Component task does not exist.'], + ['code' => 'SysomOpenAPI.AgentVersionNotExists', 'message' => 'Agent version not exists.', 'http_code' => 400, 'description' => 'Agent version does not exist.'], + ['code' => 'SysomOpenAPI.ClusterNotExists', 'message' => 'The cluster does not exist. %s.', 'http_code' => 400, 'description' => 'The cluster does not exist.'], + ['code' => 'SysomOpenAPI.ClusterStatusNotRunning', 'message' => 'Cluster The cluster status is not Running and may be in operation. Please try again later.', 'http_code' => 400, 'description' => 'The cluster status is not Running and may be in operation. Please try again later.'], + ['code' => 'SysomOpenAPI.InstanceNotExists', 'message' => 'Instance not exists.', 'http_code' => 400, 'description' => 'Instance does not exist'], + ['code' => 'SysomOpenAPI.InstanceNotSupport', 'message' => 'Instance not support by sysom.', 'http_code' => 400, 'description' => 'SysOM does not support managing the instance.'], + ['code' => 'SysomOpenAPI.InvalidParameter', 'message' => 'Invalid parameters passed when calling the interface.', 'http_code' => 400, 'description' => 'Invalid parameter passed when calling interface'], + ['code' => 'SysomOpenAPI.MissingParameter', 'message' => 'Missing parameters.', 'http_code' => 400, 'description' => 'Missing parameter'], + ['code' => 'SysomOpenAPI.NoAgentInstalled', 'message' => 'No SysOM Agent version available.', 'http_code' => 400, 'description' => 'No SysOM Agent is available.'], + ['code' => 'SysomOpenAPI.NotAuthorizedInstance', 'message' => 'Instance not authorized.', 'http_code' => 400, 'description' => 'The instance is not authorized.'], + ['code' => 'SysomOpenAPI.NotFoundAIRecord', 'message' => 'This analysis record was not found. Please check if the analysis id is correct. %s.', 'http_code' => 400, 'description' => 'the analysis record is not found. check whether the analysis id is correct.'], + ['code' => 'SysomOpenAPI.NotOwnInstance', 'message' => 'Not own current instance.', 'http_code' => 400, 'description' => 'The specified instance does not belong to the current user.'], + ['code' => 'SysomOpenAPI.NotOwnTask', 'message' => 'Diagnosis result does not belong to the current account.', 'http_code' => 400, 'description' => 'Diagnosis result does not belong to the current account'], + ['code' => 'SysomOpenAPI.NotSupportedAgentVersion', 'message' => 'Unsupported sysom agent version.', 'http_code' => 400, 'description' => 'Unsupported SysOM client version.'], + ['code' => 'SysomOpenAPI.ServerError', 'message' => 'Server error, please correct the code according to the error message.', 'http_code' => 400, 'description' => 'Server error, please correct the code according to the error message'], + ['code' => 'Sysom.ConcurrentTaskLimitExceeded', 'message' => 'The maximum number of concurrent tasks has been exceeded.', 'http_code' => 400, 'description' => 'Maximum number of concurrent tasks exceeded'], + ['code' => 'SysomOpenAPI.OperationInProgress', 'message' => 'The cluster is being operated, please try again later.', 'http_code' => 400, 'description' => 'The cluster is performing another operation, please try again later.'], + ['code' => 'SysomOpenAPI.ServiceRoleNotExists', 'message' => 'Service role does not exist, please init the sysom service first.', 'http_code' => 400, 'description' => 'The service role does not exist. Activate the Alinux console first.'], + ['code' => 'SysomOpenAPI.RegionNotSupport', 'message' => 'Region not supported.', 'http_code' => 400, 'description' => 'Region is not supported.'], + ['code' => 'Sysom.TaskNotFound', 'message' => 'The specified task was not found.', 'http_code' => 400, 'description' => 'The specified task was not found.'], + ['code' => 'SysomOpenAPI.ResourceNotFound', 'message' => 'The specified resource is not found. %s.', 'http_code' => 404, 'description' => 'The resource does not exist.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAgentTask'], + ], + 'createdAt' => '2025-11-03T02:41:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAlertStrategy'], + ['description' => 'Response parameters changed', 'api' => 'GetAlertStrategy'], + ['description' => 'Response parameters changed', 'api' => 'ListAlertStrategies'], + ['description' => 'Request parameters changed', 'api' => 'UpdateAlertStrategy'], + ], + 'createdAt' => '2025-11-03T02:34:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAbnormalEventsCount'], + ], + 'createdAt' => '2024-12-24T14:08:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AuthDiagnosis'], + ], + 'createdAt' => '2024-09-18T04:40:29.000Z', + 'description' => '', + ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'sysom.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetDiagnosisResult'], + ], + 'createdAt' => '2024-09-18T03:31:17.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ram' => [ + 'productCode' => 'SYSOM', + 'productName' => 'Alibaba Cloud Linux', + 'ramCodes' => ['sysom'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetServiceFuncStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetServiceFuncStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotspotPidList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotPidList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateVmcoreDiagnosisTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CreateVmcoreDiagnosisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeMetricList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:DescribeMetricList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlertItems', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:ListAlertItems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAIQueryResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAIQueryResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AuthDiagnosis', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:AuthDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlertDestination', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAlertStrategy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GetAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotspotTracking', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotTracking', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAbnormalyEvents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAbnormalyEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAlertDestination', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sysom:DeleteAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstancesWithEcsInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:ListInstancesWithEcsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotspotInstanceList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotInstanceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListClusters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotspotAnalysis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDiagnosisResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetDiagnosisResult', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'Diagnosis', 'arn' => 'acs:sysom::{#accountId}:diagnosis/{#DiagnosisId}'], + ], + ], + ], + [ + 'apiName' => 'InstallAgentForCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InstallAgentForCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListPluginsInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:ListPluginsInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstantScore', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetInstantScore', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartAIAnalysis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:StartAIAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlertStrategies', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAlertStrategies', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateClusterVpcEndpointConnection', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:CreateClusterVpcEndpointConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAllInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAllInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAgents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAgents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRangeScore', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetRangeScore', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InitialSysom', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InitialSysom', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAgent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAlertStrategy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:UpdateAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAlertStrategy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CreateAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAgentInstallRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAgentInstallRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartAIDiffAnalysis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:StartAIDiffAnalysis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetProblemPercentage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetProblemPercentage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeAgentForCluster', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpgradeAgentForCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlertDestinations', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListAlertDestinations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceStatus', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListInstanceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAbnormalEventsCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAbnormalEventsCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InvokeDiagnosis', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InvokeDiagnosis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'Diagnosis', 'arn' => 'acs:sysom::{#accountId}:diagnosis/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAlertEnabled', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:UpdateAlertEnabled', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAlertStrategy', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sysom:DeleteAlertStrategy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHostCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHostCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeAgent', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpgradeAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckInstanceSupport', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CheckInstanceSupport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateCopilotResponse', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GenerateCopilotResponse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstancesEcsInfoList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:ListInstancesEcsInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotspotCompare', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHotspotCompare', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetListRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetListRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CpuHighAgentStreamResponse', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:CpuHighAgentStreamResponse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotSpotUniqList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:hotSpotUniqList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetBasicResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UninstallAgent', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sysom:UninstallAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateInstanceInspection', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:CreateInstanceInspection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInspectionReport', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetInspectionReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCopilotHistory', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:GetCopilotHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceHealth', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListInstanceHealth', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAlertDestination', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:CreateAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListPodsOfInstance', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListPodsOfInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateEventsAttention', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpdateEventsAttention', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UninstallAgentForCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:UninstallAgentForCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetVmcoreDiagnosisTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GetVmcoreDiagnosisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHealthPercentage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetHealthPercentage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InvokeAnomalyDiagnosis', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sysom:InvokeAnomalyDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClusterAgentInstallRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListClusterAgentInstallRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDiagnosis', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListDiagnosis', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateCopilotStreamResponse', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:GenerateCopilotStreamResponse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAlertDestination', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sysom:UpdateAlertDestination', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InstallAgent', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:InstallAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAgentTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:GetAgentTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRegions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'sysom:ListRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListVmcoreDiagnosisTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sysom:ListVmcoreDiagnosisTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFuncSwitchRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sysom:UpdateFuncSwitchRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SYSOM', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Diagnosis', 'arn' => 'acs:sysom::{#accountId}:diagnosis/{#DiagnosisId}'], + ['validationType' => 'always', 'resourceType' => 'Diagnosis', 'arn' => 'acs:sysom::{#accountId}:diagnosis/*'], ], ], ]; |