diff options
Diffstat (limited to 'data/en_us/cms-export')
| -rw-r--r-- | data/en_us/cms-export/2021-11-01/api-docs.php | 551 |
1 files changed, 551 insertions, 0 deletions
diff --git a/data/en_us/cms-export/2021-11-01/api-docs.php b/data/en_us/cms-export/2021-11-01/api-docs.php new file mode 100644 index 0000000..64ee5ec --- /dev/null +++ b/data/en_us/cms-export/2021-11-01/api-docs.php @@ -0,0 +1,551 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'cms-export', + 'version' => '2021-11-01', + ], + 'directories' => [ + [ + 'id' => 120930, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'BatchGet', + 'Cursor', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'BatchGet' => [ + 'summary' => 'Batch Export', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data namespace of the cloud product.'."\n" + ."\n" + .'For how to obtain the data namespace of the cloud product, see [Cloud Product Monitoring Items](~~163515~~).'."\n" + ."\n" + .'> This parameter must be the same as the `Namespace` request parameter in the Cursor interface.', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the cloud product\'s monitoring item.'."\n" + ."\n" + .'For how to obtain the name of the cloud product\'s monitoring item, see [Cloud Product Monitoring Items](~~163515~~).'."\n" + ."\n" + .'> This parameter must be the same as the `Metric` request parameter in the Cursor interface.', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'formData', + 'schema' => [ + 'description' => 'When calling this interface to export data repeatedly, you must input the value of `Cursor`. The methods to obtain the `Cursor` value are as follows:'."\n" + ."\n" + .'- When you call this interface for the first time, you must first call the Cursor interface to get the `Cursor` value. For more information, see [Cursor](~~391206~~).'."\n" + ."\n" + .'- When you call this interface again, you can obtain the `Cursor` value from the response data of the previous call to this interface.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', + ], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The maximum number of data entries returned each time.'."\n" + ."\n" + .'Value range: 1~10000.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'CompressionType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The compression type of the monitoring data.'."\n" + ."\n" + .'Currently, only `normal` (no compression) is supported.', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'RecordKeyWhiteList', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The whitelist of the monitoring item\'s statistical methods.'."\n" + ."\n" + .'- If this parameter is not set, it means that the monitoring data of all statistical methods of the monitoring item will be returned.'."\n" + ."\n" + .'- If this parameter is set, it means that only the monitoring data of the statistical methods in the whitelist will be returned.'."\n" + ."\n" + .'For how to obtain the statistical methods of the monitoring item, see the `Statistics` parameter in [Cloud Product Monitoring Items](~~163515~~).', + 'type' => 'string', + 'required' => false, + 'example' => 'Maximum', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '251402CD-305C-1617-808E-D8C11FC8138D', + ], + 'Message' => [ + 'description' => 'Response message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Returned data body.', + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => 'Used to call this interface again.'."\n" + ."\n" + .'> If the returned result is `null`, it indicates that the monitoring data export is complete.'."\n", + 'type' => 'string', + 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0=', + ], + 'Records' => [ + 'description' => 'List of exported monitoring data.', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => 'The data namespace of the cloud product.', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Metric' => [ + 'description' => 'The name of the cloud product\'s monitoring item.', + 'type' => 'string', + 'example' => 'cpu_idle', + ], + 'MeasureLabels' => [ + 'description' => 'Keys of the monitoring item\'s statistical methods.'."\n" + ."\n" + .'Format of the monitoring item\'s statistical methods: a collection of key-value pairs.', + 'type' => 'array', + 'items' => [ + 'description' => '监控项统计方法的键。'."\n" + ."\n" + .'监控项统计方法的格式：key-value键值对形式的集合。', + 'type' => 'string', + 'example' => '[Minimum, Maximum, Average]', + ], + ], + 'MeasureValues' => [ + 'description' => 'The values of the metric statistical methods.'."\n" + ."\n" + .'Format: A collection in key-value pairs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The values of the metric statistical methods.'."\n" + ."\n" + .'Format: A collection in key-value pairs.', + 'type' => 'string', + 'example' => '[0.71, 0.81, 0.91]', + ], + ], + 'Labels' => [ + 'description' => 'The keys of the metric dimensions.'."\n" + ."\n" + .'Format: A collection in key-value pairs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The keys of the metric dimensions.'."\n" + ."\n" + .'Format: A collection in key-value pairs.', + 'type' => 'string', + 'example' => '[instanceId, userId]', + ], + ], + 'LabelValues' => [ + 'description' => 'The values of the metric dimensions.'."\n" + ."\n" + .'Format: A collection in key-value pairs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The values of the metric dimensions.'."\n" + ."\n" + .'Format: A collection in key-value pairs.', + 'type' => 'string', + 'example' => '[i-0jl0z6wbjh8w4xcv****, 173651113438****]', + ], + ], + 'Tags' => [ + 'description' => 'The resource tag keys.'."\n" + ."\n" + .'> Currently, this parameter is empty.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tag keys.'."\n" + ."\n" + .'> Currently, this parameter is empty.', + 'type' => 'string', + 'example' => '-', + ], + ], + 'TagValues' => [ + 'description' => 'The resource tag values.'."\n" + ."\n" + .'> Currently, this parameter is empty.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tag values.'."\n" + ."\n" + .'> Currently, this parameter is empty.', + 'type' => 'string', + 'example' => '-', + ], + ], + 'Timestamp' => [ + 'description' => 'The timestamp of the monitoring data.'."\n" + ."\n" + .'Unit: milliseconds.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641454680000', + ], + 'Period' => [ + 'description' => 'The statistical period of the monitoring data.'."\n" + ."\n" + .'Unit: seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + ], + ], + 'Length' => [ + 'description' => 'The maximum number of data entries returned each time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'CompressionKeys' => [ + 'description' => 'The keys for the compression type of the monitoring data.'."\n" + ."\n" + .'> When `CompressionType` is `normal`, this parameter is empty.', + 'type' => 'array', + 'items' => [ + 'description' => 'The keys for the compression type of the monitoring data.'."\n" + ."\n" + .'> When `CompressionType` is `normal`, this parameter is empty.', + 'type' => 'string', + 'example' => '-', + ], + ], + 'CompressionValues' => [ + 'description' => 'The values for the compression type of the monitoring data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The values for the compression type of the monitoring data.'."\n" + ."\n" + .'> When `CompressionType` is `normal`, this parameter is empty.', + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the monitoring data compression type.'."\n" + ."\n" + .'> This parameter is empty when `CompressionType` is `normal`.', + 'type' => 'string', + 'example' => '-', + ], + ], + ], + '__anchorTs__' => [ + 'description' => 'Anchor timestamp', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727085162975', + ], + ], + ], + 'Code' => [ + 'description' => 'Status code.'."\n" + ."\n" + .'> 200 indicates success.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"251402CD-305C-1617-808E-D8C11FC8138D\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Cursor\\": \\"eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0=\\",\\n \\"Records\\": [\\n {\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Metric\\": \\"cpu_idle\\",\\n \\"MeasureLabels\\": [\\n \\"[Minimum, Maximum, Average]\\"\\n ],\\n \\"MeasureValues\\": [\\n \\"[0.71, 0.81, 0.91]\\"\\n ],\\n \\"Labels\\": [\\n \\"[instanceId, userId]\\"\\n ],\\n \\"LabelValues\\": [\\n \\"[i-0jl0z6wbjh8w4xcv****, 173651113438****]\\"\\n ],\\n \\"Tags\\": [\\n \\"-\\"\\n ],\\n \\"TagValues\\": [\\n \\"-\\"\\n ],\\n \\"Timestamp\\": 1641454680000,\\n \\"Period\\": 60\\n }\\n ],\\n \\"Length\\": 1000,\\n \\"CompressionKeys\\": [\\n \\"-\\"\\n ],\\n \\"CompressionValues\\": [\\n [\\n \\"-\\"\\n ]\\n ],\\n \\"__anchorTs__\\": 1727085162975\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchGetResponse>\\n\\t<RequestId>251402CD-305C-1617-808E-D8C11FC8138D</RequestId>\\n\\t<Message>success</Message>\\n\\t<Data>\\n\\t\\t<Cursor>eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0=</Cursor>\\n\\t\\t<Records>\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\n\\t\\t\\t<Metric>cpu_idle</Metric>\\n\\t\\t\\t<MeasureLabels>[Minimum, Maximum, Average]</MeasureLabels>\\n\\t\\t\\t<MeasureValues>[0.71, 0.81, 0.91]</MeasureValues>\\n\\t\\t\\t<Labels>[instanceId, userId]</Labels>\\n\\t\\t\\t<LabelValues>[i-0jl0z6wbjh8w4xcv****, 173651113438****]</LabelValues>\\n\\t\\t\\t<Timestamp>1641454680000</Timestamp>\\n\\t\\t\\t<Period>60</Period>\\n\\t\\t</Records>\\n\\t\\t<Length>1000</Length>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</BatchGetResponse>\\t","errorExample":""}]', + 'title' => 'Get Exported Data', + 'description' => '### Prerequisites'."\n" + .'Ensure that you have called the Cursor interface to obtain the initial `Cursor`. For more information, see [Cursor](~~391206~~).'."\n" + ."\n" + .'### Usage Instructions'."\n" + .'This document provides an example of exporting monitoring data for the `cpu_idle` metric of the cloud product `acs_ecs_dashboard` with a specific initial `Cursor`, and it returns up to 1000 data entries at a time.'."\n", + 'requestParamsDescription' => 'For details about common request parameters, see [Common Parameters](~~382265~~).', + 'translator' => 'machine', + ], + 'Cursor' => [ + 'summary' => 'Create cursor', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data namespace of the cloud product.'."\n" + ."\n" + .'To learn how to obtain the data namespace of a cloud product, see [Cloud Product Monitoring Items](~~163515~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the monitoring item of the cloud product.'."\n" + ."\n" + .'To learn how to obtain the name of a monitoring item of a cloud product, see [Cloud Product Monitoring Items](~~163515~~).', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The time interval of the monitoring item.'."\n" + ."\n" + .'Unit: seconds.'."\n" + ."\n" + .'> The time interval of the monitoring item is usually 60 seconds. For special values, see the parameter `Period` in [Cloud Product Monitoring Items](~~163515~~).'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The start timestamp.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'> Since the monitoring data in Cloud Monitoring can only be stored for 90 days, it is recommended that the start time be no more than 90 days from the current time.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1641627000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The end timestamp.'."\n" + ."\n" + .'Unit: milliseconds.'."\n" + ."\n" + .'> There is no restriction on the end time; it can be set to a future time.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1641645000000', + ], + ], + [ + 'name' => 'Matchers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Dimension information of the monitoring item.', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => 'The key of the monitoring item dimension.'."\n" + ."\n" + .'The format of the monitoring item dimension: a collection of key-value pairs, such as `instanceId:i-2ze2d6j5uhg20x47****` or `userId:120886317861****`.'."\n" + ."\n" + .'To learn how to obtain the dimensions of a monitoring item, see the parameter `Dimension` in [Cloud Product Monitoring Items](~~163515~~).'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'userId', + ], + 'Value' => [ + 'description' => 'The value of the monitoring item dimension.'."\n" + ."\n" + .'The format of the monitoring item dimension: a collection of key-value pairs, such as `instanceId:i-2ze2d6j5uhg20x47****` or `userId:120886317861****`.'."\n" + ."\n" + .'To learn how to obtain the dimensions of a monitoring item, see the parameter `Dimension` in [Cloud Product Monitoring Items](~~163515~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '120886317861****', + ], + 'Operator' => [ + 'description' => 'The matching relationship of the monitoring item dimension.'."\n" + ."\n" + .'Currently, only EQUALS (equals) is supported.', + 'type' => 'string', + 'required' => false, + 'example' => 'EQUALS', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Returned data body.', + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => 'Used for the first call to the BatchGet interface.', + 'type' => 'string', + 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', + ], + ], + ], + 'Code' => [ + 'description' => 'Status code.'."\n" + ."\n" + .'> 200 indicates success.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Cursor\\": \\"eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CursorResponse>\\n\\t<RequestId>915C2D7A-E6A4-17C3-8E13-4DBDD61E7919</RequestId>\\n\\t<Message>success</Message>\\n\\t<Data>\\n\\t\\t<Cursor>eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****</Cursor>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CursorResponse>\\t","errorExample":""}]', + 'title' => 'Get Initial Export Data Cursor', + 'description' => '### Prerequisites'."\n" + .'Ensure that you have activated Enterprise Cloud Monitoring. For detailed steps, see [Activate Enterprise Cloud Monitoring](~~250773~~).'."\n" + ."\n" + .'### Background Information'."\n" + .'First, call this interface to get the initial Cursor, then use the BatchGet interface to export monitoring data. For more information, see [BatchGet](~~391205~~).'."\n" + ."\n" + .'### Usage Instructions'."\n" + .'This article provides an example, defining the monitoring item `cpu_idle` of the cloud product `acs_ecs_dashboard` within the time range from `1641627000000` (2022-01-08 15:30:00) to `1641645000000` (2022-01-08 20:30:00), with a 60-second interval for data export. The response will show the `Cursor` information.', + 'requestParamsDescription' => 'For details on common request parameters, see [Common Parameters](~~382265~~).', + 'translator' => 'machine', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cms-export.cn-shanghai.aliyuncs.com', + ], + ], +]; |