diff options
Diffstat (limited to 'data/en_us/sofa/2019-08-15')
| -rw-r--r-- | data/en_us/sofa/2019-08-15/api-docs.php | 11987 |
1 files changed, 4627 insertions, 7360 deletions
diff --git a/data/en_us/sofa/2019-08-15/api-docs.php b/data/en_us/sofa/2019-08-15/api-docs.php index 305e72e..7b594a8 100644 --- a/data/en_us/sofa/2019-08-15/api-docs.php +++ b/data/en_us/sofa/2019-08-15/api-docs.php @@ -1,240 +1,80 @@ <?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' => null, + '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' => 122104, - 'title' => null, - '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' => 122139, - 'title' => null, + 'children' => ['CreateMqSofamqTopic', 'UpdateMqSofamqTopicRemark'], 'type' => 'directory', - 'children' => [ - 'CreateMqSofamqTopic', - 'UpdateMqSofamqTopicRemark', - ], + 'title' => 'Topic', ], [ - 'id' => 122158, - 'title' => null, + 'children' => ['DescribeCasComputers'], 'type' => 'directory', - 'children' => [ - 'DescribeCasComputers', - ], + 'title' => 'Cas', ], [ - 'id' => 122169, - 'title' => null, + 'children' => ['AddMsConfigAttributes', 'AddMsConfigResources'], 'type' => 'directory', - 'children' => [ - 'AddMsConfigAttributes', - 'AddMsConfigResources', - ], + 'title' => 'DMS', ], [ - 'id' => 122172, - 'title' => null, + 'children' => ['UpdateRMSUnifiedAlarmRule', 'CreateRMSUnifiedAlarmRule', 'DeleteRMSUnifiedAlarmRule', 'QueryRMSUnifiedAlarmEvent', 'QueryRMSUnifiedAlarmRule', 'QueryRMSUnifiedAlarmHistory', 'QueryRMSUnifiedAlarmNotifyHistory', 'QueryRMSMetrics'], 'type' => 'directory', - 'children' => [ - 'UpdateRMSUnifiedAlarmRule', - 'CreateRMSUnifiedAlarmRule', - 'DeleteRMSUnifiedAlarmRule', - 'QueryRMSUnifiedAlarmEvent', - 'QueryRMSUnifiedAlarmRule', - 'QueryRMSUnifiedAlarmHistory', - 'QueryRMSUnifiedAlarmNotifyHistory', - 'QueryRMSMetrics', - ], + 'title' => 'RMS', ], [ - 'id' => 169573, - 'title' => null, + 'children' => ['LogoutMsRegistryService'], 'type' => 'directory', - 'children' => [ - 'LogoutMsRegistryService', - ], + 'title' => 'Others', ], ], '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The property name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'age', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The property description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '年龄', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - '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' => 'DeleteMsConfigAttributes', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The environment instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The auto-increment ID of the resource to which the property belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''], ], ], 'responses' => [ @@ -242,420 +82,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'Attribute' => [ + 'description' => 'The struct of the successfully added property.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'AttributeName' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Id' => ['description' => 'The property ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The property description.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteMsConfigResources', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Add property metadata', + 'summary' => 'Adds a property to a configuration item in a configuration file. You can push a property only after it is added.', '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' => '', - 'docRequired' => true, - 'example' => 'age', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Desc', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - 'required' => true, - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'changeSet' => [ + ['createdAt' => '2025-03-12T03:15:50.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', ], ], ], - '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":""}]', - 'extraInfo' => ' ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'title' => 'UpdateMsConfigAttributes', - ], - 'UpdateMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'foo', 'title' => ''], ], [ 'name' => 'Attributes', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The attribute information of the resource, passed in as a JSON string.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[ { "attribute_name":"attName", "desc":"some attribute comment" }, ... ]', 'title' => ''], ], [ 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The description of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试资源类', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Alipay', - ], + 'schema' => ['description' => 'The domain to which the resource type belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alipay', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.test.resource', - ], - ], - [ - 'name' => 'UpdateAttribute', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - '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' => '', - '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' => 'UpdateMsConfigResources', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Attribute' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '', - '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' => 'GetMsConfigAttributes', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The resource ID, similar to the file name of a configuration file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alipay.test.resource', 'title' => ''], ], ], 'responses' => [ @@ -663,295 +178,179 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Resource' => [ - 'description' => '', + 'description' => 'The information about the resource that was created.', 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'drmdemo', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Alipay', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.alipay.drmResource', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'drmdemo', 'title' => ''], + 'Region' => ['description' => 'The domain to which the resource belongs.', 'type' => 'string', 'example' => 'Alipay', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'com.alipay.drmResource', 'title' => ''], + 'Id' => ['description' => 'The auto-increment ID of the resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The description of the resource.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], 'Attributes' => [ - 'description' => '', + 'description' => 'The attribute list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'AttributeName' => ['description' => 'The attribute name.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Id' => ['description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The description of the attribute.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetMsConfigResources', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Add resource metadata', + 'summary' => 'Adds resource metadata. A resource is similar to a file and can have multiple attributes.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'docRequired' => true, - 'example' => 'demo-app', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Group ID to create.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_group_id', 'title' => ''], ], [ - 'name' => 'AttributeName', + 'name' => 'GroupType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'age', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The group type.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tcp', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID associated with the Group ID to create.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], ], [ - 'name' => 'Region', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'Alipay', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'ResourceId', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'com.alipay.test', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The description of the Group ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], - 'Attribute' => [ - 'description' => '', - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'example' => 'abcdEFGH1234', - 'type' => 'string', - ], - 'AttributeName' => [ - 'description' => '', - 'example' => 'switch', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Desc' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'CreateMqSofamqGroup', + 'summary' => 'Creates a Group ID. The created Group ID is used to publish and subscribe to messages.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'QueryMsConfigAttributes', - ], - 'QueryMsConfigClients' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the instance to which the topic to be created belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000001', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'MessageType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The message type. Valid values: 0: normal message. 1: partitionally ordered message. 2: globally ordered message. 4: transactional message. 5: scheduled or delayed message.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The description of the topic.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '测试', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the topic to be created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -959,552 +358,177 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'switch', - ], - 'Cell' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DEFAULT', - ], - ], - ], - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryMsConfigClients', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Create a topic in a specified environment instance', + 'summary' => 'Specifies the message type and topic name to create a topic.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMsConfigClientValues' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'uitest1645783390369', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The type of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CUSTOM', 'title' => ''], ], [ - 'name' => 'Ips', + 'name' => 'RuleConfig', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.0.1,127.0.0.2', - ], + 'schema' => ['description' => 'The configuration information of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"trafficType\\":\\"i\\",\\"methodName\\":\\"*\\",\\"faultInjectRuleItems\\":[{\\"action\\":{\\"type\\":\\"REJECT\\"},\\"ruleType\\":\\"ABORT\\",\\"configs\\":{\\"faultPercent\\":100}}]} ', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Clients' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Ip' => [ - 'description' => '', - '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' => 'QueryMsConfigClientValues', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryMsConfigData' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AlarmNodata', + 'in' => 'formData', + 'schema' => ['description' => 'The no-data alert notification result.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'AttributeId', + 'name' => 'Level', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The severity level of the Prometheus alert rule.'."\n" + ."\n" + .'- P1: used for alert notifications about critical issues that affect the availability of core services, have a wide impact, and may cause severe consequences.'."\n" + .'- P2: used for alert notifications about issues where some services encounter errors and service availability is affected to a certain extent, but the impact is relatively limited.'."\n" + .'- P3: used for alert notifications about issues that may cause service errors or affect services, or for alert notifications sent for services of relatively low importance.'."\n" + .'- P4: used for alert notifications in scenarios that require notification but have a low priority and do not affect services.'."\n" + .'- Default: if you do not need to distinguish alert severity levels, use the default level.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Emergency', 'in' => 'formData', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'QueryResult' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some push data', - ], - 'Cell' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cell1', - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => 'The emergency handler.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], - ], - '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' => 'QueryMsConfigData', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EmergencyUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The emergency handling URL.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'PendingHit', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'foo', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The trigger cycle.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'RecoveredHit', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The recovery cycle.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'Step', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'com.alipay.drmResource', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The detection frequency.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'SilenceTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The notification mute period.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '300', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NotifyFiring', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => '10', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to send a notification when the alert is triggered. Valid values: 1: selected. 0: not selected.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TotalCount' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Resources' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'AppName' => [ - 'description' => '', - 'example' => 'drmdemo', - 'type' => 'string', - ], - 'Region' => [ - 'description' => '', - 'example' => 'Alipay', - 'type' => 'string', - ], - 'InstanceId' => [ - 'description' => '', - 'example' => 'abcdEFGH1234', - 'type' => 'string', - ], - 'ResourceId' => [ - 'description' => '', - 'example' => 'com.alipay.drmResource', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Desc' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Attributes' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'example' => 'abcdEFGH1234', - 'type' => 'string', - ], - 'AttributeName' => [ - 'description' => '', - 'example' => 'switch', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Desc' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - ], - ], - '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":""}]', - 'extraInfo' => ' ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'GrayPushMsConfigData' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '109242', - 'abilityTreeNodes' => [ - 'FEATUREsofaNCKPTU', + 'name' => 'NotifyRecovered', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to send a notification when the alert is resolved. Valid values: 1: selected. 0: not selected.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'AttributeId', + 'name' => 'NotifyNodata', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The total amount of subscription data to be deleted.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'Data', + 'name' => 'NotifyTimeFilterJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hello world', - ], + 'schema' => ['description' => 'The time range for querying alert rules.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Hosts', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.0.1,127.0.0.2', - ], + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ChannelsRepeatList', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The alert notification channels.', + 'type' => 'array', + 'items' => ['description' => 'The name of the alert channel.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Operator', + 'name' => 'NotifyTarget', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The Notification Recipient for alerting. Set the value to accountContact.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Notification Recipient for alerting. Set the value to accountContact.', + 'type' => 'object', + 'properties' => [ + 'SubscriberSource' => ['description' => 'The subscriber source.', 'type' => 'string', 'required' => true, 'example' => 'LOCAL', 'title' => ''], + 'SubscriberType' => ['description' => 'The subscriber type.', 'type' => 'string', 'required' => true, 'example' => 'USER_GROUP', 'title' => ''], + 'Subscriber' => ['description' => 'The ID of the notification recipient.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'SubscriberUuid' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '400', 'title' => ''], + 'SubscriberName' => ['description' => 'The name of the alert notification target.', 'type' => 'string', 'required' => true, 'example' => '实人认证-灰度测试', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => 'wang.li', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -1513,121 +537,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'PushResult' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => '127.0.0.1', - ], - ], - ], - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5F656C56-F99E-5C1E-AE7F-D9F78AC8D706', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'GrayPushMsConfigData', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'PushMsConfigData' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"5F656C56-F99E-5C1E-AE7F-D9F78AC8D706\\"\\n}","type":"json"}]', + 'title' => 'Create an alert rule', + 'summary' => 'Creates an alert rule.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:CreateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - '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' => 'The group ID of the message consumption cluster to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_group_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - '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' => 'The instance ID corresponding to the group ID to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], ], ], 'responses' => [ @@ -1635,41 +597,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'PushMsConfigData', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete a group', + 'summary' => 'Deletes a specified group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateMqSofamqGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteMqSofamqTopic' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1677,95 +642,62 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'test_group_id', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'GroupType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'tcp', - 'required' => false, - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the instance to which the topic to be deleted belongs. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000001', 'title' => ''], ], [ - 'name' => 'Remark', + 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'test', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the topic to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete a specified topic', + 'summary' => 'Deletes a specified topic. After the topic is deleted, all subscriptions under the topic are cleared.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'CreateMqSofamqGroup', - ], - 'DeleteMqSofamqGroup' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteMqSofamqTrace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1773,31 +705,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_group_id', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'QueryId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - ], + 'schema' => ['description' => 'The ID of the message trace query task to be deleted.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '272967562652883649157096685****', 'title' => ''], ], ], 'responses' => [ @@ -1805,73 +723,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteMqSofamqGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete a message trace query task', + 'summary' => 'Deletes a specified message trace query task.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqTopic' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '000001', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ - 'name' => 'Topic', + 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the alert rule to delete.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000001', 'title' => ''], ], ], 'responses' => [ @@ -1879,73 +785,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteMqSofamqTopic', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete a specified alert rule', + 'summary' => 'Deletes a specified alert rule by alert rule ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqTrace' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The auto-increment ID of the property.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'QueryId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '272967562652883649157096685****', - ], + 'schema' => ['description' => 'The ID of the environment instance. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], ], 'responses' => [ @@ -1953,73 +851,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DeleteMqSofamqTrace', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete property metadata', + 'summary' => 'Deletes the metadata of a property based on the property ID. Deleting the property metadata does not delete the property values.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'Auto-increment resource ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'WarnId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001', - ], + 'schema' => ['description' => 'System field: environment instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], ], 'responses' => [ @@ -2027,84 +914,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'Result description', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'Result code', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteMqSofamqWarn', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete Specified Resource', + 'summary' => 'Delete the corresponding resource by resource ID. Deleting a resource will also delete all attribute information under the resource.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMqSofamqGroupRemark' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteRMSUnifiedAlarmRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_group_id', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - ], - [ - 'name' => 'Remark', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod', 'title' => ''], ], ], 'responses' => [ @@ -2112,201 +978,339 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UpdateMqSofamqGroupRemark', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Delete an alert rule', + 'summary' => 'Deletes an alert rule.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:DeleteRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DescribeCasComputers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AlertTime', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '00:00-24:00', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '21', 'title' => ''], ], [ - 'name' => 'Contacts', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'opscenter', 'title' => ''], ], [ - 'name' => 'DelayTime', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '10', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Frequency', + 'name' => 'Workspace', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '10', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'shfinpre', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Threshold', + 'name' => 'AppServiceIdsRepeatList', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'format' => 'int64', + 'description' => 'The list of application service IDs.', + 'type' => 'array', + 'items' => ['description' => 'The list of application service IDs.', 'type' => 'string', 'required' => false, 'example' => '2144098938', 'title' => ''], 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'WarnId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '10000001 ', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ + 'CurrentPage' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DB5EB9EB-8690-570B-8A7F-41FF1C89C02E', 'title' => ''], + 'ResultMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResultCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '75', 'title' => ''], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SerialNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VpcId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PrivateIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UtcCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProviderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ImageIaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ImageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SpecIaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeployMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Initialized' => ['description' => 'Indicates whether the machine is initialized.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AutoRenewPeriod' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'PaasStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InstanceChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VSwitchIaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ImageName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PublicIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ZoneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpuShared' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'IaasType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OsBit' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'IaasStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NetworkType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Password' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Bandwidth' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UtcModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AppId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OsVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'LastOpsType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Memory' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CommonImage' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'AutoRenew' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId2' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Os' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IoOptimized' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Cpu' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ElasticIp' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExpiredTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ThreadsPerCore' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'LastOpsOrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DataDisks' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnableAutoSnapshot' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'UtcCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProviderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeleteAutoSnapshot' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UtcModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Size' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Device' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ZoneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Portable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Category' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ImageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeleteWithComputer' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Computer' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Options' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AssignedAppServiceIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AppServiceIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SystemDisk' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnableAutoSnapshot' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'UtcCreate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProviderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeleteAutoSnapshot' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UtcModified' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Size' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Device' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ZoneId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Portable' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Category' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ImageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeleteWithComputer' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Computer' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IaasId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', - ], - 'DisableMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', + '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\\": false,\\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\\": false,\\n \\"AutoRenew\\": false,\\n \\"TenantId2\\": \\"\\",\\n \\"Os\\": \\"\\",\\n \\"RegionId\\": \\"\\",\\n \\"IoOptimized\\": false,\\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\\": false,\\n \\"UtcCreate\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"DeleteAutoSnapshot\\": false,\\n \\"RegionId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"Size\\": 0,\\n \\"Device\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"Portable\\": false,\\n \\"Category\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"DeleteWithComputer\\": false,\\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\\": false,\\n \\"UtcCreate\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"ProviderId\\": \\"\\",\\n \\"DeleteAutoSnapshot\\": false,\\n \\"RegionId\\": \\"\\",\\n \\"WorkspaceId\\": \\"\\",\\n \\"UtcModified\\": \\"\\",\\n \\"Size\\": 0,\\n \\"Device\\": \\"\\",\\n \\"ZoneId\\": \\"\\",\\n \\"Portable\\": false,\\n \\"Category\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"DeleteWithComputer\\": false,\\n \\"Id\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"Computer\\": {\\n \\"Status\\": \\"\\",\\n \\"IaasId\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Id\\": \\"\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query machine list', + 'description' => 'Queries machines with paged query.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:DescribeCasComputers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'summary' => '', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DisableMqSofamqWarn' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001', - ], + 'schema' => ['description' => 'The ID of the alert rule to disable.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000001', 'title' => ''], ], ], 'responses' => [ @@ -2314,73 +1318,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DisableMqSofamqWarn', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Disable an alert rule', + 'summary' => 'Disables a specified alert rule by alert rule ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EnableMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:DisableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'EnableMqSofamqWarn' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'schema' => ['description' => 'The ID of the alert rule to enable.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001', 'title' => ''], ], ], 'responses' => [ @@ -2388,94 +1380,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'EnableMqSofamqWarn', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Enable an alert rule', + 'summary' => 'Enables a specified alert rule by alert rule ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetMqSofamqConsumerJStack' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:EnableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMqSofamqConsumerJStack' => [ + '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' => 'The cell to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RZ00A', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=', - ], + 'schema' => ['description' => 'The client ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => 'The group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE_ID_111', - ], + 'schema' => ['description' => 'The instance ID associated with the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_ID_111', 'title' => ''], ], ], 'responses' => [ @@ -2483,74 +1452,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The Jstack call stack information of the consumer.', 'type' => 'object', 'properties' => [ - 'ClientId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=', - ], + 'ClientId' => ['description' => 'The client ID of the consumer.', 'type' => 'string', 'example' => '10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=', 'title' => ''], 'Jstack' => [ - 'description' => '', + 'description' => 'The Jstack call stack information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Thread' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ConsumeMessageThread_0 ', - ], + 'Thread' => ['description' => 'The thread name.', 'type' => 'string', 'example' => 'ConsumeMessageThread_0 ', 'title' => ''], 'TrackList' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)', - ], + 'items' => ['description' => 'The Jstack call stack information string.', 'type' => 'string', 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ClientId\\": \\"10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=\\",\\n \\"Jstack\\": [\\n {\\n \\"Thread\\": \\"ConsumeMessageThread_0\\\\t\\",\\n \\"TrackList\\": [\\n \\"java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <ClientId>10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=</ClientId>\\n <Jstack>\\n <Thread>ConsumeMessageThread_0\\t</Thread>\\n </Jstack>\\n <Jstack>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </Jstack>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'GetMqSofamqConsumerJStack', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ClientId\\": \\"10.15.232.86@1129e#e4a224f4#2fa8320f33c4#eyIwIjoienRoIn0=\\",\\n \\"Jstack\\": [\\n {\\n \\"Thread\\": \\"ConsumeMessageThread_0\\\\t\\",\\n \\"TrackList\\": [\\n \\"java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query consumer stack information', + 'summary' => 'Queries consumer call stack information for troubleshooting purposes.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetMqSofamqConsumerStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerJStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMqSofamqConsumerStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2558,437 +1528,256 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'RZ01A ', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A ', 'title' => ''], ], [ 'name' => 'Detail', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to query detailed information. Valid values:'."\n" + .'- true: Query detailed information.'."\n" + .'- false: Do not query detailed information.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'GID_test_group_id', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID that corresponds to the Group ID to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'NeedJstack', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'false', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to print Jstack information.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', + 'type' => 'object', 'properties' => [ - 'ConsumeTps' => [ - 'description' => '', - 'example' => '0', - 'type' => 'string', - ], - 'SubscriptionSame' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'ConsumeModel' => [ - 'description' => '', - 'example' => 'CLUSTERING', - 'type' => 'string', - ], - 'TotalDiff' => [ - 'description' => '', - 'example' => '197', - 'format' => 'int64', - 'type' => 'integer', - ], - 'LastTimestamp' => [ - 'description' => '', - 'example' => '1566883844954', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DelayTime' => [ - 'description' => '', - 'example' => '100857', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Online' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'InstanceId' => [ - 'description' => '', - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - 'type' => 'string', - ], - 'RebalanceOk' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'ConsumeTps' => ['description' => 'The total consumption TPS.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'SubscriptionSame' => ['description' => 'Indicates whether the subscription relationships are consistent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ConsumeModel' => ['description' => 'The consumption model. Valid values:'."\n" + .'- CLUSTERING: clustering consumption mode.'."\n" + .'- BROADCASTING: broadcasting consumption mode.', 'type' => 'string', 'example' => 'CLUSTERING', 'title' => ''], + 'TotalDiff' => ['description' => 'The total consumption backlog of the cluster.', 'type' => 'integer', 'format' => 'int64', 'example' => '197', 'title' => ''], + 'LastTimestamp' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1566883844954', 'title' => ''], + 'DelayTime' => ['description' => 'The delay time.', 'type' => 'integer', 'format' => 'int64', 'example' => '100857', 'title' => ''], + 'Online' => ['description' => 'Indicates whether the consumer is online.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], + 'RebalanceOk' => ['description' => 'Indicates whether the client rebalance is normal. Valid values:'."\n" + .'- true: Normal.'."\n" + .'- false: Not normal.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'ConnectionSet' => [ - 'description' => '', + 'description' => 'The information about the clients that are currently online in the cluster.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'RemoteIp' => [ - 'description' => '', - 'example' => '42.120.74.**', - 'type' => 'string', - ], - 'ClientAddr' => [ - 'description' => '', - 'example' => '30.5.121.**', - 'type' => 'string', - ], - 'Version' => [ - 'description' => '', - 'example' => 'V4_3_6_SNAPSHOT', - 'type' => 'string', - ], - 'Language' => [ - 'description' => '', - 'example' => 'JAVA', - 'type' => 'string', - ], - 'ClientId' => [ - 'description' => '', - 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275 ', - 'type' => 'string', - ], + 'RemoteIp' => ['description' => 'The host IP address or public IP address.', 'type' => 'string', 'example' => '42.120.74.**', 'title' => ''], + 'ClientAddr' => ['description' => 'The address and port of the consumer instance.', 'type' => 'string', 'example' => '30.5.121.**', 'title' => ''], + 'Version' => ['description' => 'The consumer version.', 'type' => 'string', 'example' => 'V4_3_6_SNAPSHOT', 'title' => ''], + 'Language' => ['description' => 'The programming language of the consumer.', 'type' => 'string', 'example' => 'JAVA', 'title' => ''], + 'ClientId' => ['description' => 'The ID of the consumer instance.', 'type' => 'string', 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275 ', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'ConsumerConnectionInfoList' => [ - 'description' => '', + 'description' => 'The detailed information about the online clients in the cluster, including Jstack information and consumption RT.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'Connection' => [ - 'description' => '', - 'example' => '**', - 'type' => 'string', - ], - 'MessageModel' => [ - 'description' => '', - 'example' => 'CLUSTERING', - 'type' => 'string', - ], - 'Version' => [ - 'description' => '', - 'example' => 'V4_3_6', - 'type' => 'string', - ], - 'StartTimestamp' => [ - 'description' => '', - 'example' => '1570701361528', - 'format' => 'int64', - 'type' => 'integer', - ], - 'LastTimestamp' => [ - 'description' => '', - 'example' => '1570701368114', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ConsumeType' => [ - 'description' => 'PUSH/PULL', - 'example' => 'PUSH', - 'type' => 'string', - ], - 'ThreadCount' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Language' => [ - 'description' => '', - 'example' => 'JAVA', - 'type' => 'string', - ], - 'ClientId' => [ - 'description' => '', - 'example' => '30.5.**.**@25560#-1999745829#-1737591554#458773089270275', - 'type' => 'string', - ], + 'Connection' => ['description' => 'The connection information.', 'type' => 'string', 'example' => '**', 'title' => ''], + 'MessageModel' => ['description' => 'The consumption model. Valid values:'."\n" + .'- CLUSTERING: clustering consumption mode.'."\n" + .'- BROADCASTING: broadcasting consumption mode.', 'type' => 'string', 'example' => 'CLUSTERING', 'title' => ''], + 'Version' => ['description' => 'The client version number.', 'type' => 'string', 'example' => 'V4_3_6', 'title' => ''], + 'StartTimestamp' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701361528', 'title' => ''], + 'LastTimestamp' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701368114', 'title' => ''], + 'ConsumeType' => ['description' => 'PUSH/PULL', 'type' => 'string', 'example' => 'PUSH', 'title' => ''], + 'ThreadCount' => ['description' => 'The number of consumption threads.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Language' => ['description' => 'The programming language of the client.', 'type' => 'string', 'example' => 'JAVA', 'title' => ''], + 'ClientId' => ['description' => 'The ID of the consumer instance.', 'type' => 'string', 'example' => '30.5.**.**@25560#-1999745829#-1737591554#458773089270275', 'title' => ''], 'Jstack' => [ - 'description' => '', + 'description' => 'The Jstack stack information.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'Thread' => [ - 'description' => '', - 'example' => 'ConsumeMessageThread_0', - 'type' => 'string', - ], + 'Thread' => ['description' => 'The thread name.', 'type' => 'string', 'example' => 'ConsumeMessageThread_0', 'title' => ''], 'TrackList' => [ - 'items' => [ - 'description' => '', - 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)', - 'type' => 'string', - ], 'type' => 'array', + 'items' => ['description' => 'The Jstack stack information string.', 'type' => 'string', 'example' => 'java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'RunningDataList' => [ - 'description' => '', + 'description' => 'The real-time status statistics.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'description' => '', - 'example' => '000', - 'type' => 'string', - ], - 'Diff' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Rt' => [ - 'description' => '', - 'example' => '0.1', - 'type' => 'string', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'test-mq_topic', - 'type' => 'string', - ], - 'FailedCountPerHour' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'OkTps' => [ - 'description' => '', - 'example' => '0.1', - 'type' => 'string', - ], - 'FailedTps' => [ - 'description' => '', - 'example' => '0.1', - 'type' => 'string', - ], + 'GroupId' => ['description' => 'The Group ID of the subscriber.', 'type' => 'string', 'example' => '000', 'title' => ''], + 'Diff' => ['description' => 'The backlog amount.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Rt' => ['description' => 'The consumption response time, in milliseconds.', 'type' => 'string', 'example' => '0.1', 'title' => ''], + 'Topic' => ['description' => 'The name of the subscribed topic.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], + 'FailedCountPerHour' => ['description' => 'The number of messages that failed to be consumed per hour.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'OkTps' => ['description' => 'The TPS of successfully consumed messages.', 'type' => 'string', 'example' => '0.1', 'title' => ''], + 'FailedTps' => ['description' => 'The TPS of messages that failed to be consumed.', 'type' => 'string', 'example' => '0.1', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'SubscriptionSet' => [ - 'description' => '', + 'description' => 'The collection of subscription relationships.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'SubString' => [ - 'description' => '', - 'example' => '*', - 'type' => 'string', - ], - 'SubVersion' => [ - 'description' => '', - 'example' => '1570701364301', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'test-mq_topic', - 'type' => 'string', - ], + 'SubString' => ['description' => 'The tag expression for the subcategory subscribed to the topic.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'SubVersion' => ['description' => 'The version number of the subscription relationship. The value is an auto-incrementing Long type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701364301', 'title' => ''], + 'Topic' => ['description' => 'The name of the subscribed topic.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], 'TagsSet' => [ - 'items' => [ - 'description' => '', - 'example' => '*', - 'type' => 'string', - ], 'type' => 'array', + 'items' => ['description' => 'The collection of subscribed tags.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], 'DetailInTopicList' => [ - 'description' => '', + 'description' => 'The consumption details of each topic.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'TotalDiff' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DelayTime' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'LastTimestamp' => [ - 'description' => '', - 'example' => '1570701259403', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'test-mq_topic', - 'type' => 'string', - ], + 'TotalDiff' => ['description' => 'The total consumption backlog of the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DelayTime' => ['description' => 'The delay time.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'LastTimestamp' => ['description' => 'The last update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'Topic' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ConsumeTps\\": \\"0\\",\\n \\"SubscriptionSame\\": true,\\n \\"ConsumeModel\\": \\"CLUSTERING\\",\\n \\"TotalDiff\\": 197,\\n \\"LastTimestamp\\": 1566883844954,\\n \\"DelayTime\\": 100857,\\n \\"Online\\": true,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\\\t \\",\\n \\"RebalanceOk\\": true,\\n \\"ConnectionSet\\": [\\n {\\n \\"RemoteIp\\": \\"42.120.74.**\\",\\n \\"ClientAddr\\": \\"30.5.121.**\\",\\n \\"Version\\": \\"V4_3_6_SNAPSHOT\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\\\t \\"\\n }\\n ],\\n \\"ConsumerConnectionInfoList\\": [\\n {\\n \\"Connection\\": \\"**\\",\\n \\"MessageModel\\": \\"CLUSTERING\\",\\n \\"Version\\": \\"V4_3_6\\",\\n \\"StartTimestamp\\": 1570701361528,\\n \\"LastTimestamp\\": 1570701368114,\\n \\"ConsumeType\\": \\"PUSH\\",\\n \\"ThreadCount\\": 20,\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.**.**@25560#-1999745829#-1737591554#458773089270275\\",\\n \\"Jstack\\": [\\n {\\n \\"Thread\\": \\"ConsumeMessageThread_0\\",\\n \\"TrackList\\": [\\n \\"java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)\\"\\n ]\\n }\\n ],\\n \\"RunningDataList\\": [\\n {\\n \\"GroupId\\": \\"000\\",\\n \\"Diff\\": 100,\\n \\"Rt\\": \\"0.1\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"FailedCountPerHour\\": 0,\\n \\"OkTps\\": \\"0.1\\",\\n \\"FailedTps\\": \\"0.1\\"\\n }\\n ],\\n \\"SubscriptionSet\\": [\\n {\\n \\"SubString\\": \\"*\\",\\n \\"SubVersion\\": 1570701364301,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"TagsSet\\": [\\n \\"*\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"DetailInTopicList\\": [\\n {\\n \\"TotalDiff\\": 0,\\n \\"DelayTime\\": 0,\\n \\"LastTimestamp\\": 1570701259403,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <ConsumerConnectionInfoList>\\n <ClientAddr>30.5.121.**</ClientAddr>\\n <Language>JAVA</Language>\\n <RemoteIp>42.120.74.**</RemoteIp>\\n <Version>V4_3_6_SNAPSHOT</Version>\\n <ClientId>30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\t </ClientId>\\n </ConsumerConnectionInfoList>\\n <ConsumerConnectionInfoList>\\n <MessageModel>CLUSTERING</MessageModel>\\n <ThreadCount>20</ThreadCount>\\n <ConsumeType>PUSH</ConsumeType>\\n <Language>JAVA</Language>\\n <LastTimestamp>1570701368114</LastTimestamp>\\n <StartTimestamp>1570701361528</StartTimestamp>\\n <Version>V4_3_6</Version>\\n <Connection>**</Connection>\\n <ClientId>30.5.**.**@25560#-1999745829#-1737591554#458773089270275</ClientId>\\n </ConsumerConnectionInfoList>\\n <ConsumerConnectionInfoList>\\n <RunningDataList>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </RunningDataList>\\n <RunningDataList>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </RunningDataList>\\n <RunningDataList>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </RunningDataList>\\n <RunningDataList>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </RunningDataList>\\n <RunningDataList>\\n <TagsSet>*</TagsSet>\\n </RunningDataList>\\n <SubscriptionSet>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <TagsSet>*</TagsSet>\\n </SubscriptionSet>\\n <Jstack>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </Jstack>\\n <Jstack>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </Jstack>\\n <Jstack>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </Jstack>\\n <Jstack>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </Jstack>\\n <Jstack>\\n <TagsSet>*</TagsSet>\\n </Jstack>\\n </ConsumerConnectionInfoList>\\n <ConsumerConnectionInfoList>\\n <LastTimestamp>1570701259403</LastTimestamp>\\n <TotalDiff>0</TotalDiff>\\n <DelayTime>0</DelayTime>\\n <Topic>test-mq_topic</Topic>\\n </ConsumerConnectionInfoList>\\n <ConsumeModel>CLUSTERING</ConsumeModel>\\n <ConsumeTps>0</ConsumeTps>\\n <LastTimestamp>1566883844954</LastTimestamp>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx\\t </InstanceId>\\n <RebalanceOk>true</RebalanceOk>\\n <SubscriptionSame>true</SubscriptionSame>\\n <TotalDiff>197</TotalDiff>\\n <DelayTime>100857</DelayTime>\\n <Online>true</Online>\\n <ConnectionSet>\\n <ClientAddr>30.5.121.**</ClientAddr>\\n <Language>JAVA</Language>\\n <RemoteIp>42.120.74.**</RemoteIp>\\n <Version>V4_3_6_SNAPSHOT</Version>\\n <ClientId>30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\t </ClientId>\\n </ConnectionSet>\\n <ConnectionSet>\\n <MessageModel>CLUSTERING</MessageModel>\\n <ThreadCount>20</ThreadCount>\\n <ConsumeType>PUSH</ConsumeType>\\n <Language>JAVA</Language>\\n <LastTimestamp>1570701368114</LastTimestamp>\\n <StartTimestamp>1570701361528</StartTimestamp>\\n <Version>V4_3_6</Version>\\n <Connection>**</Connection>\\n <ClientId>30.5.**.**@25560#-1999745829#-1737591554#458773089270275</ClientId>\\n </ConnectionSet>\\n <ConnectionSet>\\n <RunningDataList>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </RunningDataList>\\n <RunningDataList>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </RunningDataList>\\n <RunningDataList>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </RunningDataList>\\n <RunningDataList>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </RunningDataList>\\n <RunningDataList>\\n <TagsSet>*</TagsSet>\\n </RunningDataList>\\n <SubscriptionSet>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <TagsSet>*</TagsSet>\\n </SubscriptionSet>\\n <Jstack>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </Jstack>\\n <Jstack>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </Jstack>\\n <Jstack>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </Jstack>\\n <Jstack>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </Jstack>\\n <Jstack>\\n <TagsSet>*</TagsSet>\\n </Jstack>\\n </ConnectionSet>\\n <ConnectionSet>\\n <LastTimestamp>1570701259403</LastTimestamp>\\n <TotalDiff>0</TotalDiff>\\n <DelayTime>0</DelayTime>\\n <Topic>test-mq_topic</Topic>\\n </ConnectionSet>\\n <DetailInTopicList>\\n <ClientAddr>30.5.121.**</ClientAddr>\\n <Language>JAVA</Language>\\n <RemoteIp>42.120.74.**</RemoteIp>\\n <Version>V4_3_6_SNAPSHOT</Version>\\n <ClientId>30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\t </ClientId>\\n </DetailInTopicList>\\n <DetailInTopicList>\\n <MessageModel>CLUSTERING</MessageModel>\\n <ThreadCount>20</ThreadCount>\\n <ConsumeType>PUSH</ConsumeType>\\n <Language>JAVA</Language>\\n <LastTimestamp>1570701368114</LastTimestamp>\\n <StartTimestamp>1570701361528</StartTimestamp>\\n <Version>V4_3_6</Version>\\n <Connection>**</Connection>\\n <ClientId>30.5.**.**@25560#-1999745829#-1737591554#458773089270275</ClientId>\\n </DetailInTopicList>\\n <DetailInTopicList>\\n <RunningDataList>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </RunningDataList>\\n <RunningDataList>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </RunningDataList>\\n <RunningDataList>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </RunningDataList>\\n <RunningDataList>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </RunningDataList>\\n <RunningDataList>\\n <TagsSet>*</TagsSet>\\n </RunningDataList>\\n <SubscriptionSet>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </SubscriptionSet>\\n <SubscriptionSet>\\n <TagsSet>*</TagsSet>\\n </SubscriptionSet>\\n <Jstack>\\n <Thread>ConsumeMessageThread_0</Thread>\\n </Jstack>\\n <Jstack>\\n <TrackList>java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)</TrackList>\\n </Jstack>\\n <Jstack>\\n <OkTps>0.1</OkTps>\\n <Rt>0.1</Rt>\\n <Diff>100</Diff>\\n <FailedTps>0.1</FailedTps>\\n <Topic>test-mq_topic</Topic>\\n <FailedCountPerHour>0</FailedCountPerHour>\\n <GroupId>000</GroupId>\\n </Jstack>\\n <Jstack>\\n <SubString>*</SubString>\\n <Topic>test-mq_topic</Topic>\\n <SubVersion>1570701364301</SubVersion>\\n </Jstack>\\n <Jstack>\\n <TagsSet>*</TagsSet>\\n </Jstack>\\n </DetailInTopicList>\\n <DetailInTopicList>\\n <LastTimestamp>1570701259403</LastTimestamp>\\n <TotalDiff>0</TotalDiff>\\n <DelayTime>0</DelayTime>\\n <Topic>test-mq_topic</Topic>\\n </DetailInTopicList>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ConsumeTps\\": \\"0\\",\\n \\"SubscriptionSame\\": true,\\n \\"ConsumeModel\\": \\"CLUSTERING\\",\\n \\"TotalDiff\\": 197,\\n \\"LastTimestamp\\": 1566883844954,\\n \\"DelayTime\\": 100857,\\n \\"Online\\": true,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\\\t \\",\\n \\"RebalanceOk\\": true,\\n \\"ConnectionSet\\": [\\n {\\n \\"RemoteIp\\": \\"42.120.74.**\\",\\n \\"ClientAddr\\": \\"30.5.121.**\\",\\n \\"Version\\": \\"V4_3_6_SNAPSHOT\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\\\t \\"\\n }\\n ],\\n \\"ConsumerConnectionInfoList\\": [\\n {\\n \\"Connection\\": \\"**\\",\\n \\"MessageModel\\": \\"CLUSTERING\\",\\n \\"Version\\": \\"V4_3_6\\",\\n \\"StartTimestamp\\": 1570701361528,\\n \\"LastTimestamp\\": 1570701368114,\\n \\"ConsumeType\\": \\"PUSH\\",\\n \\"ThreadCount\\": 20,\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.**.**@25560#-1999745829#-1737591554#458773089270275\\",\\n \\"Jstack\\": [\\n {\\n \\"Thread\\": \\"ConsumeMessageThread_0\\",\\n \\"TrackList\\": [\\n \\"java.util.concurrent.locks.LockSupport.park(LockSupport.java:175)\\"\\n ]\\n }\\n ],\\n \\"RunningDataList\\": [\\n {\\n \\"GroupId\\": \\"000\\",\\n \\"Diff\\": 100,\\n \\"Rt\\": \\"0.1\\",\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"FailedCountPerHour\\": 0,\\n \\"OkTps\\": \\"0.1\\",\\n \\"FailedTps\\": \\"0.1\\"\\n }\\n ],\\n \\"SubscriptionSet\\": [\\n {\\n \\"SubString\\": \\"*\\",\\n \\"SubVersion\\": 1570701364301,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"TagsSet\\": [\\n \\"*\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"DetailInTopicList\\": [\\n {\\n \\"TotalDiff\\": 0,\\n \\"DelayTime\\": 0,\\n \\"LastTimestamp\\": 1570701259403,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query detailed consumer status', + 'summary' => 'Includes subscription consistency checks, consumption TPS statistics, load balancing status, and consumer connections.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'GetMqSofamqConsumerStatus', - ], - 'GetMqSofamqDLQMessageById' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMqSofamqDLQMessageById' => [ + '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' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id ', - ], + 'schema' => ['description' => 'The Group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id ', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance to which the message belongs. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'MsgId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0BC16699165C03B925DB8A404E2D****', - ], + 'schema' => ['description' => 'The ID of the message to query, which is the Message ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0BC16699165C03B925DB8A404E2D****', 'title' => ''], ], ], 'responses' => [ @@ -2996,126 +1785,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', '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' => '', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => 'The message size.', 'type' => 'integer', 'format' => 'int64', 'example' => '407', 'title' => ''], + 'ReconsumeTimes' => ['description' => 'The number of retries for consuming the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StoreTimestamp' => ['description' => 'The timestamp when the message was stored on the server.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708', 'title' => ''], + 'Topic' => ['description' => 'The topic of the message.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], + 'StoreHost' => ['description' => 'The server instance that stores the message.', 'type' => 'string', 'example' => '11.220.***.***:10911', 'title' => ''], + 'BornTimestamp' => ['description' => 'The timestamp when the message was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'Body' => ['description' => 'The message body.', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', 'title' => ''], + 'BodyCrc' => ['description' => 'The CRC checksum of the message body.', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295', 'title' => ''], + 'BornHost' => ['description' => 'The client instance that generated the message.', 'type' => 'string', 'example' => '42.120.**.**:64646', 'title' => ''], 'PropertyList' => [ - 'description' => '', + 'description' => 'The list of message properties.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'The key name.', 'type' => 'string', 'example' => 'TAGS', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <PropertyList>\\n <Value>TagA</Value>\\n <Name>TAGS</Name>\\n </PropertyList>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <StoreSize>407</StoreSize>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCrc>914112295</BodyCrc>\\n <Topic>test-mq_topic</Topic>\\n <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'GetMqSofamqDLQMessageById', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query dead-letter message', + 'summary' => 'Queries a dead-letter message by Message ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetMqSofamqMessageById' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMqSofamqMessageById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3123,180 +1865,108 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'RZ01A ', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The cell where the message to query resides.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A ', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID associated with the message to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], ], [ 'name' => 'MsgId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1E0578FE110F18B4AAC235C05F2*****', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the message to query, that is, the Message ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E0578FE110F18B4AAC235C05F2*****', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'test-mq_topic ', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The topic of the message to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic ', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', + 'type' => 'object', 'properties' => [ - 'StoreSize' => [ - 'description' => '', - 'example' => '407', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ReconsumeTimes' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'StoreTimestamp' => [ - 'description' => '', - 'example' => '1570761026708', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'test-mq_topic', - 'type' => 'string', - ], - 'StoreHost' => [ - 'description' => '', - 'example' => '11.220.***.***:10911', - 'type' => 'string', - ], - 'BornTimestamp' => [ - 'description' => '', - 'example' => '1570761026630', - 'format' => 'int64', - 'type' => 'integer', - ], - 'InstanceId' => [ - 'description' => '', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - 'type' => 'string', - ], - 'Body' => [ - 'description' => '', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - 'type' => 'string', - ], - 'MsgId' => [ - 'description' => '', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - 'type' => 'string', - ], - 'BodyCrc' => [ - 'description' => '', - 'example' => '914112295', - 'format' => 'int64', - 'type' => 'integer', - ], - 'BornHost' => [ - 'description' => '', - 'example' => '42.120.**.**:64646', - 'type' => 'string', - ], + 'StoreSize' => ['description' => 'The message size. Unit: KB.', 'type' => 'integer', 'format' => 'int64', 'example' => '407', 'title' => ''], + 'ReconsumeTimes' => ['description' => 'The number of times the message has been retried for consumption.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StoreTimestamp' => ['description' => 'The timestamp when the message was stored on the server.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708', 'title' => ''], + 'Topic' => ['description' => 'The topic of the message.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], + 'StoreHost' => ['description' => 'The server instance that stores the message.', 'type' => 'string', 'example' => '11.220.***.***:10911', 'title' => ''], + 'BornTimestamp' => ['description' => 'The timestamp when the message was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'Body' => ['description' => 'The message body.', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', 'title' => ''], + 'MsgId' => ['description' => 'The message ID, that is, the Message ID.', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', 'title' => ''], + 'BodyCrc' => ['description' => 'The CRC checksum of the message body.', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295', 'title' => ''], + 'BornHost' => ['description' => 'The client instance that generated the message.', 'type' => 'string', 'example' => '42.120.**.**:64646', 'title' => ''], 'PropertyList' => [ - 'description' => '', + 'description' => 'The message property list.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'example' => 'TAGS', - 'type' => 'string', - ], - 'Value' => [ - 'description' => '', - 'example' => 'TagA', - 'type' => 'string', - ], + 'Name' => ['description' => 'The key name.', 'type' => 'string', 'example' => 'TAGS', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <PropertyList>\\n <Value>TagA</Value>\\n <Name>TAGS</Name>\\n </PropertyList>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <StoreSize>407</StoreSize>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCrc>914112295</BodyCrc>\\n <Topic>test-mq_topic</Topic>\\n <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query message by message ID', + 'summary' => 'Queries a message by exact match. The Message ID required for the query is obtained from the SendResult returned each time a message is sent successfully.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'GetMqSofamqMessageById', - ], - 'GetMqSofamqTraceByMsgId' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'translator' => 'machine', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMqSofamqTraceByMsgId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3304,155 +1974,100 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'BeginTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1570852800', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570852800', 'title' => ''], ], [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'RZ01A', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1570968000', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570968000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the instance that corresponds to the topic of the message to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], ], [ 'name' => 'MsgId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1E05791C117818B4AAC23B1BB0CE**** ', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the message to query, that is, the Message ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E05791C117818B4AAC23B1BB0CE**** ', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'test', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The topic of the message to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], - 'QueryId' => [ - 'description' => '', - 'example' => '272967562652883649157096685****', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'QueryId' => ['description' => 'The ID of the query task. You can call the GetMqSofamqTraceResult operation with this task ID to obtain detailed results.', 'type' => 'string', 'example' => '272967562652883649157096685****', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<QueryId>272967562652883649157096685****</QueryId>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\"\\n}","type":"json"}]', + 'title' => 'Query message delivery trace', + 'summary' => 'Queries the delivery trace of a message by Message ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'GetMqSofamqTraceByMsgId', - ], - 'GetMqSofamqTraceResult' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceByMsgId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMqSofamqTraceResult' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'QueryId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '272967562652883649157096685****', - ], + 'schema' => ['description' => 'The task ID of the message trace query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '272967562652883649157096685****', 'title' => ''], ], ], 'responses' => [ @@ -3460,228 +2075,139 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The details of the query task result.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'finish', - ], - 'MsgKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'keyA', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '27296756265288****', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'topic_a', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E05791C117818B4AAC23B1BB0CE****', - ], - 'QueryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '272967562652883649157096685****', - ], + 'Status' => ['description' => 'The result of the query task. Valid values:'."\n" + ."\n" + .'- finish: The query is complete.'."\n" + .'- working: The query is in progress.'."\n" + .'- removed: The task has been deleted.', 'type' => 'string', 'example' => 'finish', 'title' => ''], + 'MsgKey' => ['description' => 'The message key associated with the query task.', 'type' => 'string', 'example' => 'keyA', 'title' => ''], + 'UpdateTime' => ['description' => 'The last update time of the query task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the query task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000', 'title' => ''], + 'UserId' => ['description' => 'The ID of the query user.', 'type' => 'string', 'example' => '27296756265288****', 'title' => ''], + 'Topic' => ['description' => 'The topic of the query task.', 'type' => 'string', 'example' => 'topic_a', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'MsgId' => ['description' => 'The message ID associated with the query task.', 'type' => 'string', 'example' => '1E05791C117818B4AAC23B1BB0CE****', 'title' => ''], + 'QueryId' => ['description' => 'The query task ID.', 'type' => 'string', 'example' => '272967562652883649157096685****', 'title' => ''], 'TraceList' => [ - 'description' => '', + 'description' => 'The list of matched traces for the query task.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SEND_SUCCESS', - ], - 'MsgKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ORDERID_100', - ], - 'PubTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570850870478', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'CostTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Tag' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TagA', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0BC1F01800002A9F000000531246**** ', - ], - 'PubGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'GID_test', - ], - 'Cell' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RZ00A', - ], - 'BornHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30.5.**.**', - ], + 'Status' => ['description' => 'The sending status. Valid values:'."\n" + ."\n" + .'- SEND_SUCCESS: The message is sent.'."\n" + .'- SEND_FAILED: The message failed to be sent.'."\n" + .'- SEND_ROLLBACK: The transactional message is rolled back.'."\n" + .'- SEND_UNKNOWN: The transactional message is not committed.'."\n" + .'- SEND_DELAY: The scheduled or delayed message is pending delivery.', 'type' => 'string', 'example' => 'SEND_SUCCESS', 'title' => ''], + 'MsgKey' => ['description' => 'The key of the message, that is, the message key.', 'type' => 'string', 'example' => 'ORDERID_100', 'title' => ''], + 'PubTime' => ['description' => 'The time when the message was sent.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570850870478', 'title' => ''], + 'Topic' => ['description' => 'The topic of the message.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CostTime' => ['description' => 'The time consumed for sending the message. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''], + 'Tag' => ['description' => 'The tag of the message, that is, the message tag.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], + 'MsgId' => ['description' => 'The ID of the message, that is, the message ID.', 'type' => 'string', 'example' => '0BC1F01800002A9F000000531246**** ', 'title' => ''], + 'PubGroupName' => ['description' => 'The group ID configured on the producer client.', 'type' => 'string', 'example' => 'GID_test', 'title' => ''], + 'Cell' => ['description' => 'The cell name of the producer.', 'type' => 'string', 'example' => 'RZ00A', 'title' => ''], + 'BornHost' => ['description' => 'The client address of the message producer.', 'type' => 'string', 'example' => '30.5.**.**', 'title' => ''], 'SubList' => [ - 'description' => '', + 'description' => 'The list of consumption traces for the message.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'SubGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'GID_test', - ], - 'SuccessCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FailCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Cell' => [ - 'description' => 'cell name', - 'type' => 'string', - 'example' => 'RZ00A', - ], + 'SubGroupName' => ['description' => 'The group ID of the consumer.', 'type' => 'string', 'example' => 'GID_test', 'title' => ''], + 'SuccessCount' => ['description' => 'The number of successful consumption attempts for the group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'FailCount' => ['description' => 'The number of failed consumption attempts for the group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Cell' => ['description' => 'cell name', 'type' => 'string', 'example' => 'RZ00A', 'title' => ''], 'ClientList' => [ - 'description' => '', + 'description' => 'The detailed list of client consumption records for the group ID.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'GID_test', - ], - 'CostTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43', - ], + 'Status' => ['description' => 'The consumption status. Valid values:'."\n" + ."\n" + .'- CONSUME_FAILED: The message failed to be consumed.'."\n" + .'- CONSUME_SUCCESS: The message is consumed.'."\n" + .'- CONSUME_NOT_RETURN: No consumption result is returned.'."\n" + .'- SEND_UNKNOWN: The transactional message is not committed.'."\n" + .'- SEND_DELAY: The scheduled or delayed message is pending delivery.', 'type' => 'string', 'example' => 'CONSUME_SUCCESS', 'title' => ''], + 'SubTime' => ['description' => 'The timestamp when the consumption started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570851590511', 'title' => ''], + 'ReconsumeTimes' => ['description' => 'The delivery round of the current consumption attempt.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ClientHost' => ['description' => 'The client address of the consumer.', 'type' => 'string', 'example' => '30.5.**.**', 'title' => ''], + 'SubGroupName' => ['description' => 'The group ID to which the client belongs.', 'type' => 'string', 'example' => 'GID_test', 'title' => ''], + 'CostTime' => ['description' => 'The time consumed for the current consumption attempt. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '43', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"Status\\": \\"finish\\",\\n \\"MsgKey\\": \\"keyA\\",\\n \\"UpdateTime\\": 1570966857000,\\n \\"CreateTime\\": 1570966857000,\\n \\"UserId\\": \\"27296756265288****\\",\\n \\"Topic\\": \\"topic_a\\",\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E05791C117818B4AAC23B1BB0CE****\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\",\\n \\"TraceList\\": [\\n {\\n \\"Status\\": \\"SEND_SUCCESS\\",\\n \\"MsgKey\\": \\"ORDERID_100\\",\\n \\"PubTime\\": 1570850870478,\\n \\"Topic\\": \\"test\\",\\n \\"CostTime\\": 24,\\n \\"Tag\\": \\"TagA\\",\\n \\"MsgId\\": \\"0BC1F01800002A9F000000531246****\\\\t\\",\\n \\"PubGroupName\\": \\"GID_test\\",\\n \\"Cell\\": \\"RZ00A\\",\\n \\"BornHost\\": \\"30.5.**.**\\",\\n \\"SubList\\": [\\n {\\n \\"SubGroupName\\": \\"GID_test\\",\\n \\"SuccessCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"Cell\\": \\"RZ00A\\",\\n \\"ClientList\\": [\\n {\\n \\"Status\\": \\"CONSUME_SUCCESS\\",\\n \\"SubTime\\": 1570851590511,\\n \\"ReconsumeTimes\\": 1,\\n \\"ClientHost\\": \\"30.5.**.**\\",\\n \\"SubGroupName\\": \\"GID_test\\",\\n \\"CostTime\\": 43\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <Status>finish</Status>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <UserId>27296756265288****</UserId>\\n <CreateTime>1570966857000</CreateTime>\\n <MsgKey>keyA</MsgKey>\\n <QueryId>272967562652883649157096685****</QueryId>\\n <UpdateTime>1570966857000</UpdateTime>\\n <TraceList>\\n <CostTime>24</CostTime>\\n <Status>SEND_SUCCESS</Status>\\n <MsgKey>ORDERID_100</MsgKey>\\n <BornHost>30.5.**.**</BornHost>\\n <Tag>TagA</Tag>\\n <PubGroupName>GID_test</PubGroupName>\\n <PubTime>1570850870478</PubTime>\\n <Topic>test</Topic>\\n <Cell>RZ00A</Cell>\\n <MsgId>0BC1F01800002A9F000000531246****\\t</MsgId>\\n </TraceList>\\n <TraceList>\\n <SubList>\\n <FailCount>0</FailCount>\\n <SubGroupName>GID_test</SubGroupName>\\n <SuccessCount>1</SuccessCount>\\n <Cell>RZ00A</Cell>\\n </SubList>\\n <SubList>\\n <ClientList>\\n <CostTime>43</CostTime>\\n <Status>CONSUME_SUCCESS</Status>\\n <ClientHost>30.5.**.**</ClientHost>\\n <SubTime>1570851590511</SubTime>\\n <SubGroupName>GID_test</SubGroupName>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n </ClientList>\\n </SubList>\\n </TraceList>\\n <Topic>topic_a</Topic>\\n <MsgId>1E05791C117818B4AAC23B1BB0CE****</MsgId>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'GetMqSofamqTraceResult', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"Status\\": \\"finish\\",\\n \\"MsgKey\\": \\"keyA\\",\\n \\"UpdateTime\\": 1570966857000,\\n \\"CreateTime\\": 1570966857000,\\n \\"UserId\\": \\"27296756265288****\\",\\n \\"Topic\\": \\"topic_a\\",\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"MsgId\\": \\"1E05791C117818B4AAC23B1BB0CE****\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\",\\n \\"TraceList\\": [\\n {\\n \\"Status\\": \\"SEND_SUCCESS\\",\\n \\"MsgKey\\": \\"ORDERID_100\\",\\n \\"PubTime\\": 1570850870478,\\n \\"Topic\\": \\"test\\",\\n \\"CostTime\\": 24,\\n \\"Tag\\": \\"TagA\\",\\n \\"MsgId\\": \\"0BC1F01800002A9F000000531246****\\\\t\\",\\n \\"PubGroupName\\": \\"GID_test\\",\\n \\"Cell\\": \\"RZ00A\\",\\n \\"BornHost\\": \\"30.5.**.**\\",\\n \\"SubList\\": [\\n {\\n \\"SubGroupName\\": \\"GID_test\\",\\n \\"SuccessCount\\": 1,\\n \\"FailCount\\": 0,\\n \\"Cell\\": \\"RZ00A\\",\\n \\"ClientList\\": [\\n {\\n \\"Status\\": \\"CONSUME_SUCCESS\\",\\n \\"SubTime\\": 1570851590511,\\n \\"ReconsumeTimes\\": 1,\\n \\"ClientHost\\": \\"30.5.**.**\\",\\n \\"SubGroupName\\": \\"GID_test\\",\\n \\"CostTime\\": 43\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'View message trace query results', + 'summary' => 'Retrieves the details of a message trace query result by specifying the query task ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMqSofamqGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetMsConfigAttributes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3690,268 +2216,419 @@ 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '109214', + 'abilityTreeNodes' => ['FEATUREsofaNCKPTU'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => 'Auto-increment ID of the attribute', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'System field: environment instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'Result description', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'Result code', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'Attribute' => [ + 'description' => 'Attribute information', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'AttributeName' => ['description' => 'Attribute name', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Id' => ['description' => 'Attribute ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'Attribute description', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'docRequired' => false, - 'example' => 'GID_test_group_id ', - 'required' => false, - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Get Attribute Information', + 'summary' => 'Get the corresponding attribute information by attribute ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => 'The auto-increment ID of the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['description' => 'The system field: environment instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'Resource' => [ + 'description' => 'The resource information.', + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'drmdemo', 'title' => ''], + 'Region' => ['description' => 'The region to which the resource belongs.', 'type' => 'string', 'example' => 'Alipay', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'com.alipay.drmResource', 'title' => ''], + 'Id' => ['description' => 'The auto-increment ID of the resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The resource description.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + 'Attributes' => [ + 'description' => 'The information about all properties of the resource.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'AttributeName' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Id' => ['description' => 'The property ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The property description.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'docRequired' => false, - 'required' => false, - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve resource metadata', + 'summary' => 'Retrieves the metadata of a resource by resource ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => 'The auto-increment ID of the property. You can obtain the ID by calling the query property operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The property value to push.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'hello world', 'title' => ''], + ], + [ + 'name' => 'Hosts', + 'in' => 'formData', + 'schema' => ['description' => 'The list of machines for canary release push. Separate multiple IP addresses with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,127.0.0.2', 'title' => ''], + ], [ 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['description' => 'The operator.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'wang.li', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'PushResult' => [ + 'description' => 'The list of push results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the push was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Host' => ['description' => 'The destination host of the push.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - 'required' => true, - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Push property value by canary release', + 'summary' => 'Pushes a property value by IP-based canary release.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' The IP addresses specified for IP-based canary release push must be accessible for the push to succeed.', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:GrayPushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ListMqSofamqGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The Group ID to query. If this parameter is not specified, all Group IDs are queried.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'GID_test_group_id ', 'title' => ''], + ], + [ + 'name' => 'GroupType', + 'in' => 'formData', + 'schema' => ['description' => 'The group type. Default value: tcp, which indicates that the Group ID is applicable only to message sending and receiving over the TCP protocol.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'tcp', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID that corresponds to the Group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], + ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '20', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The collection of queried subscription relationships.', + 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Total' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'The group information.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'RetryPerm' => [ - 'format' => 'int64', - 'type' => 'integer', - ], - 'Cluster' => [ - 'description' => '', - 'example' => 'SINGLE', - 'type' => 'string', - ], - 'Remark' => [ - 'description' => '', - 'example' => 'test', - 'type' => 'string', - ], - 'InstanceId' => [ - 'description' => '', - 'example' => 'SOFAMQ_INSTANCE_000001', - 'type' => 'string', - ], - 'GmtModified' => [ - 'description' => '', - 'example' => '1570966857000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RetryWriteQueueNum' => [ - 'format' => 'int64', - 'type' => 'integer', - ], - 'DeleteMark' => [ - 'type' => 'string', - ], - 'GroupId' => [ - 'description' => 'Group ID', - 'example' => 'test_group_id', - 'type' => 'string', - ], - 'Version' => [ - 'format' => 'int64', - 'type' => 'integer', - ], - 'GmtCreate' => [ - 'description' => '', - 'example' => '1570966857000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RetryReadQueueNum' => [ - 'format' => 'int64', - 'type' => 'integer', - ], - 'Scope' => [ - 'type' => 'string', - ], - 'Operator' => [ - 'description' => '', - 'example' => 'alipay', - 'type' => 'string', - ], - 'GroupType' => [ - 'description' => '', - 'example' => 'tcp', - 'type' => 'string', - ], - 'ReadEnable' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], + 'RetryPerm' => ['description' => 'The retry permission.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'Cluster' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'SINGLE', 'title' => ''], + 'Remark' => ['description' => 'The remarks of the group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000', 'title' => ''], + 'RetryWriteQueueNum' => ['description' => 'The retry write queue permission.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DeleteMark' => ['description' => 'The deletion mark.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => 'test_group_id', 'title' => ''], + 'Version' => ['description' => 'The version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000', 'title' => ''], + 'RetryReadQueueNum' => ['description' => 'The number of retry read queues.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Scope' => ['description' => 'The scope.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'Operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => 'alipay', 'title' => ''], + 'GroupType' => ['description' => 'The group type. Default value: tcp, which indicates that the Group ID is applicable only to message sending and receiving over the TCP protocol.', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'ReadEnable' => ['description' => 'The read permission.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The database ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"RetryPerm\\": 6,\\n \\"Cluster\\": \\"SINGLE\\",\\n \\"Remark\\": \\"test\\",\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570966857000,\\n \\"RetryWriteQueueNum\\": 1,\\n \\"DeleteMark\\": \\"0\\",\\n \\"GroupId\\": \\"test_group_id\\",\\n \\"Version\\": 1,\\n \\"GmtCreate\\": 1570966857000,\\n \\"RetryReadQueueNum\\": 1,\\n \\"Scope\\": \\"*\\",\\n \\"Operator\\": \\"alipay\\",\\n \\"GroupType\\": \\"tcp\\",\\n \\"ReadEnable\\": true,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <Content>\\n <Operator>alipay</Operator>\\n <GmtCreate>1570966857000</GmtCreate>\\n <InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>\\n <GmtModified>1570966857000</GmtModified>\\n <ReadEnable>true</ReadEnable>\\n <Cluster>SINGLE</Cluster>\\n <Id>1</Id>\\n <GroupId>test_group_id</GroupId>\\n <Remark>test</Remark>\\n </Content>\\n <Total>100</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"RetryPerm\\": 6,\\n \\"Cluster\\": \\"SINGLE\\",\\n \\"Remark\\": \\"test\\",\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570966857000,\\n \\"RetryWriteQueueNum\\": 1,\\n \\"DeleteMark\\": \\"0\\",\\n \\"GroupId\\": \\"test_group_id\\",\\n \\"Version\\": 1,\\n \\"GmtCreate\\": 1570966857000,\\n \\"RetryReadQueueNum\\": 1,\\n \\"Scope\\": \\"*\\",\\n \\"Operator\\": \\"alipay\\",\\n \\"GroupType\\": \\"tcp\\",\\n \\"ReadEnable\\": true,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListMqSofamqGroup', + 'summary' => 'Queries the list of Group ID resources in a specified environment instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'ListMqSofamqGroup', - ], - 'ListMqSofamqTopic' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListMqSofamqTopic' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '000001', - ], + 'schema' => ['description' => 'The ID of the instance for which you want to query the topic list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000001', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TP_TEST', - ], + 'schema' => ['description' => 'The name of the topic to query. If this parameter is not specified, all topics are queried.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TP_TEST', 'title' => ''], ], ], 'responses' => [ @@ -3959,141 +2636,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The list of topic information returned by the query.', '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' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'The topic information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Cluster' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'single', - ], - 'Remark' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'desc', - ], - 'WriteQueueNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'ReadQueueNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '000001', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'MessageType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Perm' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TP_TEST', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570966857000', - ], - 'Operator' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'alipay', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'Cluster' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'single', 'title' => ''], + 'Remark' => ['description' => 'The remarks of the topic.', 'type' => 'string', 'example' => 'desc', 'title' => ''], + 'WriteQueueNum' => ['description' => 'The number of write partitions.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'ReadQueueNum' => ['description' => 'The number of read partitions.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '000001', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000', 'title' => ''], + 'MessageType' => ['description' => 'The message type. Valid values:'."\n" + ."\n" + .'0: normal message'."\n" + .'1: partitionally ordered message'."\n" + .'2: globally ordered message'."\n" + .'4: transactional message'."\n" + .'5: scheduled or delayed message.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Perm' => ['description' => 'The read/write mode of the topic. Valid values:'."\n" + ."\n" + .'6: both read and write'."\n" + .'4: write disabled'."\n" + .'2: read disabled.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'Topic' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'TP_TEST', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570966857000', 'title' => ''], + 'Operator' => ['description' => 'The creator.', 'type' => 'string', 'example' => 'alipay', 'title' => ''], + 'Id' => ['description' => 'The database ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"Cluster\\": \\"single\\",\\n \\"Remark\\": \\"desc\\",\\n \\"WriteQueueNum\\": 8,\\n \\"ReadQueueNum\\": 8,\\n \\"InstanceId\\": \\"000001\\",\\n \\"GmtModified\\": 1570966857000,\\n \\"MessageType\\": 0,\\n \\"Perm\\": 6,\\n \\"Topic\\": \\"TP_TEST\\",\\n \\"GmtCreate\\": 1570966857000,\\n \\"Operator\\": \\"alipay\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <Content>\\n <Operator>alipay</Operator>\\n <GmtCreate>1570966857000</GmtCreate>\\n <InstanceId>000001</InstanceId>\\n <Perm>6</Perm>\\n <GmtModified>1570966857000</GmtModified>\\n <Cluster>single</Cluster>\\n <ReadQueueNum/>\\n <Id>1</Id>\\n <Topic>TP_TEST</Topic>\\n <WriteQueueNum>8</WriteQueueNum>\\n <MessageType>0</MessageType>\\n <Remark>desc</Remark>\\n </Content>\\n <Total>100</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'ListMqSofamqTopic', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"Cluster\\": \\"single\\",\\n \\"Remark\\": \\"desc\\",\\n \\"WriteQueueNum\\": 8,\\n \\"ReadQueueNum\\": 8,\\n \\"InstanceId\\": \\"000001\\",\\n \\"GmtModified\\": 1570966857000,\\n \\"MessageType\\": 0,\\n \\"Perm\\": 6,\\n \\"Topic\\": \\"TP_TEST\\",\\n \\"GmtCreate\\": 1570966857000,\\n \\"Operator\\": \\"alipay\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query topic list', + 'summary' => 'Queries the list of topics for a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMqSofamqTrace' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListMqSofamqTrace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4101,55 +2728,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'QueryItem', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'TP_xx，0BA6EEBD700549C2FAAE076616860003，keyA', - ], + 'schema' => ['description' => 'The fuzzy query item. Valid values: Topic, Message ID, and Message Key.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TP_xx，0BA6EEBD700549C2FAAE076616860003，keyA', 'title' => ''], ], ], 'responses' => [ @@ -4157,445 +2756,239 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data returned by the query.', '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' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'The trace information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'QUERYING', - ], - 'MsgKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ORDERID_100', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TP_xxx', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SOFAMQ_INSTANCE_000001', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E05791C117818B4AAC23B1BB0CE****', - ], - 'QueryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '272967562652883649157096685****', - ], - 'Cell' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RZ001', - ], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'QUERYING', 'title' => ''], + 'MsgKey' => ['description' => 'The message key used for the message query.', 'type' => 'string', 'example' => 'ORDERID_100', 'title' => ''], + 'Topic' => ['description' => 'The topic of the query.', 'type' => 'string', 'example' => 'TP_xxx', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the task was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'MsgId' => ['description' => 'The message ID used for the message query.', 'type' => 'string', 'example' => '1E05791C117818B4AAC23B1BB0CE****', 'title' => ''], + 'QueryId' => ['description' => 'The query ID.', 'type' => 'string', 'example' => '272967562652883649157096685****', 'title' => ''], + 'Cell' => ['description' => 'The cell of the query.', 'type' => 'string', 'example' => 'RZ001', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"Status\\": \\"QUERYING\\",\\n \\"MsgKey\\": \\"ORDERID_100\\",\\n \\"Topic\\": \\"TP_xxx\\",\\n \\"GmtCreate\\": 1570701259403,\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570701259403,\\n \\"MsgId\\": \\"1E05791C117818B4AAC23B1BB0CE****\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\",\\n \\"Cell\\": \\"RZ001\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <Content>\\n <Status>QUERYING</Status>\\n <GmtCreate>1570701259403</GmtCreate>\\n <InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>\\n <MsgKey>ORDERID_100</MsgKey>\\n <QueryId>272967562652883649157096685****</QueryId>\\n <GmtModified>1570701259403</GmtModified>\\n <Topic>TP_xxx</Topic>\\n <Cell>RZ001</Cell>\\n <MsgId>1E05791C117818B4AAC23B1BB0CE****</MsgId>\\n </Content>\\n <Total>100</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'ListMqSofamqTrace', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"Status\\": \\"QUERYING\\",\\n \\"MsgKey\\": \\"ORDERID_100\\",\\n \\"Topic\\": \\"TP_xxx\\",\\n \\"GmtCreate\\": 1570701259403,\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570701259403,\\n \\"MsgId\\": \\"1E05791C117818B4AAC23B1BB0CE****\\",\\n \\"QueryId\\": \\"272967562652883649157096685****\\",\\n \\"Cell\\": \\"RZ001\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query message trace query task list', + 'summary' => 'Queries the list of message trace query tasks under a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMqSofamqWarn' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListMqSofamqWarn' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'GID_group', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Set when querying alarm rules for a specified group.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GID_group', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '20', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Number of entries displayed per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'test', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Set when querying alarm rules for a specified topic.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'Result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'Result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Collection of queried alarm rules.', + 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Total' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], + 'PageNum' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of entries displayed per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'Alarm rule information.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'WarnLevel' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Frequency' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Contacts' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Attribute' => [ - 'description' => '', - 'example' => '""', - 'type' => 'string', - ], - 'WarnType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'InstanceId' => [ - 'description' => '', - 'example' => 'SOFAMQ_INSTANCE_000001', - 'type' => 'string', - ], - 'GmtModified' => [ - 'description' => '', - 'example' => '1570701259403', - 'format' => 'int64', - 'type' => 'integer', - ], - 'GroupId' => [ - 'description' => '', - 'example' => 'GID_TEST', - 'type' => 'string', - ], - 'AlertTime' => [ - 'description' => '', - 'example' => '00:00-23:59', - 'type' => 'string', - ], - 'DelayTime' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'TP_TEST', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'description' => '', - 'example' => '1570701259403', - 'format' => 'int64', - 'type' => 'integer', - ], - 'WarnStatus' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'BlockTime' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Operator' => [ - 'description' => '', - 'example' => 'alipay', - 'type' => 'string', - ], - 'Threshold' => [ - 'description' => '', - 'example' => '3000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], + 'WarnLevel' => ['description' => 'Alarm level.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Frequency' => ['description' => 'Alarm frequency, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Contacts' => ['description' => 'Contact list.', 'type' => 'string', 'example' => '[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]', 'title' => ''], + 'Attribute' => ['description' => 'Attribute string.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'WarnType' => ['description' => 'Alarm type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], + 'GmtModified' => ['description' => 'Modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'GroupId' => ['description' => 'Consumer group ID.', 'type' => 'string', 'example' => 'GID_TEST', 'title' => ''], + 'AlertTime' => ['description' => 'Alarm time period.', 'type' => 'string', 'example' => '00:00-23:59', 'title' => ''], + 'DelayTime' => ['description' => 'Delay time, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Topic' => ['description' => 'Alarm topic.', 'type' => 'string', 'example' => 'TP_TEST', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'WarnStatus' => ['description' => 'Alarm status.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BlockTime' => ['description' => 'Message blocking time.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Operator' => ['description' => 'Operator.', 'type' => 'string', 'example' => 'alipay', 'title' => ''], + 'Threshold' => ['description' => 'Threshold.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''], + 'Id' => ['description' => 'Alarm ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"WarnLevel\\": 5,\\n \\"Frequency\\": 10,\\n \\"Contacts\\": \\"[[\\\\\\"DingTalk\\\\\\", \\\\\\"机器人令牌\\\\\\", \\\\\\"组名\\\\\\"], [\\\\\\"DingTalk\\\\\\", \\\\\\"机器人令牌2\\\\\\", \\\\\\"组名2\\\\\\"]]\\",\\n \\"Attribute\\": \\"\\\\\\"\\\\\\"\\",\\n \\"WarnType\\": 1,\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570701259403,\\n \\"GroupId\\": \\"GID_TEST\\",\\n \\"AlertTime\\": \\"00:00-23:59\\",\\n \\"DelayTime\\": 5,\\n \\"Topic\\": \\"TP_TEST\\",\\n \\"GmtCreate\\": 1570701259403,\\n \\"WarnStatus\\": 1,\\n \\"BlockTime\\": 10,\\n \\"Operator\\": \\"alipay\\",\\n \\"Threshold\\": 3000,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <Content>\\n <Operator>alipay</Operator>\\n <WarnType>1</WarnType>\\n <Attribute>\\"\\"</Attribute>\\n <InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>\\n <BlockTime>10</BlockTime>\\n <GmtModified>1570701259403</GmtModified>\\n <DelayTime>5</DelayTime>\\n <AlertTime>00:00-23:59</AlertTime>\\n <GroupId>GID_TEST</GroupId>\\n <WarnStatus>1</WarnStatus>\\n <GmtCreate>1570701259403</GmtCreate>\\n <WarnLevel>5</WarnLevel>\\n <Contacts>[[\\"DingTalk\\", \\"机器人令牌\\", \\"组名\\"], [\\"DingTalk\\", \\"机器人令牌2\\", \\"组名2\\"]]</Contacts>\\n <Frequency>10</Frequency>\\n <Id>1</Id>\\n <Topic>TP_TEST</Topic>\\n <Threshold>3000</Threshold>\\n </Content>\\n <Total>100</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Content\\": [\\n {\\n \\"WarnLevel\\": 5,\\n \\"Frequency\\": 10,\\n \\"Contacts\\": \\"[[\\\\\\"DingTalk\\\\\\", \\\\\\"机器人令牌\\\\\\", \\\\\\"组名\\\\\\"], [\\\\\\"DingTalk\\\\\\", \\\\\\"机器人令牌2\\\\\\", \\\\\\"组名2\\\\\\"]]\\",\\n \\"Attribute\\": \\"\\\\\\"\\\\\\"\\",\\n \\"WarnType\\": 1,\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570701259403,\\n \\"GroupId\\": \\"GID_TEST\\",\\n \\"AlertTime\\": \\"00:00-23:59\\",\\n \\"DelayTime\\": 5,\\n \\"Topic\\": \\"TP_TEST\\",\\n \\"GmtCreate\\": 1570701259403,\\n \\"WarnStatus\\": 1,\\n \\"BlockTime\\": 10,\\n \\"Operator\\": \\"alipay\\",\\n \\"Threshold\\": 3000,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query alarm records', + 'summary' => 'Obtain the list of alarm rules.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'ListMqSofamqWarnHistory' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListMqSofamqWarnHistory' => [ + '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' => 'Target cell', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ00A', 'title' => ''], ], [ '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', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE_XXX', - ], + 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE_XXX', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'TP_TEST', - ], + 'schema' => ['description' => 'Topic name', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TP_TEST', 'title' => ''], ], [ 'name' => 'WarnId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '4', - ], + 'schema' => ['description' => 'Alert rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '4', 'title' => ''], ], ], 'responses' => [ @@ -4603,117 +2996,213 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'Result description', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'Result code', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Collection of queried alert logs', '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' => 'Page number', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'Total number of entries', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'Alert log information', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'WarnId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GroupId' => [ - 'description' => 'Group ID', - 'type' => 'string', - 'example' => 'GID_TEST', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TP_TEST', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'WarnInfo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SOFAMQ_INSTANCE_000001', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701259403', - ], - 'Cell' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RZ00A', - ], + 'WarnId' => ['description' => 'Alert ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => 'GID_TEST', 'title' => ''], + 'Topic' => ['description' => 'Topic name', 'type' => 'string', 'example' => 'TP_TEST', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'WarnInfo' => ['description' => 'Alert information', 'type' => 'string', 'example' => '"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, "', 'title' => ''], + 'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], + 'GmtModified' => ['description' => 'Modification time', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'Cell' => ['description' => 'Cell name', 'type' => 'string', 'example' => 'RZ00A', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 10,\\n \\"Content\\": [\\n {\\n \\"WarnId\\": 1,\\n \\"GroupId\\": \\"GID_TEST\\",\\n \\"Topic\\": \\"TP_TEST\\",\\n \\"GmtCreate\\": 1570701259403,\\n \\"WarnInfo\\": \\"\\\\\\"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, \\\\\\"\\",\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570701259403,\\n \\"Cell\\": \\"RZ00A\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>20</PageSize>\\n <Content>\\n <WarnId/>\\n <GmtCreate/>\\n <InstanceId>SOFAMQ_INSTANCE_000001</InstanceId>\\n <GmtModified/>\\n <WarnInfo>\\"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, \\"</WarnInfo>\\n <Topic>TP_TEST</Topic>\\n <Cell>RZ00A</Cell>\\n <GroupId>GID_TEST</GroupId>\\n </Content>\\n <Total>10</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'ListMqSofamqWarnHistory', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 10,\\n \\"Content\\": [\\n {\\n \\"WarnId\\": 1,\\n \\"GroupId\\": \\"GID_TEST\\",\\n \\"Topic\\": \\"TP_TEST\\",\\n \\"GmtCreate\\": 1570701259403,\\n \\"WarnInfo\\": \\"\\\\\\"Alert: 消息积压: 609 大于阈值: 600, 消息延时: 23478710ms 大于阈值: 10ms, \\\\\\"\\",\\n \\"InstanceId\\": \\"SOFAMQ_INSTANCE_000001\\",\\n \\"GmtModified\\": 1570701259403,\\n \\"Cell\\": \\"RZ00A\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query Historical Alert Records', + 'summary' => 'Query historical alert records. By default, alert information within the last 30 days is retained.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarnHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], ], - '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, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ServerIpsRepeatList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResultCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'UnknowError.SystemError', 'errorMessage' => 'An unknown error occurred in the system.', 'description' => 'An unknown error occurred in the system. Please submit the work order after the refresh attempt is invalid.'], + ], + ], + 'title' => '', + 'summary' => '', + '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' => 'The auto-increment ID of the property.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Cells', + 'in' => 'formData', + 'schema' => ['description' => 'The list of cells to which the value is published, separated by commas. If this parameter is left empty, the value is pushed to all cells.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Cell1,Cell2', 'title' => ''], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'The property value to push.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '12', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['description' => 'The operator who performs the push.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'wang.li', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Push core property value', + 'summary' => 'Pushes a property value. After the push, all clients that subscribe to the corresponding property update the in-memory value within one second and invoke the setter method associated with the property.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:PushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'QueryMqSofamqConsumerAccumulate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4724,160 +3213,110 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '110354', - 'abilityTreeNodes' => [ - 'FEATUREsofaBCGLVK', - ], + 'abilityTreeNodes' => ['FEATUREsofaBCGLVK'], ], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'RZ01A', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The cell where the Group ID to query resides.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'Detail', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to query detailed information. Valid values:'."\n" + .'- true: Query detailed information.'."\n" + .'- false: Do not query detailed information. This is the default value.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'GID_test_consumer_id', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_consumer_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The consumption backlog of the specified consumer.', + 'type' => 'object', 'properties' => [ - 'ConsumeTps' => [ - 'description' => '', - 'example' => '10', - 'type' => 'string', - ], - 'TotalDiff' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], - 'LastTimestamp' => [ - 'description' => '', - 'example' => '1566231000000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DelayTime' => [ - 'description' => '', - 'example' => '10000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Online' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'ConsumeTps' => ['description' => 'The total TPS at which consumer instances under this Group ID receive messages. Unit: messages per second.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'TotalDiff' => ['description' => 'The number of accumulated messages for this topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'LastTimestamp' => ['description' => 'The production time of the most recently consumed message in this topic. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1566231000000', 'title' => ''], + 'DelayTime' => ['description' => 'The maximum consumption delay time for messages sent to this topic. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'Online' => ['description' => 'Indicates whether any consumer instances under this Group ID are online. The Group ID is considered online as long as at least one consumer instance is online. Valid values:'."\n" + ."\n" + .'- true: Online.'."\n" + .'- false: Not online.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DetailInTopicList' => [ - 'description' => '', + 'description' => 'The details of each topic.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'TotalDiff' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DelayTime' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'LastTimestamp' => [ - 'description' => '', - 'example' => '1570701259403', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'test-mq_topic', - 'type' => 'string', - ], + 'TotalDiff' => ['description' => 'The total number of accumulated messages for this topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DelayTime' => ['description' => 'The delay time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'LastTimestamp' => ['description' => 'The last update time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701259403', 'title' => ''], + 'Topic' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ConsumeTps\\": \\"10\\",\\n \\"TotalDiff\\": 100,\\n \\"LastTimestamp\\": 1566231000000,\\n \\"DelayTime\\": 10000,\\n \\"Online\\": true,\\n \\"DetailInTopicList\\": [\\n {\\n \\"TotalDiff\\": 0,\\n \\"DelayTime\\": 0,\\n \\"LastTimestamp\\": 1570701259403,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <ConsumeTps>10</ConsumeTps>\\n <LastTimestamp>1566231000000</LastTimestamp>\\n <TotalDiff>100</TotalDiff>\\n <DelayTime>10000</DelayTime>\\n <Online>true</Online>\\n <DetailInTopicList>\\n <LastTimestamp>1570701259403</LastTimestamp>\\n <TotalDiff>0</TotalDiff>\\n <DelayTime>0</DelayTime>\\n <Topic>test-mq_topic</Topic>\\n </DetailInTopicList>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ConsumeTps\\": \\"10\\",\\n \\"TotalDiff\\": 100,\\n \\"LastTimestamp\\": 1566231000000,\\n \\"DelayTime\\": 10000,\\n \\"Online\\": true,\\n \\"DetailInTopicList\\": [\\n {\\n \\"TotalDiff\\": 0,\\n \\"DelayTime\\": 0,\\n \\"LastTimestamp\\": 1570701259403,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query consumer message backlog', + 'summary' => 'Provides a rough assessment of message consumption and latency.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'QueryMqSofamqConsumerConnection' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T05:55:26.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerAccumulate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMqSofamqConsumerConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4885,42 +3324,22 @@ ], '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' => 'The cell in which the specified Group ID resides.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_consumer_id', - ], + 'schema' => ['description' => 'The Group ID to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_consumer_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The instance ID that corresponds to the Group ID. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], ], 'responses' => [ @@ -4928,81 +3347,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The connection information of the specified Group ID.', 'type' => 'object', 'properties' => [ 'ConnectionList' => [ - 'description' => '', + 'description' => 'The connection information of the specified Group ID.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RemoteIp' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275', - ], + 'RemoteIp' => ['description' => 'The host IP address or public IP address.', 'type' => 'string', 'example' => '42.120.74.**', 'title' => ''], + 'ClientAddr' => ['description' => 'The address and port of the consumer instance.', 'type' => 'string', 'example' => '30.5.121.**', 'title' => ''], + 'Version' => ['description' => 'The version of the consumer client.', 'type' => 'string', 'example' => 'V4_3_6_SNAPSHOT', 'title' => ''], + 'Language' => ['description' => 'The programming language of the consumer client.', 'type' => 'string', 'example' => 'JAVA', 'title' => ''], + 'ClientId' => ['description' => 'The ID of the consumer instance.', 'type' => 'string', 'example' => '30.5.121.**@25560#-1999745829#-1737591554#458773089270275', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ConnectionList\\": [\\n {\\n \\"RemoteIp\\": \\"42.120.74.**\\",\\n \\"ClientAddr\\": \\"30.5.121.**\\",\\n \\"Version\\": \\"V4_3_6_SNAPSHOT\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <ConnectionList>\\n <ClientAddr>30.5.121.**</ClientAddr>\\n <Language>JAVA</Language>\\n <RemoteIp>42.120.74.**</RemoteIp>\\n <Version>V4_3_6_SNAPSHOT</Version>\\n <ClientId>30.5.121.**@25560#-1999745829#-1737591554#458773089270275</ClientId>\\n </ConnectionList>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'QueryMqSofamqConsumerConnection', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"ConnectionList\\": [\\n {\\n \\"RemoteIp\\": \\"42.120.74.**\\",\\n \\"ClientAddr\\": \\"30.5.121.**\\",\\n \\"Version\\": \\"V4_3_6_SNAPSHOT\\",\\n \\"Language\\": \\"JAVA\\",\\n \\"ClientId\\": \\"30.5.121.**@25560#-1999745829#-1737591554#458773089270275\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Determine whether the consumer of a specified group ID is online', + 'summary' => 'Determines whether the consumer of a specified Group ID is online and retrieves the detailed list of client connections.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMqSofamqConsumerTimespan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMqSofamqConsumerTimespan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5013,54 +3422,28 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '110356', - 'abilityTreeNodes' => [ - 'FEATUREsofaBCGLVK', - ], + 'abilityTreeNodes' => ['FEATUREsofaBCGLVK'], ], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => 'The cell where the consumer group ID to query resides.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => 'The consumer group ID to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The instance ID that corresponds to the consumer group ID to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic', - ], + 'schema' => ['description' => 'The topic subscribed to by the consumer group ID to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic', 'title' => ''], ], ], 'responses' => [ @@ -5068,175 +3451,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', 'type' => 'object', 'properties' => [ - 'MaxTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026804', - ], - 'MinTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570701231122', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'ConsumeTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026400', - ], - 'Topic' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], + 'MaxTimestamp' => ['description' => 'The timestamp of the earliest message currently stored for the entire topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026804', 'title' => ''], + 'MinTimestamp' => ['description' => 'The timestamp of the latest message currently stored for the entire topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570701231122', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID that corresponds to the consumer group ID to query.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'ConsumeTimestamp' => ['description' => 'The most recent time when the current group consumed the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026400', 'title' => ''], + 'Topic' => ['description' => 'The name of the topic to query.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"MaxTimestamp\\": 1570761026804,\\n \\"MinTimestamp\\": 1570701231122,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"ConsumeTimestamp\\": 1570761026400,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <MinTimestamp>1570701231122</MinTimestamp>\\n <ConsumeTimestamp>1570761026400</ConsumeTimestamp>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <MaxTimestamp>1570761026804</MaxTimestamp>\\n <Topic>test-mq_topic</Topic>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'QueryMqSofamqConsumerTimespan', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"MaxTimestamp\\": 1570761026804,\\n \\"MinTimestamp\\": 1570701231122,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"ConsumeTimestamp\\": 1570761026400,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query consumer time span', + 'summary' => 'Queries the earliest and latest message timestamps currently stored on the server for a specified topic, as well as the most recent consumption time of the consumer.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMqSofamqDLQMessageByGroupId' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T12:07:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerTimespan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMqSofamqDLQMessageByGroupId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - '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' => 'The beginning timestamp of the query range.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570723200000', 'title' => ''], ], [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570809600000', - ], + 'schema' => ['description' => 'The ending timestamp of the query range.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570809600000', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => 'The consumer Group ID to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The instance ID corresponding to the messages to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'schema' => ['description' => 'The ID of the query task. This parameter is not required for the first query. For subsequent queries, this parameter is required. Obtain the value from the response of the previous query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0BC1310300002A9F000021E4D7A48346', 'title' => ''], ], ], 'responses' => [ @@ -5244,158 +3557,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The message content.', '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' => '', - 'type' => 'string', - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'TaskId' => ['description' => 'The query task ID returned when a query is first created. This ID is used for subsequent message retrieval.', 'type' => 'string', 'example' => '0BC1310300002A9F000021E4D7A48346', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'The detailed information of the messages.', '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' => '', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => 'The message size.', 'type' => 'integer', 'format' => 'int64', 'example' => '407', 'title' => ''], + 'ReconsumeTimes' => ['description' => 'The number of consumption retries for the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StoreTimestamp' => ['description' => 'The timestamp when the message was stored on the server.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708', 'title' => ''], + 'Topic' => ['description' => 'The topic of the message.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], + 'StoreHost' => ['description' => 'The server instance that stores the message.', 'type' => 'string', 'example' => '11.220.***.***:10911', 'title' => ''], + 'BornTimestamp' => ['description' => 'The timestamp when the message was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'Body' => ['description' => 'The message body.', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', 'title' => ''], + 'BodyCrc' => ['description' => 'The CRC checksum of the message body.', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295', 'title' => ''], + 'BornHost' => ['description' => 'The client instance that generated the message.', 'type' => 'string', 'example' => '42.120.**.**:64646', 'title' => ''], 'PropertyList' => [ - 'description' => '', + 'description' => 'The message property list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'The key name.', 'type' => 'string', 'example' => 'TAGS', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TaskId\\": \\"0BC1310300002A9F000021E4D7A48346\\",\\n \\"Content\\": [\\n {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <TaskId>0BC1310300002A9F000021E4D7A48346</TaskId>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <Content>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <StoreSize>407</StoreSize>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCrc>914112295</BodyCrc>\\n <Topic>test-mq_topic</Topic>\\n <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n </Content>\\n <Content>\\n <PropertyList>\\n <Value>TagA</Value>\\n <Name>TAGS</Name>\\n </PropertyList>\\n </Content>\\n <Total>100</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'QueryMqSofamqDLQMessageByGroupId', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TaskId\\": \\"0BC1310300002A9F000021E4D7A48346\\",\\n \\"Content\\": [\\n {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query dead-letter messages by group', + 'summary' => 'Queries all dead-letter messages within a specified Group ID during a specified time range by paging.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMqSofamqGroupSubDetail' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqDLQMessageByGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMqSofamqGroupSubDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5403,128 +3655,97 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => 'RZ01A', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The cell in which the Group ID to query resides.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'GID_test_group_id', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Group ID to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'SOFAMQ_INSTANCE_000001', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID corresponding to the Group ID to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAMQ_INSTANCE_000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', + 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'description' => 'Group ID', - 'example' => 'GID_test_group_id', - 'type' => 'string', - ], - 'MessageModel' => [ - 'description' => '', - 'example' => 'CLUSTERING', - 'type' => 'string', - ], - 'Online' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'GroupId' => ['description' => 'Group ID', 'type' => 'string', 'example' => 'GID_test_group_id', 'title' => ''], + 'MessageModel' => ['description' => 'The deployment model. Valid values:'."\n" + .'- BROADCASTING: broadcasting consumption mode.'."\n" + .'- CLUSTERING: clustering consumption mode.', 'type' => 'string', 'example' => 'CLUSTERING', 'title' => ''], + 'Online' => ['description' => 'Indicates whether the consumer is online.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SubscriptionDataList' => [ - 'description' => '', + 'description' => 'The subscription information list.', + 'type' => 'array', 'items' => [ + 'type' => 'object', 'properties' => [ - 'SubString' => [ - 'description' => '', - 'example' => '*', - 'type' => 'string', - ], - 'Online' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Topic' => [ - 'description' => '', - 'example' => 'test-mq_topic', - 'type' => 'string', - ], + 'SubString' => ['description' => 'The subscription matching string.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'Online' => ['description' => 'Indicates whether the consumer is online.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Topic' => ['description' => 'The topic name.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"GID_test_group_id\\",\\n \\"MessageModel\\": \\"CLUSTERING\\",\\n \\"Online\\": true,\\n \\"SubscriptionDataList\\": [\\n {\\n \\"SubString\\": \\"*\\",\\n \\"Online\\": true,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <MessageModel>CLUSTERING</MessageModel>\\n <SubscriptionDataList>\\n <SubString>*</SubString>\\n <Online>true</Online>\\n <Topic>test-mq_topic</Topic>\\n </SubscriptionDataList>\\n <Online>true</Online>\\n <GroupId>GID_test_group_id</GroupId>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"GID_test_group_id\\",\\n \\"MessageModel\\": \\"CLUSTERING\\",\\n \\"Online\\": true,\\n \\"SubscriptionDataList\\": [\\n {\\n \\"SubString\\": \\"*\\",\\n \\"Online\\": true,\\n \\"Topic\\": \\"test-mq_topic\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query subscription of a group', + 'summary' => 'Queries the subscription information of a group. If the consumer instances corresponding to the Group ID are not online, no data is returned.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'QueryMqSofamqMessageByKey' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqGroupSubDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMqSofamqMessageByKey' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5532,53 +3753,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' => 'The cell in which the message to query resides.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A ', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The ID of the instance to which the message belongs. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'messageKey1', - ], + 'schema' => ['description' => 'The Message Key of the message to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'messageKey1', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic ', - ], + 'schema' => ['description' => 'The topic of the message to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic ', 'title' => ''], ], ], 'responses' => [ @@ -5586,129 +3781,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The description of the result.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', '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' => '', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => 'The size of the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '407', 'title' => ''], + 'ReconsumeTimes' => ['description' => 'The number of retries for consuming the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StoreTimestamp' => ['description' => 'The timestamp when the message was stored on the server.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708', 'title' => ''], + 'Topic' => ['description' => 'The topic of the message.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], + 'StoreHost' => ['description' => 'The server instance that stores the message.', 'type' => 'string', 'example' => '11.220.***.***:10911', 'title' => ''], + 'BornTimestamp' => ['description' => 'The timestamp when the message was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'Body' => ['description' => 'The message body.', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', 'title' => ''], + 'BodyCrc' => ['description' => 'The CRC checksum of the message body.', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295', 'title' => ''], + 'BornHost' => ['description' => 'The client instance that generated the message.', 'type' => 'string', 'example' => '42.120.**.**:64646', 'title' => ''], 'PropertyList' => [ - 'description' => '', + 'description' => 'The list of message properties.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'The key name.', 'type' => 'string', 'example' => 'TAGS', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": [\\n {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <StoreSize>407</StoreSize>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCrc>914112295</BodyCrc>\\n <Topic>test-mq_topic</Topic>\\n <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n</Data>\\n<Data>\\n <PropertyList>\\n <Value>TagA</Value>\\n <Name>TAGS</Name>\\n </PropertyList>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'QueryMqSofamqMessageByKey', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": [\\n {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query messages by message key', + 'summary' => 'Performs a fuzzy query. Because the Message Key of a business may not be unique, the query result may contain multiple messages.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMqSofamqMessageByTopic' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMqSofamqMessageByTopic' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5716,101 +3867,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' => 'The start timestamp of the query range.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570723200000', 'title' => ''], ], [ 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], + 'schema' => ['description' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1570809600000', - ], + 'schema' => ['description' => 'The end timestamp of the query range.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1570809600000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => 'The ID of the instance to which the messages belong. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'schema' => ['description' => 'The ID of the query task. This parameter is not required for the first query. For subsequent queries, this parameter is required. Obtain the value from the response of the previous query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0BC1310300002A9F000021E4D7A48346', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-mq_topic ', - ], + 'schema' => ['description' => 'The topic name of the messages to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq_topic ', 'title' => ''], ], ], 'responses' => [ @@ -5818,209 +3915,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The paged query result for messages.', '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' => '', - 'type' => 'string', - 'example' => '0BC1310300002A9F000021E4D7A48346', - ], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'TaskId' => ['description' => 'The query task ID returned when a query is first created. This ID is used for subsequent message retrieval.', 'type' => 'string', 'example' => '0BC1310300002A9F000021E4D7A48346', 'title' => ''], 'Content' => [ - 'description' => '', + 'description' => 'The details of the messages.', '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' => '', - 'type' => 'string', - 'example' => 'test-mq_topic', - ], - 'StoreHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11.220.***.***:10911', - ], - 'BornTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1570761026630', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], - 'Body' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', - ], - 'MsgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', - ], - 'BodyCrc' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914112295', - ], - 'BornHost' => [ - 'description' => '', - 'type' => 'string', - 'example' => '42.120.**.**:64646', - ], + 'StoreSize' => ['description' => 'The size of the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '407', 'title' => ''], + 'ReconsumeTimes' => ['description' => 'The number of times the message has been retried for consumption.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StoreTimestamp' => ['description' => 'The timestamp when the message was stored on the server.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026708', 'title' => ''], + 'Topic' => ['description' => 'The topic of the message.', 'type' => 'string', 'example' => 'test-mq_topic', 'title' => ''], + 'StoreHost' => ['description' => 'The server instance that stores the message.', 'type' => 'string', 'example' => '11.220.***.***:10911', 'title' => ''], + 'BornTimestamp' => ['description' => 'The timestamp when the message was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1570761026630', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], + 'Body' => ['description' => 'The message body.', 'type' => 'string', 'example' => 'SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv', 'title' => ''], + 'MsgId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C8460BA2', 'title' => ''], + 'BodyCrc' => ['description' => 'The CRC checksum of the message body.', 'type' => 'integer', 'format' => 'int64', 'example' => '914112295', 'title' => ''], + 'BornHost' => ['description' => 'The client instance that generated the message.', 'type' => 'string', 'example' => '42.120.**.**:64646', 'title' => ''], 'PropertyList' => [ - 'description' => '', + 'description' => 'The list of message properties.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TAGS', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TagA', - ], + 'Name' => ['description' => 'The key name.', 'type' => 'string', 'example' => 'TAGS', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TaskId\\": \\"0BC1310300002A9F000021E4D7A48346\\",\\n \\"Content\\": [\\n {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>\\n<Data>\\n <TaskId>0BC1310300002A9F000021E4D7A48346</TaskId>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <Content>\\n <BornTimestamp>1570761026630</BornTimestamp>\\n <InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>\\n <StoreSize>407</StoreSize>\\n <BornHost>42.120.**.**:64646</BornHost>\\n <BodyCrc>914112295</BodyCrc>\\n <Topic>test-mq_topic</Topic>\\n <Body>SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv</Body>\\n <ReconsumeTimes>1</ReconsumeTimes>\\n <MsgId>1E0578FE110F18B4AAC235C0C8460BA2</MsgId>\\n <StoreHost>11.220.***.***:10911</StoreHost>\\n <StoreTimestamp>1570761026708</StoreTimestamp>\\n </Content>\\n <Content>\\n <PropertyList>\\n <Value>TagA</Value>\\n <Name>TAGS</Name>\\n </PropertyList>\\n </Content>\\n <Total>100</Total>\\n</Data>\\n<ResultMessage>OK</ResultMessage>\\n<ResultCode>OK</ResultCode>","errorExample":""}]', - 'title' => 'QueryMqSofamqMessageByTopic', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TaskId\\": \\"0BC1310300002A9F000021E4D7A48346\\",\\n \\"Content\\": [\\n {\\n \\"StoreSize\\": 407,\\n \\"ReconsumeTimes\\": 1,\\n \\"StoreTimestamp\\": 1570761026708,\\n \\"Topic\\": \\"test-mq_topic\\",\\n \\"StoreHost\\": \\"11.220.***.***:10911\\",\\n \\"BornTimestamp\\": 1570761026630,\\n \\"InstanceId\\": \\"MQ_INST_111111111111_DOxxxxxx\\",\\n \\"Body\\": \\"SGVsbG8gTVEg5raT7oWf5p6D5ai05ayt55iv\\",\\n \\"MsgId\\": \\"1E0578FE110F18B4AAC235C0C8460BA2\\",\\n \\"BodyCrc\\": 914112295,\\n \\"BornHost\\": \\"42.120.**.**:64646\\",\\n \\"PropertyList\\": [\\n {\\n \\"Name\\": \\"TAGS\\",\\n \\"Value\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query topic messages', + 'summary' => 'Queries all messages within a specified topic during a specified time range by paging. You can pass in the topic name and time range for the query.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResendMqSofamqDLQMessageBatch' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'demo-app', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'AttributeName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id', - ], + 'schema' => ['description' => 'The property name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'age', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - ], + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ - 'name' => 'MsgIds', + 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******', - ], + 'schema' => ['description' => 'The domain to which the resource belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alipay', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The resource ID, similar to a file name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alipay.test', 'title' => ''], ], ], 'responses' => [ @@ -6028,97 +4045,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'Attribute' => [ + 'description' => 'The property information.', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'AttributeName' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Id' => ['description' => 'The property ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The property description.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'ResendMqSofamqDLQMessageBatch', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve property details', + 'summary' => 'Retrieves detailed property information, including the property ID, based on the domain, application name, resource ID, and property name. Other API operations depend on this operation to obtain the property ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResendMqSofamqDLQMessageById' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'QueryMsConfigClientValues' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Cell', + 'name' => 'AttributeId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RZ01A', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'GID_test_group_id ', - ], + 'schema' => ['description' => 'The auto-increment ID of the property. You can obtain the ID by calling the query property operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => 'The environment instance ID, which is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ - 'name' => 'MsgId', + 'name' => 'Ips', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1E0578FE110F18B4AAC235C0C****** ', - ], + 'schema' => ['description' => 'The list of IP addresses to query, separated by commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1,127.0.0.2', 'title' => ''], ], ], 'responses' => [ @@ -6126,214 +4126,175 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'Clients' => [ + 'description' => 'The client information, including the memory value.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Ip' => ['description' => 'The client IP address.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'Data' => ['description' => 'The value in the client memory.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the query is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'ResendMqSofamqDLQMessageById', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query client memory value', + 'summary' => 'Queries the memory value of a specified client by property ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResetMqSofamqConsumerOffset' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClientValues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'docRequired' => false, - 'example' => 'RZ01A', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'GroupId', + 'name' => 'AttributeId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'GID_test_consumer_id', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The auto-increment ID of the property. You can obtain the ID by querying the property.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'ResetTimestamp', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => '1568033253', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The environment instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ - 'name' => 'Topic', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'test-mq-topic ', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of clients.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Clients' => [ + 'description' => 'The client information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PushData' => ['description' => 'The pushed value.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Ip' => ['description' => 'The IP address of the client.', 'type' => 'string', 'example' => '127.0.0.1', 'title' => ''], + 'Data' => ['description' => 'The value stored in the client memory.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Cell' => ['description' => 'The cell to which the client belongs.', 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":""}]', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query information about all clients subscribed to a property', + 'summary' => 'Queries the information about all clients that subscribe to a property. When a dynamic configuration client starts, it establishes a persistent connection with the server and reports its associated property information. You can use this persistent connection to query the information about all clients that subscribe to the property.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'title' => 'ResetMqSofamqConsumerOffset', - ], - 'CreateMqSofamqTopic' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '000001', - ], - ], - [ - 'name' => 'MessageType', + 'name' => 'AttributeId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The auto-increment ID of the property. You can obtain the ID by calling the query property operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Remark', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '', - ], - ], - [ - 'name' => 'Topic', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], ], 'responses' => [ @@ -6341,84 +4302,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'QueryResult' => [ + 'description' => 'The query result of pushed values. Each item in the array represents a specific cell. DEFAULT_ZONE indicates all cells.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The pushed value.', 'type' => 'string', 'example' => 'some push data', 'title' => ''], + 'Cell' => ['description' => 'The target cell for the push.', 'type' => 'string', 'example' => 'cell1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'CreateMqSofamqTopic', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the last pushed value of a property', + 'summary' => 'Queries the last pushed value of a property by property ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMqSofamqTopicRemark' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:12.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'foo', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MQ_INST_111111111111_DOxxxxxx ', - ], + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ - 'name' => 'Remark', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The keyword for fuzzy matching by resource ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'com.alipay.drmResource', 'title' => ''], ], [ - 'name' => 'Topic', + 'name' => 'PageNum', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The page number for pagination.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -6426,1159 +4397,729 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', + 'PageNum' => ['description' => 'The page number for pagination.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of results that match the fuzzy match criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Resources' => [ + 'description' => 'The fuzzy match results for resources.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'drmdemo', 'title' => ''], + 'Region' => ['description' => 'The region to which the resource belongs.', 'type' => 'string', 'example' => 'Alipay', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'com.alipay.drmResource', 'title' => ''], + 'Id' => ['description' => 'The auto-increment ID of the resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The resource description.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + 'Attributes' => [ + 'description' => 'The list of attributes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'abcdEFGH1234', 'title' => ''], + 'AttributeName' => ['description' => 'The attribute name.', 'type' => 'string', 'example' => 'switch', 'title' => ''], + 'Id' => ['description' => 'The attribute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Desc' => ['description' => 'The attribute description.', 'type' => 'string', 'example' => '活动开关', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UpdateMqSofamqTopicRemark', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query resource metadata', + 'summary' => 'Queries resource metadata by fuzzy matching an application name or resource ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCasComputers' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1636308360000', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'End', + 'in' => 'formData', + 'schema' => ['description' => 'The end time of the query.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1632278280000', 'title' => ''], + ], + [ + 'name' => 'Plugin', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The plug-in type.', + 'enumValueTitles' => ['SEC' => 'SEC', 'STACK' => 'STACK', 'MM' => 'MM', 'SPM' => 'SPM', 'SM' => 'SM'], 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'opscenter', + 'required' => true, + 'docRequired' => true, + 'example' => 'SM', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'DsId', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the monitoring metrics.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2643', 'title' => ''], + ], + [ + 'name' => 'ContentType', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The data type of the metric.', + 'enumValueTitles' => ['SPM' => 'SPM', 'KEYSET' => 'KEYSET', 'SINGLE_KEY_STAT' => 'SINGLE_KEY_STAT', 'INDEXABLE_MULTI_KEY_STAT' => 'INDEXABLE_MULTI_KEY_STAT'], + 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => '100', + 'example' => 'INDEXABLE_MULTI_KEY_STAT', + 'title' => '', ], ], [ - 'name' => 'Workspace', + 'name' => 'WorkspaceName', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod', 'title' => ''], + ], + [ + 'name' => 'PeriodType', 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FieldsRepeatList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'shfinpre', + 'description' => 'The metric dimension filter conditions. You can leave this parameter empty in most cases.', + 'type' => 'array', + 'items' => ['description' => 'The metric dimension filter conditions. You can leave this parameter empty in most cases.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AppServiceIdsRepeatList', + 'name' => 'Where', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The additional filter conditions.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The filter condition object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The filter key.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''], + 'Value' => ['description' => 'The filter value.', 'type' => 'string', 'required' => false, 'example' => 'monitorprod', 'title' => ''], + ], 'required' => false, - 'example' => '2144098938', + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The monitoring metrics data.', 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'RequestId' => [ - 'description' => '', - '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' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'ResultCode' => ['description' => 'The return code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '38D23571-2FDD-5A3B-AF04-15A30B96D11B', 'title' => ''], + 'Result' => ['description' => 'The returned result.', '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}}}}}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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"}]', - ], - 'AddMsConfigAttributes' => [ - 'methods' => [ - 'post', - 'get', + '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' => 'Query monitoring metric data', + 'summary' => 'Queries monitoring metrics timing data based on conditional query filters such as metric ID.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'The workspace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'Desc', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'AlarmLevel', + 'in' => 'formData', + 'schema' => ['description' => 'The alert level.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The trigger status.', + 'enumValueTitles' => [2 => 'alerting.', 4 => 'silenced.', 'recovered.'], 'type' => 'integer', 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100', + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], - 'Attribute' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abcdEFGH1234', - ], - 'AttributeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'switch', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Desc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], + [ + 'name' => 'AlarmTargetType', + 'in' => 'formData', + 'schema' => ['description' => 'The alerting object type.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], - ], - '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' => 'AddMsConfigAttributes', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddMsConfigResources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword used to query by alert content.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'foo', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'Attributes', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => '[ { "attribute_name":"attName", "desc":"some attribute comment" }, ... ]', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'Desc', + 'name' => 'AlarmRuleId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'AlarmStackInfoJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'abcdEFGH1234', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Filters by application stack in JSON format. The following fields are included:'."\n" + ."\n" + .'datasource_type STRING No ["CUSTOM","STACK","TABLE] '."\n" + .'Specifies whether the data source is application monitoring or custom monitoring.'."\n" + ."\n" + .'datasource STRING No MM@@2000464 '."\n" + .'The data source.'."\n" + ."\n" + .'alarm_target_type STRING No ["APP","HOST"] '."\n" + .'The application type.'."\n" + ."\n" + .'alarm_target_identify STRING No RMS-monitorprod '."\n" + .'The application name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Region', + 'name' => 'AlarmRuleUuid', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'Alipay', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The UUID of the alert rule.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ResourceId', + 'name' => 'AlarmTargetKeyword', 'in' => 'formData', + 'schema' => ['description' => 'The keyword used to search by alert target.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AlarmStatusRepeatList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'com.alipay.test.resource', - 'required' => true, - 'type' => 'string', + 'description' => 'The alert status.', + 'type' => 'array', + 'items' => ['description' => 'The alert status.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - 'type' => 'string', - ], - 'Resource' => [ - 'description' => '', - 'properties' => [ - 'AppName' => [ - 'description' => '', - 'example' => 'drmdemo', - 'type' => 'string', - ], - 'Region' => [ - 'description' => '', - 'example' => 'Alipay', - 'type' => 'string', - ], - 'InstanceId' => [ - 'description' => '', - 'example' => 'abcdEFGH1234', - 'type' => 'string', - ], - 'ResourceId' => [ - 'description' => '', - 'example' => 'com.alipay.drmResource', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Desc' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Attributes' => [ - 'description' => '', - 'items' => [ - 'properties' => [ - 'InstanceId' => [ - 'description' => '', - 'example' => 'abcdEFGH1234', - 'type' => 'string', - ], - 'AttributeName' => [ - 'description' => '', - 'example' => 'switch', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Desc' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'title' => '', 'example' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'UnifiedAlarmEventList' => [ + 'description' => 'The alert event details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert event details.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The trigger status.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmTargetType' => ['description' => 'The alerting object type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmStartTime' => ['description' => 'The time when the alert was generated.', 'type' => 'string', 'title' => '', 'example' => ''], + 'SilenceRemainTime' => ['description' => 'The remaining silence time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'DataSourceName' => ['description' => 'The data source name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmType' => ['description' => 'The alerting type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmRecoverTime' => ['description' => 'The time when the alert was recovered.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmRuleId' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmHistoryId' => ['description' => 'The alert history ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmContent' => ['description' => 'The alert content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmUrl' => ['description' => 'The URL of the alert data source.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmUrlWithDomain' => ['description' => 'The absolute path of the web page, including the domain name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmTargetDeleted' => ['description' => 'Indicates whether the target object is deleted.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'AlarmLevel' => ['description' => 'The alert level.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmEventId' => ['description' => 'The alert event ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmTarget' => ['description' => 'The alert target.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmHistoryList' => [ + 'description' => 'The list of alert history details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert history details.', + 'type' => 'object', + 'properties' => [ + 'AlarmTargetType' => ['description' => 'The alerting object type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Status' => ['description' => 'The trigger status.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'DataSourceName' => ['description' => 'The data source name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmType' => ['description' => 'The alerting type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EventId' => ['description' => 'The alert event ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'WorkspaceId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'UniqueIdentity' => ['description' => 'The unique identifier of the alert rule.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmTime' => ['description' => 'The alert time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmRuleId' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmDetail' => ['description' => 'The alert details.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmUrl' => ['description' => 'The URL of the alert data source.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmContent' => ['description' => 'The alert content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmUrlWithDomain' => ['description' => 'The absolute path of the web page, including the domain name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmTargetDeleted' => ['description' => 'Indicates whether the target object is deleted.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'AlarmLevel' => ['description' => 'The alert level.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmTarget' => ['description' => 'The alert target.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmRuleName' => ['description' => 'The alert rule name.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'array', ], + 'title' => '', + 'example' => '', ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":""}]', - 'extraInfo' => ' ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'title' => 'AddMsConfigResources', - ], - 'UpdateRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', + '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\\": false,\\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\\": false,\\n \\"AlarmLevel\\": 0,\\n \\"Id\\": 0,\\n \\"TenantId\\": 0,\\n \\"AlarmTarget\\": \\"\\",\\n \\"AlarmRuleName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query alert event history', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'summary' => '', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'Workspace name ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SOFAStack杭州金区-生产', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Start', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TAGS', - ], + 'schema' => ['description' => 'Query start time, in Unix timestamp format, in milliseconds. '."\n" + ."\n" + .'> The query start time must fall within the SQL Explorer storage duration of the database instance and cannot be earlier than 90 days before the current time. '."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1668911820000', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'End', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CUSTOM', - ], + 'schema' => ['description' => 'The end date of the query data, in Unix timestamp format, in milliseconds.'."\n" + ."\n" + .'> The query end time must be later than the query start time. The latest data you can query is up to 00:00 (midnight) of the current day.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1662516900000', 'title' => ''], ], [ - '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' => 'Current page ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'AlarmNodata', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Pagination parameter, page size ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'AlarmTargetType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2', - ], + 'schema' => ['description' => 'Alert object type ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'APP', 'title' => ''], ], [ - 'name' => 'Emergency', + 'name' => 'AlarmTarget', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Alert object ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'PlanetKms', 'title' => ''], ], [ - 'name' => 'EmergencyUrl', + 'name' => 'AlarmLevel', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Alert level ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PendingHit', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Alert status ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RecoveredHit', + 'name' => 'AlarmStackInfoJsonStr', 'in' => 'formData', + 'schema' => ['description' => 'A JSON-formatted string for filtering alert history by application. It contains the following fields:'."\n" + ."\n" + .'datasource_type STRING No ["CUSTOM","STACK","TABLE"] '."\n" + .'Indicates whether it is application monitoring or custom monitoring.'."\n" + ."\n" + .'datasource STRING No MM@@2000464 '."\n" + .'Data source'."\n" + ."\n" + .'alarm_target_type STRING No ["APP","HOST"] '."\n" + .'Application type'."\n" + ."\n" + .'alarm_target_identify STRING No RMS-monitorprod '."\n" + .'Application name', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\"DatasourceType\\":\\"STACK\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-twc-universal\\"}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => ['description' => 'Current page', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'CB2B427A-E370-5599-8872-A249F8EFD859', 'title' => ''], + 'ResultMessage' => ['description' => 'Result description', 'type' => 'string', 'example' => 'workspace not found with name TWCProd, tenant_id 0008528286', 'title' => ''], + 'ResultCode' => ['description' => 'Result code', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageSize' => ['description' => 'Pagination parameter, page size', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of entries', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'AlarmHistories' => [ + 'description' => 'List of alert history objects', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert history details', + 'type' => 'object', + 'properties' => [ + 'AlarmTargetType' => ['description' => 'Alert Object Type', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'Status' => ['description' => 'alert status', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DataSourceName' => ['description' => 'Datasource Name', 'type' => 'string', 'example' => 'ant_intel_hz', 'title' => ''], + 'AlarmType' => ['description' => 'Alarm Metric', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'GmtModified' => ['description' => 'Updated At', 'type' => 'string', 'example' => '2020-04-02 21:53:24', 'title' => ''], + 'EventId' => ['description' => 'Alert event ID ', 'type' => 'string', 'example' => '355402_1670998540000_598877597', 'title' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'UniqueIdentity' => ['description' => 'Unique identifier of the alert rule ', 'type' => 'string', 'example' => '174851af-6c56-4d8b-8cc7-9f998e752f09', 'title' => ''], + 'AlarmTime' => ['description' => 'Alert Time', 'type' => 'integer', 'format' => 'int64', 'example' => '1671088115000', 'title' => ''], + 'AlarmRuleId' => ['description' => 'Alert rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '860', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation Time', 'type' => 'string', 'example' => '2020-04-02 21:53:24', 'title' => ''], + 'AlarmDetail' => ['description' => 'Alert details', '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}]}]', 'title' => ''], + 'AlarmUrl' => ['description' => 'Hyperlink URL for the alert data source', 'type' => 'string', 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', 'title' => ''], + 'AlarmContent' => ['description' => 'Alert content ', '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', 'title' => ''], + 'AlarmUrlWithDomain' => ['description' => 'Absolute path of the web page, including the domain name', 'type' => 'string', 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', 'title' => ''], + 'AlarmTargetDeleted' => ['description' => 'Indicates whether the target object is deleted', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AlarmLevel' => ['description' => 'Alert level', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Id' => ['description' => 'Property ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '3376', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AlarmTarget' => ['description' => 'Alert object', 'type' => 'string', 'example' => 'sibei_1229_1', 'title' => ''], + 'AlarmRuleName' => ['description' => 'Alert rule name ', 'type' => 'string', 'example' => 'bvtcase测试', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', + 'title' => '', + 'example' => '', ], ], + ], + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'title' => '', + 'summary' => '', + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'QueryRMSUnifiedAlarmNotifyHistory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Step', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Sending status.', + 'enumValueTitles' => ['Failed', 'Successful'], 'type' => 'integer', 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '5', + 'required' => false, + 'docRequired' => false, + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'SilenceTime', + 'name' => 'Channel', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '900', - ], + 'schema' => ['description' => 'Notification channel.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'DD_WEBHOOK', 'title' => ''], ], [ - 'name' => 'NotifyFiring', + 'name' => 'Subscriber', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Subscriber ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NotifyRecovered', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Current page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NotifyNodata', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'NotifyTimeFilterJsonStr', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Workspace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acgatewayprod', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'EventId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Firing', - ], + 'schema' => ['description' => 'Event ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '355400_1670410905000_598877597', 'title' => ''], ], [ - 'name' => 'SuspendedStartTime', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1660730580000', 'title' => ''], ], [ - 'name' => 'SuspendedEndTime', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'End time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1668160800150', 'title' => ''], ], [ - 'name' => 'SuspendedReason', + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'Query alarm content.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'asd', 'title' => ''], + ], + [ + 'name' => 'AlarmRuleId', + 'in' => 'formData', + 'schema' => ['description' => 'Alarm rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '22', 'title' => ''], + ], + [ + 'name' => 'AlarmStatus', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Alarm status.', + 'enumValueTitles' => [2 => 'Alerting', 4 => 'Silenced', 'Recovered'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, 'docRequired' => false, + 'example' => '2', + 'title' => '', ], ], [ - 'name' => 'WorkspaceName', + 'name' => 'AlarmStackInfoJsonStr', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => 'JSON format for filtering alarm history by application. Contains the following fields:'."\n" + ."\n" + .'datasource_type STRING No ["CUSTOM","STACK","TABLE"] '."\n" + .'Whether it is application monitoring or custom monitoring.'."\n" + ."\n" + .'datasource STRING No MM@@2000464 '."\n" + .'Data source.'."\n" + ."\n" + .'alarm_target_type STRING No ["APP","HOST"] '."\n" + .'Application type.'."\n" + ."\n" + .'alarm_target_identify STRING No RMS-monitorprod '."\n" + .'Application name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{\\"DatasourceType\\":\\"CUSTOM\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-acrbasis\\"，\\"Datasource\\":\\"SPM@@15984\\"}', 'title' => ''], ], [ - 'name' => 'ChannelsRepeatList', + 'name' => 'DashboardQueryParamJsonStr', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Dashboard alarm query parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'NotifyTarget', + 'name' => 'AlarmSubscribers', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'Filter by notification subscriber.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Notification subscriber.', 'type' => 'object', 'properties' => [ - 'SubscriberSource' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'LOCAL', - ], - 'SubscriberType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'USER_GROUP', - ], - 'Subscriber' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'SubscriberUuid' => [ - 'type' => 'string', - 'required' => true, - 'example' => '400', - ], - 'SubscriberName' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'SubscriberSource' => ['description' => 'Subscriber source.', 'type' => 'string', 'required' => true, 'example' => 'LOCAL', 'title' => ''], + 'SubscriberType' => ['description' => 'Subscriber type.', 'type' => 'string', 'required' => true, 'example' => 'USER_GROUP', 'title' => ''], + 'Subscriber' => ['description' => 'Subscriber.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'SubscriberUuid' => ['description' => 'Subscriber UUID.', 'type' => 'string', 'required' => true, 'example' => '839f5cf92ab3435385ef3949c001a7a8', 'title' => ''], + 'SubscriberName' => ['description' => 'Name of the alarm target.', 'type' => 'string', 'required' => true, 'example' => 'mike', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -7587,295 +5128,347 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'type' => 'string', - ], - 'ResultCode' => [ - 'type' => 'string', + 'CurrentPage' => ['description' => 'Current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B4C10721-BD3E-5F45-AF3C-880715462315', 'title' => ''], + 'ResultMessage' => ['description' => 'Result description.', 'type' => 'string', 'example' => 'Rpc error', 'title' => ''], + 'ResultCode' => ['description' => 'Result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '84', 'title' => ''], + 'AlarmNotifyHistories' => [ + 'description' => 'Alarm notification history.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alarm notification history.', + 'type' => 'object', + 'properties' => [ + 'AlarmSilenceTime' => ['description' => 'Alarm silence period.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Status' => ['description' => 'Notification status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ErrorMessage' => ['description' => 'Describes the reason for message sending failure.', 'type' => 'string', 'example' => 'Specified private IP address is duplicated.', 'title' => ''], + 'AlarmType' => ['description' => 'Alarm type.', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'GmtModified' => ['description' => 'Modified time.', 'type' => 'string', 'example' => '2020-03-18 21:47:32', 'title' => ''], + 'NotifyContent' => ['description' => 'Message content.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AlarmRuleId' => ['description' => 'Alarm rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5839', 'title' => ''], + 'Subscriber' => ['description' => 'Subscriber.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'Channel' => ['description' => 'Notification channel.', 'type' => 'string', 'example' => 'DD_WEBHOOK', 'title' => ''], + 'AlarmTargetDeleted' => ['description' => 'Whether the target object has been deleted.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'AlarmLevel' => ['description' => 'Alarm level.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AlarmEventId' => ['description' => 'Alarm event ID.', 'type' => 'string', 'example' => '356454_1670377620000_1650847553', 'title' => ''], + 'AlarmRuleName' => ['description' => 'Alarm rule name.', 'type' => 'string', 'example' => 'bvtcase测试', 'title' => ''], + 'AlarmTargetType' => ['description' => 'Alarm target type.', 'type' => 'string', 'example' => 'APP', 'title' => ''], + 'SubscriberType' => ['description' => 'Type of subscriber.', 'type' => 'string', 'example' => 'USER_GROUP', 'title' => ''], + 'AlarmStatus' => ['description' => 'Alarm status.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'DataSourceName' => ['description' => 'Data source name.', 'type' => 'string', 'example' => '交易成功量', 'title' => ''], + 'AlarmRuleUuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SubscriberSource' => ['description' => 'Subscriber source.', 'type' => 'string', 'example' => 'LOCAL', 'title' => ''], + 'AlarmTime' => ['description' => 'Alarm time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1671076740000', 'title' => ''], + 'AggCount' => ['description' => 'Aggregation count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AlarmTargetIdentify' => ['description' => 'Alarm target.', 'type' => 'string', 'example' => 'monitorprod', 'title' => ''], + 'AlarmHistoryId' => ['description' => 'Alarm notification record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '27313821', 'title' => ''], + 'GmtCreate' => ['description' => 'Created time.', 'type' => 'string', 'example' => '2020-03-13 02:25:08', 'title' => ''], + 'AlarmUrl' => ['description' => 'Alarm data source redirect URL.', 'type' => 'string', 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', 'title' => ''], + 'AlarmUrlWithDomain' => ['description' => 'Absolute path of the web page, including the domain name.', 'type' => 'string', 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', 'title' => ''], + 'TraceId' => ['description' => 'Trace ID, used for precise query of call information.', 'type' => 'string', 'example' => '0a6481081662012458401682123', 'title' => ''], + 'Id' => ['description' => 'Property ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '73738', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SubscriberName' => ['description' => 'Subscriber name.', 'type' => 'string', 'example' => 'mike', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'type' => 'string', + 'AlarmNotifySubs' => [ + 'description' => 'Notification subscribers corresponding to the alarm notification history.', + 'type' => 'array', + 'items' => [ + 'description' => 'Notification subscriber.', + 'type' => 'object', + 'properties' => [ + 'SubscriberSource' => ['description' => 'Subscriber source.', 'type' => 'string', 'example' => 'LOCAL', 'title' => ''], + 'Subscriber' => ['description' => 'Subscriber.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'SubscriberUuid' => ['description' => 'Subscriber UUID.', 'type' => 'string', 'example' => '839f5cf92ab3435385ef3949c001a7a8', 'title' => ''], + 'SubscriberType' => ['description' => 'Subscriber type.', 'type' => 'string', 'example' => 'USER_GROUP', 'title' => ''], + 'SubscriberName' => ['description' => 'Subscriber name.', 'type' => 'string', 'example' => 'mike', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"\\",\\n \\"ResultCode\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', - ], - 'CreateRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', + '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\\": false,\\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' => 'Query Alarm Notification History', + 'summary' => 'Query alarm notification history, including notification records from DingTalk, phone calls, SMS, and webhooks, as well as notification status.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmNotifyHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'Fuzzy search by alert rule name ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Category', + 'name' => 'Level', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CUSTOM', - ], + 'schema' => ['description' => 'Alert Level ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - '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' => 'Alarm object search in JSON format. The following fields are included:'."\n" + ."\n" + .'rule_status NUMBER No 1: enabled, 0: disabled '."\n" + .'Rule status'."\n" + ."\n" + .'alarm_status NUMBER No 0 '."\n" + .'Alert Status'."\n" + ."\n" + .'only_me BOOLEAN No true, false '."\n" + .'View only my items'."\n" + ."\n" + .'current_page NUMBER No 1 '."\n" + .'Current page'."\n" + ."\n" + .'page_size NUMBER No 3 '."\n" + .'Page size'."\n" + ."\n" + .'workspace_name STRING Yes Workspace name '."\n" + .'Workspace name'."\n" + ."\n" + .'rule_id NUMBER No '."\n" + .'Alert rule ID'."\n" + ."\n" + .'rule_unique_identity STRING No 1234_asdf '."\n" + .'UUID of the alert rule'."\n" + ."\n" + .'category STRING Yes "Custom", "pql" '."\n" + .'Identifier indicating whether the rule is a Custom rule or a PQL rule'."\n" + ."\n" + .'ref_datasource_type STRING No datasource '."\n" + .'filter_user_group NUMBER No 1 '."\n" + .'Filter by group'."\n" + ."\n" + .'filter_webhook NUMBER No 1 '."\n" + .'Filter by webhook'."\n" + ."\n" + .'filter_ding_robot NUMBER No 1 '."\n" + .'Filter by DingTalk Robot ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'AlarmNodata', + 'name' => 'RuleStatus', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Rule status: 1 for enabled, 0 for disabled ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Level', + 'name' => 'AlarmStatus', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'Alert Status ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Emergency', + 'name' => 'OnlyMe', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'View only my items ', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'EmergencyUrl', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Current page ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'PendingHit', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Page size ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'RecoveredHit', + 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Workspace name ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'Step', + 'name' => 'RuleId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'Alert rule ID ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'SilenceTime', + 'name' => 'RuleUniqueIdentity', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '300', - ], + 'schema' => ['description' => 'Alert UUID ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'NotifyFiring', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Rule category ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'NotifyRecovered', + 'name' => 'RefDatasourceType', 'in' => 'formData', + 'schema' => ['description' => 'datasource', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => ['description' => 'Current page ', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'Request ID ', 'type' => 'string', 'title' => '', 'example' => ''], + 'ResultMessage' => ['description' => 'Result description ', 'type' => 'string', 'title' => '', 'example' => ''], + 'ResultCode' => ['description' => 'Result code ', 'type' => 'string', 'title' => '', 'example' => ''], + 'PageSize' => ['description' => 'Page size ', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'TotalCount' => ['description' => 'Total number of entries ', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmRules' => [ + 'description' => 'Alert rule information', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert rule information', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Status: 1 indicates enabled, 0 indicates disabled', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'NotifyTplId' => ['description' => 'Notification template ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Channels' => ['description' => 'Notification channels: ["ddWebhook","sms","phone","email"]', 'type' => 'string', 'title' => '', 'example' => ''], + 'NotifyFiring' => ['description' => 'Notify when alert is triggered: 1 indicates selected, 0 indicates not selected', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'GmtModified' => ['description' => 'Updated At', 'type' => 'string', 'title' => '', 'example' => ''], + 'NotifyEmpty' => ['description' => 'Notify when no data is available for the alert: 1 for enabled, 0 for disabled ', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Creator' => ['description' => 'Rule creator', 'type' => 'string', 'title' => '', 'example' => ''], + 'NotifyTimeFilter' => ['description' => 'Notification time', 'type' => 'string', 'title' => '', 'example' => ''], + 'Modifier' => ['description' => 'Updated By', 'type' => 'string', 'title' => '', 'example' => ''], + 'NotifyRecovered' => ['description' => 'Notify when the alert recovers: 1 for enabled, 0 for disabled', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'SuspendedStartTime' => ['description' => 'Pause start time', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Deleted' => ['description' => 'Soft delete', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'SuspendedReason' => ['description' => 'Reason for pause', 'type' => 'string', 'title' => '', 'example' => ''], + 'PendingHit' => ['description' => 'Trigger epoch', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Name' => ['description' => 'Rule name', 'type' => 'string', 'title' => '', 'example' => ''], + 'RecoveredHit' => ['description' => 'Recovery epoch', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmEmpty' => ['description' => 'Toggle for triggering alerts when metric data is empty. 1: enabled, 0: disabled', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'SilenceTime' => ['description' => 'Notification silence duration', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AlarmStatus' => ['description' => 'Alert Status', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Emergency' => ['description' => 'Emergency contact', 'type' => 'string', 'title' => '', 'example' => ''], + 'SourceId' => ['description' => 'ID of the alert rule before migration', 'type' => 'string', 'title' => '', 'example' => ''], + 'SuspendedEndTime' => ['description' => 'Pause end time ', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Step' => ['description' => 'Detection frequency', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'WorkspaceId' => ['description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'UniqueIdentity' => ['description' => 'UUID of the alert rule', 'type' => 'string', 'title' => '', 'example' => ''], + 'TimeZone' => ['description' => 'Time Zone', 'type' => 'string', 'title' => '', 'example' => ''], + 'EmergencyUrl' => ['description' => 'Emergency handling link ', 'type' => 'string', 'title' => '', 'example' => ''], + 'GmtCreate' => ['description' => 'Creation Time', 'type' => 'string', 'title' => '', 'example' => ''], + 'Category' => ['description' => 'Rule type', 'type' => 'string', 'title' => '', 'example' => ''], + 'Level' => ['description' => 'Alert level', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'Id' => ['description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'TenantId' => ['description' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'RuleConfig' => ['description' => 'Rule Configuration Information', 'type' => 'string', 'title' => '', 'example' => ''], + 'ConditionsDes' => [ + 'description' => 'Trigger Conditions', + 'type' => 'array', + 'items' => ['description' => 'Trigger Condition', 'type' => 'string', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', + 'title' => '', + 'example' => '', ], ], - [ - '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' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'title' => '', + 'summary' => '', + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ - 'name' => 'WorkspaceName', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => 'The Group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id', 'title' => ''], ], [ - 'name' => 'ChannelsRepeatList', + 'name' => 'InstanceId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The instance ID that corresponds to the messages to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ - 'name' => 'NotifyTarget', + 'name' => 'MsgIds', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SubscriberSource' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'LOCAL', - ], - 'SubscriberType' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'USER_GROUP', - ], - 'Subscriber' => [ - 'description' => '', - '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' => 'The IDs of the messages to resend, that is, the message IDs. Separate multiple message IDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******', 'title' => ''], ], ], 'responses' => [ @@ -7883,69 +5476,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5F656C56-F99E-5C1E-AE7F-D9F78AC8D706', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Data' => ['description' => 'The IDs of the messages that failed to be sent, that is, the message IDs.', 'type' => 'string', 'example' => '1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"5F656C56-F99E-5C1E-AE7F-D9F78AC8D706\\"\\n}","type":"json"}]', - ], - 'DeleteRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"Data\\": \\"1E0578FE110F18B4AAC235C0C******,1E0578FE110F18B4AAC235C0C******\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Batch resend dead-letter messages', + 'summary' => 'Resends dead-letter messages with specified message IDs in batches so that consumers can consume these messages again.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ResendMqSofamqDLQMessageById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Cell', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RZ01A', 'title' => ''], ], [ - 'name' => 'WorkspaceName', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => 'The group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_group_id ', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the instance to which the message belongs. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], + ], + [ + 'name' => 'MsgId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the message to query, that is, the message ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1E0578FE110F18B4AAC235C0C****** ', 'title' => ''], ], ], 'responses' => [ @@ -7953,205 +5549,220 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', - ], - 'QueryRMSUnifiedAlarmEvent' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Resend dead-letter message', + 'summary' => 'Resurrects a dead-letter message so that the message can be consumed by a consumer again.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'The cell to query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'RZ01A', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The Group ID of the consumer to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'GID_test_consumer_id', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The instance ID that corresponds to the Group ID to query. This parameter is required for instances that have independent namespaces.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ - 'name' => 'AlarmLevel', + 'name' => 'ResetTimestamp', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The timestamp to which the consumer offset is reset. This parameter takes effect only when Type is set to 1. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1568033253000', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Topic', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 2 => '', - 4 => '', - '', - ], - ], + 'schema' => ['description' => 'The name of the topic for which you want to reset the consumer offset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-mq-topic ', 'title' => ''], ], [ - 'name' => 'AlarmTargetType', + 'name' => 'Type', 'in' => 'formData', + 'schema' => ['description' => 'The message cleanup type. Valid values:'."\n" + .'- 0: clears all messages.'."\n" + .'- 1: clears messages up to a specified time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Reset consumer offset', + 'summary' => 'Resets the consumer offset of a specified Group ID to a specified timestamp. This operation is typically used to clear accumulated messages or replay consumed messages.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResetMqSofamqConsumerOffset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => 'The ID of the group to update.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_group_id', 'title' => ''], ], [ - 'name' => 'AlarmRuleId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx', 'title' => ''], ], [ - 'name' => 'AlarmStackInfoJsonStr', + 'name' => 'Remark', 'in' => 'formData', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'The result message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Update group information', + 'summary' => 'Modifies or updates the description of a group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqGroupRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], ], [ - 'name' => 'AlarmTargetKeyword', + 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The description of the topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - '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' => 'The name of the topic to update. The topic name must be unique within a user account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -8159,374 +5770,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - ], - 'AlarmRuleId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmHistoryId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmContent' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmUrl' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmUrlWithDomain' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmTargetDeleted' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'AlarmLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmEventId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'UniqueIdentity' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmRuleId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmDetail' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmUrl' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmContent' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmUrlWithDomain' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmTargetDeleted' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'AlarmLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmTarget' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmRuleName' => [ - 'description' => '', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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"}]', - ], - 'QueryRMSUnifiedAlarmRule' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'Update topic information', + 'summary' => 'Updates the description of a topic.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqTopicRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => 'Alert time range', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '00:00-24:00', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'Contacts', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Alert notification contact information', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[["DingTalk", "机器人令牌", "组名"], ["DingTalk", "机器人令牌2", "组名2"]]', 'title' => ''], ], [ - 'name' => 'AlarmTargetJsonStr', + 'name' => 'DelayTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Delay in seconds before triggering an alert', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'RuleStatus', + 'name' => 'Frequency', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Alert frequency, in minutes', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AlarmStatus', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MQ_INST_111111111111_DOxxxxxx ', 'title' => ''], ], [ - 'name' => 'OnlyMe', + 'name' => 'Threshold', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Threshold', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '3000', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'WarnId', 'in' => 'formData', + 'schema' => ['description' => 'Specified alert rule to modify', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000001 ', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResultMessage' => ['description' => 'Result description', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'Result code', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'UpdateMqSofamqWarn', + 'summary' => 'Updates the configuration of the specified alert rule.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The property name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'age', 'title' => ''], ], [ - 'name' => 'RuleUniqueIdentity', + 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The property description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '年龄', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The auto-increment ID of the property.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RefDatasourceType', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'datasource', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The environment instance ID. This is a system field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], ], 'responses' => [ @@ -8534,349 +5930,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'NotifyTplId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Channels' => [ - 'description' => '', - 'type' => 'string', - ], - 'NotifyFiring' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - ], - 'NotifyEmpty' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - ], - 'NotifyTimeFilter' => [ - 'description' => '', - 'type' => 'string', - ], - 'Modifier' => [ - 'description' => '', - 'type' => 'string', - ], - 'NotifyRecovered' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'SilenceTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'AlarmStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Emergency' => [ - 'description' => '', - 'type' => 'string', - ], - 'SourceId' => [ - 'description' => '', - 'type' => 'string', - ], - 'SuspendedEndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'Step' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'WorkspaceId' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'RuleConfig' => [ - 'description' => '', - 'type' => 'string', - ], - 'ConditionsDes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - ], - ], - ], - ], - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code. Valid values: OK, INTERNALERROR, ERRPERMISSIONDENIED, ERRNOTENABLED, INVALIDSIGNATURE, ERRORREQUEST, ACCESSDENIED, MISSINGPARAMETER, ERRORINTERNALPROVIDER, and BADPROVIDER_RESPONSE.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'ServerInernalError', - 'errorMessage' => 'A server internal error occurred while processing your request. Contact the administrator.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultMessage\\": \\"OK\\",\\n \\"ResultCode\\": \\"OK\\",\\n \\"RequestId\\": \\"861E6630-AEC0-4B2D-B214-6CB5E44B7F04\\"\\n}","type":"json"}]', + 'title' => 'UpdateMsConfigAttributes', + 'summary' => 'Updates the metadata of a property by property ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-12T16:17:11.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', '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', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - ], - ], - [ - 'name' => 'Start', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1668911820000', - ], - ], - [ - 'name' => 'End', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1662516900000', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'foo', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'Attributes', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The property information of the resource, passed in as a JSON string.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"attributeName":"age","desc":"描述信息"}]', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Desc', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The description of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试资源', 'title' => ''], ], [ - 'name' => 'AlarmTargetType', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'APP', - ], + 'schema' => ['description' => 'The auto-increment ID of the resource to update.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AlarmTarget', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'PlanetKms', - ], + 'schema' => ['description' => 'The system field: environment instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abcdEFGH1234', 'title' => ''], ], [ - 'name' => 'AlarmLevel', + 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The domain for resource search.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Alipay', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'ResourceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The unique identifier of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.test.resource', 'title' => ''], ], [ - 'name' => 'AlarmStackInfoJsonStr', + 'name' => 'UpdateAttribute', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{\\"DatasourceType\\":\\"STACK\\",\\"AlarmTargetType\\":\\"APP\\",\\"AlarmTargetIdentify\\":\\"prod-app-twc-universal\\"}', - ], + 'schema' => ['description' => 'Specifies whether to perform a full update of properties. Default value: false.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -8884,872 +6023,1000 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CurrentPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'APP', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-04-02 21:53:24', - ], - 'EventId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '355402_1670998540000_598877597', - ], - 'WorkspaceId' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '860', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-04-02 21:53:24', - ], - 'AlarmDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AlarmUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', - ], - 'AlarmContent' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AlarmUrlWithDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.alipay.com/rms/sofacloud/sofa_app/view/a?workspaceName=b&tenantName=c', - ], - 'AlarmTargetDeleted' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AlarmLevel' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3376', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AlarmTarget' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sibei_1229_1', - ], - 'AlarmRuleName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'ResultMessage' => ['description' => 'The result description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'ResultCode' => ['description' => 'The result code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '861E6630-AEC0-4B2D-B214-6CB5E44B7F04', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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"}]', - ], - 'QueryRMSUnifiedAlarmNotifyHistory' => [ - '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' => 'Update resource metadata', + 'summary' => 'When update_attribute is set to false, only the resource metadata is updated, and the property information is not updated.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + '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' => '', - 'docRequired' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Alert rule ID ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Channel', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Alert rule Name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TAGS', 'title' => ''], ], [ - 'name' => 'Subscriber', + 'name' => 'Category', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Rule category', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CUSTOM', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'RuleConfig', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Alert rule configuration ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\\"trafficType\\":\\"i\\",\\"methodName\\":\\"*\\",\\"faultInjectRuleItems\\":[{\\"action\\":{\\"type\\":\\"REJECT\\"},\\"ruleType\\":\\"ABORT\\",\\"configs\\":{\\"faultPercent\\":100}}]} ', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AlarmNodata', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Alert notification Result Data', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'WorkspaceName', + 'name' => 'Level', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Alert level ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'Emergency', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Emergency handler ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'EmergencyUrl', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Emergency handling link', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PendingHit', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Trigger epoch', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'RecoveredHit', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Recovery epoch', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'AlarmRuleId', + 'name' => 'Step', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Detection frequency', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '5', 'title' => ''], ], [ - 'name' => 'AlarmStatus', + 'name' => 'SilenceTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'enumValueTitles' => [ - 2 => '', - 4 => '', - '', - ], - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Notification silence duration', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '900', 'title' => ''], ], [ - 'name' => 'AlarmStackInfoJsonStr', + 'name' => 'NotifyFiring', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Notify when an alert is triggered: 1 for enabled, 0 for disabled', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'DashboardQueryParamJsonStr', + 'name' => 'NotifyRecovered', 'in' => 'formData', - 'schema' => [ - 'docRequired' => false, - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Notify when an alert recovers: 1 for enabled, 0 for disabled', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], [ - 'name' => 'AlarmSubscribers', + 'name' => 'NotifyNodata', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'SubscriberSource' => [ - 'description' => '', - 'required' => true, - 'type' => 'string', - ], - 'SubscriberType' => [ - 'description' => '', - 'required' => true, - 'type' => 'string', - ], - 'Subscriber' => [ - 'description' => '', - 'required' => true, - 'type' => 'string', - ], - 'SubscriberUuid' => [ - 'description' => '', - 'required' => true, - 'type' => 'string', - ], - 'SubscriberName' => [ - 'description' => '', - 'required' => true, - 'type' => 'string', - ], - ], - 'required' => false, - 'type' => 'object', - ], - 'maxItems' => 100, - 'required' => false, - 'type' => 'array', - ], + 'schema' => ['description' => 'Number of alert rules to be modified', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'title' => '', 'example' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'properties' => [ - 'CurrentPage' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - ], - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - ], - 'PageSize' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TotalCount' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AlarmNotifyHistories' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'AlarmSilenceTime' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Status' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmType' => [ - 'description' => '', - 'type' => 'string', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - ], - 'NotifyContent' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmRuleId' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Subscriber' => [ - 'description' => '', - 'type' => 'string', - ], - 'Channel' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmTargetDeleted' => [ - 'description' => '', - 'type' => 'boolean', - ], - 'AlarmLevel' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AlarmEventId' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmRuleName' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmTargetType' => [ - 'description' => '', - 'type' => 'string', - ], - 'SubscriberType' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmStatus' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DataSourceName' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmRuleUuid' => [ - 'type' => 'string', - ], - 'WorkspaceId' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'SubscriberSource' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmTime' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AggCount' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AlarmTargetIdentify' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmHistoryId' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmUrl' => [ - 'description' => '', - 'type' => 'string', - ], - 'AlarmUrlWithDomain' => [ - 'description' => '', - 'type' => 'string', - ], - 'TraceId' => [ - 'description' => '', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TenantId' => [ - 'description' => '', - 'format' => 'int64', - 'type' => 'integer', - ], - 'SubscriberName' => [ - 'description' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - 'AlarmNotifySubs' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'SubscriberSource' => [ - 'description' => '', - 'type' => 'string', - ], - 'Subscriber' => [ - 'description' => '', - 'type' => 'string', - ], - 'SubscriberUuid' => [ - 'description' => '', - 'type' => 'string', - ], - 'SubscriberType' => [ - 'description' => '', - 'type' => 'string', - ], - 'SubscriberName' => [ - 'description' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - ], - ], - '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"}]', - ], - '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' => 'Time Range for querying alert rules', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'End', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1632278280000', - ], + 'schema' => ['description' => 'Sending Status', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Firing', 'title' => ''], ], [ - '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' => 'Pause Start Time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'DsId', + 'name' => 'SuspendedEndTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2643', - ], + 'schema' => ['description' => 'Pause end time ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ - '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' => 'Reason for pause ', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'WorkspaceName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prod', - ], + 'schema' => ['description' => 'Workspace name ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prod', 'title' => ''], ], [ - 'name' => 'PeriodType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], - ], - [ - 'name' => 'FieldsRepeatList', + 'name' => 'ChannelsRepeatList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'Alert notification channels ', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - ], - 'required' => false, + 'items' => ['description' => 'Alert notification channel ', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + 'required' => true, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Where', + 'name' => 'NotifyTarget', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'Quota alert notification object.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Quota alert notification object. ', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'app', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'monitorprod', - ], + 'SubscriberSource' => ['description' => 'Subscriber source ', 'type' => 'string', 'required' => true, 'example' => 'LOCAL', 'title' => ''], + 'SubscriberType' => ['description' => 'Type of subscriber ', 'type' => 'string', 'required' => true, 'example' => 'USER_GROUP', 'title' => ''], + 'Subscriber' => ['description' => 'Subscriber ID ', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'SubscriberUuid' => ['type' => 'string', 'required' => true, 'example' => '400', 'description' => '', 'title' => ''], + 'SubscriberName' => ['description' => 'Subscriber name '."\n", 'type' => 'string', 'required' => true, 'example' => '实人认证-灰度测试', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ResultMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', 'title' => '', 'example' => ''], + 'ResultCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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"}]', + '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'title' => '', + 'summary' => '', + 'flowControl' => [ + 'flowControlList' => [], + ], ], - 'LogoutMsRegistryService' => [ - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sofa.cn-hangzhou.aliyuncs.com', 'endpoint' => 'sofa.cn-hangzhou.aliyuncs.com', 'vpc' => 'sofa-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'An unknown error occurred in the system. Please submit the work order after the refresh attempt is invalid.'], + ['code' => 'UnknowError.SystemError', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddMsConfigResources'], + ['description' => 'Error codes changed', 'api' => 'DeleteMsConfigAttributes'], + ['description' => 'Error codes changed', 'api' => 'DeleteMsConfigResources'], + ['description' => 'Error codes changed', 'api' => 'GetMsConfigAttributes'], + ['description' => 'Error codes changed', 'api' => 'GetMsConfigResources'], + ['description' => 'Error codes changed', 'api' => 'GrayPushMsConfigData'], + ['description' => 'Error codes changed', 'api' => 'PushMsConfigData'], + ['description' => 'Error codes changed', 'api' => 'QueryMsConfigAttributes'], + ['description' => 'Error codes changed', 'api' => 'QueryMsConfigClients'], + ['description' => 'Error codes changed', 'api' => 'QueryMsConfigClientValues'], + ], + 'createdAt' => '2025-03-12T16:20:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'QueryMqSofamqConsumerTimespan'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-03-12T12:07:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'QueryMqSofamqConsumerAccumulate'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2025-03-12T05:57:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddMsConfigAttributes'], + ], + 'createdAt' => '2025-03-12T03:18:24.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ram' => [ + 'productCode' => 'SOFA', + 'productName' => 'Scalable Open Financial Architecture', + 'ramCodes' => ['sofa'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetMqSofamqConsumerJStack', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerJStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + [ + 'apiName' => 'ListMqSofamqGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRMSUnifiedAlarmRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:DeleteRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqMessageById', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigClientValues', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClientValues', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqDLQMessageByGroupId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqDLQMessageByGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddMsConfigAttributes', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMsConfigAttributes', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddMsConfigResources', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:AddMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigAttributes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqWarnHistory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarnHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqTraceResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DisableMqSofamqWarn', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:DisableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRMSUnifiedAlarmRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:CreateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateMqSofamqGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResetMqSofamqConsumerOffset', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResetMqSofamqConsumerOffset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmHistory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeCasComputers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:DescribeCasComputers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqConsumerAccumulate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerAccumulate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqTraceByMsgId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqTraceByMsgId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqDLQMessageById', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSMetrics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResendMqSofamqDLQMessageBatch', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmNotifyHistory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmNotifyHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmEvent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqWarn', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GrayPushMsConfigData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:GrayPushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqTrace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMqSofamqTopic', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqGroupSubDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqGroupSubDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMqSofamqTopicRemark', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqTopicRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqTrace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteMsConfigResources', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'sofa:DeleteMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMsConfigAttributes', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqConsumerTimespan', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerTimespan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMsConfigResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PushMsConfigData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'sofa:PushMsConfigData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMsConfigClients', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMsConfigClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResendMqSofamqDLQMessageById', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:ResendMqSofamqDLQMessageById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateRMSUnifiedAlarmRule', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'sofa:UpdateRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqConsumerConnection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqConsumerConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMsConfigAttributes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMsConfigAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateMqSofamqTopic', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'sofa:CreateMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMqSofamqConsumerStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:GetMqSofamqConsumerStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnableMqSofamqWarn', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:EnableMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqWarn', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryMqSofamqMessageByTopic', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryMqSofamqMessageByTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateMqSofamqWarn', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'sofa:UpdateMqSofamqWarn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMqSofamqTopic', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:ListMqSofamqTopic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRMSUnifiedAlarmRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'sofa:QueryRMSUnifiedAlarmRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SOFA', 'resourceType' => 'All Resource', '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' => [], ], ]; |