diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/sofa/2019-08-15/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/sofa/2019-08-15/api-docs.php')
| -rw-r--r-- | data/zh_cn/sofa/2019-08-15/api-docs.php | 11470 |
1 files changed, 3959 insertions, 7511 deletions
diff --git a/data/zh_cn/sofa/2019-08-15/api-docs.php b/data/zh_cn/sofa/2019-08-15/api-docs.php index 9d8d239..12418d5 100644 --- a/data/zh_cn/sofa/2019-08-15/api-docs.php +++ b/data/zh_cn/sofa/2019-08-15/api-docs.php @@ -1,241 +1,87 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'SOFA', - 'version' => '2019-08-15', - ], + 'info' => ['style' => 'RPC', 'product' => 'SOFA', 'version' => '2019-08-15'], 'directories' => [ [ - 'id' => 122090, - 'title' => 'MsConfig', + 'children' => ['DeleteMsConfigAttributes', 'DeleteMsConfigResources', 'UpdateMsConfigAttributes', 'UpdateMsConfigResources', 'GetMsConfigAttributes', 'GetMsConfigResources', 'QueryMsConfigAttributes', 'QueryMsConfigClients', 'QueryMsConfigClientValues', 'QueryMsConfigData', 'QueryMsConfigResources', 'GrayPushMsConfigData', 'PushMsConfigData'], 'type' => 'directory', - 'children' => [ - 'DeleteMsConfigAttributes', - 'DeleteMsConfigResources', - 'UpdateMsConfigAttributes', - 'UpdateMsConfigResources', - 'GetMsConfigAttributes', - 'GetMsConfigResources', - 'QueryMsConfigAttributes', - 'QueryMsConfigClients', - 'QueryMsConfigClientValues', - 'QueryMsConfigData', - 'QueryMsConfigResources', - 'GrayPushMsConfigData', - 'PushMsConfigData', - ], + 'title' => 'MsConfig', + 'id' => 318924, ], [ - 'id' => 122104, - 'title' => 'Sofamq', - 'type' => 'directory', 'children' => [ - 'CreateMqSofamqGroup', - 'DeleteMqSofamqGroup', - 'DeleteMqSofamqTopic', - 'DeleteMqSofamqTrace', - 'DeleteMqSofamqWarn', - 'UpdateMqSofamqGroupRemark', - 'UpdateMqSofamqWarn', - 'DisableMqSofamqWarn', - 'EnableMqSofamqWarn', - 'GetMqSofamqConsumerJStack', - 'GetMqSofamqConsumerStatus', - 'GetMqSofamqDLQMessageById', - 'GetMqSofamqMessageById', - 'GetMqSofamqTraceByMsgId', - 'GetMqSofamqTraceResult', - 'ListMqSofamqGroup', - 'ListMqSofamqTopic', - 'ListMqSofamqTrace', - 'ListMqSofamqWarn', - 'ListMqSofamqWarnHistory', - 'QueryMqSofamqConsumerAccumulate', - 'QueryMqSofamqConsumerConnection', - 'QueryMqSofamqConsumerTimespan', - 'QueryMqSofamqDLQMessageByGroupId', - 'QueryMqSofamqGroupSubDetail', - 'QueryMqSofamqMessageByKey', - 'QueryMqSofamqMessageByTopic', - 'ResendMqSofamqDLQMessageBatch', - 'ResendMqSofamqDLQMessageById', - 'ResetMqSofamqConsumerOffset', + 'CreateMqSofamqGroup', 'DeleteMqSofamqGroup', 'DeleteMqSofamqTopic', 'DeleteMqSofamqTrace', 'DeleteMqSofamqWarn', 'UpdateMqSofamqGroupRemark', 'UpdateMqSofamqWarn', 'DisableMqSofamqWarn', 'EnableMqSofamqWarn', 'GetMqSofamqConsumerJStack', 'GetMqSofamqConsumerStatus', 'GetMqSofamqDLQMessageById', 'GetMqSofamqMessageById', 'GetMqSofamqTraceByMsgId', 'GetMqSofamqTraceResult', 'ListMqSofamqGroup', 'ListMqSofamqTopic', 'ListMqSofamqTrace', 'ListMqSofamqWarn', 'ListMqSofamqWarnHistory', + 'QueryMqSofamqConsumerAccumulate', 'QueryMqSofamqConsumerConnection', 'QueryMqSofamqConsumerTimespan', 'QueryMqSofamqDLQMessageByGroupId', 'QueryMqSofamqGroupSubDetail', 'QueryMqSofamqMessageByKey', 'QueryMqSofamqMessageByTopic', 'ResendMqSofamqDLQMessageBatch', 'ResendMqSofamqDLQMessageById', 'ResetMqSofamqConsumerOffset', ], + 'type' => 'directory', + 'title' => 'Sofamq', + 'id' => 318938, ], [ - 'id' => 122139, - 'title' => 'Topic', + 'children' => ['CreateMqSofamqTopic', 'UpdateMqSofamqTopicRemark'], 'type' => 'directory', - 'children' => [ - 'CreateMqSofamqTopic', - 'UpdateMqSofamqTopicRemark', - ], + 'title' => 'Topic', + 'id' => 318972, ], [ - 'id' => 122158, - 'title' => 'Cas', + 'children' => ['DescribeCasComputers'], 'type' => 'directory', - 'children' => [ - 'DescribeCasComputers', - ], + 'title' => 'Cas', + 'id' => 318976, ], [ - 'id' => 122169, - 'title' => 'DMS', + 'children' => ['AddMsConfigAttributes', 'AddMsConfigResources'], 'type' => 'directory', - 'children' => [ - 'AddMsConfigAttributes', - 'AddMsConfigResources', - ], + 'title' => 'DMS', + 'id' => 318978, ], [ - 'id' => 122172, - 'title' => 'RMS', + 'children' => ['UpdateRMSUnifiedAlarmRule', 'CreateRMSUnifiedAlarmRule', 'DeleteRMSUnifiedAlarmRule', 'QueryRMSUnifiedAlarmEvent', 'QueryRMSUnifiedAlarmRule', 'QueryRMSUnifiedAlarmHistory', 'QueryRMSUnifiedAlarmNotifyHistory', 'QueryRMSMetrics'], 'type' => 'directory', - 'children' => [ - 'UpdateRMSUnifiedAlarmRule', - 'CreateRMSUnifiedAlarmRule', - 'DeleteRMSUnifiedAlarmRule', - 'QueryRMSUnifiedAlarmEvent', - 'QueryRMSUnifiedAlarmRule', - 'QueryRMSUnifiedAlarmHistory', - 'QueryRMSUnifiedAlarmNotifyHistory', - 'QueryRMSMetrics', - ], + 'title' => 'RMS', + 'id' => 318981, ], [ - 'id' => 169573, - 'title' => '其他', + 'children' => ['LogoutMsRegistryService'], 'type' => 'directory', - 'children' => [ - 'LogoutMsRegistryService', - ], + 'title' => '其他', + 'id' => 318990, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DeleteMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddMsConfigAttributes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '108190', - 'abilityTreeNodes' => [ - 'FEATUREsofaNCKPTU', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'AttributeName', 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '属性名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'age'], ], [ - 'name' => 'InstanceId', + 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMsConfigAttributesResponse>\\n <ResultMessage>OK</ResultMessage>\\n <ResultCode>OK</ResultCode>\\n <RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n</DeleteMsConfigAttributesResponse>","errorExample":""}]', - 'title' => '删除属性元信息', - 'summary' => '根据属性 ID 删除对应的属性元信息。删除属性元信息，属性值不会删除。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => '属性描述信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '年龄'], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '资源自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ - 'name' => 'InstanceId', + 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '所属的资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100'], ], ], 'responses' => [ @@ -243,319 +89,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'Attribute' => [ + 'description' => '添加成功的属性结构体', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'example' => 'switch'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '属性描述信息', 'type' => 'string', 'example' => '活动开关'], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '删除指定资源', - 'summary' => '根据资源 ID 删除对应资源，删除资源会同时删除对应资源下所有的属性信息。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Attribute\\": {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>357EA602-4A8C-456E-82D9-720C843F8EE4</RequestId>\\n<Attribute>\\n <Desc>性别</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <AttributeName>sex</AttributeName>\\n <Id>11</Id>\\n</Attribute>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '增加属性元信息', + 'summary' => '在配置文件配置项中增加属性，只有添加属性之后，才能对属性进行推送。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '111056', - 'abilityTreeNodes' => [ - 'FEATUREsofaNCKPTU', - ], - ], - 'parameters' => [ - [ - 'name' => 'AttributeName', - 'in' => 'formData', - 'schema' => [ - 'description' => '属性名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'age', - ], - ], - [ - 'name' => 'Desc', - 'in' => 'formData', - 'schema' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '年龄', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码，取值为： OK、INTERNALERROR、ERRPERMISSIONDENIED、ERRNOTENABLED、INVALIDSIGNATURE、ERRORREQUEST、ACCESSDENIED、MISSINGPARAMETER、ERRORINTERNALPROVIDER、BADPROVIDER_RESPONSE。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'changeSet' => [ + ['createdAt' => '2025-03-12T03:15:50.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>894900FD-184F-42C1-A53C-82B114154BE1</RequestId>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'UpdateMsConfigAttributes', - 'summary' => '根据属性 ID 更新属性元信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddMsConfigResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '应用名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'foo', - ], + 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'foo'], ], [ 'name' => 'Attributes', 'in' => 'formData', - 'schema' => [ - 'description' => '资源的属性信息，以 JSON 字符串格式传入', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"attributeName":"age","desc":"描述信息"}]', - ], + 'schema' => ['description' => '资源的属性信息，以 JSON 字符串格式传入', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[ { "attribute_name":"attName", "desc":"some attribute comment" }, ... ]'], ], [ 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '资源描述信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '测试资源', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '更新的资源自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '资源描述信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试资源类'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '系统字段：环境实例 ID'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '资源搜索的域', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Alipay', - ], + 'schema' => ['description' => '资源类所属的域', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alipay'], ], [ 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '资源唯一标识', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.test.resource', - ], - ], - [ - 'name' => 'UpdateAttribute', - 'in' => 'formData', - 'schema' => [ - 'description' => '是否全量更新属性，默认为 false', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - ], - ], - ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '更新资源元信息', - 'summary' => 'update_attribute 为 false 时，则只更新资源元信息，不会更新属性信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '109214', - 'abilityTreeNodes' => [ - 'FEATUREsofaNCKPTU', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '资源 ID，类似于配置文件的文件名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alipay.test.resource'], ], ], 'responses' => [ @@ -563,277 +178,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Attribute' => [ - 'description' => '属性信息', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '属性名', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Attribute\\": {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D7917DBF-CAA6-479E-8F26-3043AD7AAD11</RequestId>\\n<Attribute>\\n <Desc>男</Desc>\\n <InstanceId>AWHNEX3GFLJT</InstanceId>\\n <AttributeName>sex</AttributeName>\\n <Id>1</Id>\\n</Attribute>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '获取属性信息', - 'summary' => '根据属性 ID 获取对应的属性信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '109215', - 'abilityTreeNodes' => [ - 'FEATUREsofaNCKPTU', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '资源自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Resource' => [ - 'description' => '资源信息', + 'description' => '创建成功的资源信息', 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => '应用名', - 'type' => 'string', - 'example' => 'drmdemo', - ], - 'Region' => [ - 'description' => '资源所属的域', - 'type' => 'string', - 'example' => 'Alipay', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'ResourceId' => [ - 'description' => '资源 ID', - 'type' => 'string', - 'example' => 'com.alipay.drmResource', - ], - 'Id' => [ - 'description' => '资源自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '资源描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], + 'AppName' => ['description' => '应用名', 'type' => 'string', 'example' => 'drmdemo'], + 'Region' => ['description' => '资源所属的域', 'type' => 'string', 'example' => 'Alipay'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'ResourceId' => ['description' => '资源 ID', 'type' => 'string', 'example' => 'com.alipay.drmResource'], + 'Id' => ['description' => '资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '资源描述信息', 'type' => 'string', 'example' => '活动开关'], 'Attributes' => [ - 'description' => '资源下所有属性信息', + 'description' => '属性列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '属性名', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'example' => 'switch'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '属性描述信息', 'type' => 'string', 'example' => '活动开关'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Resource\\": {\\n \\"AppName\\": \\"drmdemo\\",\\n \\"Region\\": \\"Alipay\\",\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"ResourceId\\": \\"com.alipay.drmResource\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\",\\n \\"Attributes\\": [\\n {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F127DCFE-05FE-4740-AD07-18598BF37289</RequestId>\\n<Resource>\\n <Desc>测试资源类</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <ResourceId>com.alipay.resource</ResourceId>\\n <Attributes>\\n <Desc>姓名</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <AttributeName>name</AttributeName>\\n <Id>27</Id>\\n </Attributes>\\n <Attributes>\\n <Desc>性别</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <AttributeName>sex</AttributeName>\\n <Id>28</Id>\\n </Attributes>\\n <Region>Alipay</Region>\\n <Id>1</Id>\\n <AppName>foo</AppName>\\n</Resource>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '获取资源元信息', - 'summary' => '根据资源 ID 获取资源元信息。', + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Resource\\": {\\n \\"AppName\\": \\"drmdemo\\",\\n \\"Region\\": \\"Alipay\\",\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"ResourceId\\": \\"com.alipay.drmResource\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\",\\n \\"Attributes\\": [\\n {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>AD040CD2-9302-4C74-89A5-2AF0C220B1B9</RequestId>\\n<Resource>\\n <Desc>这是描述</Desc>\\n <InstanceId>AWHNEX3GFLJT</InstanceId>\\n <ResourceId>com.alipay.test.resource1</ResourceId>\\n <Region>Alipay</Region>\\n <Id>44</Id>\\n <AppName>someAppName</AppName>\\n</Resource>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '增加资源元数据', + 'summary' => '资源相当于文件的概念，一个资源下可以有多个属性。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateMqSofamqGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '应用名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'demo-app', - ], + 'schema' => ['description' => '创建的消息端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_group_id'], ], [ - 'name' => 'AttributeName', + 'name' => 'GroupType', 'in' => 'formData', - 'schema' => [ - 'description' => '属性名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'age', - ], + 'schema' => ['description' => '分组类型', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tcp'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], - ], - [ - 'name' => 'Region', - 'in' => 'formData', - 'schema' => [ - 'description' => '资源所属域', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Alipay', - ], + 'schema' => ['description' => '需创建的 Group ID 所对应的实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001'], ], [ - 'name' => 'ResourceId', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '资源 ID，类似于文件名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.alipay.test', - ], + 'schema' => ['description' => 'Group ID 描述信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'], ], ], 'responses' => [ @@ -841,124 +274,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Attribute' => [ - 'description' => '属性信息', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '属性名', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], - ], - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Attribute\\": {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取属性详细信息', - 'summary' => '根据域,、应用名、资源 ID、属性名称获取属性详细信息，包含属性 ID。其它接口都依赖此接口获取属性 ID。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => 'CreateMqSofamqGroup', + 'summary' => '创建 Group ID。创建的 Group ID 用于发布和订阅消息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMsConfigClients' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateMqSofamqTopic' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'AttributeId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID，通过查询属性方式获取 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '需创建的 Topic 所对应的实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000001'], ], [ - 'name' => 'InstanceId', + 'name' => 'MessageType', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '消息类型。取值说明如下：0：普通消息；1：分区顺序消息；2：全局顺序消息；4：事务消息；5：定时/延时消息。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '0'], ], [ - 'name' => 'PageNum', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数，页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Topic 的备注信息', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '测试'], ], [ - 'name' => 'PageSize', + 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数，分页大小', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => '需创建的 Topic 的名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -966,557 +342,167 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '分页参数，第几页', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'description' => '分页参数，分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '客户端总数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Clients' => [ - 'description' => '客户端信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PushData' => [ - 'description' => '推送的值', - 'type' => 'string', - 'example' => 'switch', - ], - 'Ip' => [ - 'description' => '客户端 IP', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'Data' => [ - 'description' => '客户端内存里的值', - 'type' => 'string', - 'example' => 'switch', - ], - 'Cell' => [ - 'description' => '所属的 cell', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - ], - ], - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Clients\\": [\\n {\\n \\"PushData\\": \\"switch\\",\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"Data\\": \\"switch\\",\\n \\"Cell\\": \\"DEFAULT\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<clients>\\n <data>DJ9P4BRNBL0S</data>\\n <ip>10.15.232.101</ip>\\n <push_data>DJ9P4BRNBL0S</push_data>\\n <cell>shanghai-et15</cell>\\n</clients>\\n<page_num>1</page_num>\\n<page_size>10</page_size>\\n<result_code>OK</result_code>\\n<result_msg>SUCCESS</result_msg>\\n<total_count>4</total_count>","errorExample":""}]', - 'title' => '查询一个属性所有订阅的客户端信息', - 'summary' => '查询一个属性所有订阅的客户端信息。动态配置客户端在启动的时候，会与服务端建立长连接，并告知动态配置服务端自身关联的属性信息，通过此长连接可以查询到所有订阅属性的客户端信息。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '在指定环境实例下创建一个 Topic', + 'summary' => '需要指定消息类型与 Topic 名称。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMsConfigClientValues' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRMSUnifiedAlarmRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AttributeId', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID，可以通过查询属性接口获取 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '报警规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'uitest1645783390369'], ], [ - 'name' => 'InstanceId', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '规则类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CUSTOM'], ], [ - 'name' => 'Ips', + 'name' => 'RuleConfig', 'in' => 'formData', - 'schema' => [ - 'description' => '查询的 IP 列表，英文逗号隔开', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.0.1,127.0.0.2', - ], + 'schema' => ['description' => '规则配置信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"trafficType\\":\\"i\\",\\"methodName\\":\\"*\\",\\"faultInjectRuleItems\\":[{\\"action\\":{\\"type\\":\\"REJECT\\"},\\"ruleType\\":\\"ABORT\\",\\"configs\\":{\\"faultPercent\\":100}}]} '], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Clients' => [ - 'description' => '客户端信息，包含内存值', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Ip' => [ - 'description' => '客户端 IP', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'Data' => [ - 'description' => '客户端内存里的值', - 'type' => 'string', - 'example' => 'switch', - ], - 'Success' => [ - 'description' => '是否查询成功', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Clients\\": [\\n {\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"Data\\": \\"switch\\",\\n \\"Success\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C8D232D5-C898-4084-880C-B8FD836AB143</RequestId>\\n<Clients>\\n <Ip>127.0.0.1</Ip>\\n <Success>false</Success>\\n</Clients>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '查询客户端的内存值', - 'summary' => '根据属性 ID 查询指定客户端的内存值。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryMsConfigData' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AlarmNodata', + 'in' => 'formData', + 'schema' => ['description' => '报警通知结果数据', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'AttributeId', + 'name' => 'Level', 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID，可以通过查询属性接口获取 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Prometheus告警规则的等级。'."\n" + ."\n" + .'- P1：一般用于影响核心业务可用性，影响范围很大，可能导致严重后果的重大问题的告警通知。'."\n" + .'- P2：一般用于部分业务出错，会对系统可用性造成一定影响，但是影响范围相对有限的问题的告警通知。'."\n" + .'- P3：一般用于对可能导致业务出错或者受影响的问题的告警通知，或者在相对重要程度较低的业务发送的告警通知。'."\n" + .'- P4： 用于需要通知，但是优先级较低，也不会对业务造成影响的场景发送告警通知。'."\n" + .'- 默认：如果不需要区分告警等级，可以使用默认级别。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1'], ], [ - 'name' => 'InstanceId', + 'name' => 'Emergency', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'QueryResult' => [ - 'description' => '查询推送值结果，数组中每一项表示具体的单元，DEFAULT_ZONE 表示所有单元。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '推送值', - 'type' => 'string', - 'example' => 'some push data', - ], - 'Cell' => [ - 'description' => '推送目标 cell', - 'type' => 'string', - 'example' => 'cell1', - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => '应急处理人', 'type' => 'string', 'required' => false, 'docRequired' => false], ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"QueryResult\\": [\\n {\\n \\"Data\\": \\"some push data\\",\\n \\"Cell\\": \\"cell1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryResult>\\n <Data>强势推送思密达</Data>\\n <Cell>ZONEA</Cell>\\n</QueryResult>\\n<RequestId>5C8C4130-BFDB-4AC2-A61C-2D26B1DDCC7B</RequestId>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '查询属性最后一次推送值', - 'summary' => '根据属性 ID 查询其最后一次推送值。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EmergencyUrl', + 'in' => 'formData', + 'schema' => ['description' => '应急处理链接', 'type' => 'string', 'required' => false, 'docRequired' => false], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'PendingHit', 'in' => 'formData', - 'schema' => [ - 'description' => '应用名', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'foo', - ], + 'schema' => ['description' => ' 触发周期', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'InstanceId', + 'name' => 'RecoveredHit', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '恢复周期', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'Keyword', + 'name' => 'Step', 'in' => 'formData', - 'schema' => [ - 'description' => '资源 ID 模糊查询关键字', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'com.alipay.drmResource', - ], + 'schema' => ['description' => '检测频率', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1'], ], [ - 'name' => 'PageNum', + 'name' => 'SilenceTime', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数，第几页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '通知静默时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '300'], ], [ - 'name' => 'PageSize', + 'name' => 'NotifyFiring', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数，分页大小。默认值为 10', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => '分页参数，第几页', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'description' => '分页参数，分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '满足模糊查询条件的结果总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Resources' => [ - 'description' => '模糊查询资源结果', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '应用名', - 'type' => 'string', - 'example' => 'drmdemo', - ], - 'Region' => [ - 'description' => '资源所属的域', - 'type' => 'string', - 'example' => 'Alipay', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'ResourceId' => [ - 'description' => '资源 ID', - 'type' => 'string', - 'example' => 'com.alipay.drmResource', - ], - 'Id' => [ - 'description' => '资源自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '资源描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], - 'Attributes' => [ - 'description' => '属性列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '属性名', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => '告警触发时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Resources\\": [\\n {\\n \\"AppName\\": \\"drmdemo\\",\\n \\"Region\\": \\"Alipay\\",\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"ResourceId\\": \\"com.alipay.drmResource\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\",\\n \\"Attributes\\": [\\n {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>2</TotalCount>\\n<RequestId>2BFB4C50-A7EE-4803-A53D-32036246F53F</RequestId>\\n<PageNum>1</PageNum>\\n<PageSize>10</PageSize>\\n<Resources>\\n <Desc>这是描述</Desc>\\n <InstanceId>AWHNEX3GFLJA</InstanceId>\\n <ResourceId>com.alipay.test.resource1</ResourceId>\\n <Region>Alipay</Region>\\n <Id>41</Id>\\n <AppName>someAppName1</AppName>\\n</Resources>\\n<Resources>\\n <Desc>这是描述</Desc>\\n <InstanceId>AWHNEX3GFLJA</InstanceId>\\n <ResourceId>com.alipay.test.resource2</ResourceId>\\n <Region>Alipay</Region>\\n <Id>44</Id>\\n <AppName>someAppName2</AppName>\\n</Resources>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '查询资源元信息', - 'summary' => '根据应用名或者资源 ID 模糊查询对应的资源元信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GrayPushMsConfigData' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '109242', - 'abilityTreeNodes' => [ - 'FEATUREsofaNCKPTU', + 'name' => 'NotifyRecovered', + 'in' => 'formData', + 'schema' => ['description' => '告警恢复时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], - ], - 'parameters' => [ [ - 'name' => 'AttributeId', + 'name' => 'NotifyNodata', 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID，可以通过查询属性接口获取 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '待删除的订阅数据总量', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'Data', + 'name' => 'NotifyTimeFilterJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '属性推送值', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hello world', - ], + 'schema' => ['description' => '查询告警规则的时间范围', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'Hosts', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '灰度推送的机器列表，多个 IP 之间英文逗号隔开', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.0.1,127.0.0.2', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod'], ], [ - 'name' => 'InstanceId', + 'name' => 'ChannelsRepeatList', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '系统字段：环境实例 ID', - 'type' => 'string', + 'description' => '告警通知渠道', + 'type' => 'array', + 'items' => ['description' => '告警渠道名称', 'type' => 'string', 'required' => false], 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', + 'maxItems' => 100, ], ], [ - 'name' => 'Operator', + 'name' => 'NotifyTarget', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '操作人', - 'type' => 'string', + 'description' => '告警通知对象。取值：accountContact。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知对象。取值：accountContact。', + 'type' => 'object', + 'properties' => [ + 'SubscriberSource' => ['description' => ' '."\n" + .'订阅者来源', 'type' => 'string', 'required' => true, 'example' => 'LOCAL'], + 'SubscriberType' => ['description' => '订阅者类型', 'type' => 'string', 'required' => true, 'example' => 'USER_GROUP'], + 'Subscriber' => ['description' => '通知人id', 'type' => 'string', 'required' => true, 'example' => '1'], + 'SubscriberUuid' => ['type' => 'string', 'required' => true, 'example' => '400', 'description' => ''], + 'SubscriberName' => ['description' => '告警对象的名称', 'type' => 'string', 'required' => true, 'example' => '实人认证-灰度测试'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => false, - 'example' => 'wang.li', + 'maxItems' => 100, ], ], ], @@ -1525,123 +511,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'PushResult' => [ - 'description' => '推送结果列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => '是否推送成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Host' => [ - 'description' => '推送目标 host', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - ], - ], - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5F656C56-F99E-5C1E-AE7F-D9F78AC8D706'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"PushResult\\": [\\n {\\n \\"Success\\": true,\\n \\"Host\\": \\"127.0.0.1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '灰度推送属性值', - 'summary' => '按 IP 灰度推送属性值。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' 按 IP 灰度推送属性值填写的 IP 值需为正常能访问到的 IP 才会推送成功。', - ], - 'PushMsConfigData' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"5F656C56-F99E-5C1E-AE7F-D9F78AC8D706\\"\\n}","type":"json"}]', + 'title' => '创建告警规则', + 'summary' => '创建告警规则。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:CreateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMqSofamqGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'AttributeId', - 'in' => 'formData', - 'schema' => [ - 'description' => '属性自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Cells', - 'in' => 'formData', - 'schema' => [ - 'description' => '需要发布的单元列表，英文逗号隔开，为空表示推送到所有单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Cell1,Cell2', - ], - ], - [ - 'name' => 'Data', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '推送的属性值', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '12', - ], + 'schema' => ['description' => '需要删除的消息消费集群的 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_group_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], - ], - [ - 'name' => 'Operator', - 'in' => 'formData', - 'schema' => [ - 'description' => '操作人', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'wang.li', - ], + 'schema' => ['description' => '需删除的 Group ID 对应的实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001'], ], ], 'responses' => [ @@ -1649,42 +566,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>41426381-937E-4486-B534-D8EEDB3D21DC</RequestId>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '核心推送属性值', - 'summary' => '推送后所有订阅对应属性的客户端都会在一秒内更新内存值，并回调属性对应的 setter 方法。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '删除 Group', + 'summary' => '删除指定的 Group。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMqSofamqGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMqSofamqTopic' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1692,53 +606,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '创建的消息端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_group_id', - ], - ], - [ - 'name' => 'GroupType', - 'in' => 'formData', - 'schema' => [ - 'description' => '分组类型', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'tcp', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需创建的 Group ID 所对应的实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - ], + 'schema' => ['description' => '需删除的 Topic 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000001'], ], [ - 'name' => 'Remark', + 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => 'Group ID 描述信息', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '指定删除的 Topic', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -1746,42 +624,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'CreateMqSofamqGroup', - 'summary' => '创建 Group ID。创建的 Group ID 用于发布和订阅消息。', + 'title' => '删除指定的 Topic', + 'summary' => '删除后，该 Topic 下所有的订阅关系会被清理。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMqSofamqTrace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1789,31 +664,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需要删除的消息消费集群的 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_group_id', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ - 'name' => 'InstanceId', + 'name' => 'QueryId', 'in' => 'formData', - 'schema' => [ - 'description' => '需删除的 Group ID 对应的实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - ], + 'schema' => ['description' => '待删除的消息轨迹查询任务 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '272967562652883649157096685****'], ], ], 'responses' => [ @@ -1821,74 +682,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '删除 Group', - 'summary' => '删除指定的 Group。', + 'title' => '删除消息轨迹查询任务', + 'summary' => '删除指定的消息轨迹查询任务。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqTopic' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMqSofamqWarn' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需删除的 Topic 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '000001', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ - 'name' => 'Topic', + 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '指定删除的 Topic', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '待删除的报警规则 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000001'], ], ], 'responses' => [ @@ -1896,74 +739,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '删除指定的 Topic', - 'summary' => '删除后，该 Topic 下所有的订阅关系会被清理。', + 'title' => '删除指定的报警规则', + 'summary' => '通过报警规则 ID。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqTrace' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMsConfigAttributes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'delete', + 'abilityTreeCode' => '108190', + 'abilityTreeNodes' => ['FEATUREsofaNCKPTU'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '属性自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'QueryId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '待删除的消息轨迹查询任务 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '272967562652883649157096685****', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], ], 'responses' => [ @@ -1971,74 +800,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '删除消息轨迹查询任务', - 'summary' => '删除指定的消息轨迹查询任务。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMsConfigAttributesResponse>\\n <ResultMessage>OK</ResultMessage>\\n <ResultCode>OK</ResultCode>\\n <RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n</DeleteMsConfigAttributesResponse>","errorExample":""}]', + 'title' => '删除属性元信息', + 'summary' => '根据属性 ID 删除对应的属性元信息。删除属性元信息，属性值不会删除。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteMsConfigResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'WarnId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '待删除的报警规则 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], ], 'responses' => [ @@ -2046,85 +858,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '删除指定的报警规则', - 'summary' => '通过报警规则 ID。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '删除指定资源', + 'summary' => '根据资源 ID 删除对应资源，删除资源会同时删除对应资源下所有的属性信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMqSofamqGroupRemark' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRMSUnifiedAlarmRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '需配置更新的 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_group_id', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1'], ], [ - 'name' => 'Remark', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '描述信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod'], ], ], 'responses' => [ @@ -2132,131 +917,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '更新 Group 的信息', - 'summary' => '修改或更新 Group 的描述信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => '删除告警规则', + 'summary' => '删除告警规则。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:DeleteRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeCasComputers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AlertTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '报警时间范围', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '00:00-24:00', - ], - ], - [ - 'name' => 'Contacts', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '报警通知人信息', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]', - ], + 'schema' => ['description' => '分页参数，第几页', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '21'], ], [ - 'name' => 'DelayTime', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '延迟多少秒报警', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'opscenter'], ], [ - 'name' => 'Frequency', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '报警频率，单位分钟', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '每页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100'], ], [ - 'name' => 'InstanceId', + 'name' => 'Workspace', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => '工作空间', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'shfinpre'], ], [ - 'name' => 'Threshold', + 'name' => 'AppServiceIdsRepeatList', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '阈值', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '应用服务id列表', + 'type' => 'array', + 'items' => ['description' => '应用服务id列表', 'type' => 'string', 'required' => false, 'example' => '2144098938'], 'required' => false, - 'docRequired' => true, - 'example' => '3000', - ], - ], - [ - 'name' => 'WarnId', - 'in' => 'formData', - 'schema' => [ - 'description' => '指定修改的报警规则', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001 ', + 'maxItems' => 100, ], ], ], @@ -2265,71 +993,224 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'CurrentPage' => ['description' => '返回结果的当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DB5EB9EB-8690-570B-8A7F-41FF1C89C02E'], + 'ResultMessage' => ['type' => 'string', 'description' => ''], + 'ResultCode' => ['type' => 'string', 'description' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'TotalCount' => ['description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '75'], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['type' => 'string', 'description' => ''], + 'SerialNumber' => ['type' => 'string', 'description' => ''], + 'VpcId' => ['type' => 'string', 'description' => ''], + 'PrivateIp' => ['type' => 'string', 'description' => ''], + 'UtcCreate' => ['type' => 'string', 'description' => ''], + 'ProviderId' => ['type' => 'string', 'description' => ''], + 'ImageIaasId' => ['type' => 'string', 'description' => ''], + 'ImageId' => ['type' => 'string', 'description' => ''], + 'SpecIaasId' => ['type' => 'string', 'description' => ''], + 'DeployMode' => ['type' => 'string', 'description' => ''], + 'IaasId' => ['type' => 'string', 'description' => ''], + 'Initialized' => ['description' => '是否已初始化。', 'type' => 'boolean', 'example' => 'true'], + 'AutoRenewPeriod' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'PaasStatus' => ['type' => 'string', 'description' => ''], + 'InstanceChargeType' => ['type' => 'string', 'description' => ''], + 'VSwitchIaasId' => ['type' => 'string', 'description' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => ''], + 'ImageName' => ['type' => 'string', 'description' => ''], + 'PublicIp' => ['type' => 'string', 'description' => ''], + 'ZoneId' => ['type' => 'string', 'description' => ''], + 'CpuShared' => ['type' => 'boolean', 'description' => ''], + 'IaasType' => ['type' => 'string', 'description' => ''], + 'Status' => ['type' => 'string', 'description' => ''], + 'OsBit' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'IaasStatus' => ['type' => 'string', 'description' => ''], + 'NetworkType' => ['type' => 'string', 'description' => ''], + 'Password' => ['type' => 'string', 'description' => ''], + 'Bandwidth' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'Description' => ['type' => 'string', 'description' => ''], + 'UtcModified' => ['type' => 'string', 'description' => ''], + 'AppId' => ['type' => 'string', 'description' => ''], + 'OsVersion' => ['type' => 'string', 'description' => ''], + 'LastOpsType' => ['type' => 'string', 'description' => ''], + 'Memory' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'Name' => ['type' => 'string', 'description' => ''], + 'CommonImage' => ['type' => 'boolean', 'description' => ''], + 'AutoRenew' => ['type' => 'boolean', 'description' => ''], + 'TenantId2' => ['type' => 'string', 'description' => ''], + 'Os' => ['type' => 'string', 'description' => ''], + 'RegionId' => ['type' => 'string', 'description' => ''], + 'IoOptimized' => ['type' => 'boolean', 'description' => ''], + 'Cpu' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'ElasticIp' => ['type' => 'string', 'description' => ''], + 'ExpiredTime' => ['type' => 'string', 'description' => ''], + 'ThreadsPerCore' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'Id' => ['type' => 'string', 'description' => ''], + 'LastOpsOrderId' => ['type' => 'string', 'description' => ''], + 'TenantId' => ['type' => 'string', 'description' => ''], + 'DataDisks' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => ''], + 'Status' => ['type' => 'string', 'description' => ''], + 'EnableAutoSnapshot' => ['type' => 'boolean', 'description' => ''], + 'UtcCreate' => ['type' => 'string', 'description' => ''], + 'IaasId' => ['type' => 'string', 'description' => ''], + 'ProviderId' => ['type' => 'string', 'description' => ''], + 'DeleteAutoSnapshot' => ['type' => 'boolean', 'description' => ''], + 'RegionId' => ['type' => 'string', 'description' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => ''], + 'UtcModified' => ['type' => 'string', 'description' => ''], + 'Size' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'Device' => ['type' => 'string', 'description' => ''], + 'ZoneId' => ['type' => 'string', 'description' => ''], + 'Portable' => ['type' => 'boolean', 'description' => ''], + 'Category' => ['type' => 'string', 'description' => ''], + 'Name' => ['type' => 'string', 'description' => ''], + 'ImageId' => ['type' => 'string', 'description' => ''], + 'DeleteWithComputer' => ['type' => 'boolean', 'description' => ''], + 'Id' => ['type' => 'string', 'description' => ''], + 'TenantId' => ['type' => 'string', 'description' => ''], + 'Computer' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'string', 'description' => ''], + 'IaasId' => ['type' => 'string', 'description' => ''], + 'Name' => ['type' => 'string', 'description' => ''], + 'Id' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + 'description' => '', + ], + 'Options' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => ''], + 'Value' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => ''], + 'Value' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], + 'AssignedAppServiceIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', + ], + 'AppServiceIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', + ], + 'SystemDisk' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => ''], + 'Status' => ['type' => 'string', 'description' => ''], + 'EnableAutoSnapshot' => ['type' => 'boolean', 'description' => ''], + 'UtcCreate' => ['type' => 'string', 'description' => ''], + 'IaasId' => ['type' => 'string', 'description' => ''], + 'ProviderId' => ['type' => 'string', 'description' => ''], + 'DeleteAutoSnapshot' => ['type' => 'boolean', 'description' => ''], + 'RegionId' => ['type' => 'string', 'description' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => ''], + 'UtcModified' => ['type' => 'string', 'description' => ''], + 'Size' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'Device' => ['type' => 'string', 'description' => ''], + 'ZoneId' => ['type' => 'string', 'description' => ''], + 'Portable' => ['type' => 'boolean', 'description' => ''], + 'Category' => ['type' => 'string', 'description' => ''], + 'Name' => ['type' => 'string', 'description' => ''], + 'ImageId' => ['type' => 'string', 'description' => ''], + 'DeleteWithComputer' => ['type' => 'boolean', 'description' => ''], + 'Id' => ['type' => 'string', 'description' => ''], + 'TenantId' => ['type' => 'string', 'description' => ''], + 'Computer' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'string', 'description' => ''], + 'IaasId' => ['type' => 'string', 'description' => ''], + 'Name' => ['type' => 'string', 'description' => ''], + 'Id' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + 'description' => '', + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\r\\n<ResultMessage>OK</ResultMessage>\\r\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'UpdateMqSofamqWarn', - 'summary' => '更新指定报警规则的配置信息。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 16,\\n \\"RequestId\\": \\"DB5EB9EB-8690-570B-8A7F-41FF1C89C02E\\",\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 75,\\n \\"Data\\": [\\n {\\n \\"CreationTime\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"PrivateIp\\": \\"\\",\\n \\"UtcCreate\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"ImageIaasId\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"SpecIaasId\\": \\"\\",\\n \\"DeployMode\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Initialized\\": true,\\n \\"AutoRenewPeriod\\": 0,\\n \\"PaasStatus\\": \\"\\",\\n \\"InstanceChargeType\\": \\"\\",\\n \\"VSwitchIaasId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ImageName\\": \\"\\",\\n \\"PublicIp\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"CpuShared\\": true,\\n \\"IaasType\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"OsBit\\": 0,\\n \\"IaasStatus\\": \\"\\",\\n \\"NetworkType\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"Bandwidth\\": 0,\\n \\"Description\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"OsVersion\\": \\"\\",\\n \\"LastOpsType\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"Name\\": \\"\\",\\n \\"CommonImage\\": true,\\n \\"AutoRenew\\": true,\\n \\"TenantId2\\": \\"\\",\\n \\"Os\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"IoOptimized\\": true,\\n \\"Cpu\\": 0,\\n \\"ElasticIp\\": \\"\\",\\n \\"ExpiredTime\\": \\"\\",\\n \\"ThreadsPerCore\\": 0,\\n \\"Id\\": \\"\\",\\n \\"LastOpsOrderId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"DataDisks\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"EnableAutoSnapshot\\": true,\\n \\"UtcCreate\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"DeleteAutoSnapshot\\": true,\\n \\"RegionId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"Size\\": 0,\\n \\"Device\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"Portable\\": true,\\n \\"Category\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"DeleteWithComputer\\": true,\\n \\"Id\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"Computer\\": {\\n \\"Status\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Id\\": \\"\\"\\n }\\n }\\n ],\\n \\"Options\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"AssignedAppServiceIds\\": [\\n \\"\\"\\n ],\\n \\"AppServiceIds\\": [\\n \\"\\"\\n ],\\n \\"SystemDisk\\": {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"EnableAutoSnapshot\\": true,\\n \\"UtcCreate\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"DeleteAutoSnapshot\\": true,\\n \\"RegionId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"Size\\": 0,\\n \\"Device\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"Portable\\": true,\\n \\"Category\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"DeleteWithComputer\\": true,\\n \\"Id\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"Computer\\": {\\n \\"Status\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Id\\": \\"\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询机器列表', + 'description' => '分页查询机器', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:DescribeCasComputers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'DisableMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '待关闭的报警规则 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001', - ], + 'schema' => ['description' => '待关闭的报警规则 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000001'], ], ], 'responses' => [ @@ -2337,22 +1218,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], @@ -2363,48 +1233,41 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:DisableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'EnableMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '待开启的报警规则 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'schema' => ['description' => '待开启的报警规则 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001'], ], ], 'responses' => [ @@ -2412,22 +1275,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], @@ -2438,69 +1290,51 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:EnableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'GetMqSofamqConsumerJStack' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RZ00A', - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RZ00A'], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的消费端 Client ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=', - ], + 'schema' => ['description' => '需要查询的消费端 Client ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0='], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的消费端的 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => '需要查询的消费端的 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的消费者对应的实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE_ID_111', - ], + 'schema' => ['description' => '需要查询的消费者对应的实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_ID_111'], ], ], 'responses' => [ @@ -2508,55 +1342,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '消费端 Jstack 堆栈信息', 'type' => 'object', 'properties' => [ - 'ClientId' => [ - 'description' => '消费端 Client ID', - 'type' => 'string', - 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=', - ], + 'ClientId' => ['description' => '消费端 Client ID', 'type' => 'string', 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0='], 'Jstack' => [ 'description' => 'Jstack 堆栈信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Thread' => [ - 'description' => '线程名称', - 'type' => 'string', - 'example' => 'ConsumeMessageThread_0 ', - ], + 'Thread' => ['description' => '线程名称', 'type' => 'string', 'example' => 'ConsumeMessageThread_0 '], 'TrackList' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Jstack 堆栈信息字符串', - 'type' => 'string', - 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)', - ], + 'items' => ['description' => 'Jstack 堆栈信息字符串', 'type' => 'string', 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)'], + 'description' => '', ], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -2567,16 +1380,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerJStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'GetMqSofamqConsumerStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2584,64 +1405,32 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A ', - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A '], ], [ 'name' => 'Detail', 'in' => 'formData', - 'schema' => [ - 'description' => '是否查询详细信息。取值说明如下：true：要查询详细信息；false：不查询详细信息。', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '是否查询详细信息。取值说明如下：true：要查询详细信息；false：不查询详细信息。', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'true'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => '需要查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'NeedJstack', 'in' => 'formData', - 'schema' => [ - 'description' => '是否打印 Jstack 信息', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => '是否打印 Jstack 信息', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false'], ], ], 'responses' => [ @@ -2649,105 +1438,35 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询结果', 'type' => 'object', 'properties' => [ - 'ConsumeTps' => [ - 'description' => '总消费 TPS', - 'type' => 'string', - 'example' => '0', - ], - 'SubscriptionSame' => [ - 'description' => '订阅关系是否一致', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ConsumeModel' => [ - 'description' => '消费模型。取值说明如下：CLUSTERING：集群消费模式；BROADCASTING：广播消费模式。', - 'type' => 'string', - 'example' => 'CLUSTERING', - ], - 'TotalDiff' => [ - 'description' => '集群总的消费堆积', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '197', - ], - 'LastTimestamp' => [ - 'description' => '最后更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1566883844954', - ], - 'DelayTime' => [ - 'description' => '延迟时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100857', - ], - 'Online' => [ - 'description' => '是否在线', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], - 'RebalanceOk' => [ - 'description' => '客户端 Rebalance 是否正常。取值说明如下：true：正常；false：不正常。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ConsumeTps' => ['description' => '总消费 TPS', 'type' => 'string', 'example' => '0'], + 'SubscriptionSame' => ['description' => '订阅关系是否一致', 'type' => 'boolean', 'example' => 'true'], + 'ConsumeModel' => ['description' => '消费模型。取值说明如下：CLUSTERING：集群消费模式；BROADCASTING：广播消费模式。', 'type' => 'string', 'example' => 'CLUSTERING'], + 'TotalDiff' => ['description' => '集群总的消费堆积', 'type' => 'integer', 'format' => 'int64', 'example' => '197'], + 'LastTimestamp' => ['description' => '最后更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1566883844954'], + 'DelayTime' => ['description' => '延迟时间', 'type' => 'integer', 'format' => 'int64', 'example' => '100857'], + 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'true'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx '], + 'RebalanceOk' => ['description' => '客户端 Rebalance 是否正常。取值说明如下：true：正常；false：不正常。', 'type' => 'boolean', 'example' => 'true'], 'ConnectionSet' => [ 'description' => '该集群当前在线客户端信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RemoteIp' => [ - 'description' => '宿主机 IP 或公网 IP', - 'type' => 'string', - 'example' => '42.120.74.**', - ], - 'ClientAddr' => [ - 'description' => '该消费实例的地址和端口', - 'type' => 'string', - 'example' => '30.5.121.**', - ], - 'Version' => [ - 'description' => '消费端版本', - 'type' => 'string', - 'example' => 'V4_3_6_SNAPSHOT', - ], - 'Language' => [ - 'description' => '消费端语言', - 'type' => 'string', - 'example' => 'JAVA', - ], - 'ClientId' => [ - 'description' => '消费实例的 ID', - 'type' => 'string', - 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275 ', - ], + 'RemoteIp' => ['description' => '宿主机 IP 或公网 IP', 'type' => 'string', 'example' => '42.120.74.**'], + 'ClientAddr' => ['description' => '该消费实例的地址和端口', 'type' => 'string', 'example' => '30.5.121.**'], + 'Version' => ['description' => '消费端版本', 'type' => 'string', 'example' => 'V4_3_6_SNAPSHOT'], + 'Language' => ['description' => '消费端语言', 'type' => 'string', 'example' => 'JAVA'], + 'ClientId' => ['description' => '消费实例的 ID', 'type' => 'string', 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275 '], ], + 'description' => '', ], ], 'ConsumerConnectionInfoList' => [ @@ -2756,74 +1475,29 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Connection' => [ - 'description' => '连接信息', - 'type' => 'string', - 'example' => '**', - ], - 'MessageModel' => [ - 'description' => '消费模型，取值说明如下：CLUSTERING：集群消费模式；BROADCASTING：广播消费模式。', - 'type' => 'string', - 'example' => 'CLUSTERING', - ], - 'Version' => [ - 'description' => ' 客户端版本号', - 'type' => 'string', - 'example' => 'V4_3_6', - ], - 'StartTimestamp' => [ - 'description' => '开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701361528', - ], - 'LastTimestamp' => [ - 'description' => '最后更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701368114', - ], - 'ConsumeType' => [ - 'description' => 'PUSH/PULL', - 'type' => 'string', - 'example' => 'PUSH', - ], - 'ThreadCount' => [ - 'description' => '消费线程数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Language' => [ - 'description' => '客户端语言', - 'type' => 'string', - 'example' => 'JAVA', - ], - 'ClientId' => [ - 'description' => '消费实例的 ID', - 'type' => 'string', - 'example' => '30.5.**.**@25560#-1999745829#-1737591554#458773089270275', - ], + 'Connection' => ['description' => '连接信息', 'type' => 'string', 'example' => '**'], + 'MessageModel' => ['description' => '消费模型，取值说明如下：CLUSTERING：集群消费模式；BROADCASTING：广播消费模式。', 'type' => 'string', 'example' => 'CLUSTERING'], + 'Version' => ['description' => ' 客户端版本号', 'type' => 'string', 'example' => 'V4_3_6'], + 'StartTimestamp' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701361528'], + 'LastTimestamp' => ['description' => '最后更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701368114'], + 'ConsumeType' => ['description' => 'PUSH/PULL', 'type' => 'string', 'example' => 'PUSH'], + 'ThreadCount' => ['description' => '消费线程数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Language' => ['description' => '客户端语言', 'type' => 'string', 'example' => 'JAVA'], + 'ClientId' => ['description' => '消费实例的 ID', 'type' => 'string', 'example' => '30.5.**.**@25560#-1999745829#-1737591554#458773089270275'], 'Jstack' => [ 'description' => 'Jstack 堆栈信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Thread' => [ - 'description' => '线程名称', - 'type' => 'string', - 'example' => 'ConsumeMessageThread_0', - ], + 'Thread' => ['description' => '线程名称', 'type' => 'string', 'example' => 'ConsumeMessageThread_0'], 'TrackList' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Jstack 堆栈信息字符串', - 'type' => 'string', - 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)', - ], + 'items' => ['description' => 'Jstack 堆栈信息字符串', 'type' => 'string', 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)'], + 'description' => '', ], ], + 'description' => '', ], ], 'RunningDataList' => [ @@ -2832,44 +1506,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'description' => '订阅方的 Group ID', - 'type' => 'string', - 'example' => '000', - ], - 'Diff' => [ - 'description' => '堆积量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Rt' => [ - 'description' => '消费 RT 时间，单位 ms', - 'type' => 'string', - 'example' => '0.1', - ], - 'Topic' => [ - 'description' => '订阅的 Topic 名称', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'FailedCountPerHour' => [ - 'description' => '每小时内消费失败的消息数统计', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OkTps' => [ - 'description' => '消费消息成功的 TPS 统计', - 'type' => 'string', - 'example' => '0.1', - ], - 'FailedTps' => [ - 'description' => '消费消息失败的 TPS 统计', - 'type' => 'string', - 'example' => '0.1', - ], + 'GroupId' => ['description' => '订阅方的 Group ID', 'type' => 'string', 'example' => '000'], + 'Diff' => ['description' => '堆积量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Rt' => ['description' => '消费 RT 时间，单位 ms', 'type' => 'string', 'example' => '0.1'], + 'Topic' => ['description' => '订阅的 Topic 名称', 'type' => 'string', 'example' => 'test-mq_topic'], + 'FailedCountPerHour' => ['description' => '每小时内消费失败的消息数统计', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OkTps' => ['description' => '消费消息成功的 TPS 统计', 'type' => 'string', 'example' => '0.1'], + 'FailedTps' => ['description' => '消费消息失败的 TPS 统计', 'type' => 'string', 'example' => '0.1'], ], + 'description' => '', ], ], 'SubscriptionSet' => [ @@ -2878,34 +1523,20 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SubString' => [ - 'description' => '订阅该 Topic 的子类别 Tag 表达式', - 'type' => 'string', - 'example' => '*', - ], - 'SubVersion' => [ - 'description' => ' 订阅关系版本号，为自增 Long 型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701364301', - ], - 'Topic' => [ - 'description' => '订阅的 Topic 名称', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], + 'SubString' => ['description' => '订阅该 Topic 的子类别 Tag 表达式', 'type' => 'string', 'example' => '*'], + 'SubVersion' => ['description' => ' 订阅关系版本号，为自增 Long 型', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701364301'], + 'Topic' => ['description' => '订阅的 Topic 名称', 'type' => 'string', 'example' => 'test-mq_topic'], 'TagsSet' => [ 'type' => 'array', - 'items' => [ - 'description' => '订阅的 Tag 集合', - 'type' => 'string', - 'example' => '*', - ], + 'items' => ['description' => '订阅的 Tag 集合', 'type' => 'string', 'example' => '*'], + 'description' => '', ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], 'DetailInTopicList' => [ @@ -2914,35 +1545,18 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TotalDiff' => [ - 'description' => '该 Topic 消费总堆积数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DelayTime' => [ - 'description' => '延迟时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LastTimestamp' => [ - 'description' => '最后更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'Topic' => [ - 'description' => 'Topic 名称', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], + 'TotalDiff' => ['description' => '该 Topic 消费总堆积数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'DelayTime' => ['description' => '延迟时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LastTimestamp' => ['description' => '最后更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'Topic' => ['description' => 'Topic 名称', 'type' => 'string', 'example' => 'test-mq_topic'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -2953,69 +1567,51 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'GetMqSofamqDLQMessageById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id ', - ], + 'schema' => ['description' => '需查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id '], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '需查询消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'MsgId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 ID，即 Message ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0BC16699165C03B925DB8A404E2D****', - ], + 'schema' => ['description' => '需查询的消息的 ID，即 Message ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0BC16699165C03B925DB8A404E2D****'], ], ], 'responses' => [ @@ -3023,107 +1619,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询结果', 'type' => 'object', 'properties' => [ - 'StoreSize' => [ - 'description' => '消息大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '407', - ], - 'ReconsumeTimes' => [ - 'description' => ' 消息重试消费的次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StoreTimestamp' => [ - 'description' => '被服务端存储的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026708', - ], - 'Topic' => [ - 'description' => ' 消息的 Topic', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '存储该消息的服务器实例', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => ' 生成时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => ' 实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '消息体', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '消息 ID，即 Message ID', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '消息体 CRC 校验值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '生成该消息的客户端实例', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => '消息大小', 'type' => 'integer', 'format' => 'int64', 'example' => '407'], + 'ReconsumeTimes' => ['description' => ' 消息重试消费的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StoreTimestamp' => ['description' => '被服务端存储的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708'], + 'Topic' => ['description' => ' 消息的 Topic', 'type' => 'string', 'example' => 'test-mq_topic'], + 'StoreHost' => ['description' => '存储该消息的服务器实例', 'type' => 'string', 'example' => '11.220.***.***:10911'], + 'BornTimestamp' => ['description' => ' 生成时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630'], + 'InstanceId' => ['description' => ' 实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'Body' => ['description' => '消息体', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv'], + 'MsgId' => ['description' => '消息 ID，即 Message ID', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2'], + 'BodyCrc' => ['description' => '消息体 CRC 校验值', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295'], + 'BornHost' => ['description' => '生成该消息的客户端实例', 'type' => 'string', 'example' => '42.120.**.**:64646'], 'PropertyList' => [ 'description' => '消息属性列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Key 名', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'Key 名', 'type' => 'string', 'example' => 'TAGS'], + 'Value' => ['description' => '值', 'type' => 'string', 'example' => 'TagA'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -3134,16 +1663,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'GetMqSofamqMessageById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3151,53 +1688,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息所在的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A ', - ], + 'schema' => ['description' => '需查询的消息所在的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A '], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => '需查询消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx '], ], [ 'name' => 'MsgId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 ID，即 Message ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1E0578FE110F18B4AAC235C05F2*****', - ], + 'schema' => ['description' => '需查询的消息的 ID，即 Message ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E0578FE110F18B4AAC235C05F2*****'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 Topic', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic ', - ], + 'schema' => ['description' => '需查询的消息的 Topic', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic '], ], ], 'responses' => [ @@ -3205,107 +1716,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询结果', 'type' => 'object', 'properties' => [ - 'StoreSize' => [ - 'description' => '消息大小，单位：KB', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '407', - ], - 'ReconsumeTimes' => [ - 'description' => ' 消息重试消费的次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StoreTimestamp' => [ - 'description' => '被服务端存储的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026708', - ], - 'Topic' => [ - 'description' => ' 消息的 Topic', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '存储该消息的服务器实例', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => ' 生成时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => ' 实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '消息体', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '消息 ID，即 Message ID', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '消息体 CRC 校验值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '生成该消息的客户端实例', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => '消息大小，单位：KB', 'type' => 'integer', 'format' => 'int64', 'example' => '407'], + 'ReconsumeTimes' => ['description' => ' 消息重试消费的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StoreTimestamp' => ['description' => '被服务端存储的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708'], + 'Topic' => ['description' => ' 消息的 Topic', 'type' => 'string', 'example' => 'test-mq_topic'], + 'StoreHost' => ['description' => '存储该消息的服务器实例', 'type' => 'string', 'example' => '11.220.***.***:10911'], + 'BornTimestamp' => ['description' => ' 生成时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630'], + 'InstanceId' => ['description' => ' 实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'Body' => ['description' => '消息体', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv'], + 'MsgId' => ['description' => '消息 ID，即 Message ID', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2'], + 'BodyCrc' => ['description' => '消息体 CRC 校验值', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295'], + 'BornHost' => ['description' => '生成该消息的客户端实例', 'type' => 'string', 'example' => '42.120.**.**:64646'], 'PropertyList' => [ 'description' => '消息属性列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Key 名', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'Key 名', 'type' => 'string', 'example' => 'TAGS'], + 'Value' => ['description' => '值', 'type' => 'string', 'example' => 'TagA'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -3316,16 +1760,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'GetMqSofamqTraceByMsgId' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3333,77 +1785,37 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BeginTime', 'in' => 'formData', - 'schema' => [ - 'description' => ' 查询的时间范围的起始时间点，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570852800', - ], + 'schema' => ['description' => ' 查询的时间范围的起始时间点，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570852800'], ], [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '查询的时间范围的结束时间点，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570968000', - ], + 'schema' => ['description' => '查询的时间范围的结束时间点，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570968000'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 Topic 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => '需查询的消息的 Topic 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx '], ], [ 'name' => 'MsgId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 ID，即 Message ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1E05791C117818B4AAC23B1BB0CE**** ', - ], + 'schema' => ['description' => '需查询的消息的 ID，即 Message ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E05791C117818B4AAC23B1BB0CE**** '], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 Topic', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '需查询的消息的 Topic', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -3411,27 +1823,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'QueryId' => [ - 'description' => ' 该查询任务的 ID。可根据该任务 ID，再调用 GetMqSofamqTraceResult 接口获取详细结果。', - 'type' => 'string', - 'example' => '272967562652883649157096685****', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'QueryId' => ['description' => ' 该查询任务的 ID。可根据该任务 ID，再调用 GetMqSofamqTraceResult 接口获取详细结果。', 'type' => 'string', 'example' => '272967562652883649157096685****'], ], + 'description' => '', ], ], ], @@ -3442,47 +1839,41 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceByMsgId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'GetMqSofamqTraceResult' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'QueryId', 'in' => 'formData', - 'schema' => [ - 'description' => '消息轨迹查询的任务 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '272967562652883649157096685****', - ], + 'schema' => ['description' => '消息轨迹查询的任务 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '272967562652883649157096685****'], ], ], 'responses' => [ @@ -3490,165 +1881,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '该查询任务的结果明细', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '该查询任务的结果。取值说明如下：finish：查询完成；working：查询中；removed：任务已删除。', - 'type' => 'string', - 'example' => 'finish', - ], - 'MsgKey' => [ - 'description' => '该查询任务对应的 Message Key', - 'type' => 'string', - 'example' => 'keyA', - ], - 'UpdateTime' => [ - 'description' => '该查询任务的最后更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'CreateTime' => [ - 'description' => '该查询任务的创建时间'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'UserId' => [ - 'description' => ' 查询用户 ID', - 'type' => 'string', - 'example' => '27296756265288****', - ], - 'Topic' => [ - 'description' => '该查询任务的 Topic', - 'type' => 'string', - 'example' => 'topic_a', - ], - 'InstanceId' => [ - 'description' => ' 实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'MsgId' => [ - 'description' => '该查询任务对应的 Message ID', - 'type' => 'string', - 'example' => '1E05791C117818B4AAC23B1BB0CE****', - ], - 'QueryId' => [ - 'description' => '查询任务 ID', - 'type' => 'string', - 'example' => '272967562652883649157096685****', - ], + 'Status' => ['description' => '该查询任务的结果。取值说明如下：finish：查询完成；working：查询中；removed：任务已删除。', 'type' => 'string', 'example' => 'finish'], + 'MsgKey' => ['description' => '该查询任务对应的 Message Key', 'type' => 'string', 'example' => 'keyA'], + 'UpdateTime' => ['description' => '该查询任务的最后更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000'], + 'CreateTime' => ['description' => '该查询任务的创建时间'."\n" + ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000'], + 'UserId' => ['description' => ' 查询用户 ID', 'type' => 'string', 'example' => '27296756265288****'], + 'Topic' => ['description' => '该查询任务的 Topic', 'type' => 'string', 'example' => 'topic_a'], + 'InstanceId' => ['description' => ' 实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'MsgId' => ['description' => '该查询任务对应的 Message ID', 'type' => 'string', 'example' => '1E05791C117818B4AAC23B1BB0CE****'], + 'QueryId' => ['description' => '查询任务 ID', 'type' => 'string', 'example' => '272967562652883649157096685****'], 'TraceList' => [ 'description' => '该查询任务的匹配轨迹列表'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '发送状态。取值说明如下：'."\n" - ."\n" - .'SEND_SUCCESS：发送成功'."\n" - .'SEND_FAILED：发送失败'."\n" - .'SEND_ROLLBACK：事务消息回滚'."\n" - .'SEND_UNKNOWN：事务消息未提交'."\n" - .'SEND_DELAY：定时(延时)消息定时中', - 'type' => 'string', - 'example' => 'SEND_SUCCESS', - ], - 'MsgKey' => [ - 'description' => ' 消息的 Key ，即 Message Key', - 'type' => 'string', - 'example' => 'ORDERID_100', - ], - 'PubTime' => [ - 'description' => '消息发送时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570850870478', - ], - 'Topic' => [ - 'description' => '消息的 Topic', - 'type' => 'string', - 'example' => 'test', - ], - 'CostTime' => [ - 'description' => '发送耗时，单位毫秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Tag' => [ - 'description' => '消息的 Tag，即 Message Tag', - 'type' => 'string', - 'example' => 'TagA', - ], - 'MsgId' => [ - 'description' => '消息的 ID，即 Message ID', - 'type' => 'string', - 'example' => '0BC1F01800002A9F000000531246**** ', - ], - 'PubGroupName' => [ - 'description' => '发送方客户端配置的 Group ID', - 'type' => 'string', - 'example' => 'GID_test', - ], - 'Cell' => [ - 'description' => '生产端的cell name', - 'type' => 'string', - 'example' => 'RZ00A', - ], - 'BornHost' => [ - 'description' => '消息发送方的客户端地址', - 'type' => 'string', - 'example' => '30.5.**.**', - ], + 'Status' => ['description' => '发送状态。取值说明如下：'."\n" + ."\n" + .'SEND_SUCCESS：发送成功'."\n" + .'SEND_FAILED：发送失败'."\n" + .'SEND_ROLLBACK：事务消息回滚'."\n" + .'SEND_UNKNOWN：事务消息未提交'."\n" + .'SEND_DELAY：定时(延时)消息定时中', 'type' => 'string', 'example' => 'SEND_SUCCESS'], + 'MsgKey' => ['description' => ' 消息的 Key ，即 Message Key', 'type' => 'string', 'example' => 'ORDERID_100'], + 'PubTime' => ['description' => '消息发送时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570850870478'], + 'Topic' => ['description' => '消息的 Topic', 'type' => 'string', 'example' => 'test'], + 'CostTime' => ['description' => '发送耗时，单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Tag' => ['description' => '消息的 Tag，即 Message Tag', 'type' => 'string', 'example' => 'TagA'], + 'MsgId' => ['description' => '消息的 ID，即 Message ID', 'type' => 'string', 'example' => '0BC1F01800002A9F000000531246**** '], + 'PubGroupName' => ['description' => '发送方客户端配置的 Group ID', 'type' => 'string', 'example' => 'GID_test'], + 'Cell' => ['description' => '生产端的cell name', 'type' => 'string', 'example' => 'RZ00A'], + 'BornHost' => ['description' => '消息发送方的客户端地址', 'type' => 'string', 'example' => '30.5.**.**'], 'SubList' => [ 'description' => '消息的消费轨迹列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SubGroupName' => [ - 'description' => '消费方 Group ID', - 'type' => 'string', - 'example' => 'GID_test', - ], - 'SuccessCount' => [ - 'description' => '该 Group ID 消费成功次数统计', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FailCount' => [ - 'description' => '该 Group ID 消费失败次数统计', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Cell' => [ - 'description' => 'cell name', - 'type' => 'string', - 'example' => 'RZ00A', - ], + 'SubGroupName' => ['description' => '消费方 Group ID', 'type' => 'string', 'example' => 'GID_test'], + 'SuccessCount' => ['description' => '该 Group ID 消费成功次数统计', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FailCount' => ['description' => '该 Group ID 消费失败次数统计', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Cell' => ['description' => 'cell name', 'type' => 'string', 'example' => 'RZ00A'], 'ClientList' => [ 'description' => '该 Group ID 客户端消费记录的明细列表'."\n" ."\n", @@ -3656,57 +1937,34 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '消费状态。取值说明如下：'."\n" - ."\n" - .'CONSUME_FAILED：消费失败'."\n" - .'CONSUME_SUCCESS：消费成功'."\n" - .'CONSUME_NOT_RETURN：消费未返回结果'."\n" - .'SEND_UNKNOWN：事务消息未提交'."\n" - .'SEND_DELAY：定时(延时)消息定时中', - 'type' => 'string', - 'example' => 'CONSUME_SUCCESS', - ], - 'SubTime' => [ - 'description' => '消费开始时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570851590511', - ], - 'ReconsumeTimes' => [ - 'description' => '本次消费的投递轮次', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ClientHost' => [ - 'description' => '消费客户端的客户端地址', - 'type' => 'string', - 'example' => '30.5.**.**', - ], - 'SubGroupName' => [ - 'description' => '该客户端所属的 Group ID', - 'type' => 'string', - 'example' => 'GID_test', - ], - 'CostTime' => [ - 'description' => '本次消费耗时，单位毫秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43', - ], + 'Status' => ['description' => '消费状态。取值说明如下：'."\n" + ."\n" + .'CONSUME_FAILED：消费失败'."\n" + .'CONSUME_SUCCESS：消费成功'."\n" + .'CONSUME_NOT_RETURN：消费未返回结果'."\n" + .'SEND_UNKNOWN：事务消息未提交'."\n" + .'SEND_DELAY：定时(延时)消息定时中', 'type' => 'string', 'example' => 'CONSUME_SUCCESS'], + 'SubTime' => ['description' => '消费开始时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570851590511'], + 'ReconsumeTimes' => ['description' => '本次消费的投递轮次', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ClientHost' => ['description' => '消费客户端的客户端地址', 'type' => 'string', 'example' => '30.5.**.**'], + 'SubGroupName' => ['description' => '该客户端所属的 Group ID', 'type' => 'string', 'example' => 'GID_test'], + 'CostTime' => ['description' => '本次消费耗时，单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '43'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -3717,16 +1975,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMqSofamqGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetMsConfigAttributes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3735,64 +2001,279 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '109214', + 'abilityTreeNodes' => ['FEATUREsofaNCKPTU'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => '属性自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询指定 Group ID 时设置，否则查询所有 Group ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'GID_test_group_id ', + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'Attribute' => [ + 'description' => '属性信息', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'example' => 'switch'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '属性描述信息', 'type' => 'string', 'example' => '活动开关'], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Attribute\\": {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>D7917DBF-CAA6-479E-8F26-3043AD7AAD11</RequestId>\\n<Attribute>\\n <Desc>男</Desc>\\n <InstanceId>AWHNEX3GFLJT</InstanceId>\\n <AttributeName>sex</AttributeName>\\n <Id>1</Id>\\n</Attribute>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '获取属性信息', + 'summary' => '根据属性 ID 获取对应的属性信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'GetMsConfigResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '109215', + 'abilityTreeNodes' => ['FEATUREsofaNCKPTU'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => '资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分组类型，默认为 tcp，表示该 Group ID 仅适用于 TCP 协议的消息收发。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'tcp', + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'Resource' => [ + 'description' => '资源信息', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => '应用名', 'type' => 'string', 'example' => 'drmdemo'], + 'Region' => ['description' => '资源所属的域', 'type' => 'string', 'example' => 'Alipay'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'ResourceId' => ['description' => '资源 ID', 'type' => 'string', 'example' => 'com.alipay.drmResource'], + 'Id' => ['description' => '资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '资源描述信息', 'type' => 'string', 'example' => '活动开关'], + 'Attributes' => [ + 'description' => '资源下所有属性信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'example' => 'switch'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '属性描述信息', 'type' => 'string', 'example' => '活动开关'], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Resource\\": {\\n \\"AppName\\": \\"drmdemo\\",\\n \\"Region\\": \\"Alipay\\",\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"ResourceId\\": \\"com.alipay.drmResource\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\",\\n \\"Attributes\\": [\\n {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>F127DCFE-05FE-4740-AD07-18598BF37289</RequestId>\\n<Resource>\\n <Desc>测试资源类</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <ResourceId>com.alipay.resource</ResourceId>\\n <Attributes>\\n <Desc>姓名</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <AttributeName>name</AttributeName>\\n <Id>27</Id>\\n </Attributes>\\n <Attributes>\\n <Desc>性别</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <AttributeName>sex</AttributeName>\\n <Id>28</Id>\\n </Attributes>\\n <Region>Alipay</Region>\\n <Id>1</Id>\\n <AppName>foo</AppName>\\n</Resource>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '获取资源元信息', + 'summary' => '根据资源 ID 获取资源元信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'GrayPushMsConfigData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '109242', + 'abilityTreeNodes' => ['FEATUREsofaNCKPTU'], + ], + 'parameters' => [ + [ + 'name' => 'AttributeId', + 'in' => 'formData', + 'schema' => ['description' => '属性自增长 ID，可以通过查询属性接口获取 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => '属性推送值', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'hello world'], + ], + [ + 'name' => 'Hosts', + 'in' => 'formData', + 'schema' => ['description' => '灰度推送的机器列表，多个 IP 之间英文逗号隔开', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,127.0.0.2'], + ], [ 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['description' => '操作人', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'wang.li'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '需获取 Group ID 所对应的实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'PushResult' => [ + 'description' => '推送结果列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => '是否推送成功', 'type' => 'boolean', 'example' => 'true'], + 'Host' => ['description' => '推送目标 host', 'type' => 'string', 'example' => '127.0.0.1'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"PushResult\\": [\\n {\\n \\"Success\\": true,\\n \\"Host\\": \\"127.0.0.1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '灰度推送属性值', + 'summary' => '按 IP 灰度推送属性值。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' 按 IP 灰度推送属性值填写的 IP 值需为正常能访问到的 IP 才会推送成功。', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:GrayPushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListMqSofamqGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => '查询指定 Group ID 时设置，否则查询所有 Group ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'GID_test_group_id '], + ], + [ + 'name' => 'GroupType', + 'in' => 'formData', + 'schema' => ['description' => '分组类型，默认为 tcp，表示该 Group ID 仅适用于 TCP 协议的消息收发。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tcp'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '需获取 Group ID 所对应的实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001'], + ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页显示数量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '每页显示数量', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20'], ], ], 'responses' => [ @@ -3800,142 +2281,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询到的订阅关系集合', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Total' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'Content' => [ 'description' => 'Group 信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RetryPerm' => [ - 'description' => '重试权限', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'Cluster' => [ - 'description' => '集群名', - 'type' => 'string', - 'example' => 'SINGLE', - ], - 'Remark' => [ - 'description' => 'Group 备注信息', - 'type' => 'string', - 'example' => 'test', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'SOFAMQ_INSTANCE_000001', - ], - 'GmtModified' => [ - 'description' => '修改时间，单位：毫秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'RetryWriteQueueNum' => [ - 'description' => '重试写队列权限', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DeleteMark' => [ - 'description' => '删除标记', - 'type' => 'string', - 'example' => '0', - ], - 'GroupId' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'example' => 'test_group_id', - ], - 'Version' => [ - 'description' => '版本', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '创建时间，单位：毫秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'RetryReadQueueNum' => [ - 'description' => '重试读队列数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Scope' => [ - 'description' => '作用范围', - 'type' => 'string', - 'example' => '*', - ], - 'Operator' => [ - 'description' => '操作人', - 'type' => 'string', - 'example' => 'alipay', - ], - 'GroupType' => [ - 'description' => '分组类型，默认为 tcp，表示该 Group ID 仅适用于 TCP 协议的消息收发。', - 'type' => 'string', - 'example' => 'tcp', - ], - 'ReadEnable' => [ - 'description' => '读权限', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => '数据库 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RetryPerm' => ['description' => '重试权限', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'Cluster' => ['description' => '集群名', 'type' => 'string', 'example' => 'SINGLE'], + 'Remark' => ['description' => 'Group 备注信息', 'type' => 'string', 'example' => 'test'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001'], + 'GmtModified' => ['description' => '修改时间，单位：毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000'], + 'RetryWriteQueueNum' => ['description' => '重试写队列权限', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DeleteMark' => ['description' => '删除标记', 'type' => 'string', 'example' => '0'], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => 'test_group_id'], + 'Version' => ['description' => '版本', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GmtCreate' => ['description' => '创建时间，单位：毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000'], + 'RetryReadQueueNum' => ['description' => '重试读队列数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Scope' => ['description' => '作用范围', 'type' => 'string', 'example' => '*'], + 'Operator' => ['description' => '操作人', 'type' => 'string', 'example' => 'alipay'], + 'GroupType' => ['description' => '分组类型，默认为 tcp，表示该 Group ID 仅适用于 TCP 协议的消息收发。', 'type' => 'string', 'example' => 'tcp'], + 'ReadEnable' => ['description' => '读权限', 'type' => 'boolean', 'example' => 'true'], + 'Id' => ['description' => '数据库 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -3946,71 +2331,51 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'ListMqSofamqTopic' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需获取的 Topic 信息列表所对应的实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '000001', - ], + 'schema' => ['description' => '需获取的 Topic 信息列表所对应的实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000001'], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '查询指定 Topic 时设置，否则查询所有 Topic', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TP_TEST', - ], + 'schema' => ['description' => '查询指定 Topic 时设置，否则查询所有 Topic', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TP_TEST'], ], ], 'responses' => [ @@ -4018,132 +2383,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '返回所有查询到的 Topic 信息列表', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Total' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'Content' => [ 'description' => 'Topic 信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Cluster' => [ - 'description' => '集群名称', - 'type' => 'string', - 'example' => 'single', - ], - 'Remark' => [ - 'description' => 'Topic 备注信息', - 'type' => 'string', - 'example' => 'desc', - ], - 'WriteQueueNum' => [ - 'description' => '写分区数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'ReadQueueNum' => [ - 'description' => '读分区数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => '000001', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'MessageType' => [ - 'description' => '消息类型。取值说明如下：'."\n" - ."\n" - .'0：普通消息'."\n" - .'1：分区顺序消息'."\n" - .'2：全局顺序消息'."\n" - .'4：事务消息'."\n" - .'5：定时/延时消息', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Perm' => [ - 'description' => '设置该 Topic 的读写模式。取值说明如下：'."\n" - ."\n" - .'6：同时支持读写'."\n" - .'4：禁写'."\n" - .'2：禁读', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'Topic' => [ - 'description' => 'Topic 名称', - 'type' => 'string', - 'example' => 'TP_TEST', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'Operator' => [ - 'description' => '创建人', - 'type' => 'string', - 'example' => 'alipay', - ], - 'Id' => [ - 'description' => '数据库 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'Cluster' => ['description' => '集群名称', 'type' => 'string', 'example' => 'single'], + 'Remark' => ['description' => 'Topic 备注信息', 'type' => 'string', 'example' => 'desc'], + 'WriteQueueNum' => ['description' => '写分区数', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'ReadQueueNum' => ['description' => '读分区数', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => '000001'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000'], + 'MessageType' => ['description' => '消息类型。取值说明如下：'."\n" + ."\n" + .'0：普通消息'."\n" + .'1：分区顺序消息'."\n" + .'2：全局顺序消息'."\n" + .'4：事务消息'."\n" + .'5：定时/延时消息', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Perm' => ['description' => '设置该 Topic 的读写模式。取值说明如下：'."\n" + ."\n" + .'6：同时支持读写'."\n" + .'4：禁写'."\n" + .'2：禁读', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'Topic' => ['description' => 'Topic 名称', 'type' => 'string', 'example' => 'TP_TEST'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000'], + 'Operator' => ['description' => '创建人', 'type' => 'string', 'example' => 'alipay'], + 'Id' => ['description' => '数据库 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -4154,16 +2439,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'ListMqSofamqTrace' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4171,55 +2464,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001'], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20'], ], [ 'name' => 'QueryItem', 'in' => 'formData', - 'schema' => [ - 'description' => '模糊查询项，可以为 Topic、Message ID 或 Message Key。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'TP_xx，0BA6EEBD700549C2FAAE076616860003，keyA', - ], + 'schema' => ['description' => '模糊查询项，可以为 Topic、Message ID 或 Message Key。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TP_xx，0BA6EEBD700549C2FAAE076616860003，keyA'], ], ], 'responses' => [ @@ -4227,102 +2492,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询返回的数据集合', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Total' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'Content' => [ 'description' => 'Trace 信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '状态', - 'type' => 'string', - 'example' => 'QUERYING', - ], - 'MsgKey' => [ - 'description' => '消息查询所用的 Message Key', - 'type' => 'string', - 'example' => 'ORDERID_100', - ], - 'Topic' => [ - 'description' => '查询的 Topic', - 'type' => 'string', - 'example' => 'TP_xxx', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'SOFAMQ_INSTANCE_000001', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'MsgId' => [ - 'description' => '消息查询所用的 Message ID', - 'type' => 'string', - 'example' => '1E05791C117818B4AAC23B1BB0CE****', - ], - 'QueryId' => [ - 'description' => '查询 ID', - 'type' => 'string', - 'example' => '272967562652883649157096685****', - ], - 'Cell' => [ - 'description' => '查询的 Cell', - 'type' => 'string', - 'example' => 'RZ001', - ], + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'QUERYING'], + 'MsgKey' => ['description' => '消息查询所用的 Message Key', 'type' => 'string', 'example' => 'ORDERID_100'], + 'Topic' => ['description' => '查询的 Topic', 'type' => 'string', 'example' => 'TP_xxx'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'MsgId' => ['description' => '消息查询所用的 Message ID', 'type' => 'string', 'example' => '1E05791C117818B4AAC23B1BB0CE****'], + 'QueryId' => ['description' => '查询 ID', 'type' => 'string', 'example' => '272967562652883649157096685****'], + 'Cell' => ['description' => '查询的 Cell', 'type' => 'string', 'example' => 'RZ001'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -4333,82 +2535,56 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'ListMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '查询指定 Group 的报警规则时设置', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'GID_group', - ], + 'schema' => ['description' => '查询指定 Group 的报警规则时设置', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GID_group'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '查询指定 Topic 的报警规则时设置', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '查询指定 Topic 的报警规则时设置', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -4416,150 +2592,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询到的告警规则集合', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Total' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'Content' => [ 'description' => '报警规则信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'WarnLevel' => [ - 'description' => '报警级别', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Frequency' => [ - 'description' => '报警频率，单位分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Contacts' => [ - 'description' => '联系人列表', - 'type' => 'string', - 'example' => '[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]', - ], - 'Attribute' => [ - 'description' => '属性字符串', - 'type' => 'string', - 'example' => '""', - ], - 'WarnType' => [ - 'description' => '报警类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'SOFAMQ_INSTANCE_000001', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'GroupId' => [ - 'description' => '消费组 ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'AlertTime' => [ - 'description' => '报警时间段', - 'type' => 'string', - 'example' => '00:00-23:59', - ], - 'DelayTime' => [ - 'description' => '延迟时间，单位分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Topic' => [ - 'description' => '报警的 Topic', - 'type' => 'string', - 'example' => 'TP_TEST', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'WarnStatus' => [ - 'description' => '报警状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BlockTime' => [ - 'description' => '消息阻塞时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Operator' => [ - 'description' => '操作者', - 'type' => 'string', - 'example' => 'alipay', - ], - 'Threshold' => [ - 'description' => '阈值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - 'Id' => [ - 'description' => '报警 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'WarnLevel' => ['description' => '报警级别', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'Frequency' => ['description' => '报警频率，单位分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Contacts' => ['description' => '联系人列表', 'type' => 'string', 'example' => '[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]'], + 'Attribute' => ['description' => '属性字符串', 'type' => 'string', 'example' => '""'], + 'WarnType' => ['description' => '报警类型', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'GroupId' => ['description' => '消费组 ID', 'type' => 'string', 'example' => 'GID_TEST'], + 'AlertTime' => ['description' => '报警时间段', 'type' => 'string', 'example' => '00:00-23:59'], + 'DelayTime' => ['description' => '延迟时间，单位分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'Topic' => ['description' => '报警的 Topic', 'type' => 'string', 'example' => 'TP_TEST'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'WarnStatus' => ['description' => '报警状态', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BlockTime' => ['description' => '消息阻塞时间', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Operator' => ['description' => '操作者', 'type' => 'string', 'example' => 'alipay'], + 'Threshold' => ['description' => '阈值', 'type' => 'integer', 'format' => 'int64', 'example' => '3000'], + 'Id' => ['description' => '报警 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -4570,105 +2643,66 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'ListMqSofamqWarnHistory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '目标单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ00A', - ], + 'schema' => ['description' => '目标单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ00A'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'GID_TEST', - ], + 'schema' => ['description' => 'Group ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GID_TEST'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE_XXX', - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_XXX'], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => 'Topic 名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'TP_TEST', - ], + 'schema' => ['description' => 'Topic 名称', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TP_TEST'], ], [ 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '4', - ], + 'schema' => ['description' => '报警规则 ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '4'], ], ], 'responses' => [ @@ -4676,98 +2710,38 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询到的报警日志集合', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Total' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'Content' => [ 'description' => '报警日志信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'WarnId' => [ - 'description' => '报警 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GroupId' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'Topic' => [ - 'description' => 'Topic 名称', - 'type' => 'string', - 'example' => 'TP_TEST', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'WarnInfo' => [ - 'description' => '报警信息', - 'type' => 'string', - 'example' => '"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, "', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'SOFAMQ_INSTANCE_000001', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'Cell' => [ - 'description' => '单元名称', - 'type' => 'string', - 'example' => 'RZ00A', - ], + 'WarnId' => ['description' => '报警 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => 'GID_TEST'], + 'Topic' => ['description' => 'Topic 名称', 'type' => 'string', 'example' => 'TP_TEST'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'WarnInfo' => ['description' => '报警信息', 'type' => 'string', 'example' => '"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, "'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'Cell' => ['description' => '单元名称', 'type' => 'string', 'example' => 'RZ00A'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -4778,16 +2752,147 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarnHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], - 'QueryMqSofamqConsumerAccumulate' => [ - 'methods' => [ - 'post', - 'get', + 'LogoutMsRegistryService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], + ], + [ + 'name' => 'ServerIpsRepeatList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + 'required' => true, + 'maxItems' => 100, + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['type' => 'string'], + 'ResultCode' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'UnknowError.SystemError', 'errorMessage' => 'An unknown error occurred in the system.', 'description' => '系统发生未知错误，刷新重试无效后请提交工单。'], + ], + ], + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'PushMsConfigData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AttributeId', + 'in' => 'formData', + 'schema' => ['description' => '属性自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'Cells', + 'in' => 'formData', + 'schema' => ['description' => '需要发布的单元列表，英文逗号隔开，为空表示推送到所有单元', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Cell1,Cell2'], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => '推送的属性值', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '12'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '系统字段：环境实例 ID'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['description' => '操作人', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'wang.li'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>41426381-937E-4486-B534-D8EEDB3D21DC</RequestId>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '核心推送属性值', + 'summary' => '推送后所有订阅对应属性的客户端都会在一秒内更新内存值，并回调属性对应的 setter 方法。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:PushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryMqSofamqConsumerAccumulate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4798,54 +2903,28 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '110354', - 'abilityTreeNodes' => [ - 'FEATUREsofaBCGLVK', - ], + 'abilityTreeNodes' => ['FEATUREsofaBCGLVK'], ], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的 Group ID 所在的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需要查询的 Group ID 所在的单元', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RZ01A'], ], [ 'name' => 'Detail', 'in' => 'formData', - 'schema' => [ - 'description' => '是否查询详细信息。取值说明如下：true：要查询详细信息；false：不查询详细信息（默认值）。', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否查询详细信息。取值说明如下：true：要查询详细信息；false：不查询详细信息（默认值）。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_consumer_id', - ], + 'schema' => ['description' => '需查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_consumer_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], ], 'responses' => [ @@ -4853,91 +2932,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '指定 Consumer 的消费堆积情况', 'type' => 'object', 'properties' => [ - 'ConsumeTps' => [ - 'description' => '该 Group ID 下消费者实例群组接收消息的总 TPS，单位：条/秒。', - 'type' => 'string', - 'example' => '10', - ], - 'TotalDiff' => [ - 'description' => '该 Topic 的消费堆积数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'LastTimestamp' => [ - 'description' => '该 Topic 中最近一条被消费的信息的生产时间，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1566231000000', - ], - 'DelayTime' => [ - 'description' => '该 Topic 所发消息的最大消费延迟时间，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'Online' => [ - 'description' => '该 Group ID 下是否有消费者实例在线；只要有一个消费者实例在线，该 Group ID 状态即为在线。取值说明如下：'."\n" - ."\n" - .'- true：状态为在线。'."\n" - .'- false：状态为不在线。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'ConsumeTps' => ['description' => '该 Group ID 下消费者实例群组接收消息的总 TPS，单位：条/秒。', 'type' => 'string', 'example' => '10'], + 'TotalDiff' => ['description' => '该 Topic 的消费堆积数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'LastTimestamp' => ['description' => '该 Topic 中最近一条被消费的信息的生产时间，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1566231000000'], + 'DelayTime' => ['description' => '该 Topic 所发消息的最大消费延迟时间，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'Online' => ['description' => '该 Group ID 下是否有消费者实例在线；只要有一个消费者实例在线，该 Group ID 状态即为在线。取值说明如下：'."\n" + ."\n" + .'- true：状态为在线。'."\n" + .'- false：状态为不在线。', 'type' => 'boolean', 'example' => 'true'], 'DetailInTopicList' => [ 'description' => '各个 Topic 具体情况', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TotalDiff' => [ - 'description' => '该 Topic 消费总堆积数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DelayTime' => [ - 'description' => '延迟时间，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LastTimestamp' => [ - 'description' => '最后更新时间，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'Topic' => [ - 'description' => 'Topic 名称', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], + 'TotalDiff' => ['description' => '该 Topic 消费总堆积数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'DelayTime' => ['description' => '延迟时间，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LastTimestamp' => ['description' => '最后更新时间，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403'], + 'Topic' => ['description' => 'Topic 名称', 'type' => 'string', 'example' => 'test-mq_topic'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -4947,16 +2974,26 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T05:55:26.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerAccumulate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryMqSofamqConsumerConnection' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4964,42 +3001,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的 Group ID 所在的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需要查询的 Group ID 所在的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_consumer_id', - ], + 'schema' => ['description' => '需查询的 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_consumer_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], ], 'responses' => [ @@ -5007,21 +3024,9 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '指定 Group ID 的连接信息'."\n" ."\n", @@ -5034,37 +3039,19 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'RemoteIp' => [ - 'description' => '宿主机 IP 或公网 IP', - 'type' => 'string', - 'example' => '42.120.74.**', - ], - 'ClientAddr' => [ - 'description' => '该消费实例的地址和端口', - 'type' => 'string', - 'example' => '30.5.121.**', - ], - 'Version' => [ - 'description' => '消费端版本', - 'type' => 'string', - 'example' => 'V4_3_6_SNAPSHOT', - ], - 'Language' => [ - 'description' => '消费端语言', - 'type' => 'string', - 'example' => 'JAVA', - ], - 'ClientId' => [ - 'description' => '消费实例的 ID', - 'type' => 'string', - 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275', - ], + 'RemoteIp' => ['description' => '宿主机 IP 或公网 IP', 'type' => 'string', 'example' => '42.120.74.**'], + 'ClientAddr' => ['description' => '该消费实例的地址和端口', 'type' => 'string', 'example' => '30.5.121.**'], + 'Version' => ['description' => '消费端版本', 'type' => 'string', 'example' => 'V4_3_6_SNAPSHOT'], + 'Language' => ['description' => '消费端语言', 'type' => 'string', 'example' => 'JAVA'], + 'ClientId' => ['description' => '消费实例的 ID', 'type' => 'string', 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -5075,16 +3062,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryMqSofamqConsumerTimespan' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5095,54 +3090,28 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '110356', - 'abilityTreeNodes' => [ - 'FEATUREsofaBCGLVK', - ], + 'abilityTreeNodes' => ['FEATUREsofaBCGLVK'], ], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID 所在的 Cell', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需查询的消费端 Group ID 所在的 Cell', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => '需查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '需查询的消费端 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID 订阅的 Topic', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic', - ], + 'schema' => ['description' => '需查询的消费端 Group ID 订阅的 Topic', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic'], ], ], 'responses' => [ @@ -5150,56 +3119,22 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询结果', 'type' => 'object', 'properties' => [ - 'MaxTimestamp' => [ - 'description' => '整个 Topic 目前存储的最早的消息的时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026804', - ], - 'MinTimestamp' => [ - 'description' => ' 整个 Topic 目前存储的最新的消息的时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701231122', - ], - 'InstanceId' => [ - 'description' => '需查询的消费端 Group ID 所对应的实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'ConsumeTimestamp' => [ - 'description' => ' 当前 Group 消费该 Topic 的最新的时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026400', - ], - 'Topic' => [ - 'description' => '需查询的 Topic 名称', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], + 'MaxTimestamp' => ['description' => '整个 Topic 目前存储的最早的消息的时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026804'], + 'MinTimestamp' => ['description' => ' 整个 Topic 目前存储的最新的消息的时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701231122'], + 'InstanceId' => ['description' => '需查询的消费端 Group ID 所对应的实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'ConsumeTimestamp' => ['description' => ' 当前 Group 消费该 Topic 的最新的时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026400'], + 'Topic' => ['description' => '需查询的 Topic 名称', 'type' => 'string', 'example' => 'test-mq_topic'], ], ], ], + 'description' => '', ], ], ], @@ -5209,118 +3144,74 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T12:07:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerTimespan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryMqSofamqDLQMessageByGroupId' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BeginTime', 'in' => 'formData', - 'schema' => [ - 'description' => '查询范围的起始时间戳'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570723200000', - ], + 'schema' => ['description' => '查询范围的起始时间戳'."\n" + ."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570723200000'], ], [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '查询范围的终止时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570809600000', - ], + 'schema' => ['description' => '查询范围的终止时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570809600000'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => '需查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '需查询的消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '每页条数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '查询任务的 ID。首次查询不需要输入，后续获取消息必须传入，根据前一次的返回结果取出该字段。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'schema' => ['description' => '查询任务的 ID。首次查询不需要输入，后续获取消息必须传入，根据前一次的返回结果取出该字段。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0BC1310300002A9F000021E4D7A48346'], ], ], 'responses' => [ @@ -5328,139 +3219,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '消息内容', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Total' => [ - 'description' => '总页数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TaskId' => [ - 'description' => '第一次新建查询时返回的查询任务 ID，用于后续获取消息。', - 'type' => 'string', - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Total' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TaskId' => ['description' => '第一次新建查询时返回的查询任务 ID，用于后续获取消息。', 'type' => 'string', 'example' => '0BC1310300002A9F000021E4D7A48346'], 'Content' => [ 'description' => '消息的详细信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StoreSize' => [ - 'description' => '消息大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '407', - ], - 'ReconsumeTimes' => [ - 'description' => ' 消息重试消费的次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StoreTimestamp' => [ - 'description' => '被服务端存储的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026708', - ], - 'Topic' => [ - 'description' => ' 消息的 Topic', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '存储该消息的服务器实例', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => ' 生成时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => ' 实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '消息体', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '消息 ID，即 Message ID', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '消息体 CRC 校验值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '生成该消息的客户端实例', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => '消息大小', 'type' => 'integer', 'format' => 'int64', 'example' => '407'], + 'ReconsumeTimes' => ['description' => ' 消息重试消费的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StoreTimestamp' => ['description' => '被服务端存储的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708'], + 'Topic' => ['description' => ' 消息的 Topic', 'type' => 'string', 'example' => 'test-mq_topic'], + 'StoreHost' => ['description' => '存储该消息的服务器实例', 'type' => 'string', 'example' => '11.220.***.***:10911'], + 'BornTimestamp' => ['description' => ' 生成时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630'], + 'InstanceId' => ['description' => ' 实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'Body' => ['description' => '消息体', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv'], + 'MsgId' => ['description' => '消息 ID，即 Message ID', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2'], + 'BodyCrc' => ['description' => '消息体 CRC 校验值', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295'], + 'BornHost' => ['description' => '生成该消息的客户端实例', 'type' => 'string', 'example' => '42.120.**.**:64646'], 'PropertyList' => [ 'description' => '消息属性列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Key 名', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'Key 名', 'type' => 'string', 'example' => 'TAGS'], + 'Value' => ['description' => '值', 'type' => 'string', 'example' => 'TagA'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -5471,16 +3277,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqDLQMessageByGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryMqSofamqGroupSubDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5488,42 +3302,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID 所在的 Cell', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需查询的 Group ID 所在的 Cell', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RZ01A'], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => '需查询的 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - ], + 'schema' => ['description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001'], ], ], 'responses' => [ @@ -5531,67 +3325,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '返回 Data 信息', 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'example' => 'GID_test_group_id', - ], - 'MessageModel' => [ - 'description' => '部署模型，包括 BROADCASTING（广播消费模式 ） 和 CLUSTERING（集群消费模式）两种。', - 'type' => 'string', - 'example' => 'CLUSTERING', - ], - 'Online' => [ - 'description' => '是否在线', - 'type' => 'boolean', - 'example' => 'true', - ], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => 'GID_test_group_id'], + 'MessageModel' => ['description' => '部署模型，包括 BROADCASTING（广播消费模式 ） 和 CLUSTERING（集群消费模式）两种。', 'type' => 'string', 'example' => 'CLUSTERING'], + 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'true'], 'SubscriptionDataList' => [ 'description' => '订阅信息列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SubString' => [ - 'description' => '订阅匹配字符串', - 'type' => 'string', - 'example' => '*', - ], - 'Online' => [ - 'description' => '是否在线', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Topic' => [ - 'description' => 'Topic 名称', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], + 'SubString' => ['description' => '订阅匹配字符串', 'type' => 'string', 'example' => '*'], + 'Online' => ['description' => '是否在线', 'type' => 'boolean', 'example' => 'true'], + 'Topic' => ['description' => 'Topic 名称', 'type' => 'string', 'example' => 'test-mq_topic'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -5602,16 +3362,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqGroupSubDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryMqSofamqMessageByKey' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5619,53 +3387,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息所在的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A ', - ], + 'schema' => ['description' => '需查询的消息所在的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A '], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '需查询的消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ 'name' => 'Key', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 Message Key', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'messageKey1', - ], + 'schema' => ['description' => '需查询的消息的 Message Key', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'messageKey1'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 Topic', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic ', - ], + 'schema' => ['description' => '需查询的消息的 Topic', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic '], ], ], 'responses' => [ @@ -5673,110 +3415,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '查询结果', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StoreSize' => [ - 'description' => '消息大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '407', - ], - 'ReconsumeTimes' => [ - 'description' => ' 消息重试消费的次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StoreTimestamp' => [ - 'description' => '被服务端存储的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026708', - ], - 'Topic' => [ - 'description' => ' 消息的 Topic', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '存储该消息的服务器实例', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => ' 生成时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => ' 实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '消息体', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '消息 ID，即 Message ID', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '消息体 CRC 校验值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '生成该消息的客户端实例', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => '消息大小', 'type' => 'integer', 'format' => 'int64', 'example' => '407'], + 'ReconsumeTimes' => ['description' => ' 消息重试消费的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StoreTimestamp' => ['description' => '被服务端存储的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708'], + 'Topic' => ['description' => ' 消息的 Topic', 'type' => 'string', 'example' => 'test-mq_topic'], + 'StoreHost' => ['description' => '存储该消息的服务器实例', 'type' => 'string', 'example' => '11.220.***.***:10911'], + 'BornTimestamp' => ['description' => ' 生成时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630'], + 'InstanceId' => ['description' => ' 实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'Body' => ['description' => '消息体', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv'], + 'MsgId' => ['description' => '消息 ID，即 Message ID', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2'], + 'BodyCrc' => ['description' => '消息体 CRC 校验值', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295'], + 'BornHost' => ['description' => '生成该消息的客户端实例', 'type' => 'string', 'example' => '42.120.**.**:64646'], 'PropertyList' => [ 'description' => '消息属性列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Key 名', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'Key 名', 'type' => 'string', 'example' => 'TAGS'], + 'Value' => ['description' => '值', 'type' => 'string', 'example' => 'TagA'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], @@ -5787,16 +3463,24 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryMqSofamqMessageByTopic' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5804,101 +3488,47 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BeginTime', 'in' => 'formData', - 'schema' => [ - 'description' => ' 查询范围的起始时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570723200000', - ], + 'schema' => ['description' => ' 查询范围的起始时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570723200000'], ], [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '需查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '查询范围的终止时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570809600000', - ], + 'schema' => ['description' => '查询范围的终止时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570809600000'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => '需查询的消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx '], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20'], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '查询任务的 ID。首次查询不需要输入，后续取消息必须传入，根据前一次的返回结果取出该字段。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'schema' => ['description' => '查询任务的 ID。首次查询不需要输入，后续取消息必须传入，根据前一次的返回结果取出该字段。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0BC1310300002A9F000021E4D7A48346'], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 Topic 名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic ', - ], + 'schema' => ['description' => '需查询的消息的 Topic 名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic '], ], ], 'responses' => [ @@ -5906,139 +3536,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], 'Data' => [ 'description' => '分页查询Message', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Total' => [ - 'description' => '总页数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TaskId' => [ - 'description' => '第一次新建查询时返回的查询任务 ID，用于后续获取消息。', - 'type' => 'string', - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'PageNum' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Total' => ['description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TaskId' => ['description' => '第一次新建查询时返回的查询任务 ID，用于后续获取消息。', 'type' => 'string', 'example' => '0BC1310300002A9F000021E4D7A48346'], 'Content' => [ 'description' => '消息的详细信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StoreSize' => [ - 'description' => '消息大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '407', - ], - 'ReconsumeTimes' => [ - 'description' => ' 消息重试消费的次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StoreTimestamp' => [ - 'description' => '被服务端存储的时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026708', - ], - 'Topic' => [ - 'description' => ' 消息的 Topic', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '存储该消息的服务器实例', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => ' 生成时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => ' 实例 ID', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '消息体', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '消息 ID，即 Message ID', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '消息体 CRC 校验值', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '生成该消息的客户端实例', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => '消息大小', 'type' => 'integer', 'format' => 'int64', 'example' => '407'], + 'ReconsumeTimes' => ['description' => ' 消息重试消费的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StoreTimestamp' => ['description' => '被服务端存储的时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708'], + 'Topic' => ['description' => ' 消息的 Topic', 'type' => 'string', 'example' => 'test-mq_topic'], + 'StoreHost' => ['description' => '存储该消息的服务器实例', 'type' => 'string', 'example' => '11.220.***.***:10911'], + 'BornTimestamp' => ['description' => ' 生成时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630'], + 'InstanceId' => ['description' => ' 实例 ID', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx'], + 'Body' => ['description' => '消息体', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv'], + 'MsgId' => ['description' => '消息 ID，即 Message ID', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2'], + 'BodyCrc' => ['description' => '消息体 CRC 校验值', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295'], + 'BornHost' => ['description' => '生成该消息的客户端实例', 'type' => 'string', 'example' => '42.120.**.**:64646'], 'PropertyList' => [ 'description' => '消息属性列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'Key 名', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '值', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'Key 名', 'type' => 'string', 'example' => 'TAGS'], + 'Value' => ['description' => '值', 'type' => 'string', 'example' => 'TagA'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], @@ -6049,67 +3594,56 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResendMqSofamqDLQMessageBatch' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryMsConfigAttributes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Cell', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demo-app'], ], [ - 'name' => 'GroupId', + 'name' => 'AttributeName', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => '属性名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'age'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询消息所对应的实例 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ - 'name' => 'MsgIds', + 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '需重发的消息的 ID，即 Message ID，多个消息使用英文逗号分隔', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******', - ], + 'schema' => ['description' => '资源所属域', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alipay'], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'schema' => ['description' => '资源 ID，类似于文件名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alipay.test'], ], ], 'responses' => [ @@ -6117,98 +3651,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '发送失败的消息的 ID，即 Message ID', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'Attribute' => [ + 'description' => '属性信息', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'example' => 'switch'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '属性描述信息', 'type' => 'string', 'example' => '活动开关'], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"Data\\": \\"1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '批量重发死信消息', - 'summary' => '批量重发指定 Message ID 的死信消息，使这些消息能够被 Consumer 再次消费。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Attribute\\": {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取属性详细信息', + 'summary' => '根据域,、应用名、资源 ID、属性名称获取属性详细信息，包含属性 ID。其它接口都依赖此接口获取属性 ID。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResendMqSofamqDLQMessageById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryMsConfigClientValues' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Cell', - 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], - ], - [ - 'name' => 'GroupId', + 'name' => 'AttributeId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id ', - ], + 'schema' => ['description' => '属性自增长 ID，可以通过查询属性接口获取 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ - 'name' => 'MsgId', + 'name' => 'Ips', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消息的 ID，即 Message ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1E0578FE110F18B4AAC235C0C****** ', - ], + 'schema' => ['description' => '查询的 IP 列表，英文逗号隔开', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,127.0.0.2'], ], ], 'responses' => [ @@ -6216,121 +3725,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'Clients' => [ + 'description' => '客户端信息，包含内存值', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => ['description' => '客户端 IP', 'type' => 'string', 'example' => '127.0.0.1'], + 'Data' => ['description' => '客户端内存里的值', 'type' => 'string', 'example' => 'switch'], + 'Success' => ['description' => '是否查询成功', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '重发死信消息', - 'summary' => '使死信消息复活，让消息能够被 Consumer 再消费一次。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Clients\\": [\\n {\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"Data\\": \\"switch\\",\\n \\"Success\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>C8D232D5-C898-4084-880C-B8FD836AB143</RequestId>\\n<Clients>\\n <Ip>127.0.0.1</Ip>\\n <Success>false</Success>\\n</Clients>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '查询客户端的内存值', + 'summary' => '根据属性 ID 查询指定客户端的内存值。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResetMqSofamqConsumerOffset' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClientValues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryMsConfigClients' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Cell', - 'in' => 'formData', - 'schema' => [ - 'description' => '需要查询的单元。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'RZ01A', - ], - ], - [ - 'name' => 'GroupId', + 'name' => 'AttributeId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的消费端 Group ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_consumer_id', - ], + 'schema' => ['description' => '属性自增长 ID，通过查询属性方式获取 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ - 'name' => 'ResetTimestamp', - 'in' => 'formData', - 'schema' => [ - 'description' => '重置位点到指定的时间戳，仅在 Type 为 1 时生效。单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1568033253000', - ], - ], - [ - 'name' => 'Topic', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '需重置位点的 Topic 名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq-topic ', - ], + 'schema' => ['description' => '分页参数，页数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Type', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '消息清理类型，取值说明如下：'."\n" - .'- 0：清除所有消息。'."\n" - .'- 1：清理到指定时间。'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页参数，分页大小', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10'], ], ], 'responses' => [ @@ -6338,97 +3807,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求 ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'PageNum' => ['description' => '分页参数，第几页', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['description' => '分页参数，分页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['description' => '客户端总数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Clients' => [ + 'description' => '客户端信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PushData' => ['description' => '推送的值', 'type' => 'string', 'example' => 'switch'], + 'Ip' => ['description' => '客户端 IP', 'type' => 'string', 'example' => '127.0.0.1'], + 'Data' => ['description' => '客户端内存里的值', 'type' => 'string', 'example' => 'switch'], + 'Cell' => ['description' => '所属的 cell', 'type' => 'string', 'example' => 'DEFAULT'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '重置消费位点', - 'summary' => '重置指定的 Group ID 的消费位点到指定时间戳。一般用于清理堆积消息，或者回溯消费。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Clients\\": [\\n {\\n \\"PushData\\": \\"switch\\",\\n \\"Ip\\": \\"127.0.0.1\\",\\n \\"Data\\": \\"switch\\",\\n \\"Cell\\": \\"DEFAULT\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<clients>\\n <data>DJ9P4BRNBL0S</data>\\n <ip>10.15.232.101</ip>\\n <push_data>DJ9P4BRNBL0S</push_data>\\n <cell>shanghai-et15</cell>\\n</clients>\\n<page_num>1</page_num>\\n<page_size>10</page_size>\\n<result_code>OK</result_code>\\n<result_msg>SUCCESS</result_msg>\\n<total_count>4</total_count>","errorExample":""}]', + 'title' => '查询一个属性所有订阅的客户端信息', + 'summary' => '查询一个属性所有订阅的客户端信息。动态配置客户端在启动的时候，会与服务端建立长连接，并告知动态配置服务端自身关联的属性信息，通过此长连接可以查询到所有订阅属性的客户端信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMqSofamqTopic' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryMsConfigData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '需创建的 Topic 所对应的实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '000001', - ], - ], - [ - 'name' => 'MessageType', + 'name' => 'AttributeId', 'in' => 'formData', - 'schema' => [ - 'description' => '消息类型。取值说明如下：0：普通消息；1：分区顺序消息；2：全局顺序消息；4：事务消息；5：定时/延时消息。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'schema' => ['description' => '属性自增长 ID，可以通过查询属性接口获取 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Remark', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Topic 的备注信息', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '测试', - ], - ], - [ - 'name' => 'Topic', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '需创建的 Topic 的名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], ], 'responses' => [ @@ -6436,85 +3883,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'QueryResult' => [ + 'description' => '查询推送值结果，数组中每一项表示具体的单元，DEFAULT_ZONE 表示所有单元。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '推送值', 'type' => 'string', 'example' => 'some push data'], + 'Cell' => ['description' => '推送目标 cell', 'type' => 'string', 'example' => 'cell1'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '在指定环境实例下创建一个 Topic', - 'summary' => '需要指定消息类型与 Topic 名称。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"QueryResult\\": [\\n {\\n \\"Data\\": \\"some push data\\",\\n \\"Cell\\": \\"cell1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryResult>\\n <Data>强势推送思密达</Data>\\n <Cell>ZONEA</Cell>\\n</QueryResult>\\n<RequestId>5C8C4130-BFDB-4AC2-A61C-2D26B1DDCC7B</RequestId>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '查询属性最后一次推送值', + 'summary' => '根据属性 ID 查询其最后一次推送值。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMqSofamqTopicRemark' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryMsConfigResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'foo'], + ], + [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ - 'name' => 'Remark', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'Topic 描述信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '资源 ID 模糊查询关键字', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'com.alipay.drmResource'], ], [ - 'name' => 'Topic', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '需更新的 Topic 名称，一个用户下不可重复。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '分页参数，第几页', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => '分页参数，分页大小。默认值为 10', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10'], ], ], 'responses' => [ @@ -6522,110 +3969,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'PageNum' => ['description' => '分页参数，第几页', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['description' => '分页参数，分页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['description' => '满足模糊查询条件的结果总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'Resources' => [ + 'description' => '模糊查询资源结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => '应用名', 'type' => 'string', 'example' => 'drmdemo'], + 'Region' => ['description' => '资源所属的域', 'type' => 'string', 'example' => 'Alipay'], + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'ResourceId' => ['description' => '资源 ID', 'type' => 'string', 'example' => 'com.alipay.drmResource'], + 'Id' => ['description' => '资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '资源描述信息', 'type' => 'string', 'example' => '活动开关'], + 'Attributes' => [ + 'description' => '属性列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例 ID', 'type' => 'string', 'example' => 'abcdEFGH1234'], + 'AttributeName' => ['description' => '属性名', 'type' => 'string', 'example' => 'switch'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Desc' => ['description' => '属性描述信息', 'type' => 'string', 'example' => '活动开关'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '更新 Topic 的信息', - 'summary' => '用来更新或修改 Topic 的描述信息。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Resources\\": [\\n {\\n \\"AppName\\": \\"drmdemo\\",\\n \\"Region\\": \\"Alipay\\",\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"ResourceId\\": \\"com.alipay.drmResource\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\",\\n \\"Attributes\\": [\\n {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<TotalCount>2</TotalCount>\\n<RequestId>2BFB4C50-A7EE-4803-A53D-32036246F53F</RequestId>\\n<PageNum>1</PageNum>\\n<PageSize>10</PageSize>\\n<Resources>\\n <Desc>这是描述</Desc>\\n <InstanceId>AWHNEX3GFLJA</InstanceId>\\n <ResourceId>com.alipay.test.resource1</ResourceId>\\n <Region>Alipay</Region>\\n <Id>41</Id>\\n <AppName>someAppName1</AppName>\\n</Resources>\\n<Resources>\\n <Desc>这是描述</Desc>\\n <InstanceId>AWHNEX3GFLJA</InstanceId>\\n <ResourceId>com.alipay.test.resource2</ResourceId>\\n <Region>Alipay</Region>\\n <Id>44</Id>\\n <AppName>someAppName2</AppName>\\n</Resources>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '查询资源元信息', + 'summary' => '根据应用名或者资源 ID 模糊查询对应的资源元信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCasComputers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRMSMetrics' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'Start', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数，第几页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '21', - ], + 'schema' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1636308360000'], ], [ - 'name' => 'Name', + 'name' => 'End', + 'in' => 'formData', + 'schema' => ['description' => '查询结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1632278280000'], + ], + [ + 'name' => 'Plugin', 'in' => 'formData', 'schema' => [ - 'description' => '名称', + 'description' => '插件类型', 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'opscenter', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => ['SEC' => 'SEC', 'STACK' => 'STACK', 'MM' => 'MM', 'SPM' => 'SPM', 'SM' => 'SM'], + 'example' => 'SM', ], ], [ - 'name' => 'PageSize', + 'name' => 'DsId', + 'in' => 'formData', + 'schema' => ['description' => '监控指标唯一ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2643'], + ], + [ + 'name' => 'ContentType', 'in' => 'formData', 'schema' => [ - 'description' => '每页大小', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '指标数据类型', + 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => '100', + 'enumValueTitles' => ['SPM' => 'SPM', 'KEYSET' => 'KEYSET', 'SINGLE_KEY_STAT' => 'SINGLE_KEY_STAT', 'INDEXABLE_MULTI_KEY_STAT' => 'INDEXABLE_MULTI_KEY_STAT'], + 'example' => 'INDEXABLE_MULTI_KEY_STAT', ], ], [ - 'name' => 'Workspace', + 'name' => 'WorkspaceName', + 'in' => 'formData', + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod'], + ], + [ + 'name' => 'PeriodType', 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => ''], + ], + [ + 'name' => 'FieldsRepeatList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '工作空间', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'shfinpre', + 'description' => '指标维度过滤条件，一般可不填', + 'type' => 'array', + 'items' => ['description' => '指标维度过滤条件，一般可不填'."\n" + ."\n", 'type' => 'string', 'required' => false], + 'required' => false, + 'maxItems' => 100, ], ], [ - 'name' => 'AppServiceIdsRepeatList', + 'name' => 'Where', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '应用服务id列表', + 'description' => '更多过滤条件', 'type' => 'array', 'items' => [ - 'description' => '应用服务id列表', - 'type' => 'string', + 'description' => '过滤条件对象', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '过滤 Key', 'type' => 'string', 'required' => false, 'example' => 'app'], + 'Value' => ['description' => '过滤 Value', 'type' => 'string', 'required' => false, 'example' => 'monitorprod'], + ], 'required' => false, - 'example' => '2144098938', ], 'required' => false, 'maxItems' => 100, @@ -6635,620 +4131,143 @@ 'responses' => [ 200 => [ 'schema' => [ + 'description' => '监控指标数据', 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '返回结果的当前页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DB5EB9EB-8690-570B-8A7F-41FF1C89C02E', - ], - 'ResultMessage' => [ - 'type' => 'string', - ], - 'ResultCode' => [ - 'type' => 'string', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'TotalCount' => [ - 'description' => '总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75', - ], - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'type' => 'string', - ], - 'SerialNumber' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'type' => 'string', - ], - 'PrivateIp' => [ - 'type' => 'string', - ], - 'UtcCreate' => [ - 'type' => 'string', - ], - 'ProviderId' => [ - 'type' => 'string', - ], - 'ImageIaasId' => [ - 'type' => 'string', - ], - 'ImageId' => [ - 'type' => 'string', - ], - 'SpecIaasId' => [ - 'type' => 'string', - ], - 'DeployMode' => [ - 'type' => 'string', - ], - 'IaasId' => [ - 'type' => 'string', - ], - 'Initialized' => [ - 'description' => '是否已初始化。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AutoRenewPeriod' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'PaasStatus' => [ - 'type' => 'string', - ], - 'InstanceChargeType' => [ - 'type' => 'string', - ], - 'VSwitchIaasId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'ImageName' => [ - 'type' => 'string', - ], - 'PublicIp' => [ - 'type' => 'string', - ], - 'ZoneId' => [ - 'type' => 'string', - ], - 'CpuShared' => [ - 'type' => 'boolean', - ], - 'IaasType' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'OsBit' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'IaasStatus' => [ - 'type' => 'string', - ], - 'NetworkType' => [ - 'type' => 'string', - ], - 'Password' => [ - 'type' => 'string', - ], - 'Bandwidth' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Description' => [ - 'type' => 'string', - ], - 'UtcModified' => [ - 'type' => 'string', - ], - 'AppId' => [ - 'type' => 'string', - ], - 'OsVersion' => [ - 'type' => 'string', - ], - 'LastOpsType' => [ - 'type' => 'string', - ], - 'Memory' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Name' => [ - 'type' => 'string', - ], - 'CommonImage' => [ - 'type' => 'boolean', - ], - 'AutoRenew' => [ - 'type' => 'boolean', - ], - 'TenantId2' => [ - 'type' => 'string', - ], - 'Os' => [ - 'type' => 'string', - ], - 'RegionId' => [ - 'type' => 'string', - ], - 'IoOptimized' => [ - 'type' => 'boolean', - ], - 'Cpu' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ElasticIp' => [ - 'type' => 'string', - ], - 'ExpiredTime' => [ - 'type' => 'string', - ], - 'ThreadsPerCore' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Id' => [ - 'type' => 'string', - ], - 'LastOpsOrderId' => [ - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'DataDisks' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'EnableAutoSnapshot' => [ - 'type' => 'boolean', - ], - 'UtcCreate' => [ - 'type' => 'string', - ], - 'IaasId' => [ - 'type' => 'string', - ], - 'ProviderId' => [ - 'type' => 'string', - ], - 'DeleteAutoSnapshot' => [ - 'type' => 'boolean', - ], - 'RegionId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'UtcModified' => [ - 'type' => 'string', - ], - 'Size' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Device' => [ - 'type' => 'string', - ], - 'ZoneId' => [ - 'type' => 'string', - ], - 'Portable' => [ - 'type' => 'boolean', - ], - 'Category' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'ImageId' => [ - 'type' => 'string', - ], - 'DeleteWithComputer' => [ - 'type' => 'boolean', - ], - 'Id' => [ - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'Computer' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'type' => 'string', - ], - 'IaasId' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'Options' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Tags' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'type' => 'string', - ], - 'Value' => [ - 'type' => 'string', - ], - ], - ], - ], - 'AssignedAppServiceIds' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AppServiceIds' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'SystemDisk' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'EnableAutoSnapshot' => [ - 'type' => 'boolean', - ], - 'UtcCreate' => [ - 'type' => 'string', - ], - 'IaasId' => [ - 'type' => 'string', - ], - 'ProviderId' => [ - 'type' => 'string', - ], - 'DeleteAutoSnapshot' => [ - 'type' => 'boolean', - ], - 'RegionId' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'type' => 'string', - ], - 'UtcModified' => [ - 'type' => 'string', - ], - 'Size' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Device' => [ - 'type' => 'string', - ], - 'ZoneId' => [ - 'type' => 'string', - ], - 'Portable' => [ - 'type' => 'boolean', - ], - 'Category' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'ImageId' => [ - 'type' => 'string', - ], - 'DeleteWithComputer' => [ - 'type' => 'boolean', - ], - 'Id' => [ - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'Computer' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'type' => 'string', - ], - 'IaasId' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Id' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], + 'ResultMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '""'], + 'ResultCode' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '38D23571-2FDD-5A3B-AF04-15A30B96D11B'], + 'Result' => ['description' => '返回结果', 'type' => 'string', 'example' => '{"success":true,"message":"query ok, time cost: 33ms, pontus@{}","data":[{"tags":{},"datasByTime":{"1646014620000":[18730.0],"1646012400000":[17849.0],"1646010180000":[17860.0],"1646014140000":[18832.0],"1646011920000":[17843.0],"1646013660000":[17799.0],"1646011440000":[17803.0],"1646015400000":[17988.0],"1646013180000":[17851.0],"1646010960000":[17895.0],"1646014920000":[17628.0],"1646012700000":[17937.0],"1646010480000":[17757.0],"1646012580000":[17815.0],"1646014440000":[17785.0],"1646010000000":[17791.0],"1646012100000":[17785.0],"1646013960000":[17895.0],"1646011620000":[17822.0],"1646013480000":[17809.0],"1646015580000":[18780.0],"1646011140000":[17805.0],"1646013000000":[17682.0],"1646015100000":[18924.0],"1646010660000":[17819.0],"1646010540000":[17653.0],"1646014740000":[17848.0],"1646012280000":[17861.0],"1646010060000":[17787.0],"1646014260000":[17770.0],"1646011800000":[17990.0],"1646013780000":[17942.0],"1646011320000":[17749.0],"1646015520000":[18159.0],"1646013300000":[17889.0],"1646010840000":[17755.0],"1646015040000":[18836.0],"1646012820000":[17878.0],"1646010360000":[17829.0],"1646012460000":[17896.0],"1646014560000":[18979.0],"1646009880000":[17798.0],"1646011980000":[17806.0],"1646014080000":[17337.0],"1646011500000":[17801.0],"1646013600000":[17940.0],"1646015700000":[17885.0],"1646015220000":[18172.0],"1646011020000":[17757.0],"1646013120000":[17650.0],"1646012640000":[17825.0],"1646010420000":[17767.0],"1646014380000":[17769.0],"1646012160000":[17806.0],"1646009940000":[17769.0],"1646013900000":[17789.0],"1646011680000":[17808.0],"1646015640000":[17905.0],"1646013420000":[17888.0],"1646011200000":[17782.0],"1646015160000":[17304.0],"1646012940000":[17807.0],"1646010720000":[17821.0],"1646014680000":[17759.0],"1646010240000":[17749.0],"1646012340000":[17826.0],"1646014200000":[18874.0],"1646011860000":[17909.0],"1646013720000":[17905.0],"1646015820000":[null],"1646011380000":[17792.0],"1646013240000":[17841.0],"1646015340000":[17853.0],"1646010900000":[17811.0],"1646012760000":[17831.0],"1646014860000":[18881.0],"1646012520000":[17836.0],"1646014500000":[17888.0],"1646010300000":[17793.0],"1646012040000":[17745.0],"1646009820000":[17785.0],"1646014020000":[18936.0],"1646011560000":[17805.0],"1646015760000":[17891.0],"1646013540000":[17843.0],"1646011080000":[17773.0],"1646015280000":[18916.0],"1646013060000":[17858.0],"1646010600000":[17774.0],"1646014800000":[18913.0],"1646010120000":[17848.0],"1646012220000":[17738.0],"1646014320000":[17758.0],"1646011740000":[17766.0],"1646013840000":[17811.0],"1646011260000":[17764.0],"1646013360000":[17872.0],"1646015460000":[17721.0],"1646010780000":[17763.0],"1646012880000":[17821.0],"1646014980000":[17770.0]},"dataMapByTime":{}}],"ip":"11.124.205.28","attend":{"attends":{"FIN-PAAS-DEV":{"expect":30.0,"actual":30.0}},"attendsByIdc":{"FIN-PAAS-DEV":{"1646015760000":{"expect":2.0,"actual":2.0},"1646015700000":{"expect":2.0,"actual":2.0},"1646015640000":{"expect":2.0,"actual":2.0},"1646015580000":{"expect":2.0,"actual":2.0},"1646015520000":{"expect":2.0,"actual":2.0},"1646015460000":{"expect":2.0,"actual":2.0},"1646015400000":{"expect":2.0,"actual":2.0},"1646015340000":{"expect":2.0,"actual":2.0},"1646015220000":{"expect":2.0,"actual":2.0},"1646015280000":{"expect":2.0,"actual":2.0},"1646015160000":{"expect":2.0,"actual":2.0},"1646015100000":{"expect":2.0,"actual":2.0},"1646015040000":{"expect":2.0,"actual":2.0},"1646014980000":{"expect":2.0,"actual":2.0},"1646014920000":{"expect":2.0,"actual":2.0}}}}}'], ], ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 16,\\n \\"RequestId\\": \\"DB5EB9EB-8690-570B-8A7F-41FF1C89C02E\\",\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 75,\\n \\"Data\\": [\\n {\\n \\"CreationTime\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"VpcId\\": \\"\\",\\n \\"PrivateIp\\": \\"\\",\\n \\"UtcCreate\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"ImageIaasId\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"SpecIaasId\\": \\"\\",\\n \\"DeployMode\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Initialized\\": true,\\n \\"AutoRenewPeriod\\": 0,\\n \\"PaasStatus\\": \\"\\",\\n \\"InstanceChargeType\\": \\"\\",\\n \\"VSwitchIaasId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"ImageName\\": \\"\\",\\n \\"PublicIp\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"CpuShared\\": true,\\n \\"IaasType\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"OsBit\\": 0,\\n \\"IaasStatus\\": \\"\\",\\n \\"NetworkType\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"Bandwidth\\": 0,\\n \\"Description\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"AppId\\": \\"\\",\\n \\"OsVersion\\": \\"\\",\\n \\"LastOpsType\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"Name\\": \\"\\",\\n \\"CommonImage\\": true,\\n \\"AutoRenew\\": true,\\n \\"TenantId2\\": \\"\\",\\n \\"Os\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"IoOptimized\\": true,\\n \\"Cpu\\": 0,\\n \\"ElasticIp\\": \\"\\",\\n \\"ExpiredTime\\": \\"\\",\\n \\"ThreadsPerCore\\": 0,\\n \\"Id\\": \\"\\",\\n \\"LastOpsOrderId\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"DataDisks\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"EnableAutoSnapshot\\": true,\\n \\"UtcCreate\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"DeleteAutoSnapshot\\": true,\\n \\"RegionId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"Size\\": 0,\\n \\"Device\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"Portable\\": true,\\n \\"Category\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"DeleteWithComputer\\": true,\\n \\"Id\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"Computer\\": {\\n \\"Status\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Id\\": \\"\\"\\n }\\n }\\n ],\\n \\"Options\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"AssignedAppServiceIds\\": [\\n \\"\\"\\n ],\\n \\"AppServiceIds\\": [\\n \\"\\"\\n ],\\n \\"SystemDisk\\": {\\n \\"Type\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"EnableAutoSnapshot\\": true,\\n \\"UtcCreate\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"DeleteAutoSnapshot\\": true,\\n \\"RegionId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"Size\\": 0,\\n \\"Device\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"Portable\\": true,\\n \\"Category\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"DeleteWithComputer\\": true,\\n \\"Id\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"Computer\\": {\\n \\"Status\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Id\\": \\"\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询机器列表', - 'description' => '分页查询机器', - ], - 'AddMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"38D23571-2FDD-5A3B-AF04-15A30B96D11B\\",\\n \\"Result\\": \\"{\\\\\\"success\\\\\\":true,\\\\\\"message\\\\\\":\\\\\\"query ok, time cost: 33ms, pontus@{}\\\\\\",\\\\\\"data\\\\\\":[{\\\\\\"tags\\\\\\":{},\\\\\\"datasByTime\\\\\\":{\\\\\\"1646014620000\\\\\\":[18730.0],\\\\\\"1646012400000\\\\\\":[17849.0],\\\\\\"1646010180000\\\\\\":[17860.0],\\\\\\"1646014140000\\\\\\":[18832.0],\\\\\\"1646011920000\\\\\\":[17843.0],\\\\\\"1646013660000\\\\\\":[17799.0],\\\\\\"1646011440000\\\\\\":[17803.0],\\\\\\"1646015400000\\\\\\":[17988.0],\\\\\\"1646013180000\\\\\\":[17851.0],\\\\\\"1646010960000\\\\\\":[17895.0],\\\\\\"1646014920000\\\\\\":[17628.0],\\\\\\"1646012700000\\\\\\":[17937.0],\\\\\\"1646010480000\\\\\\":[17757.0],\\\\\\"1646012580000\\\\\\":[17815.0],\\\\\\"1646014440000\\\\\\":[17785.0],\\\\\\"1646010000000\\\\\\":[17791.0],\\\\\\"1646012100000\\\\\\":[17785.0],\\\\\\"1646013960000\\\\\\":[17895.0],\\\\\\"1646011620000\\\\\\":[17822.0],\\\\\\"1646013480000\\\\\\":[17809.0],\\\\\\"1646015580000\\\\\\":[18780.0],\\\\\\"1646011140000\\\\\\":[17805.0],\\\\\\"1646013000000\\\\\\":[17682.0],\\\\\\"1646015100000\\\\\\":[18924.0],\\\\\\"1646010660000\\\\\\":[17819.0],\\\\\\"1646010540000\\\\\\":[17653.0],\\\\\\"1646014740000\\\\\\":[17848.0],\\\\\\"1646012280000\\\\\\":[17861.0],\\\\\\"1646010060000\\\\\\":[17787.0],\\\\\\"1646014260000\\\\\\":[17770.0],\\\\\\"1646011800000\\\\\\":[17990.0],\\\\\\"1646013780000\\\\\\":[17942.0],\\\\\\"1646011320000\\\\\\":[17749.0],\\\\\\"1646015520000\\\\\\":[18159.0],\\\\\\"1646013300000\\\\\\":[17889.0],\\\\\\"1646010840000\\\\\\":[17755.0],\\\\\\"1646015040000\\\\\\":[18836.0],\\\\\\"1646012820000\\\\\\":[17878.0],\\\\\\"1646010360000\\\\\\":[17829.0],\\\\\\"1646012460000\\\\\\":[17896.0],\\\\\\"1646014560000\\\\\\":[18979.0],\\\\\\"1646009880000\\\\\\":[17798.0],\\\\\\"1646011980000\\\\\\":[17806.0],\\\\\\"1646014080000\\\\\\":[17337.0],\\\\\\"1646011500000\\\\\\":[17801.0],\\\\\\"1646013600000\\\\\\":[17940.0],\\\\\\"1646015700000\\\\\\":[17885.0],\\\\\\"1646015220000\\\\\\":[18172.0],\\\\\\"1646011020000\\\\\\":[17757.0],\\\\\\"1646013120000\\\\\\":[17650.0],\\\\\\"1646012640000\\\\\\":[17825.0],\\\\\\"1646010420000\\\\\\":[17767.0],\\\\\\"1646014380000\\\\\\":[17769.0],\\\\\\"1646012160000\\\\\\":[17806.0],\\\\\\"1646009940000\\\\\\":[17769.0],\\\\\\"1646013900000\\\\\\":[17789.0],\\\\\\"1646011680000\\\\\\":[17808.0],\\\\\\"1646015640000\\\\\\":[17905.0],\\\\\\"1646013420000\\\\\\":[17888.0],\\\\\\"1646011200000\\\\\\":[17782.0],\\\\\\"1646015160000\\\\\\":[17304.0],\\\\\\"1646012940000\\\\\\":[17807.0],\\\\\\"1646010720000\\\\\\":[17821.0],\\\\\\"1646014680000\\\\\\":[17759.0],\\\\\\"1646010240000\\\\\\":[17749.0],\\\\\\"1646012340000\\\\\\":[17826.0],\\\\\\"1646014200000\\\\\\":[18874.0],\\\\\\"1646011860000\\\\\\":[17909.0],\\\\\\"1646013720000\\\\\\":[17905.0],\\\\\\"1646015820000\\\\\\":[null],\\\\\\"1646011380000\\\\\\":[17792.0],\\\\\\"1646013240000\\\\\\":[17841.0],\\\\\\"1646015340000\\\\\\":[17853.0],\\\\\\"1646010900000\\\\\\":[17811.0],\\\\\\"1646012760000\\\\\\":[17831.0],\\\\\\"1646014860000\\\\\\":[18881.0],\\\\\\"1646012520000\\\\\\":[17836.0],\\\\\\"1646014500000\\\\\\":[17888.0],\\\\\\"1646010300000\\\\\\":[17793.0],\\\\\\"1646012040000\\\\\\":[17745.0],\\\\\\"1646009820000\\\\\\":[17785.0],\\\\\\"1646014020000\\\\\\":[18936.0],\\\\\\"1646011560000\\\\\\":[17805.0],\\\\\\"1646015760000\\\\\\":[17891.0],\\\\\\"1646013540000\\\\\\":[17843.0],\\\\\\"1646011080000\\\\\\":[17773.0],\\\\\\"1646015280000\\\\\\":[18916.0],\\\\\\"1646013060000\\\\\\":[17858.0],\\\\\\"1646010600000\\\\\\":[17774.0],\\\\\\"1646014800000\\\\\\":[18913.0],\\\\\\"1646010120000\\\\\\":[17848.0],\\\\\\"1646012220000\\\\\\":[17738.0],\\\\\\"1646014320000\\\\\\":[17758.0],\\\\\\"1646011740000\\\\\\":[17766.0],\\\\\\"1646013840000\\\\\\":[17811.0],\\\\\\"1646011260000\\\\\\":[17764.0],\\\\\\"1646013360000\\\\\\":[17872.0],\\\\\\"1646015460000\\\\\\":[17721.0],\\\\\\"1646010780000\\\\\\":[17763.0],\\\\\\"1646012880000\\\\\\":[17821.0],\\\\\\"1646014980000\\\\\\":[17770.0]},\\\\\\"dataMapByTime\\\\\\":{}}],\\\\\\"ip\\\\\\":\\\\\\"11.124.205.28\\\\\\",\\\\\\"attend\\\\\\":{\\\\\\"attends\\\\\\":{\\\\\\"FIN-PAAS-DEV\\\\\\":{\\\\\\"expect\\\\\\":30.0,\\\\\\"actual\\\\\\":30.0}},\\\\\\"attendsByIdc\\\\\\":{\\\\\\"FIN-PAAS-DEV\\\\\\":{\\\\\\"1646015760000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015700000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015640000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015580000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015520000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015460000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015400000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015340000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015220000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015280000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015160000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015100000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015040000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646014980000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646014920000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0}}}}}\\"\\n}","type":"json"}]', + 'title' => '查询监控指标数据', + 'summary' => '根据指标ID等过滤条件查询监控指标时序数据。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRMSUnifiedAlarmEvent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AttributeName', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '属性名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'age', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true], ], [ - 'name' => 'Desc', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '年龄', - ], + 'schema' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '环境实例 ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'ResourceId', + 'name' => 'AlarmLevel', + 'in' => 'formData', + 'schema' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], + ], + [ + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => '所属的资源自增长 ID', + 'description' => ' '."\n" + .'触发状态', 'type' => 'integer', 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [2 => '告警中', 4 => '已静默', '已恢复'], ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Attribute' => [ - 'description' => '添加成功的属性结构体', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '属性名', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], - ], - ], - ], - ], + [ + 'name' => 'AlarmTargetType', + 'in' => 'formData', + 'schema' => ['description' => '告警对象类型', 'type' => 'string', 'required' => false, 'docRequired' => false], ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Attribute\\": {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>357EA602-4A8C-456E-82D9-720C843F8EE4</RequestId>\\n<Attribute>\\n <Desc>性别</Desc>\\n <InstanceId>9XP0PS5JQHJU</InstanceId>\\n <AttributeName>sex</AttributeName>\\n <Id>11</Id>\\n</Attribute>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '增加属性元信息', - 'summary' => '在配置文件配置项中增加属性，只有添加属性之后，才能对属性进行推送。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => '按告警内容查询', 'type' => 'string', 'required' => false, 'docRequired' => false], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => '应用名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'foo', - ], + 'schema' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true], ], [ - 'name' => 'Attributes', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '资源的属性信息，以 JSON 字符串格式传入', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[ { "attribute_name":"attName", "desc":"some attribute comment" }, ... ]', - ], + 'schema' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true], ], [ - 'name' => 'Desc', + 'name' => 'AlarmRuleId', 'in' => 'formData', - 'schema' => [ - 'description' => '资源描述信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '测试资源类', - ], + 'schema' => ['description' => ' '."\n" + .'告警规则 ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'InstanceId', + 'name' => 'AlarmStackInfoJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '系统字段：环境实例 ID'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => '根据应用栈过滤 json格式 包含字段如下：'."\n" + ."\n" + .'datasource_type STRING 否 ["CUSTOM","STACK","TABLE] '."\n" + .'是应用监控，还是自定义监控'."\n" + ."\n" + .'datasource STRING 否 MM@@2000464 '."\n" + .'数据源'."\n" + ."\n" + .'alarm_target_type STRING 否 ["APP","HOST"] '."\n" + .'应用类型'."\n" + ."\n" + .'alarm_target_identify STRING 否 RMS-monitorprod '."\n" + .'应用名称', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'Region', + 'name' => 'AlarmRuleUuid', 'in' => 'formData', - 'schema' => [ - 'description' => '资源类所属的域', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Alipay', - ], + 'schema' => ['description' => '告警规则uuid', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'ResourceId', + 'name' => 'AlarmTargetKeyword', 'in' => 'formData', + 'schema' => ['description' => '按告警对象搜索', 'type' => 'string', 'required' => false, 'docRequired' => false], + ], + [ + 'name' => 'AlarmStatusRepeatList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '资源 ID，类似于配置文件的文件名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.alipay.test.resource', + 'description' => '告警状态', + 'type' => 'array', + 'items' => ['description' => '告警状态', 'type' => 'integer', 'format' => 'int64', 'required' => false], + 'required' => false, + 'maxItems' => 100, ], ], ], @@ -7257,82 +4276,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Resource' => [ - 'description' => '创建成功的资源信息', - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '应用名', - 'type' => 'string', - 'example' => 'drmdemo', - ], - 'Region' => [ - 'description' => '资源所属的域', - 'type' => 'string', - 'example' => 'Alipay', - ], - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'ResourceId' => [ - 'description' => '资源 ID', - 'type' => 'string', - 'example' => 'com.alipay.drmResource', - ], - 'Id' => [ - 'description' => '资源自增长 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '资源描述信息', - 'type' => 'string', - 'example' => '活动开关', - ], - 'Attributes' => [ - 'description' => '属性列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '属性名', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '属性描述信息', - 'type' => 'string', - 'example' => '活动开关', + 'CurrentPage' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64'], + 'RequestId' => ['description' => '请求id', 'type' => 'string'], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int64'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64'], + 'UnifiedAlarmEventList' => [ + 'description' => '告警事件详情', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件详情', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '触发状态', 'type' => 'integer', 'format' => 'int64'], + 'AlarmTargetType' => ['description' => '告警对象类型', 'type' => 'string'], + 'AlarmStartTime' => ['description' => '告警产生时间', 'type' => 'string'], + 'SilenceRemainTime' => ['description' => '静默剩余时间', 'type' => 'integer', 'format' => 'int64'], + 'DataSourceName' => ['description' => '数据源名称', 'type' => 'string'], + 'AlarmType' => ['description' => ' 告警类型', 'type' => 'string'], + 'AlarmRecoverTime' => ['description' => ' '."\n" + .'告警恢复时间', 'type' => 'string'], + 'AlarmRuleId' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64'], + 'AlarmHistoryId' => ['description' => '报警历史id', 'type' => 'integer', 'format' => 'int64'], + 'AlarmContent' => ['description' => '报警内容', 'type' => 'string'], + 'AlarmUrl' => ['description' => '告警数据源跳转url', 'type' => 'string'], + 'AlarmUrlWithDomain' => ['description' => '网页的绝对路径，包含域名', 'type' => 'string'], + 'AlarmTargetDeleted' => ['description' => '目标对象是否删除', 'type' => 'boolean'], + 'AlarmLevel' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64'], + 'AlarmEventId' => ['description' => '告警事件id', 'type' => 'string'], + 'AlarmTarget' => ['description' => '告警对象', 'type' => 'string'], + 'AlarmHistoryList' => [ + 'description' => '报警历史详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警历史详情', + 'type' => 'object', + 'properties' => [ + 'AlarmTargetType' => ['description' => '告警对象类型', 'type' => 'string'], + 'Status' => ['description' => '触发状态', 'type' => 'integer', 'format' => 'int64'], + 'DataSourceName' => ['description' => '数据源名称', 'type' => 'string'], + 'AlarmType' => ['description' => '告警类型', 'type' => 'string'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'string'], + 'EventId' => ['description' => '告警事件id', 'type' => 'string'], + 'WorkspaceId' => ['description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64'], + 'UniqueIdentity' => ['description' => '告警规则唯一标识', 'type' => 'string'], + 'AlarmTime' => ['description' => '告警时间', 'type' => 'integer', 'format' => 'int64'], + 'AlarmRuleId' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string'], + 'AlarmDetail' => ['description' => '告警详情', 'type' => 'string'], + 'AlarmUrl' => ['description' => '告警数据源跳转url', 'type' => 'string'], + 'AlarmContent' => ['description' => '报警内容', 'type' => 'string'], + 'AlarmUrlWithDomain' => ['description' => '网页的绝对路径，包含域名', 'type' => 'string'], + 'AlarmTargetDeleted' => ['description' => '目标对象是否删除', 'type' => 'boolean'], + 'AlarmLevel' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64'], + 'Id' => ['description' => '主键ID', 'type' => 'integer', 'format' => 'int64'], + 'TenantId' => ['description' => '租户id', 'type' => 'integer', 'format' => 'int64'], + 'AlarmTarget' => ['description' => '告警对象', 'type' => 'string'], + 'AlarmRuleName' => ['description' => '报警规则名称', 'type' => 'string'], ], ], ], @@ -7340,344 +4341,304 @@ ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Resource\\": {\\n \\"AppName\\": \\"drmdemo\\",\\n \\"Region\\": \\"Alipay\\",\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"ResourceId\\": \\"com.alipay.drmResource\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\",\\n \\"Attributes\\": [\\n {\\n \\"InstanceId\\": \\"abcdEFGH1234\\",\\n \\"AttributeName\\": \\"switch\\",\\n \\"Id\\": 1,\\n \\"Desc\\": \\"活动开关\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>AD040CD2-9302-4C74-89A5-2AF0C220B1B9</RequestId>\\n<Resource>\\n <Desc>这是描述</Desc>\\n <InstanceId>AWHNEX3GFLJT</InstanceId>\\n <ResourceId>com.alipay.test.resource1</ResourceId>\\n <Region>Alipay</Region>\\n <Id>44</Id>\\n <AppName>someAppName</AppName>\\n</Resource>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => '增加资源元数据', - 'summary' => '资源相当于文件的概念，一个资源下可以有多个属性。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 0,\\n \\"UnifiedAlarmEventList\\": [\\n {\\n \\"Status\\": 0,\\n \\"AlarmTargetType\\": \\"\\",\\n \\"AlarmStartTime\\": \\"\\",\\n \\"SilenceRemainTime\\": 0,\\n \\"DataSourceName\\": \\"\\",\\n \\"AlarmType\\": \\"\\",\\n \\"AlarmRecoverTime\\": \\"\\",\\n \\"AlarmRuleId\\": 0,\\n \\"AlarmHistoryId\\": 0,\\n \\"AlarmContent\\": \\"\\",\\n \\"AlarmUrl\\": \\"\\",\\n \\"AlarmUrlWithDomain\\": \\"\\",\\n \\"AlarmTargetDeleted\\": true,\\n \\"AlarmLevel\\": 0,\\n \\"AlarmEventId\\": \\"\\",\\n \\"AlarmTarget\\": \\"\\",\\n \\"AlarmHistoryList\\": [\\n {\\n \\"AlarmTargetType\\": \\"\\",\\n \\"Status\\": 0,\\n \\"DataSourceName\\": \\"\\",\\n \\"AlarmType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"EventId\\": \\"\\",\\n \\"WorkspaceId\\": 0,\\n \\"UniqueIdentity\\": \\"\\",\\n \\"AlarmTime\\": 0,\\n \\"AlarmRuleId\\": 0,\\n \\"GmtCreate\\": \\"\\",\\n \\"AlarmDetail\\": \\"\\",\\n \\"AlarmUrl\\": \\"\\",\\n \\"AlarmContent\\": \\"\\",\\n \\"AlarmUrlWithDomain\\": \\"\\",\\n \\"AlarmTargetDeleted\\": true,\\n \\"AlarmLevel\\": 0,\\n \\"Id\\": 0,\\n \\"TenantId\\": 0,\\n \\"AlarmTarget\\": \\"\\",\\n \\"AlarmRuleName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询告警事件历史', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRMSUnifiedAlarmHistory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAStack杭州金区-生产'], ], [ - 'name' => 'Name', + 'name' => 'Start', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TAGS', - ], + 'schema' => ['description' => '查询开始时间，格式为Unix时间戳，单位为毫秒。'."\n" + ."\n" + .'> 查询开始时间需在数据库实例SQL洞察存储时长范围内，最大不能早于当前时间90天。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1668911820000'], ], [ - 'name' => 'Category', + 'name' => 'End', 'in' => 'formData', - 'schema' => [ - 'description' => '规则类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CUSTOM', - ], + 'schema' => ['description' => '查询数据的终止日期，格式为Unix时间戳，单位为毫秒。'."\n" + ."\n" + .'> 查询结束时间需晚于查询开始时间，最晚只能查询到当天凌晨0点的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1662516900000'], ], [ - 'name' => 'RuleConfig', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则配置', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{\\"trafficType\\":\\"i\\",\\"methodName\\":\\"*\\",\\"faultInjectRuleItems\\":[{\\"action\\":{\\"type\\":\\"REJECT\\"},\\"ruleType\\":\\"ABORT\\",\\"configs\\":{\\"faultPercent\\":100}}]} ', - ], + 'schema' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '2'], ], [ - 'name' => 'AlarmNodata', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '报警通知结果数据', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '分页参数，分页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'], ], [ - 'name' => 'Level', + 'name' => 'AlarmTargetType', 'in' => 'formData', - 'schema' => [ - 'description' => '告警等级', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2', - ], + 'schema' => ['description' => '告警对象类型', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'APP'], ], [ - 'name' => 'Emergency', + 'name' => 'AlarmTarget', 'in' => 'formData', - 'schema' => [ - 'description' => '应急处理人', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '告警对象', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PlanetKms'], ], [ - 'name' => 'EmergencyUrl', + 'name' => 'AlarmLevel', 'in' => 'formData', - 'schema' => [ - 'description' => '应急处理链接', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'PendingHit', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => ' 触发周期', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '告警状态', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'RecoveredHit', + 'name' => 'AlarmStackInfoJsonStr', 'in' => 'formData', + 'schema' => ['description' => '根据应用过滤告警历史json格式 包含字段如下：'."\n" + ."\n" + .'datasource_type STRING 否 ["CUSTOM","STACK","TABLE] '."\n" + .'是应用监控，还是自定义监控'."\n" + ."\n" + .'datasource STRING 否 MM@@2000464 '."\n" + .'数据源'."\n" + ."\n" + .'alarm_target_type STRING 否 ["APP","HOST"] '."\n" + .'应用类型'."\n" + ."\n" + .'alarm_target_identify STRING 否 RMS-monitorprod '."\n" + .'应用名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\"DatasourceType\\":\\"STACK\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-twc-universal\\"}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '恢复周期', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'CB2B427A-E370-5599-8872-A249F8EFD859'], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'workspace not found with name TWCProd, tenant_id 0008528286'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['description' => '分页参数，分页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'AlarmHistories' => [ + 'description' => '报警历史对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '报警历史详情', + 'type' => 'object', + 'properties' => [ + 'AlarmTargetType' => ['description' => '告警对象类型', 'type' => 'string', 'example' => 'APP'], + 'Status' => ['description' => '报警状态', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DataSourceName' => ['description' => '数据源名称', 'type' => 'string', 'example' => 'ant_intel_hz'], + 'AlarmType' => ['description' => ' '."\n" + .'告警类型', 'type' => 'string', 'example' => 'APP'], + 'GmtModified' => ['description' => '最后修改时间', 'type' => 'string', 'example' => '2020-04-02 21:53:24'], + 'EventId' => ['description' => '告警事件id', 'type' => 'string', 'example' => '355402_1670998540000_598877597'], + 'WorkspaceId' => ['description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'UniqueIdentity' => ['description' => '告警规则唯一标识', 'type' => 'string', 'example' => '174851af-6c56-4d8b-8cc7-9f998e752f09'], + 'AlarmTime' => ['description' => '告警时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1671088115000'], + 'AlarmRuleId' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64', 'example' => '860'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-04-02 21:53:24'], + 'AlarmDetail' => ['description' => '告警详情', 'type' => 'string', 'example' => '[{"datasource":"basic@@machinePortCheck","tags":[{"key":"cluster","value":"default-kernel"},{"key":"hostname","value":"100.83.13.115"},{"key":"port","value":"22"}],"conditionValues":[{"condition":{"metric":"total","metricDisplayName":"总量","type":"Current","compareOperation":"LT","N":0,"threshold":10000.0,"conditionDesc":"total 当前时间 > 10000.0"},"value":1.0}]}]'], + 'AlarmUrl' => ['description' => '告警数据源跳转url', 'type' => 'string', 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c'], + 'AlarmContent' => ['description' => '报警内容', 'type' => 'string', 'example' => '[测试实例] [cluster:default-kernel hostname:100.83.13.115 port:22 cluster:antcloud-middlewaredev-import-cluster-38742336 namespace:kube-system] 物理机端口探测/总量 当前时间的值 1.000 < 10000.00'], + 'AlarmUrlWithDomain' => ['description' => ' '."\n" + .'网页的绝对路径，包含域名', 'type' => 'string', 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c'], + 'AlarmTargetDeleted' => ['description' => ' '."\n" + .'目标对象是否删除', 'type' => 'boolean', 'example' => 'false'], + 'AlarmLevel' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3376'], + 'TenantId' => ['description' => '租户id', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AlarmTarget' => ['description' => '告警对象', 'type' => 'string', 'example' => 'sibei_1229_1'], + 'AlarmRuleName' => ['description' => ' '."\n" + .'告警规则名', 'type' => 'string', 'example' => 'bvtcase测试'], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 5,\\n \\"RequestId\\": \\"CB2B427A-E370-5599-8872-A249F8EFD859\\",\\n \\"ResultMessage\\": \\"workspace not found with name TWCProd, tenant_id 0008528286\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 120,\\n \\"AlarmHistories\\": [\\n {\\n \\"AlarmTargetType\\": \\"APP\\",\\n \\"Status\\": 1,\\n \\"DataSourceName\\": \\"ant_intel_hz\\",\\n \\"AlarmType\\": \\"APP\\",\\n \\"GmtModified\\": \\"2020-04-02 21:53:24\\",\\n \\"EventId\\": \\"355402_1670998540000_598877597\\",\\n \\"WorkspaceId\\": 1,\\n \\"UniqueIdentity\\": \\"174851af-6c56-4d8b-8cc7-9f998e752f09\\",\\n \\"AlarmTime\\": 1671088115000,\\n \\"AlarmRuleId\\": 860,\\n \\"GmtCreate\\": \\"2020-04-02 21:53:24\\",\\n \\"AlarmDetail\\": \\"[{\\\\\\"datasource\\\\\\":\\\\\\"basic@@machinePortCheck\\\\\\",\\\\\\"tags\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"cluster\\\\\\",\\\\\\"value\\\\\\":\\\\\\"default-kernel\\\\\\"},{\\\\\\"key\\\\\\":\\\\\\"hostname\\\\\\",\\\\\\"value\\\\\\":\\\\\\"100.83.13.115\\\\\\"},{\\\\\\"key\\\\\\":\\\\\\"port\\\\\\",\\\\\\"value\\\\\\":\\\\\\"22\\\\\\"}],\\\\\\"conditionValues\\\\\\":[{\\\\\\"condition\\\\\\":{\\\\\\"metric\\\\\\":\\\\\\"total\\\\\\",\\\\\\"metricDisplayName\\\\\\":\\\\\\"总量\\\\\\",\\\\\\"type\\\\\\":\\\\\\"Current\\\\\\",\\\\\\"compareOperation\\\\\\":\\\\\\"LT\\\\\\",\\\\\\"N\\\\\\":0,\\\\\\"threshold\\\\\\":10000.0,\\\\\\"conditionDesc\\\\\\":\\\\\\"total 当前时间 > 10000.0\\\\\\"},\\\\\\"value\\\\\\":1.0}]}]\\",\\n \\"AlarmUrl\\": \\"/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"AlarmContent\\": \\"[测试实例] [cluster:default-kernel hostname:100.83.13.115 port:22 cluster:antcloud-middlewaredev-import-cluster-38742336 namespace:kube-system] 物理机端口探测/总量 当前时间的值 1.000 < 10000.00\\",\\n \\"AlarmUrlWithDomain\\": \\"http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"AlarmTargetDeleted\\": false,\\n \\"AlarmLevel\\": 1,\\n \\"Id\\": 3376,\\n \\"TenantId\\": 1,\\n \\"AlarmTarget\\": \\"sibei_1229_1\\",\\n \\"AlarmRuleName\\": \\"bvtcase测试\\"\\n }\\n ]\\n}","type":"json"}]', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryRMSUnifiedAlarmNotifyHistory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Step', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => '检测频率', + 'description' => ' '."\n" + .'发送状态', 'type' => 'integer', 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '5', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['失败', '成功'], + 'example' => '0', ], ], [ - 'name' => 'SilenceTime', + 'name' => 'Channel', 'in' => 'formData', - 'schema' => [ - 'description' => '通知静默时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '900', - ], + 'schema' => ['description' => ' '."\n" + .'通知渠道', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'DD_WEBHOOK'], ], [ - 'name' => 'NotifyFiring', + 'name' => 'Subscriber', 'in' => 'formData', - 'schema' => [ - 'description' => '告警触发时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '通知人id', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'NotifyRecovered', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '告警恢复时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1'], ], [ - 'name' => 'NotifyNodata', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '待修改的告警规则的数量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '每页条数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '20'], ], [ - 'name' => 'NotifyTimeFilterJsonStr', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '查询告警规则的时间范围', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '工作区名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acgatewayprod'], ], [ - 'name' => 'Status', + 'name' => 'EventId', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'发送状态', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Firing', - ], + 'schema' => ['description' => ' '."\n" + .'事件id', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '355400_1670410905000_598877597'], ], [ - 'name' => 'SuspendedStartTime', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => '暂停开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => ' '."\n" + .'开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1660730580000'], ], [ - 'name' => 'SuspendedEndTime', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '暂停结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1668160800150'], ], [ - 'name' => 'SuspendedReason', + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => '查询告警内容', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'asd'], + ], + [ + 'name' => 'AlarmRuleId', + 'in' => 'formData', + 'schema' => ['description' => '告警规则 ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '22'], + ], + [ + 'name' => 'AlarmStatus', 'in' => 'formData', 'schema' => [ - 'description' => '暂停的原因', - 'type' => 'string', + 'description' => '告警状态', + 'type' => 'integer', + 'format' => 'int64', 'required' => false, 'docRequired' => false, + 'enumValueTitles' => [2 => '告警中', 4 => '已静默', '已恢复'], + 'example' => '2', ], ], [ - 'name' => 'WorkspaceName', + 'name' => 'AlarmStackInfoJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => '根据应用过滤告警历史json格式 包含字段如下：'."\n" + ."\n" + .'datasource_type STRING 否 ["CUSTOM","STACK","TABLE] '."\n" + .'是应用监控，还是自定义监控'."\n" + ."\n" + .'datasource STRING 否 MM@@2000464 '."\n" + .'数据源'."\n" + ."\n" + .'alarm_target_type STRING 否 ["APP","HOST"] '."\n" + .'应用类型'."\n" + ."\n" + .'alarm_target_identify STRING 否 RMS-monitorprod '."\n" + .'应用名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\"DatasourceType\\":\\"CUSTOM\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-acrbasis\\"，\\"Datasource\\":\\"SPM@@15984\\"}'], ], [ - 'name' => 'ChannelsRepeatList', + 'name' => 'DashboardQueryParamJsonStr', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '告警通知渠道', - 'type' => 'array', - 'items' => [ - 'description' => '告警通知渠道', - 'type' => 'string', - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => '大盘告警查询参数', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'NotifyTarget', + 'name' => 'AlarmSubscribers', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '配额告警通知对象。', + 'description' => '根据通知对象过滤', 'type' => 'array', 'items' => [ - 'description' => '配额告警通知对象。', + 'description' => '通知对象', 'type' => 'object', 'properties' => [ - 'SubscriberSource' => [ - 'description' => ' '."\n" - .'订阅者来源', - 'type' => 'string', - 'required' => true, - 'example' => 'LOCAL', - ], - 'SubscriberType' => [ - 'description' => '订阅人的类型', - 'type' => 'string', - 'required' => true, - 'example' => 'USER_GROUP', - ], - 'Subscriber' => [ - 'description' => '通知人id', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'SubscriberUuid' => [ - 'type' => 'string', - 'required' => true, - 'example' => '400', - ], - 'SubscriberName' => [ - 'description' => '订阅者名称'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'example' => '实人认证-灰度测试', - ], + 'SubscriberSource' => ['description' => ' '."\n" + .'订阅者来源', 'type' => 'string', 'required' => true, 'example' => 'LOCAL'], + 'SubscriberType' => ['description' => '订阅者类型', 'type' => 'string', 'required' => true, 'example' => 'USER_GROUP'], + 'Subscriber' => ['description' => '订阅者', 'type' => 'string', 'required' => true, 'example' => '1'], + 'SubscriberUuid' => ['description' => '订阅者uuid', 'type' => 'string', 'required' => true, 'example' => '839f5cf92ab3435385ef3949c001a7a8'], + 'SubscriberName' => ['description' => '告警对象的名称', 'type' => 'string', 'required' => true, 'example' => 'mike'], ], 'required' => false, ], @@ -7691,302 +4652,329 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'type' => 'string', - ], - 'ResultCode' => [ - 'type' => 'string', + 'CurrentPage' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'B4C10721-BD3E-5F45-AF3C-880715462315'], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'Rpc error'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['description' => '每页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '84'], + 'AlarmNotifyHistories' => [ + 'description' => '报警通知历史', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知历史', + 'type' => 'object', + 'properties' => [ + 'AlarmSilenceTime' => ['description' => ' '."\n" + .'告警静默期', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Status' => ['description' => '通知状态', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ErrorMessage' => ['description' => '描述消息发送错误原因', 'type' => 'string', 'example' => 'Specified private IP address is duplicated.'], + 'AlarmType' => ['description' => ' '."\n" + .'告警类型', 'type' => 'string', 'example' => 'APP'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'string', 'example' => '2020-03-18 21:47:32'], + 'NotifyContent' => ['description' => '消息内容', 'type' => 'string'], + 'AlarmRuleId' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64', 'example' => '5839'], + 'Subscriber' => ['description' => '订阅人', 'type' => 'string', 'example' => '400'], + 'Channel' => ['description' => '通知渠道', 'type' => 'string', 'example' => 'DD_WEBHOOK'], + 'AlarmTargetDeleted' => ['description' => ' '."\n" + .'目标对象是否删除', 'type' => 'boolean'], + 'AlarmLevel' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AlarmEventId' => ['description' => '报警事件id', 'type' => 'string', 'example' => '356454_1670377620000_1650847553'], + 'AlarmRuleName' => ['description' => ' '."\n" + .'告警规则名', 'type' => 'string', 'example' => 'bvtcase测试'], + 'AlarmTargetType' => ['description' => '告警对象类型', 'type' => 'string', 'example' => 'APP'], + 'SubscriberType' => ['description' => '订阅人的类型', 'type' => 'string', 'example' => 'USER_GROUP'], + 'AlarmStatus' => ['description' => '报警状态', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'DataSourceName' => ['description' => '数据源名称', 'type' => 'string', 'example' => '交易成功量'], + 'AlarmRuleUuid' => ['type' => 'string', 'description' => ''], + 'WorkspaceId' => ['description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SubscriberSource' => ['description' => '订阅者来源', 'type' => 'string', 'example' => 'LOCAL'], + 'AlarmTime' => ['description' => '报警时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1671076740000'], + 'AggCount' => ['description' => ' '."\n" + .'聚合条数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AlarmTargetIdentify' => ['description' => '告警对象', 'type' => 'string', 'example' => 'monitorprod'], + 'AlarmHistoryId' => ['description' => '报警发送记录id', 'type' => 'integer', 'format' => 'int64', 'example' => '27313821'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-03-13 02:25:08'], + 'AlarmUrl' => ['description' => '告警数据源跳转url', 'type' => 'string', 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c'], + 'AlarmUrlWithDomain' => ['description' => ' '."\n" + .'网页的绝对路径，包含域名', 'type' => 'string', 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c'], + 'TraceId' => ['description' => '调用链ID，用于精确查询调用信息。', 'type' => 'string', 'example' => '0a6481081662012458401682123'], + 'Id' => ['description' => '属性 ID', 'type' => 'integer', 'format' => 'int64', 'example' => '73738'], + 'TenantId' => ['description' => '租户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SubscriberName' => ['description' => '订阅者名称'."\n" + ."\n", 'type' => 'string', 'example' => 'mike'], + ], + ], ], - 'RequestId' => [ - 'type' => 'string', + 'AlarmNotifySubs' => [ + 'description' => '告警通知历史中对应的通知对象', + 'type' => 'array', + 'items' => [ + 'description' => '通知对象', + 'type' => 'object', + 'properties' => [ + 'SubscriberSource' => ['description' => '订阅者来源', 'type' => 'string', 'example' => 'LOCAL'], + 'Subscriber' => ['description' => '订阅者', 'type' => 'string', 'example' => '400'], + 'SubscriberUuid' => ['description' => '订阅者uuid', 'type' => 'string', 'example' => '839f5cf92ab3435385ef3949c001a7a8'], + 'SubscriberType' => ['description' => '订阅者类型', 'type' => 'string', 'example' => 'USER_GROUP'], + 'SubscriberName' => ['description' => '订阅者名称', 'type' => 'string', 'example' => 'mike'], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', - ], - 'CreateRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"B4C10721-BD3E-5F45-AF3C-880715462315\\",\\n \\"ResultMessage\\": \\"Rpc error\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 84,\\n \\"AlarmNotifyHistories\\": [\\n {\\n \\"AlarmSilenceTime\\": 20,\\n \\"Status\\": 0,\\n \\"ErrorMessage\\": \\"Specified private IP address is duplicated.\\",\\n \\"AlarmType\\": \\"APP\\",\\n \\"GmtModified\\": \\"2020-03-18 21:47:32\\",\\n \\"NotifyContent\\": \\"\\",\\n \\"AlarmRuleId\\": 5839,\\n \\"Subscriber\\": \\"400\\",\\n \\"Channel\\": \\"DD_WEBHOOK\\",\\n \\"AlarmTargetDeleted\\": true,\\n \\"AlarmLevel\\": 1,\\n \\"AlarmEventId\\": \\"356454_1670377620000_1650847553\\",\\n \\"AlarmRuleName\\": \\"bvtcase测试\\",\\n \\"AlarmTargetType\\": \\"APP\\",\\n \\"SubscriberType\\": \\"USER_GROUP\\",\\n \\"AlarmStatus\\": 2,\\n \\"DataSourceName\\": \\"交易成功量\\",\\n \\"AlarmRuleUuid\\": \\"\\",\\n \\"WorkspaceId\\": 1,\\n \\"SubscriberSource\\": \\"LOCAL\\",\\n \\"AlarmTime\\": 1671076740000,\\n \\"AggCount\\": 1,\\n \\"AlarmTargetIdentify\\": \\"monitorprod\\",\\n \\"AlarmHistoryId\\": 27313821,\\n \\"GmtCreate\\": \\"2020-03-13 02:25:08\\",\\n \\"AlarmUrl\\": \\"/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"AlarmUrlWithDomain\\": \\"http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"TraceId\\": \\"0a6481081662012458401682123\\",\\n \\"Id\\": 73738,\\n \\"TenantId\\": 1,\\n \\"SubscriberName\\": \\"mike\\"\\n }\\n ],\\n \\"AlarmNotifySubs\\": [\\n {\\n \\"SubscriberSource\\": \\"LOCAL\\",\\n \\"Subscriber\\": \\"400\\",\\n \\"SubscriberUuid\\": \\"839f5cf92ab3435385ef3949c001a7a8\\",\\n \\"SubscriberType\\": \\"USER_GROUP\\",\\n \\"SubscriberName\\": \\"mike\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询告警通知历史', + 'summary' => '查询告警通知历史，如钉钉、电话、短信、webhook的通知记录，以及通知状态。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmNotifyHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRMSUnifiedAlarmRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'uitest1645783390369', - ], + 'schema' => ['description' => '告警规则名称模糊搜索', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'Category', + 'name' => 'Level', 'in' => 'formData', - 'schema' => [ - 'description' => '规则类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CUSTOM', - ], + 'schema' => ['description' => '告警等级', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'RuleConfig', + 'name' => 'AlarmTargetJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '规则配置信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{\\"trafficType\\":\\"i\\",\\"methodName\\":\\"*\\",\\"faultInjectRuleItems\\":[{\\"action\\":{\\"type\\":\\"REJECT\\"},\\"ruleType\\":\\"ABORT\\",\\"configs\\":{\\"faultPercent\\":100}}]} ', - ], + 'schema' => ['description' => '告警对象搜索 json格式 包含字段如下 ：'."\n" + ."\n" + .'rule_status NUMBER 否 1：打开 0:闭合 '."\n" + .'启停状态'."\n" + ."\n" + .'alarm_status NUMBER 否 0 '."\n" + .'告警状态'."\n" + ."\n" + .'only_me BOOLEAN 否 true, false '."\n" + .'只看我'."\n" + ."\n" + .'current_page NUMBER 否 1 '."\n" + .'当前页'."\n" + ."\n" + .'page_size NUMBER 否 3 '."\n" + .'页面尺寸'."\n" + ."\n" + .'workspace_name STRING 是 工作区名 '."\n" + .'工作区名'."\n" + ."\n" + .'rule_id NUMBER 否 '."\n" + .'告警规则id'."\n" + ."\n" + .'rule_unique_identity STRING 否 1234_asdf '."\n" + .'告警唯一标识'."\n" + ."\n" + .'category STRING 是 "自定义"、"pql" '."\n" + .'标识符 区分规则是自定义规则还是pql规则'."\n" + ."\n" + .'ref_datasource_type STRING 否 datasource'."\n" + .' '."\n" + .'filter_user_group NUMBER 否 1 '."\n" + .'根据用户组过滤'."\n" + ."\n" + .'filter_webhook NUMBER 否 1 '."\n" + .'根据webhook过滤'."\n" + ."\n" + .'filter_ding_robot NUMBER 否 1 '."\n" + .'钉钉机器人过滤', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'AlarmNodata', + 'name' => 'RuleStatus', 'in' => 'formData', - 'schema' => [ - 'description' => '报警通知结果数据', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '启停状态 1：打开 0:闭合', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'Level', + 'name' => 'AlarmStatus', 'in' => 'formData', - 'schema' => [ - 'description' => 'Prometheus告警规则的等级。'."\n" - ."\n" - .'- P1：一般用于影响核心业务可用性，影响范围很大，可能导致严重后果的重大问题的告警通知。'."\n" - .'- P2：一般用于部分业务出错，会对系统可用性造成一定影响，但是影响范围相对有限的问题的告警通知。'."\n" - .'- P3：一般用于对可能导致业务出错或者受影响的问题的告警通知，或者在相对重要程度较低的业务发送的告警通知。'."\n" - .'- P4： 用于需要通知，但是优先级较低，也不会对业务造成影响的场景发送告警通知。'."\n" - .'- 默认：如果不需要区分告警等级，可以使用默认级别。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '告警状态', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'Emergency', + 'name' => 'OnlyMe', 'in' => 'formData', - 'schema' => [ - 'description' => '应急处理人', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '只看我', 'type' => 'boolean', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'EmergencyUrl', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '应急处理链接', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'PendingHit', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => ' 触发周期', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '每页大小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'RecoveredHit', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '恢复周期', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true], ], [ - 'name' => 'Step', + 'name' => 'RuleId', 'in' => 'formData', - 'schema' => [ - 'description' => '检测频率', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'SilenceTime', + 'name' => 'RuleUniqueIdentity', 'in' => 'formData', - 'schema' => [ - 'description' => '通知静默时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '300', - ], + 'schema' => ['description' => '告警唯一标识', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'NotifyFiring', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'description' => '告警触发时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => '规则类型', 'type' => 'string', 'required' => true, 'docRequired' => true], ], [ - 'name' => 'NotifyRecovered', + 'name' => 'RefDatasourceType', 'in' => 'formData', + 'schema' => ['description' => 'datasource', 'type' => 'string', 'required' => false, 'docRequired' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '告警恢复时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => ['description' => '当前页', 'type' => 'integer', 'format' => 'int64'], + 'RequestId' => ['description' => '请求id', 'type' => 'string'], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string'], + 'PageSize' => ['description' => '每页大小', 'type' => 'integer', 'format' => 'int64'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int64'], + 'AlarmRules' => [ + 'description' => '报警规则信息', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则信息', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '启停状态 1：打开 0:闭合', 'type' => 'integer', 'format' => 'int64'], + 'NotifyTplId' => ['description' => '通知模板id', 'type' => 'integer', 'format' => 'int64'], + 'Channels' => ['description' => '通知渠道 "["ddWebhook","sms","phone","email"]"', 'type' => 'string'], + 'NotifyFiring' => ['description' => '告警触发时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64'], + 'GmtModified' => ['description' => '修改时间', 'type' => 'string'], + 'NotifyEmpty' => ['description' => '告警无数据时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64'], + 'Creator' => ['description' => '规则创建者', 'type' => 'string'], + 'NotifyTimeFilter' => ['description' => '通知时间', 'type' => 'string'], + 'Modifier' => ['description' => '修改人', 'type' => 'string'], + 'NotifyRecovered' => ['description' => '告警恢复时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64'], + 'SuspendedStartTime' => ['description' => '暂停开始时间', 'type' => 'integer', 'format' => 'int64'], + 'Deleted' => ['description' => '软删除', 'type' => 'integer', 'format' => 'int64'], + 'SuspendedReason' => ['description' => '暂停的原因', 'type' => 'string'], + 'PendingHit' => ['description' => ' 触发周期', 'type' => 'integer', 'format' => 'int64'], + 'Name' => ['description' => '规则名称', 'type' => 'string'], + 'RecoveredHit' => ['description' => '恢复周期', 'type' => 'integer', 'format' => 'int64'], + 'AlarmEmpty' => ['description' => '指标无数据触发告警 是个开关 1:打开 0:关闭', 'type' => 'integer', 'format' => 'int64'], + 'SilenceTime' => ['description' => '通知静默时间', 'type' => 'integer', 'format' => 'int64'], + 'AlarmStatus' => ['description' => '告警状态', 'type' => 'integer', 'format' => 'int64'], + 'Emergency' => ['description' => '应急处理人', 'type' => 'string'], + 'SourceId' => ['description' => '标识告警规则迁移之前的 ID', 'type' => 'string'], + 'SuspendedEndTime' => ['description' => '暂停结束时间', 'type' => 'integer', 'format' => 'int64'], + 'Step' => ['description' => '检测频率', 'type' => 'integer', 'format' => 'int64'], + 'WorkspaceId' => ['description' => '工作空间id', 'type' => 'integer', 'format' => 'int64'], + 'UniqueIdentity' => ['description' => '告警规则唯一标识', 'type' => 'string'], + 'TimeZone' => ['description' => '时区', 'type' => 'string'], + 'EmergencyUrl' => ['description' => '应急处理链接', 'type' => 'string'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string'], + 'Category' => ['description' => '规则类型', 'type' => 'string'], + 'Level' => ['description' => '告警级别', 'type' => 'integer', 'format' => 'int64'], + 'Id' => ['description' => '主键id', 'type' => 'integer', 'format' => 'int64'], + 'TenantId' => ['description' => '租户id', 'type' => 'integer', 'format' => 'int64'], + 'RuleConfig' => ['description' => '规则配置信息', 'type' => 'string'], + 'ConditionsDes' => [ + 'description' => '告警触发条件', + 'type' => 'array', + 'items' => ['description' => '告警触发条件', 'type' => 'string'], + ], + ], + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'NotifyNodata', - 'in' => 'formData', - 'schema' => [ - 'description' => '待删除的订阅数据总量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'ServerInernalError', 'errorMessage' => 'A server internal error occurred while processing your request. Contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 0,\\n \\"AlarmRules\\": [\\n {\\n \\"Status\\": 0,\\n \\"NotifyTplId\\": 0,\\n \\"Channels\\": \\"\\",\\n \\"NotifyFiring\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"NotifyEmpty\\": 0,\\n \\"Creator\\": \\"\\",\\n \\"NotifyTimeFilter\\": \\"\\",\\n \\"Modifier\\": \\"\\",\\n \\"NotifyRecovered\\": 0,\\n \\"SuspendedStartTime\\": 0,\\n \\"Deleted\\": 0,\\n \\"SuspendedReason\\": \\"\\",\\n \\"PendingHit\\": 0,\\n \\"Name\\": \\"\\",\\n \\"RecoveredHit\\": 0,\\n \\"AlarmEmpty\\": 0,\\n \\"SilenceTime\\": 0,\\n \\"AlarmStatus\\": 0,\\n \\"Emergency\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SuspendedEndTime\\": 0,\\n \\"Step\\": 0,\\n \\"WorkspaceId\\": 0,\\n \\"UniqueIdentity\\": \\"\\",\\n \\"TimeZone\\": \\"\\",\\n \\"EmergencyUrl\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"Category\\": \\"\\",\\n \\"Level\\": 0,\\n \\"Id\\": 0,\\n \\"TenantId\\": 0,\\n \\"RuleConfig\\": \\"\\",\\n \\"ConditionsDes\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'ResendMqSofamqDLQMessageBatch' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NotifyTimeFilterJsonStr', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '查询告警规则的时间范围', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ - 'name' => 'WorkspaceName', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => '需查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id'], ], [ - 'name' => 'ChannelsRepeatList', + 'name' => 'InstanceId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '告警通知渠道', - 'type' => 'array', - 'items' => [ - 'description' => '告警渠道名称', - 'type' => 'string', - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => '需查询消息所对应的实例 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ - 'name' => 'NotifyTarget', + 'name' => 'MsgIds', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '告警通知对象。取值：accountContact。', - 'type' => 'array', - 'items' => [ - 'description' => '告警通知对象。取值：accountContact。', - 'type' => 'object', - 'properties' => [ - 'SubscriberSource' => [ - 'description' => ' '."\n" - .'订阅者来源', - 'type' => 'string', - 'required' => true, - 'example' => 'LOCAL', - ], - 'SubscriberType' => [ - 'description' => '订阅者类型', - 'type' => 'string', - 'required' => true, - 'example' => 'USER_GROUP', - ], - 'Subscriber' => [ - 'description' => '通知人id', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'SubscriberUuid' => [ - 'type' => 'string', - 'required' => true, - 'example' => '400', - ], - 'SubscriberName' => [ - 'description' => '告警对象的名称', - 'type' => 'string', - 'required' => true, - 'example' => '实人认证-灰度测试', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => '需重发的消息的 ID，即 Message ID，多个消息使用英文逗号分隔', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******'], ], ], 'responses' => [ @@ -7994,71 +4982,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5F656C56-F99E-5C1E-AE7F-D9F78AC8D706', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '发送失败的消息的 ID，即 Message ID', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"5F656C56-F99E-5C1E-AE7F-D9F78AC8D706\\"\\n}","type":"json"}]', - 'title' => '创建告警规则', - 'summary' => '创建告警规则。', - ], - 'DeleteRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"Data\\": \\"1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '批量重发死信消息', + 'summary' => '批量重发指定 Message ID 的死信消息，使这些消息能够被 Consumer 再次消费。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ResendMqSofamqDLQMessageById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '需要查询的单元', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A'], ], [ - 'name' => 'WorkspaceName', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => '需查询的消费端 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id '], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '需查询消息所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx '], + ], + [ + 'name' => 'MsgId', + 'in' => 'formData', + 'schema' => ['description' => '需查询的消息的 ID，即 Message ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E0578FE110F18B4AAC235C0C****** '], ], ], 'responses' => [ @@ -8066,221 +5050,206 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', - 'title' => '删除告警规则', - 'summary' => '删除告警规则。', - ], - 'QueryRMSUnifiedAlarmEvent' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '重发死信消息', + 'summary' => '使死信消息复活，让消息能够被 Consumer 再消费一次。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ResetMqSofamqConsumerOffset' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'WorkspaceName', + 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '需要查询的单元。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RZ01A'], ], [ - 'name' => 'CurrentPage', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '需查询的消费端 Group ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_consumer_id'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '需查询的 Group ID 所对应的实例 ID。针对有独立命名空间的实例，该参数为必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ - 'name' => 'AlarmLevel', + 'name' => 'ResetTimestamp', 'in' => 'formData', - 'schema' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '重置位点到指定的时间戳，仅在 Type 为 1 时生效。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1568033253000'], ], [ - 'name' => 'Status', + 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'触发状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 2 => '告警中', - 4 => '已静默', - '已恢复', - ], - ], + 'schema' => ['description' => '需重置位点的 Topic 名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq-topic '], ], [ - 'name' => 'AlarmTargetType', + 'name' => 'Type', 'in' => 'formData', + 'schema' => ['description' => '消息清理类型，取值说明如下：'."\n" + .'- 0：清除所有消息。'."\n" + .'- 1：清理到指定时间。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '告警对象类型', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + ], + 'description' => '', ], ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => '按告警内容查询', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '重置消费位点', + 'summary' => '重置指定的 Group ID 的消费位点到指定时间戳。一般用于清理堆积消息，或者回溯消费。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResetMqSofamqConsumerOffset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateMqSofamqGroupRemark' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '需配置更新的 Group ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_group_id'], ], [ - 'name' => 'AlarmRuleId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'告警规则 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx'], ], [ - 'name' => 'AlarmStackInfoJsonStr', + 'name' => 'Remark', 'in' => 'formData', + 'schema' => ['description' => '描述信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '根据应用栈过滤 json格式 包含字段如下：'."\n" - ."\n" - .'datasource_type STRING 否 ["CUSTOM","STACK","TABLE] '."\n" - .'是应用监控，还是自定义监控'."\n" - ."\n" - .'datasource STRING 否 MM@@2000464 '."\n" - .'数据源'."\n" - ."\n" - .'alarm_target_type STRING 否 ["APP","HOST"] '."\n" - .'应用类型'."\n" - ."\n" - .'alarm_target_identify STRING 否 RMS-monitorprod '."\n" - .'应用名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '更新 Group 的信息', + 'summary' => '修改或更新 Group 的描述信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqGroupRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateMqSofamqTopicRemark' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AlarmRuleUuid', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '告警规则uuid', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx '], ], [ - 'name' => 'AlarmTargetKeyword', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '按告警对象搜索', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Topic 描述信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'AlarmStatusRepeatList', + 'name' => 'Topic', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '告警状态', - 'type' => 'array', - 'items' => [ - 'description' => '告警状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => '需更新的 Topic 名称，一个用户下不可重复。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -8288,414 +5257,149 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - ], - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int64', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'UnifiedAlarmEventList' => [ - 'description' => '告警事件详情', - 'type' => 'array', - 'items' => [ - 'description' => '告警事件详情', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '触发状态', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmTargetType' => [ - 'description' => '告警对象类型', - 'type' => 'string', - ], - 'AlarmStartTime' => [ - 'description' => '告警产生时间', - 'type' => 'string', - ], - 'SilenceRemainTime' => [ - 'description' => '静默剩余时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'DataSourceName' => [ - 'description' => '数据源名称', - 'type' => 'string', - ], - 'AlarmType' => [ - 'description' => ' 告警类型', - 'type' => 'string', - ], - 'AlarmRecoverTime' => [ - 'description' => ' '."\n" - .'告警恢复时间', - 'type' => 'string', - ], - 'AlarmRuleId' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmHistoryId' => [ - 'description' => '报警历史id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmContent' => [ - 'description' => '报警内容', - 'type' => 'string', - ], - 'AlarmUrl' => [ - 'description' => '告警数据源跳转url', - 'type' => 'string', - ], - 'AlarmUrlWithDomain' => [ - 'description' => '网页的绝对路径，包含域名', - 'type' => 'string', - ], - 'AlarmTargetDeleted' => [ - 'description' => '目标对象是否删除', - 'type' => 'boolean', - ], - 'AlarmLevel' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmEventId' => [ - 'description' => '告警事件id', - 'type' => 'string', - ], - 'AlarmTarget' => [ - 'description' => '告警对象', - 'type' => 'string', - ], - 'AlarmHistoryList' => [ - 'description' => '报警历史详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => '报警历史详情', - 'type' => 'object', - 'properties' => [ - 'AlarmTargetType' => [ - 'description' => '告警对象类型', - 'type' => 'string', - ], - 'Status' => [ - 'description' => '触发状态', - 'type' => 'integer', - 'format' => 'int64', - ], - 'DataSourceName' => [ - 'description' => '数据源名称', - 'type' => 'string', - ], - 'AlarmType' => [ - 'description' => '告警类型', - 'type' => 'string', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'string', - ], - 'EventId' => [ - 'description' => '告警事件id', - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID', - 'type' => 'integer', - 'format' => 'int64', - ], - 'UniqueIdentity' => [ - 'description' => '告警规则唯一标识', - 'type' => 'string', - ], - 'AlarmTime' => [ - 'description' => '告警时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmRuleId' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - ], - 'AlarmDetail' => [ - 'description' => '告警详情', - 'type' => 'string', - ], - 'AlarmUrl' => [ - 'description' => '告警数据源跳转url', - 'type' => 'string', - ], - 'AlarmContent' => [ - 'description' => '报警内容', - 'type' => 'string', - ], - 'AlarmUrlWithDomain' => [ - 'description' => '网页的绝对路径，包含域名', - 'type' => 'string', - ], - 'AlarmTargetDeleted' => [ - 'description' => '目标对象是否删除', - 'type' => 'boolean', - ], - 'AlarmLevel' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Id' => [ - 'description' => '主键ID', - 'type' => 'integer', - 'format' => 'int64', - ], - 'TenantId' => [ - 'description' => '租户id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmTarget' => [ - 'description' => '告警对象', - 'type' => 'string', - ], - 'AlarmRuleName' => [ - 'description' => '报警规则名称', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 0,\\n \\"UnifiedAlarmEventList\\": [\\n {\\n \\"Status\\": 0,\\n \\"AlarmTargetType\\": \\"\\",\\n \\"AlarmStartTime\\": \\"\\",\\n \\"SilenceRemainTime\\": 0,\\n \\"DataSourceName\\": \\"\\",\\n \\"AlarmType\\": \\"\\",\\n \\"AlarmRecoverTime\\": \\"\\",\\n \\"AlarmRuleId\\": 0,\\n \\"AlarmHistoryId\\": 0,\\n \\"AlarmContent\\": \\"\\",\\n \\"AlarmUrl\\": \\"\\",\\n \\"AlarmUrlWithDomain\\": \\"\\",\\n \\"AlarmTargetDeleted\\": true,\\n \\"AlarmLevel\\": 0,\\n \\"AlarmEventId\\": \\"\\",\\n \\"AlarmTarget\\": \\"\\",\\n \\"AlarmHistoryList\\": [\\n {\\n \\"AlarmTargetType\\": \\"\\",\\n \\"Status\\": 0,\\n \\"DataSourceName\\": \\"\\",\\n \\"AlarmType\\": \\"\\",\\n \\"GmtModified\\": \\"\\",\\n \\"EventId\\": \\"\\",\\n \\"WorkspaceId\\": 0,\\n \\"UniqueIdentity\\": \\"\\",\\n \\"AlarmTime\\": 0,\\n \\"AlarmRuleId\\": 0,\\n \\"GmtCreate\\": \\"\\",\\n \\"AlarmDetail\\": \\"\\",\\n \\"AlarmUrl\\": \\"\\",\\n \\"AlarmContent\\": \\"\\",\\n \\"AlarmUrlWithDomain\\": \\"\\",\\n \\"AlarmTargetDeleted\\": true,\\n \\"AlarmLevel\\": 0,\\n \\"Id\\": 0,\\n \\"TenantId\\": 0,\\n \\"AlarmTarget\\": \\"\\",\\n \\"AlarmRuleName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询告警事件历史', - ], - 'QueryRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => '更新 Topic 的信息', + 'summary' => '用来更新或修改 Topic 的描述信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqTopicRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateMqSofamqWarn' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Keyword', + 'name' => 'AlertTime', 'in' => 'formData', - 'schema' => [ - 'description' => '告警规则名称模糊搜索', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '报警时间范围', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '00:00-24:00'], ], [ - 'name' => 'Level', + 'name' => 'Contacts', 'in' => 'formData', - 'schema' => [ - 'description' => '告警等级', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '报警通知人信息', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]'], ], [ - 'name' => 'AlarmTargetJsonStr', + 'name' => 'DelayTime', 'in' => 'formData', - 'schema' => [ - 'description' => '告警对象搜索 json格式 包含字段如下 ：'."\n" - ."\n" - .'rule_status NUMBER 否 1：打开 0:闭合 '."\n" - .'启停状态'."\n" - ."\n" - .'alarm_status NUMBER 否 0 '."\n" - .'告警状态'."\n" - ."\n" - .'only_me BOOLEAN 否 true, false '."\n" - .'只看我'."\n" - ."\n" - .'current_page NUMBER 否 1 '."\n" - .'当前页'."\n" - ."\n" - .'page_size NUMBER 否 3 '."\n" - .'页面尺寸'."\n" - ."\n" - .'workspace_name STRING 是 工作区名 '."\n" - .'工作区名'."\n" - ."\n" - .'rule_id NUMBER 否 '."\n" - .'告警规则id'."\n" - ."\n" - .'rule_unique_identity STRING 否 1234_asdf '."\n" - .'告警唯一标识'."\n" - ."\n" - .'category STRING 是 "自定义"、"pql" '."\n" - .'标识符 区分规则是自定义规则还是pql规则'."\n" - ."\n" - .'ref_datasource_type STRING 否 datasource'."\n" - .' '."\n" - .'filter_user_group NUMBER 否 1 '."\n" - .'根据用户组过滤'."\n" - ."\n" - .'filter_webhook NUMBER 否 1 '."\n" - .'根据webhook过滤'."\n" - ."\n" - .'filter_ding_robot NUMBER 否 1 '."\n" - .'钉钉机器人过滤', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '延迟多少秒报警', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'RuleStatus', + 'name' => 'Frequency', 'in' => 'formData', - 'schema' => [ - 'description' => '启停状态 1：打开 0:闭合', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '报警频率，单位分钟', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'AlarmStatus', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '告警状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx '], ], [ - 'name' => 'OnlyMe', + 'name' => 'Threshold', 'in' => 'formData', - 'schema' => [ - 'description' => '只看我', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '阈值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '3000'], ], [ - 'name' => 'CurrentPage', + 'name' => 'WarnId', 'in' => 'formData', + 'schema' => ['description' => '指定修改的报警规则', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000001 '], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], + ], + 'description' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '每页大小', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\r\\n<ResultMessage>OK</ResultMessage>\\r\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => 'UpdateMqSofamqWarn', + 'summary' => '更新指定报警规则的配置信息。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateMsConfigAttributes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'WorkspaceName', - 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '111056', + 'abilityTreeNodes' => ['FEATUREsofaNCKPTU'], + ], + 'parameters' => [ [ - 'name' => 'RuleId', + 'name' => 'AttributeName', 'in' => 'formData', - 'schema' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '属性名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'age'], ], [ - 'name' => 'RuleUniqueIdentity', + 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '告警唯一标识', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '属性描述信息', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '年龄'], ], [ - 'name' => 'Category', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '规则类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '属性自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'RefDatasourceType', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'datasource', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], ], 'responses' => [ @@ -8703,365 +5407,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - ], - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - ], - 'PageSize' => [ - 'description' => '每页大小', - 'type' => 'integer', - 'format' => 'int64', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmRules' => [ - 'description' => '报警规则信息', - 'type' => 'array', - 'items' => [ - 'description' => '报警规则信息', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '启停状态 1：打开 0:闭合', - 'type' => 'integer', - 'format' => 'int64', - ], - 'NotifyTplId' => [ - 'description' => '通知模板id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Channels' => [ - 'description' => '通知渠道 "["ddWebhook","sms","phone","email"]"', - 'type' => 'string', - ], - 'NotifyFiring' => [ - 'description' => '告警触发时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'string', - ], - 'NotifyEmpty' => [ - 'description' => '告警无数据时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Creator' => [ - 'description' => '规则创建者', - 'type' => 'string', - ], - 'NotifyTimeFilter' => [ - 'description' => '通知时间', - 'type' => 'string', - ], - 'Modifier' => [ - 'description' => '修改人', - 'type' => 'string', - ], - 'NotifyRecovered' => [ - 'description' => '告警恢复时通知 1:勾选 0:不勾选', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SuspendedStartTime' => [ - 'description' => '暂停开始时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Deleted' => [ - 'description' => '软删除', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SuspendedReason' => [ - 'description' => '暂停的原因', - 'type' => 'string', - ], - 'PendingHit' => [ - 'description' => ' 触发周期', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Name' => [ - 'description' => '规则名称', - 'type' => 'string', - ], - 'RecoveredHit' => [ - 'description' => '恢复周期', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmEmpty' => [ - 'description' => '指标无数据触发告警 是个开关 1:打开 0:关闭', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SilenceTime' => [ - 'description' => '通知静默时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmStatus' => [ - 'description' => '告警状态', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Emergency' => [ - 'description' => '应急处理人', - 'type' => 'string', - ], - 'SourceId' => [ - 'description' => '标识告警规则迁移之前的 ID', - 'type' => 'string', - ], - 'SuspendedEndTime' => [ - 'description' => '暂停结束时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Step' => [ - 'description' => '检测频率', - 'type' => 'integer', - 'format' => 'int64', - ], - 'WorkspaceId' => [ - 'description' => '工作空间id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'UniqueIdentity' => [ - 'description' => '告警规则唯一标识', - 'type' => 'string', - ], - 'TimeZone' => [ - 'description' => '时区', - 'type' => 'string', - ], - 'EmergencyUrl' => [ - 'description' => '应急处理链接', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - ], - 'Category' => [ - 'description' => '规则类型', - 'type' => 'string', - ], - 'Level' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Id' => [ - 'description' => '主键id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'TenantId' => [ - 'description' => '租户id', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RuleConfig' => [ - 'description' => '规则配置信息', - 'type' => 'string', - ], - 'ConditionsDes' => [ - 'description' => '告警触发条件', - 'type' => 'array', - 'items' => [ - 'description' => '告警触发条件', - 'type' => 'string', - ], - ], - ], - ], - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码，取值为： OK、INTERNALERROR、ERRPERMISSIONDENIED、ERRNOTENABLED、INVALIDSIGNATURE、ERRORREQUEST、ACCESSDENIED、MISSINGPARAMETER、ERRORINTERNALPROVIDER、BADPROVIDER_RESPONSE。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'ServerInernalError', - 'errorMessage' => 'A server internal error occurred while processing your request. Contact the administrator.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>894900FD-184F-42C1-A53C-82B114154BE1</RequestId>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', + 'title' => 'UpdateMsConfigAttributes', + 'summary' => '根据属性 ID 更新属性元信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => '错误码发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"TotalCount\\": 0,\\n \\"AlarmRules\\": [\\n {\\n \\"Status\\": 0,\\n \\"NotifyTplId\\": 0,\\n \\"Channels\\": \\"\\",\\n \\"NotifyFiring\\": 0,\\n \\"GmtModified\\": \\"\\",\\n \\"NotifyEmpty\\": 0,\\n \\"Creator\\": \\"\\",\\n \\"NotifyTimeFilter\\": \\"\\",\\n \\"Modifier\\": \\"\\",\\n \\"NotifyRecovered\\": 0,\\n \\"SuspendedStartTime\\": 0,\\n \\"Deleted\\": 0,\\n \\"SuspendedReason\\": \\"\\",\\n \\"PendingHit\\": 0,\\n \\"Name\\": \\"\\",\\n \\"RecoveredHit\\": 0,\\n \\"AlarmEmpty\\": 0,\\n \\"SilenceTime\\": 0,\\n \\"AlarmStatus\\": 0,\\n \\"Emergency\\": \\"\\",\\n \\"SourceId\\": \\"\\",\\n \\"SuspendedEndTime\\": 0,\\n \\"Step\\": 0,\\n \\"WorkspaceId\\": 0,\\n \\"UniqueIdentity\\": \\"\\",\\n \\"TimeZone\\": \\"\\",\\n \\"EmergencyUrl\\": \\"\\",\\n \\"GmtCreate\\": \\"\\",\\n \\"Category\\": \\"\\",\\n \\"Level\\": 0,\\n \\"Id\\": 0,\\n \\"TenantId\\": 0,\\n \\"RuleConfig\\": \\"\\",\\n \\"ConditionsDes\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'QueryRMSUnifiedAlarmHistory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateMsConfigResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'WorkspaceName', - 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAStack杭州金区-生产', - ], - ], - [ - 'name' => 'Start', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '查询开始时间，格式为Unix时间戳，单位为毫秒。'."\n" - ."\n" - .'> 查询开始时间需在数据库实例SQL洞察存储时长范围内，最大不能早于当前时间90天。'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1668911820000', - ], + 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'foo'], ], [ - 'name' => 'End', + 'name' => 'Attributes', 'in' => 'formData', - 'schema' => [ - 'description' => '查询数据的终止日期，格式为Unix时间戳，单位为毫秒。'."\n" - ."\n" - .'> 查询结束时间需晚于查询开始时间，最晚只能查询到当天凌晨0点的数据。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1662516900000', - ], + 'schema' => ['description' => '资源的属性信息，以 JSON 字符串格式传入', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"attributeName":"age","desc":"描述信息"}]'], ], [ - 'name' => 'CurrentPage', - 'in' => 'formData', - 'schema' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '分页参数，分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => '资源描述信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试资源'], ], [ - 'name' => 'AlarmTargetType', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '告警对象类型', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'APP', - ], + 'schema' => ['description' => '更新的资源自增长 ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AlarmTarget', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '告警对象', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'PlanetKms', - ], + 'schema' => ['description' => '系统字段：环境实例 ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234'], ], [ - 'name' => 'AlarmLevel', + 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => '资源搜索的域', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alipay'], ], [ - 'name' => 'Status', + 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '告警状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => '资源唯一标识', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.test.resource'], ], [ - 'name' => 'AlarmStackInfoJsonStr', + 'name' => 'UpdateAttribute', 'in' => 'formData', - 'schema' => [ - 'description' => '根据应用过滤告警历史json格式 包含字段如下：'."\n" - ."\n" - .'datasource_type STRING 否 ["CUSTOM","STACK","TABLE] '."\n" - .'是应用监控，还是自定义监控'."\n" - ."\n" - .'datasource STRING 否 MM@@2000464 '."\n" - .'数据源'."\n" - ."\n" - .'alarm_target_type STRING 否 ["APP","HOST"] '."\n" - .'应用类型'."\n" - ."\n" - .'alarm_target_identify STRING 否 RMS-monitorprod '."\n" - .'应用名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{\\"DatasourceType\\":\\"STACK\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-twc-universal\\"}', - ], + 'schema' => ['description' => '是否全量更新属性，默认为 false', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -9069,836 +5495,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'RequestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => 'CB2B427A-E370-5599-8872-A249F8EFD859', - ], - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'workspace not found with name TWCProd, tenant_id 0008528286', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'description' => '分页参数，分页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'AlarmHistories' => [ - 'description' => '报警历史对象列表', - 'type' => 'array', - 'items' => [ - 'description' => '报警历史详情', - 'type' => 'object', - 'properties' => [ - 'AlarmTargetType' => [ - 'description' => '告警对象类型', - 'type' => 'string', - 'example' => 'APP', - ], - 'Status' => [ - 'description' => '报警状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSourceName' => [ - 'description' => '数据源名称', - 'type' => 'string', - 'example' => 'ant_intel_hz', - ], - 'AlarmType' => [ - 'description' => ' '."\n" - .'告警类型', - 'type' => 'string', - 'example' => 'APP', - ], - 'GmtModified' => [ - 'description' => '最后修改时间', - 'type' => 'string', - 'example' => '2020-04-02 21:53:24', - ], - 'EventId' => [ - 'description' => '告警事件id', - 'type' => 'string', - 'example' => '355402_1670998540000_598877597', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'UniqueIdentity' => [ - 'description' => '告警规则唯一标识', - 'type' => 'string', - 'example' => '174851af-6c56-4d8b-8cc7-9f998e752f09', - ], - 'AlarmTime' => [ - 'description' => '告警时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1671088115000', - ], - 'AlarmRuleId' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '860', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2020-04-02 21:53:24', - ], - 'AlarmDetail' => [ - 'description' => '告警详情', - 'type' => 'string', - 'example' => '[{"datasource":"basic@@machinePortCheck","tags":[{"key":"cluster","value":"default-kernel"},{"key":"hostname","value":"100.83.13.115"},{"key":"port","value":"22"}],"conditionValues":[{"condition":{"metric":"total","metricDisplayName":"总量","type":"Current","compareOperation":"LT","N":0,"threshold":10000.0,"conditionDesc":"total 当前时间 > 10000.0"},"value":1.0}]}]', - ], - 'AlarmUrl' => [ - 'description' => '告警数据源跳转url', - 'type' => 'string', - 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', - ], - 'AlarmContent' => [ - 'description' => '报警内容', - 'type' => 'string', - 'example' => '[测试实例] [cluster:default-kernel hostname:100.83.13.115 port:22 cluster:antcloud-middlewaredev-import-cluster-38742336 namespace:kube-system] 物理机端口探测/总量 当前时间的值 1.000 < 10000.00', - ], - 'AlarmUrlWithDomain' => [ - 'description' => ' '."\n" - .'网页的绝对路径，包含域名', - 'type' => 'string', - 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', - ], - 'AlarmTargetDeleted' => [ - 'description' => ' '."\n" - .'目标对象是否删除', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AlarmLevel' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3376', - ], - 'TenantId' => [ - 'description' => '租户id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AlarmTarget' => [ - 'description' => '告警对象', - 'type' => 'string', - 'example' => 'sibei_1229_1', - ], - 'AlarmRuleName' => [ - 'description' => ' '."\n" - .'告警规则名', - 'type' => 'string', - 'example' => 'bvtcase测试', - ], - ], - ], - ], + 'ResultMessage' => ['description' => '结果描述', 'type' => 'string', 'example' => 'OK'], + 'ResultCode' => ['description' => '结果码', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04'], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 5,\\n \\"RequestId\\": \\"CB2B427A-E370-5599-8872-A249F8EFD859\\",\\n \\"ResultMessage\\": \\"workspace not found with name TWCProd, tenant_id 0008528286\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 120,\\n \\"AlarmHistories\\": [\\n {\\n \\"AlarmTargetType\\": \\"APP\\",\\n \\"Status\\": 1,\\n \\"DataSourceName\\": \\"ant_intel_hz\\",\\n \\"AlarmType\\": \\"APP\\",\\n \\"GmtModified\\": \\"2020-04-02 21:53:24\\",\\n \\"EventId\\": \\"355402_1670998540000_598877597\\",\\n \\"WorkspaceId\\": 1,\\n \\"UniqueIdentity\\": \\"174851af-6c56-4d8b-8cc7-9f998e752f09\\",\\n \\"AlarmTime\\": 1671088115000,\\n \\"AlarmRuleId\\": 860,\\n \\"GmtCreate\\": \\"2020-04-02 21:53:24\\",\\n \\"AlarmDetail\\": \\"[{\\\\\\"datasource\\\\\\":\\\\\\"basic@@machinePortCheck\\\\\\",\\\\\\"tags\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"cluster\\\\\\",\\\\\\"value\\\\\\":\\\\\\"default-kernel\\\\\\"},{\\\\\\"key\\\\\\":\\\\\\"hostname\\\\\\",\\\\\\"value\\\\\\":\\\\\\"100.83.13.115\\\\\\"},{\\\\\\"key\\\\\\":\\\\\\"port\\\\\\",\\\\\\"value\\\\\\":\\\\\\"22\\\\\\"}],\\\\\\"conditionValues\\\\\\":[{\\\\\\"condition\\\\\\":{\\\\\\"metric\\\\\\":\\\\\\"total\\\\\\",\\\\\\"metricDisplayName\\\\\\":\\\\\\"总量\\\\\\",\\\\\\"type\\\\\\":\\\\\\"Current\\\\\\",\\\\\\"compareOperation\\\\\\":\\\\\\"LT\\\\\\",\\\\\\"N\\\\\\":0,\\\\\\"threshold\\\\\\":10000.0,\\\\\\"conditionDesc\\\\\\":\\\\\\"total 当前时间 > 10000.0\\\\\\"},\\\\\\"value\\\\\\":1.0}]}]\\",\\n \\"AlarmUrl\\": \\"/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"AlarmContent\\": \\"[测试实例] [cluster:default-kernel hostname:100.83.13.115 port:22 cluster:antcloud-middlewaredev-import-cluster-38742336 namespace:kube-system] 物理机端口探测/总量 当前时间的值 1.000 < 10000.00\\",\\n \\"AlarmUrlWithDomain\\": \\"http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"AlarmTargetDeleted\\": false,\\n \\"AlarmLevel\\": 1,\\n \\"Id\\": 3376,\\n \\"TenantId\\": 1,\\n \\"AlarmTarget\\": \\"sibei_1229_1\\",\\n \\"AlarmRuleName\\": \\"bvtcase测试\\"\\n }\\n ]\\n}","type":"json"}]', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '更新资源元信息', + 'summary' => 'update_attribute 为 false 时，则只更新资源元信息，不会更新属性信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], ], - 'QueryRMSUnifiedAlarmNotifyHistory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateRMSUnifiedAlarmRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'发送状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - '失败', - '成功', - ], - 'example' => '0', - ], + 'schema' => ['description' => '报警规则id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1'], ], [ - 'name' => 'Channel', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'通知渠道', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'DD_WEBHOOK', - ], + 'schema' => ['description' => '报警规则名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TAGS'], ], [ - 'name' => 'Subscriber', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'description' => '通知人id', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => '规则类型', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CUSTOM'], ], [ - 'name' => 'CurrentPage', + 'name' => 'RuleConfig', 'in' => 'formData', - 'schema' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => '报警规则配置', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"trafficType\\":\\"i\\",\\"methodName\\":\\"*\\",\\"faultInjectRuleItems\\":[{\\"action\\":{\\"type\\":\\"REJECT\\"},\\"ruleType\\":\\"ABORT\\",\\"configs\\":{\\"faultPercent\\":100}}]} '], ], [ - 'name' => 'PageSize', + 'name' => 'AlarmNodata', 'in' => 'formData', - 'schema' => [ - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '20', - ], + 'schema' => ['description' => '报警通知结果数据', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'WorkspaceName', + 'name' => 'Level', 'in' => 'formData', - 'schema' => [ - 'description' => '工作区名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acgatewayprod', - ], + 'schema' => ['description' => '告警等级', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2'], ], [ - 'name' => 'EventId', + 'name' => 'Emergency', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'事件id', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '355400_1670410905000_598877597', - ], + 'schema' => ['description' => '应急处理人', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'StartTime', + 'name' => 'EmergencyUrl', 'in' => 'formData', - 'schema' => [ - 'description' => ' '."\n" - .'开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1660730580000', - ], + 'schema' => ['description' => '应急处理链接', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'EndTime', + 'name' => 'PendingHit', 'in' => 'formData', - 'schema' => [ - 'description' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1668160800150', - ], + 'schema' => ['description' => ' 触发周期', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'Keyword', + 'name' => 'RecoveredHit', 'in' => 'formData', - 'schema' => [ - 'description' => '查询告警内容', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'asd', - ], + 'schema' => ['description' => '恢复周期', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'AlarmRuleId', + 'name' => 'Step', 'in' => 'formData', - 'schema' => [ - 'description' => '告警规则 ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '22', - ], + 'schema' => ['description' => '检测频率', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '5'], ], [ - 'name' => 'AlarmStatus', + 'name' => 'SilenceTime', 'in' => 'formData', - 'schema' => [ - 'description' => '告警状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 2 => '告警中', - 4 => '已静默', - '已恢复', - ], - 'example' => '2', - ], + 'schema' => ['description' => '通知静默时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '900'], ], [ - 'name' => 'AlarmStackInfoJsonStr', + 'name' => 'NotifyFiring', 'in' => 'formData', - 'schema' => [ - 'description' => '根据应用过滤告警历史json格式 包含字段如下：'."\n" - ."\n" - .'datasource_type STRING 否 ["CUSTOM","STACK","TABLE] '."\n" - .'是应用监控，还是自定义监控'."\n" - ."\n" - .'datasource STRING 否 MM@@2000464 '."\n" - .'数据源'."\n" - ."\n" - .'alarm_target_type STRING 否 ["APP","HOST"] '."\n" - .'应用类型'."\n" - ."\n" - .'alarm_target_identify STRING 否 RMS-monitorprod '."\n" - .'应用名称', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{\\"DatasourceType\\":\\"CUSTOM\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-acrbasis\\"，\\"Datasource\\":\\"SPM@@15984\\"}', - ], + 'schema' => ['description' => '告警触发时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'DashboardQueryParamJsonStr', + 'name' => 'NotifyRecovered', 'in' => 'formData', - 'schema' => [ - 'description' => '大盘告警查询参数', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '告警恢复时通知 1:勾选 0:不勾选', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], [ - 'name' => 'AlarmSubscribers', + 'name' => 'NotifyNodata', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '根据通知对象过滤', - 'type' => 'array', - 'items' => [ - 'description' => '通知对象', - 'type' => 'object', - 'properties' => [ - 'SubscriberSource' => [ - 'description' => ' '."\n" - .'订阅者来源', - 'type' => 'string', - 'required' => true, - 'example' => 'LOCAL', - ], - 'SubscriberType' => [ - 'description' => '订阅者类型', - 'type' => 'string', - 'required' => true, - 'example' => 'USER_GROUP', - ], - 'Subscriber' => [ - 'description' => '订阅者', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'SubscriberUuid' => [ - 'description' => '订阅者uuid', - 'type' => 'string', - 'required' => true, - 'example' => '839f5cf92ab3435385ef3949c001a7a8', - ], - 'SubscriberName' => [ - 'description' => '告警对象的名称', - 'type' => 'string', - 'required' => true, - 'example' => 'mike', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => '待修改的告警规则的数量', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'CurrentPage' => [ - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'B4C10721-BD3E-5F45-AF3C-880715462315', - ], - 'ResultMessage' => [ - 'description' => '结果描述', - 'type' => 'string', - 'example' => 'Rpc error', - ], - 'ResultCode' => [ - 'description' => '结果码', - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'description' => '每页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '84', - ], - 'AlarmNotifyHistories' => [ - 'description' => '报警通知历史', - 'type' => 'array', - 'items' => [ - 'description' => '报警通知历史', - 'type' => 'object', - 'properties' => [ - 'AlarmSilenceTime' => [ - 'description' => ' '."\n" - .'告警静默期', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Status' => [ - 'description' => '通知状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ErrorMessage' => [ - 'description' => '描述消息发送错误原因', - 'type' => 'string', - 'example' => 'Specified private IP address is duplicated.', - ], - 'AlarmType' => [ - 'description' => ' '."\n" - .'告警类型', - 'type' => 'string', - 'example' => 'APP', - ], - 'GmtModified' => [ - 'description' => '修改时间', - 'type' => 'string', - 'example' => '2020-03-18 21:47:32', - ], - 'NotifyContent' => [ - 'description' => '消息内容', - 'type' => 'string', - ], - 'AlarmRuleId' => [ - 'description' => '报警规则id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5839', - ], - 'Subscriber' => [ - 'description' => '订阅人', - 'type' => 'string', - 'example' => '400', - ], - 'Channel' => [ - 'description' => '通知渠道', - 'type' => 'string', - 'example' => 'DD_WEBHOOK', - ], - 'AlarmTargetDeleted' => [ - 'description' => ' '."\n" - .'目标对象是否删除', - 'type' => 'boolean', - ], - 'AlarmLevel' => [ - 'description' => '告警级别', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AlarmEventId' => [ - 'description' => '报警事件id', - 'type' => 'string', - 'example' => '356454_1670377620000_1650847553', - ], - 'AlarmRuleName' => [ - 'description' => ' '."\n" - .'告警规则名', - 'type' => 'string', - 'example' => 'bvtcase测试', - ], - 'AlarmTargetType' => [ - 'description' => '告警对象类型', - 'type' => 'string', - 'example' => 'APP', - ], - 'SubscriberType' => [ - 'description' => '订阅人的类型', - 'type' => 'string', - 'example' => 'USER_GROUP', - ], - 'AlarmStatus' => [ - 'description' => '报警状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'DataSourceName' => [ - 'description' => '数据源名称', - 'type' => 'string', - 'example' => '交易成功量', - ], - 'AlarmRuleUuid' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'description' => '工作空间ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SubscriberSource' => [ - 'description' => '订阅者来源', - 'type' => 'string', - 'example' => 'LOCAL', - ], - 'AlarmTime' => [ - 'description' => '报警时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1671076740000', - ], - 'AggCount' => [ - 'description' => ' '."\n" - .'聚合条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AlarmTargetIdentify' => [ - 'description' => '告警对象', - 'type' => 'string', - 'example' => 'monitorprod', - ], - 'AlarmHistoryId' => [ - 'description' => '报警发送记录id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27313821', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2020-03-13 02:25:08', - ], - 'AlarmUrl' => [ - 'description' => '告警数据源跳转url', - 'type' => 'string', - 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', - ], - 'AlarmUrlWithDomain' => [ - 'description' => ' '."\n" - .'网页的绝对路径，包含域名', - 'type' => 'string', - 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', - ], - 'TraceId' => [ - 'description' => '调用链ID，用于精确查询调用信息。', - 'type' => 'string', - 'example' => '0a6481081662012458401682123', - ], - 'Id' => [ - 'description' => '属性 ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '73738', - ], - 'TenantId' => [ - 'description' => '租户ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SubscriberName' => [ - 'description' => '订阅者名称'."\n" - ."\n", - 'type' => 'string', - 'example' => 'mike', - ], - ], - ], - ], - 'AlarmNotifySubs' => [ - 'description' => '告警通知历史中对应的通知对象', - 'type' => 'array', - 'items' => [ - 'description' => '通知对象', - 'type' => 'object', - 'properties' => [ - 'SubscriberSource' => [ - 'description' => '订阅者来源', - 'type' => 'string', - 'example' => 'LOCAL', - ], - 'Subscriber' => [ - 'description' => '订阅者', - 'type' => 'string', - 'example' => '400', - ], - 'SubscriberUuid' => [ - 'description' => '订阅者uuid', - 'type' => 'string', - 'example' => '839f5cf92ab3435385ef3949c001a7a8', - ], - 'SubscriberType' => [ - 'description' => '订阅者类型', - 'type' => 'string', - 'example' => 'USER_GROUP', - ], - 'SubscriberName' => [ - 'description' => '订阅者名称', - 'type' => 'string', - 'example' => 'mike', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"B4C10721-BD3E-5F45-AF3C-880715462315\\",\\n \\"ResultMessage\\": \\"Rpc error\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 84,\\n \\"AlarmNotifyHistories\\": [\\n {\\n \\"AlarmSilenceTime\\": 20,\\n \\"Status\\": 0,\\n \\"ErrorMessage\\": \\"Specified private IP address is duplicated.\\",\\n \\"AlarmType\\": \\"APP\\",\\n \\"GmtModified\\": \\"2020-03-18 21:47:32\\",\\n \\"NotifyContent\\": \\"\\",\\n \\"AlarmRuleId\\": 5839,\\n \\"Subscriber\\": \\"400\\",\\n \\"Channel\\": \\"DD_WEBHOOK\\",\\n \\"AlarmTargetDeleted\\": true,\\n \\"AlarmLevel\\": 1,\\n \\"AlarmEventId\\": \\"356454_1670377620000_1650847553\\",\\n \\"AlarmRuleName\\": \\"bvtcase测试\\",\\n \\"AlarmTargetType\\": \\"APP\\",\\n \\"SubscriberType\\": \\"USER_GROUP\\",\\n \\"AlarmStatus\\": 2,\\n \\"DataSourceName\\": \\"交易成功量\\",\\n \\"AlarmRuleUuid\\": \\"\\",\\n \\"WorkspaceId\\": 1,\\n \\"SubscriberSource\\": \\"LOCAL\\",\\n \\"AlarmTime\\": 1671076740000,\\n \\"AggCount\\": 1,\\n \\"AlarmTargetIdentify\\": \\"monitorprod\\",\\n \\"AlarmHistoryId\\": 27313821,\\n \\"GmtCreate\\": \\"2020-03-13 02:25:08\\",\\n \\"AlarmUrl\\": \\"/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"AlarmUrlWithDomain\\": \\"http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c\\",\\n \\"TraceId\\": \\"0a6481081662012458401682123\\",\\n \\"Id\\": 73738,\\n \\"TenantId\\": 1,\\n \\"SubscriberName\\": \\"mike\\"\\n }\\n ],\\n \\"AlarmNotifySubs\\": [\\n {\\n \\"SubscriberSource\\": \\"LOCAL\\",\\n \\"Subscriber\\": \\"400\\",\\n \\"SubscriberUuid\\": \\"839f5cf92ab3435385ef3949c001a7a8\\",\\n \\"SubscriberType\\": \\"USER_GROUP\\",\\n \\"SubscriberName\\": \\"mike\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询告警通知历史', - 'summary' => '查询告警通知历史，如钉钉、电话、短信、webhook的通知记录，以及通知状态。', - ], - 'QueryRMSMetrics' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Start', + 'name' => 'NotifyTimeFilterJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1636308360000', - ], + 'schema' => ['description' => '查询告警规则的时间范围', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'End', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => '查询结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1632278280000', - ], + 'schema' => ['description' => ' '."\n" + .'发送状态', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Firing'], ], [ - 'name' => 'Plugin', + 'name' => 'SuspendedStartTime', 'in' => 'formData', - 'schema' => [ - 'description' => '插件类型', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'SEC' => 'SEC', - 'STACK' => 'STACK', - 'MM' => 'MM', - 'SPM' => 'SPM', - 'SM' => 'SM', - ], - 'example' => 'SM', - ], + 'schema' => ['description' => '暂停开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'DsId', + 'name' => 'SuspendedEndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '监控指标唯一ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2643', - ], + 'schema' => ['description' => '暂停结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false], ], [ - 'name' => 'ContentType', + 'name' => 'SuspendedReason', 'in' => 'formData', - 'schema' => [ - 'description' => '指标数据类型', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'SPM' => 'SPM', - 'KEYSET' => 'KEYSET', - 'SINGLE_KEY_STAT' => 'SINGLE_KEY_STAT', - 'INDEXABLE_MULTI_KEY_STAT' => 'INDEXABLE_MULTI_KEY_STAT', - ], - 'example' => 'INDEXABLE_MULTI_KEY_STAT', - ], + 'schema' => ['description' => '暂停的原因', 'type' => 'string', 'required' => false, 'docRequired' => false], ], [ 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '工作空间名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], - ], - [ - 'name' => 'PeriodType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => '工作空间名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod'], ], [ - 'name' => 'FieldsRepeatList', + 'name' => 'ChannelsRepeatList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '指标维度过滤条件，一般可不填', + 'description' => '告警通知渠道', 'type' => 'array', - 'items' => [ - 'description' => '指标维度过滤条件，一般可不填'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - ], - 'required' => false, + 'items' => ['description' => '告警通知渠道', 'type' => 'string', 'required' => false], + 'required' => true, 'maxItems' => 100, ], ], [ - 'name' => 'Where', + 'name' => 'NotifyTarget', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '更多过滤条件', + 'description' => '配额告警通知对象。', 'type' => 'array', 'items' => [ - 'description' => '过滤条件对象', + 'description' => '配额告警通知对象。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '过滤 Key', - 'type' => 'string', - 'required' => false, - 'example' => 'app', - ], - 'Value' => [ - 'description' => '过滤 Value', - 'type' => 'string', - 'required' => false, - 'example' => 'monitorprod', - ], + 'SubscriberSource' => ['description' => ' '."\n" + .'订阅者来源', 'type' => 'string', 'required' => true, 'example' => 'LOCAL'], + 'SubscriberType' => ['description' => '订阅人的类型', 'type' => 'string', 'required' => true, 'example' => 'USER_GROUP'], + 'Subscriber' => ['description' => '通知人id', 'type' => 'string', 'required' => true, 'example' => '1'], + 'SubscriberUuid' => ['type' => 'string', 'required' => true, 'example' => '400', 'description' => ''], + 'SubscriberName' => ['description' => '订阅者名称'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => '实人认证-灰度测试'], ], 'required' => false, ], @@ -9910,122 +5671,809 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => '监控指标数据', 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => '""', - ], - 'ResultCode' => [ - 'description' => '返回码', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '38D23571-2FDD-5A3B-AF04-15A30B96D11B', - ], - 'Result' => [ - 'description' => '返回结果', - 'type' => 'string', - 'example' => '{"success":true,"message":"query ok, time cost: 33ms, pontus@{}","data":[{"tags":{},"datasByTime":{"1646014620000":[18730.0],"1646012400000":[17849.0],"1646010180000":[17860.0],"1646014140000":[18832.0],"1646011920000":[17843.0],"1646013660000":[17799.0],"1646011440000":[17803.0],"1646015400000":[17988.0],"1646013180000":[17851.0],"1646010960000":[17895.0],"1646014920000":[17628.0],"1646012700000":[17937.0],"1646010480000":[17757.0],"1646012580000":[17815.0],"1646014440000":[17785.0],"1646010000000":[17791.0],"1646012100000":[17785.0],"1646013960000":[17895.0],"1646011620000":[17822.0],"1646013480000":[17809.0],"1646015580000":[18780.0],"1646011140000":[17805.0],"1646013000000":[17682.0],"1646015100000":[18924.0],"1646010660000":[17819.0],"1646010540000":[17653.0],"1646014740000":[17848.0],"1646012280000":[17861.0],"1646010060000":[17787.0],"1646014260000":[17770.0],"1646011800000":[17990.0],"1646013780000":[17942.0],"1646011320000":[17749.0],"1646015520000":[18159.0],"1646013300000":[17889.0],"1646010840000":[17755.0],"1646015040000":[18836.0],"1646012820000":[17878.0],"1646010360000":[17829.0],"1646012460000":[17896.0],"1646014560000":[18979.0],"1646009880000":[17798.0],"1646011980000":[17806.0],"1646014080000":[17337.0],"1646011500000":[17801.0],"1646013600000":[17940.0],"1646015700000":[17885.0],"1646015220000":[18172.0],"1646011020000":[17757.0],"1646013120000":[17650.0],"1646012640000":[17825.0],"1646010420000":[17767.0],"1646014380000":[17769.0],"1646012160000":[17806.0],"1646009940000":[17769.0],"1646013900000":[17789.0],"1646011680000":[17808.0],"1646015640000":[17905.0],"1646013420000":[17888.0],"1646011200000":[17782.0],"1646015160000":[17304.0],"1646012940000":[17807.0],"1646010720000":[17821.0],"1646014680000":[17759.0],"1646010240000":[17749.0],"1646012340000":[17826.0],"1646014200000":[18874.0],"1646011860000":[17909.0],"1646013720000":[17905.0],"1646015820000":[null],"1646011380000":[17792.0],"1646013240000":[17841.0],"1646015340000":[17853.0],"1646010900000":[17811.0],"1646012760000":[17831.0],"1646014860000":[18881.0],"1646012520000":[17836.0],"1646014500000":[17888.0],"1646010300000":[17793.0],"1646012040000":[17745.0],"1646009820000":[17785.0],"1646014020000":[18936.0],"1646011560000":[17805.0],"1646015760000":[17891.0],"1646013540000":[17843.0],"1646011080000":[17773.0],"1646015280000":[18916.0],"1646013060000":[17858.0],"1646010600000":[17774.0],"1646014800000":[18913.0],"1646010120000":[17848.0],"1646012220000":[17738.0],"1646014320000":[17758.0],"1646011740000":[17766.0],"1646013840000":[17811.0],"1646011260000":[17764.0],"1646013360000":[17872.0],"1646015460000":[17721.0],"1646010780000":[17763.0],"1646012880000":[17821.0],"1646014980000":[17770.0]},"dataMapByTime":{}}],"ip":"11.124.205.28","attend":{"attends":{"FIN-PAAS-DEV":{"expect":30.0,"actual":30.0}},"attendsByIdc":{"FIN-PAAS-DEV":{"1646015760000":{"expect":2.0,"actual":2.0},"1646015700000":{"expect":2.0,"actual":2.0},"1646015640000":{"expect":2.0,"actual":2.0},"1646015580000":{"expect":2.0,"actual":2.0},"1646015520000":{"expect":2.0,"actual":2.0},"1646015460000":{"expect":2.0,"actual":2.0},"1646015400000":{"expect":2.0,"actual":2.0},"1646015340000":{"expect":2.0,"actual":2.0},"1646015220000":{"expect":2.0,"actual":2.0},"1646015280000":{"expect":2.0,"actual":2.0},"1646015160000":{"expect":2.0,"actual":2.0},"1646015100000":{"expect":2.0,"actual":2.0},"1646015040000":{"expect":2.0,"actual":2.0},"1646014980000":{"expect":2.0,"actual":2.0},"1646014920000":{"expect":2.0,"actual":2.0}}}}}', - ], + 'ResultMessage' => ['type' => 'string', 'description' => ''], + 'ResultCode' => ['type' => 'string', 'description' => ''], + 'RequestId' => ['type' => 'string', 'description' => ''], ], + 'description' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"38D23571-2FDD-5A3B-AF04-15A30B96D11B\\",\\n \\"Result\\": \\"{\\\\\\"success\\\\\\":true,\\\\\\"message\\\\\\":\\\\\\"query ok, time cost: 33ms, pontus@{}\\\\\\",\\\\\\"data\\\\\\":[{\\\\\\"tags\\\\\\":{},\\\\\\"datasByTime\\\\\\":{\\\\\\"1646014620000\\\\\\":[18730.0],\\\\\\"1646012400000\\\\\\":[17849.0],\\\\\\"1646010180000\\\\\\":[17860.0],\\\\\\"1646014140000\\\\\\":[18832.0],\\\\\\"1646011920000\\\\\\":[17843.0],\\\\\\"1646013660000\\\\\\":[17799.0],\\\\\\"1646011440000\\\\\\":[17803.0],\\\\\\"1646015400000\\\\\\":[17988.0],\\\\\\"1646013180000\\\\\\":[17851.0],\\\\\\"1646010960000\\\\\\":[17895.0],\\\\\\"1646014920000\\\\\\":[17628.0],\\\\\\"1646012700000\\\\\\":[17937.0],\\\\\\"1646010480000\\\\\\":[17757.0],\\\\\\"1646012580000\\\\\\":[17815.0],\\\\\\"1646014440000\\\\\\":[17785.0],\\\\\\"1646010000000\\\\\\":[17791.0],\\\\\\"1646012100000\\\\\\":[17785.0],\\\\\\"1646013960000\\\\\\":[17895.0],\\\\\\"1646011620000\\\\\\":[17822.0],\\\\\\"1646013480000\\\\\\":[17809.0],\\\\\\"1646015580000\\\\\\":[18780.0],\\\\\\"1646011140000\\\\\\":[17805.0],\\\\\\"1646013000000\\\\\\":[17682.0],\\\\\\"1646015100000\\\\\\":[18924.0],\\\\\\"1646010660000\\\\\\":[17819.0],\\\\\\"1646010540000\\\\\\":[17653.0],\\\\\\"1646014740000\\\\\\":[17848.0],\\\\\\"1646012280000\\\\\\":[17861.0],\\\\\\"1646010060000\\\\\\":[17787.0],\\\\\\"1646014260000\\\\\\":[17770.0],\\\\\\"1646011800000\\\\\\":[17990.0],\\\\\\"1646013780000\\\\\\":[17942.0],\\\\\\"1646011320000\\\\\\":[17749.0],\\\\\\"1646015520000\\\\\\":[18159.0],\\\\\\"1646013300000\\\\\\":[17889.0],\\\\\\"1646010840000\\\\\\":[17755.0],\\\\\\"1646015040000\\\\\\":[18836.0],\\\\\\"1646012820000\\\\\\":[17878.0],\\\\\\"1646010360000\\\\\\":[17829.0],\\\\\\"1646012460000\\\\\\":[17896.0],\\\\\\"1646014560000\\\\\\":[18979.0],\\\\\\"1646009880000\\\\\\":[17798.0],\\\\\\"1646011980000\\\\\\":[17806.0],\\\\\\"1646014080000\\\\\\":[17337.0],\\\\\\"1646011500000\\\\\\":[17801.0],\\\\\\"1646013600000\\\\\\":[17940.0],\\\\\\"1646015700000\\\\\\":[17885.0],\\\\\\"1646015220000\\\\\\":[18172.0],\\\\\\"1646011020000\\\\\\":[17757.0],\\\\\\"1646013120000\\\\\\":[17650.0],\\\\\\"1646012640000\\\\\\":[17825.0],\\\\\\"1646010420000\\\\\\":[17767.0],\\\\\\"1646014380000\\\\\\":[17769.0],\\\\\\"1646012160000\\\\\\":[17806.0],\\\\\\"1646009940000\\\\\\":[17769.0],\\\\\\"1646013900000\\\\\\":[17789.0],\\\\\\"1646011680000\\\\\\":[17808.0],\\\\\\"1646015640000\\\\\\":[17905.0],\\\\\\"1646013420000\\\\\\":[17888.0],\\\\\\"1646011200000\\\\\\":[17782.0],\\\\\\"1646015160000\\\\\\":[17304.0],\\\\\\"1646012940000\\\\\\":[17807.0],\\\\\\"1646010720000\\\\\\":[17821.0],\\\\\\"1646014680000\\\\\\":[17759.0],\\\\\\"1646010240000\\\\\\":[17749.0],\\\\\\"1646012340000\\\\\\":[17826.0],\\\\\\"1646014200000\\\\\\":[18874.0],\\\\\\"1646011860000\\\\\\":[17909.0],\\\\\\"1646013720000\\\\\\":[17905.0],\\\\\\"1646015820000\\\\\\":[null],\\\\\\"1646011380000\\\\\\":[17792.0],\\\\\\"1646013240000\\\\\\":[17841.0],\\\\\\"1646015340000\\\\\\":[17853.0],\\\\\\"1646010900000\\\\\\":[17811.0],\\\\\\"1646012760000\\\\\\":[17831.0],\\\\\\"1646014860000\\\\\\":[18881.0],\\\\\\"1646012520000\\\\\\":[17836.0],\\\\\\"1646014500000\\\\\\":[17888.0],\\\\\\"1646010300000\\\\\\":[17793.0],\\\\\\"1646012040000\\\\\\":[17745.0],\\\\\\"1646009820000\\\\\\":[17785.0],\\\\\\"1646014020000\\\\\\":[18936.0],\\\\\\"1646011560000\\\\\\":[17805.0],\\\\\\"1646015760000\\\\\\":[17891.0],\\\\\\"1646013540000\\\\\\":[17843.0],\\\\\\"1646011080000\\\\\\":[17773.0],\\\\\\"1646015280000\\\\\\":[18916.0],\\\\\\"1646013060000\\\\\\":[17858.0],\\\\\\"1646010600000\\\\\\":[17774.0],\\\\\\"1646014800000\\\\\\":[18913.0],\\\\\\"1646010120000\\\\\\":[17848.0],\\\\\\"1646012220000\\\\\\":[17738.0],\\\\\\"1646014320000\\\\\\":[17758.0],\\\\\\"1646011740000\\\\\\":[17766.0],\\\\\\"1646013840000\\\\\\":[17811.0],\\\\\\"1646011260000\\\\\\":[17764.0],\\\\\\"1646013360000\\\\\\":[17872.0],\\\\\\"1646015460000\\\\\\":[17721.0],\\\\\\"1646010780000\\\\\\":[17763.0],\\\\\\"1646012880000\\\\\\":[17821.0],\\\\\\"1646014980000\\\\\\":[17770.0]},\\\\\\"dataMapByTime\\\\\\":{}}],\\\\\\"ip\\\\\\":\\\\\\"11.124.205.28\\\\\\",\\\\\\"attend\\\\\\":{\\\\\\"attends\\\\\\":{\\\\\\"FIN-PAAS-DEV\\\\\\":{\\\\\\"expect\\\\\\":30.0,\\\\\\"actual\\\\\\":30.0}},\\\\\\"attendsByIdc\\\\\\":{\\\\\\"FIN-PAAS-DEV\\\\\\":{\\\\\\"1646015760000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015700000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015640000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015580000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015520000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015460000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015400000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015340000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015220000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015280000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015160000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015100000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646015040000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646014980000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0},\\\\\\"1646014920000\\\\\\":{\\\\\\"expect\\\\\\":2.0,\\\\\\"actual\\\\\\":2.0}}}}}\\"\\n}","type":"json"}]', - 'title' => '查询监控指标数据', - 'summary' => '根据指标ID等过滤条件查询监控指标时序数据。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:UpdateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], - 'LogoutMsRegistryService' => [ - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'sofa.cn-hangzhou.aliyuncs.com', 'endpoint' => 'sofa.cn-hangzhou.aliyuncs.com', 'vpc' => 'sofa-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'sofa.cn-shanghai.aliyuncs.com', 'endpoint' => 'sofa.cn-shanghai.aliyuncs.com', 'vpc' => 'sofa-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'sofa.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'sofa.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'sofa-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'sofa.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'sofa.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'sofa-vpc.cn-hangzhou-finance.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'UnknowError.SystemError', 'message' => 'An unknown error occurred in the system.', 'http_code' => 500, 'description' => '系统发生未知错误，刷新重试无效后请提交工单。'], + ['code' => 'UnknowError.SystemError', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => '系统错误'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddMsConfigResources'], + ['description' => '错误码发生变更', 'api' => 'DeleteMsConfigAttributes'], + ['description' => '错误码发生变更', 'api' => 'DeleteMsConfigResources'], + ['description' => '错误码发生变更', 'api' => 'GetMsConfigAttributes'], + ['description' => '错误码发生变更', 'api' => 'GetMsConfigResources'], + ['description' => '错误码发生变更', 'api' => 'GrayPushMsConfigData'], + ['description' => '错误码发生变更', 'api' => 'PushMsConfigData'], + ['description' => '错误码发生变更', 'api' => 'QueryMsConfigAttributes'], + ['description' => '错误码发生变更', 'api' => 'QueryMsConfigClients'], + ['description' => '错误码发生变更', 'api' => 'QueryMsConfigClientValues'], + ], + 'createdAt' => '2025-03-12T16:20:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryMqSofamqConsumerTimespan'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-03-12T12:07:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'QueryMqSofamqConsumerAccumulate'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2025-03-12T05:57:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AddMsConfigAttributes'], + ], + 'createdAt' => '2025-03-12T03:18:24.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ram' => [ + 'productCode' => 'SOFA', + 'productName' => '金融分布式架构', + 'ramCodes' => ['sofa'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetMqSofamqConsumerJStack', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerJStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + [ + 'apiName' => 'ListMqSofamqGroup', + 'description' => 'ListMqSofamqGroup', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ServerIpsRepeatList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'maxItems' => 100, + ], + [ + 'apiName' => 'QueryMsConfigResources', + 'description' => '查询资源元信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'type' => 'string', - ], - 'ResultCode' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'UpdateMqSofamqGroupRemark', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqGroupRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'UnknowError.SystemError', - 'errorMessage' => 'An unknown error occurred in the system.', + [ + 'apiName' => 'QueryMqSofamqMessageByKey', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRMSUnifiedAlarmRule', + 'description' => '删除告警规则', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:DeleteRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqMessageById', + 'description' => '通过消息 ID 查询消息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigClientValues', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClientValues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqDLQMessageByGroupId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqDLQMessageByGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddMsConfigAttributes', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMsConfigAttributes', + 'description' => 'DeleteMsConfigAttributes', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddMsConfigResources', + 'description' => '增加资源元数据', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigAttributes', + 'description' => '获取属性详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqWarnHistory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarnHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqTraceResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DisableMqSofamqWarn', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:DisableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRMSUnifiedAlarmRule', + 'description' => '创建告警规则', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:CreateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateMqSofamqGroup', + 'description' => 'CreateMqSofamqGroup', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetMqSofamqConsumerOffset', + 'description' => '重置消费位点', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResetMqSofamqConsumerOffset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmHistory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeCasComputers', + 'description' => '查询机器列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:DescribeCasComputers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqConsumerAccumulate', + 'description' => '查询消费者消息积压', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerAccumulate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqTraceByMsgId', + 'description' => '查询消息投递轨迹信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceByMsgId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqDLQMessageById', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSMetrics', + 'description' => '查询监控指标数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResendMqSofamqDLQMessageBatch', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmNotifyHistory', + 'description' => '查询告警通知历史', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmNotifyHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmEvent', + 'description' => '查询告警事件历史', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqWarn', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GrayPushMsConfigData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:GrayPushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqTrace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqTopic', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqGroupSubDetail', + 'description' => '查询 Group 的订阅关系', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqGroupSubDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMqSofamqTopicRemark', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqTopicRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqTrace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMsConfigResources', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMsConfigAttributes', + 'description' => 'UpdateMsConfigAttributes', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqConsumerTimespan', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerTimespan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMsConfigResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PushMsConfigData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:PushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigClients', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResendMqSofamqDLQMessageById', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRMSUnifiedAlarmRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:UpdateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqConsumerConnection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMsConfigAttributes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateMqSofamqTopic', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqConsumerStatus', + 'description' => '查询消费端详细状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnableMqSofamqWarn', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:EnableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqWarn', + 'description' => '查询报警记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqMessageByTopic', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMqSofamqWarn', + 'description' => 'UpdateMqSofamqWarn', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqTopic', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'sofa.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'sofa.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'sofa.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'sofa.cn-shanghai-finance-1.aliyuncs.com', - ], + 'resourceTypes' => [], ], ]; |