diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/cms | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/cms')
| -rw-r--r-- | data/zh_cn/cms/2015-04-20/api-docs.php | 319 | ||||
| -rw-r--r-- | data/zh_cn/cms/2015-08-01/api-docs.php | 896 | ||||
| -rw-r--r-- | data/zh_cn/cms/2015-10-20/api-docs.php | 724 | ||||
| -rw-r--r-- | data/zh_cn/cms/2016-03-18/api-docs.php | 718 | ||||
| -rw-r--r-- | data/zh_cn/cms/2016-09-22/api-docs.php | 1725 | ||||
| -rw-r--r-- | data/zh_cn/cms/2017-03-01/api-docs.php | 2547 | ||||
| -rw-r--r-- | data/zh_cn/cms/2017-08-24/api-docs.php | 505 | ||||
| -rw-r--r-- | data/zh_cn/cms/2018-03-08/api-docs.php | 12340 | ||||
| -rw-r--r-- | data/zh_cn/cms/2019-01-01/api-docs.php | 41518 | ||||
| -rw-r--r-- | data/zh_cn/cms/2024-03-30/api-docs.php | 23327 |
10 files changed, 84619 insertions, 0 deletions
diff --git a/data/zh_cn/cms/2015-04-20/api-docs.php b/data/zh_cn/cms/2015-04-20/api-docs.php new file mode 100644 index 0000000..0ab3fff --- /dev/null +++ b/data/zh_cn/cms/2015-04-20/api-docs.php @@ -0,0 +1,319 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2015-04-20', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeMetricDatum', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeMetricDatum' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'NextToken' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2015-08-01/api-docs.php b/data/zh_cn/cms/2015-08-01/api-docs.php new file mode 100644 index 0000000..abd6917 --- /dev/null +++ b/data/zh_cn/cms/2015-08-01/api-docs.php @@ -0,0 +1,896 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2015-08-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'BatchPutDimTableData', + 'BatchQueryMetric', + 'DescribeMetricList', + 'GetMetricStatistics', + 'ListProject', + 'QueryMetric', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'BatchPutDimTableData' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DimTableName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Body', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'BatchQueryMetric' => [ + 'summary' => 'BatchQueryMetric', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DescribeMetricList' => [ + 'summary' => '查询指标', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'GetMetricStatistics' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'NextToken' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'ListProject' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ProjectOwner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetric' => [ + 'summary' => '查询指标', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2015-10-20/api-docs.php b/data/zh_cn/cms/2015-10-20/api-docs.php new file mode 100644 index 0000000..7ffa0de --- /dev/null +++ b/data/zh_cn/cms/2015-10-20/api-docs.php @@ -0,0 +1,724 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2015-10-20', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeMetricDatum', + 'PutDimTableData', + 'QueryMetric', + 'QueryMetricList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeMetricDatum' => [ + 'summary' => 'DescribeMetricDatum', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'NextToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'PutDimTableData' => [ + 'summary' => 'PutDimTableData', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DimTableName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetric' => [ + 'summary' => 'QueryMetric', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetricList' => [ + 'summary' => 'QueryMetricList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Cursor' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Size' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2016-03-18/api-docs.php b/data/zh_cn/cms/2016-03-18/api-docs.php new file mode 100644 index 0000000..c6ff1de --- /dev/null +++ b/data/zh_cn/cms/2016-03-18/api-docs.php @@ -0,0 +1,718 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2016-03-18', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'PutDimTableData', + 'QueryEvent', + 'QueryMetricLast', + 'QueryMetricList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'PutDimTableData' => [ + 'summary' => '上传维表数据', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DimTableName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryEvent' => [ + 'summary' => 'QueryEvent', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OrderDesc', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'type' => 'string', + ], + 'NextToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetricLast' => [ + 'summary' => 'QueryMetricLast', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetricList' => [ + 'summary' => 'QueryMetricList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2016-09-22/api-docs.php b/data/zh_cn/cms/2016-09-22/api-docs.php new file mode 100644 index 0000000..0309926 --- /dev/null +++ b/data/zh_cn/cms/2016-09-22/api-docs.php @@ -0,0 +1,1725 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2016-09-22', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'GetMetricStatistics', + 'GetMetrics', + 'ListMetrics', + 'NodeAgentVersion', + 'NodeInstall', + 'NodeStatus', + 'PutDimTableData', + 'QueryEvent', + 'QueryMetric', + 'QueryMetricLast', + 'QueryMetricList', + 'QueryMetricTop', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetMetricStatistics' => [ + 'summary' => 'getmetricstatistics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'NextToken' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'GetMetrics' => [ + 'summary' => 'GetMetrics', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MetricStreamName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Result' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '404', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'ListMetrics' => [ + 'summary' => 'ListMetrics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项所属的项目名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_slb_dashboard', + ], + ], + [ + 'name' => 'MetricStreamName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项所属的stream名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'def_stream', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'InstanceActiveConnection', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。默认值:1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数,默认值:1000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'description' => '指标项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标项的定义信息。', + 'type' => 'string', + 'example' => ' {'."\n" + .' "id": 123456,'."\n" + .' "projectId": 789012,'."\n" + .' "projectName": "my-project",'."\n" + .' "metricStreamId": 345678,'."\n" + .' "metricStreamName": "ecs-stream",'."\n" + .' "metricName": "cpu_utilization",'."\n" + .' "fields": ['."\n" + .' {'."\n" + .' "name": "cpu_usage",'."\n" + .' "type": "DOUBLE"'."\n" + .' }'."\n" + .' ],'."\n" + .' "aggregates": ['."\n" + .' {'."\n" + .' "type": "AVG",'."\n" + .' "field": "cpu_usage"'."\n" + .' }'."\n" + .' ],'."\n" + .' "groupbys": [],'."\n" + .' "arithmetics": [],'."\n" + .' "tumblingwindows": [60],'."\n" + .' "timestamp": "2023-10-27T10:00:00Z",'."\n" + .' "gmtCreate": "2023-10-27T10:00:00Z",'."\n" + .' "gmtModified": "2023-10-27T10:00:00Z",'."\n" + .' "isPublic": 1,'."\n" + .' "status": 1,'."\n" + .' "type": 0'."\n" + .' }'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": \\"true\\",\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n \\" {\\\\n \\\\\\"id\\\\\\": 123456,\\\\n \\\\\\"projectId\\\\\\": 789012,\\\\n \\\\\\"projectName\\\\\\": \\\\\\"my-project\\\\\\",\\\\n \\\\\\"metricStreamId\\\\\\": 345678,\\\\n \\\\\\"metricStreamName\\\\\\": \\\\\\"ecs-stream\\\\\\",\\\\n \\\\\\"metricName\\\\\\": \\\\\\"cpu_utilization\\\\\\",\\\\n \\\\\\"fields\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"cpu_usage\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"DOUBLE\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"aggregates\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"AVG\\\\\\",\\\\n \\\\\\"field\\\\\\": \\\\\\"cpu_usage\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"groupbys\\\\\\": [],\\\\n \\\\\\"arithmetics\\\\\\": [],\\\\n \\\\\\"tumblingwindows\\\\\\": [60],\\\\n \\\\\\"timestamp\\\\\\": \\\\\\"2023-10-27T10:00:00Z\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": \\\\\\"2023-10-27T10:00:00Z\\\\\\",\\\\n \\\\\\"gmtModified\\\\\\": \\\\\\"2023-10-27T10:00:00Z\\\\\\",\\\\n \\\\\\"isPublic\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": 1,\\\\n \\\\\\"type\\\\\\": 0\\\\n }\\\\n\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询标签统计结果', + ], + 'NodeAgentVersion' => [ + 'summary' => 'NodeAgentVersion', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'TianjimonVersion' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeInstall' => [ + 'summary' => 'nodeinstall', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeStatus' => [ + 'summary' => '查询指定实例的云监控插件运行状态', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id', + 'type' => 'string', + 'required' => true, + 'example' => 'i-abcdefgh123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '插件运行状态', + 'type' => 'string', + 'example' => 'stopped', + ], + 'ErrorMessage' => [ + 'description' => '错误提示', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E14096E-68A1-4908-92D0-E5FC6408623A', + ], + 'AutoInstall' => [ + 'description' => '现有ECS主机是否自动安装云监控插件。取值:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码,200为成功', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceId' => [ + 'description' => '实例id', + 'type' => 'string', + 'example' => 'i-abcdefgh123456', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"stopped\\",\\n \\"ErrorMessage\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"9E14096E-68A1-4908-92D0-E5FC6408623A\\",\\n \\"AutoInstall\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"InstanceId\\": \\"i-abcdefgh123456\\"\\n}","type":"json"}]', + 'title' => '查询指定实例的云监控插件运行状态', + ], + 'PutDimTableData' => [ + 'summary' => '上传维表数据', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '当前接口限制了用户以及VPC访问', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DimTableName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryEvent' => [ + 'summary' => 'QueryEvent', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OrderDesc', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'type' => 'string', + ], + 'NextToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '', + ], + 'QueryMetric' => [ + 'summary' => 'QueryMetric', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetricLast' => [ + 'summary' => '查询指定监控对象的最新监控数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人。', + 'type' => 'string', + 'required' => false, + 'example' => '97u8ers', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的project,用于查询监控数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的时间间隔。单位:秒。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。'."\n" + ."\n\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"instanceId\\":\\"rm-3ns530d6ptf2w47m1\\"}', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数,用于分页查询。说明 单次请求Length的最大值为1440。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查出的现有结果进行时时计算的表达式,例如` {"groupby":["instanceId"]}`', + 'type' => 'string', + 'required' => false, + 'example' => '{"groupby":["userId","instanceId"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', + ], + 'Datapoints' => [ + 'description' => '监控数据列表,内容格式例如:{"timestamp":1423333,"maximum":100,"userid":"1234567898765432","minimum":4.55,"instanceid":"i-bp18abl200xk9599ck7c","average":93.84}', + 'type' => 'string', + 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]', + ], + 'Code' => [ + 'description' => '状态码,200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Period' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '查询最新监控数据', + ], + 'QueryMetricList' => [ + 'summary' => '查询一段时间内指定产品实例的监控数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人。', + 'type' => 'string', + 'required' => false, + 'example' => '97u8ers', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的project,用于查询监控数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的时间间隔。单位:秒。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。', + 'type' => 'string', + 'required' => false, + 'example' => '[{instanceId:\'rm-zf86h352r1ljuqp4r\'}]', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询出的现有结果进行时时计算的表达式,例如` {"groupby":["instanceId"]}`', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"groupby\\":[\\"instanceId\\"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', + ], + 'Datapoints' => [ + 'description' => '监控数据列表,内容格式例如:{"timestamp":1490164200000,"maximum":100,"userid":"1234567898765432","minimum":4.55,"instanceid":"i-bp18abl200xk9599ck7c","average":93.84}', + 'type' => 'string', + 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]', + ], + 'Code' => [ + 'description' => '状态码。返回200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Period' => [ + 'description' => '监控项的时间间隔。单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '查询产品实例监控数据', + ], + 'QueryMetricTop' => [ + 'summary' => 'QueryMetricTop', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Orderby', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OrderDesc', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2017-03-01/api-docs.php b/data/zh_cn/cms/2017-03-01/api-docs.php new file mode 100644 index 0000000..2f961f5 --- /dev/null +++ b/data/zh_cn/cms/2017-03-01/api-docs.php @@ -0,0 +1,2547 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2017-03-01', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateAlarm', + 'DeleteAlarm', + 'DescribeAlarms', + 'DisableAlarm', + 'EnableAlarm', + 'ListAlarm', + 'ListAlarmHistory', + 'NodeInstall', + 'NodeStatus', + 'NodeStatusList', + 'PutCustomMetric', + 'QueryMetricLast', + 'QueryMetricList', + 'UpdateAlarm', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateAlarm' => [ + 'summary' => 'CreateAlarm', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '300', + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '3', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '0', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '24', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '86400', + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteAlarm' => [ + 'summary' => 'DeleteAlarm', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DescribeAlarms' => [ + 'summary' => '查询告警信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组ID', + 'type' => 'string', + 'required' => false, + 'example' => '239758093', + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'description' => '分组的groupby。', + 'type' => 'string', + 'required' => false, + 'example' => 'product', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'EnableState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警的启用状态。取值:'."\n" + .'- true:启用。'."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间', + 'type' => 'string', + 'required' => false, + 'example' => 'default-aliyun', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '显示名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestAlarm1', + ], + ], + [ + 'name' => 'Names', + 'in' => 'query', + 'schema' => [ + 'description' => '报警名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'metricRuleTargets-20180308ofoa', + ], + ], + [ + 'name' => 'NameKeyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id。', + 'type' => 'string', + 'example' => '4D3907D7-F747-582F-9A08-D32362857B5F', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'TraceId' => [ + 'description' => '调用链ID。', + 'type' => 'string', + 'example' => '403F0D3A-30FB-5BB1-9F58-14704EA23DC0', + ], + 'Total' => [ + 'description' => '结果总数。', + 'type' => 'string', + 'example' => '23810', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警数组', + 'type' => 'array', + 'items' => [ + 'description' => '报警对象', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '显示名称', + 'type' => 'string', + 'example' => '过去5分钟的系统平均负载', + ], + 'MetricName' => [ + 'description' => '指标名称。', + 'type' => 'string', + 'example' => 'ResponseTime', + ], + 'EffectiveInterval' => [ + 'description' => '报警的生效时间范围。', + 'type' => 'string', + 'example' => '0:00-23:59', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警不生效的时间段。', + 'type' => 'string', + 'example' => '00:00-05:30', + ], + 'ComparisonOperator' => [ + 'description' => '比较符', + 'type' => 'string', + 'example' => 'LessThanLastWeek', + ], + 'Subject' => [ + 'description' => '告警标题', + 'type' => 'string', + 'example' => 'JHighSchool_Geography', + ], + 'Dimensions' => [ + 'description' => '维度。', + 'type' => 'string', + 'example' => '[{\\"instanceId\\":\\"i-2ze1f2hf4tda59jxrjim\\"}]', + ], + 'Name' => [ + 'description' => '报警名称。', + 'type' => 'string', + 'example' => 'yc-api-test-rule-black-0onik7', + ], + 'Resources' => [ + 'description' => '资源名称', + 'type' => 'string', + 'example' => '{\'Resource\': [{\'Category\': \'K8S_POD\', \'AliUid\': 1530662934927689, \'InstanceId\': \'7ca2a9eb-342d-11ee-a881-669fb70e3d81\', \'RegionId\': \'cn-hangzhou\', \'InstanceName\': \'logtail-fpftv\', \'Id\': 2881183319}]}', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '97', + ], + 'SilenceTime' => [ + 'description' => '静默时间。', + 'type' => 'string', + 'example' => '60', + ], + 'EvaluationCount' => [ + 'description' => '连续探测几次都满足阈值条件时报警。', + 'type' => 'string', + 'example' => '3', + ], + 'Webhook' => [ + 'description' => '触发报警回调的URL地址。', + 'type' => 'string', + 'example' => '{\\"method\\":\\"post\\",\\"url\\":\\"https://dns.console.aliyun.com/gtm/webhook/alarm.json?sign=860765935a01fef8f31ea384c11dabc7&aliUid=35160428\\"}', + ], + 'State' => [ + 'description' => '报警状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ContactGroups' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => '云账号报警联系人', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'acs_dts', + ], + 'Period' => [ + 'description' => '统计周期。', + 'type' => 'string', + 'example' => '60', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'DBS_EVENT_RULE', + ], + 'Uuid' => [ + 'description' => '报警UUID。', + 'type' => 'string', + 'example' => 'ddd4c5b6-38db-44fa-8ad0-7ce966efc0ba', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => '239954856', + ], + 'GroupName' => [ + 'description' => '分组名称。', + 'type' => 'string', + 'example' => 'monitor_group_2018_templateNameFail', + ], + 'Level' => [ + 'description' => '报警级别。', + 'type' => 'string', + 'example' => 'INFO', + ], + 'Enable' => [ + 'description' => '报警的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Statistics' => [ + 'description' => '统计信息。', + 'type' => 'string', + 'example' => 'Maximum', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D3907D7-F747-582F-9A08-D32362857B5F\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"TraceId\\": \\"403F0D3A-30FB-5BB1-9F58-14704EA23DC0\\",\\n \\"Total\\": \\"23810\\",\\n \\"Datapoints\\": {\\n \\"Alarm\\": [\\n {\\n \\"DisplayName\\": \\"过去5分钟的系统平均负载\\",\\n \\"MetricName\\": \\"ResponseTime\\",\\n \\"EffectiveInterval\\": \\"0:00-23:59\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"ComparisonOperator\\": \\"LessThanLastWeek\\",\\n \\"Subject\\": \\"JHighSchool_Geography\\",\\n \\"Dimensions\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2ze1f2hf4tda59jxrjim\\\\\\\\\\\\\\"}]\\",\\n \\"Name\\": \\"yc-api-test-rule-black-0onik7\\",\\n \\"Resources\\": \\"{\'Resource\': [{\'Category\': \'K8S_POD\', \'AliUid\': 1530662934927689, \'InstanceId\': \'7ca2a9eb-342d-11ee-a881-669fb70e3d81\', \'RegionId\': \'cn-hangzhou\', \'InstanceName\': \'logtail-fpftv\', \'Id\': 2881183319}]}\\",\\n \\"Threshold\\": \\"97\\",\\n \\"SilenceTime\\": \\"60\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Webhook\\": \\"{\\\\\\\\\\\\\\"method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"post\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://dns.console.aliyun.com/gtm/webhook/alarm.json?sign=860765935a01fef8f31ea384c11dabc7&aliUid=35160428\\\\\\\\\\\\\\"}\\",\\n \\"State\\": \\"OK\\",\\n \\"ContactGroups\\": \\"云账号报警联系人\\",\\n \\"Namespace\\": \\"acs_dts\\",\\n \\"Period\\": \\"60\\",\\n \\"RuleName\\": \\"DBS_EVENT_RULE\\",\\n \\"Uuid\\": \\"ddd4c5b6-38db-44fa-8ad0-7ce966efc0ba\\",\\n \\"GroupId\\": \\"239954856\\",\\n \\"GroupName\\": \\"monitor_group_2018_templateNameFail\\",\\n \\"Level\\": \\"INFO\\",\\n \\"Enable\\": true,\\n \\"Statistics\\": \\"Maximum\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询报警信息', + ], + 'DisableAlarm' => [ + 'summary' => 'DisableAlarm', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'EnableAlarm' => [ + 'summary' => 'EnableAlarm', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'ListAlarm' => [ + 'summary' => '查询指定或全部报警规则设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人。', + 'type' => 'string', + 'required' => false, + 'example' => 'user789', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的id。', + 'type' => 'string', + 'required' => false, + 'example' => 'A052CE0CC481AE6F8EE5BFDE8209E39229091623', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => '报警测试', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => [ + 'description' => '维度', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"clusterId\\":\\"C-9F308DAF783A80DF\\",\\"userId\\":\\"5654008347177444\\"}', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '报警状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'ok', + ], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用。取值范围:'."\n" + ."\n" + .'- true:已启用。'."\n" + .'- false:已停用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码,默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页,为空代表没有下一页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求ID,一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => 'DC4B526D-D522-59AA-85E2-B6118D4941DC', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求返回信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Total' => [ + 'description' => '符合条件数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'AlarmList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警列表', + 'type' => 'array', + 'items' => [ + 'description' => '报警对象', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '静默时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'MetricName' => [ + 'description' => '监控项的名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'EvaluationCount' => [ + 'description' => '连续探测几次都满足阈值条件时报警。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Webhook' => [ + 'description' => '触发报警回调的URL地址。', + 'type' => 'string', + 'example' => '{\\"method\\":\\"post\\",\\"url\\":\\"https://alidns-http-proxy.aliyuncs.com/api/gtm/alert/callback?sign=494b2a13b63a77def1b3b56d63b96d0a&aliUid=1763735399554991\\"}', + ], + 'State' => [ + 'description' => '报警状态。', + 'type' => 'string', + 'example' => 'ok', + ], + 'ContactGroups' => [ + 'description' => '报警联系组。', + 'type' => 'string', + 'example' => '云账号报警联系人,阿里_gccs告警', + ], + 'Namespace' => [ + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'acs_event_sys', + ], + 'Period' => [ + 'description' => '统计周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'EndTime' => [ + 'description' => '查询报警的结束时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2025-07-06T02:00:14Z', + ], + 'ComparisonOperator' => [ + 'description' => '比较符。', + 'type' => 'string', + 'example' => 'NotEqualToThreshold', + ], + 'StartTime' => [ + 'description' => '查询报警的起始时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2025-05-27T16:00:00Z', + ], + 'NotifyType' => [ + 'description' => '通知对象类型', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => '26519034', + ], + 'Dimensions' => [ + 'description' => '维度。', + 'type' => 'string', + 'example' => '[{instanceId:\'rm-zf83q02vh8r0bzr9c\'}]', + ], + 'Name' => [ + 'description' => '报警名称', + 'type' => 'string', + 'example' => 'emr测试集群CPU/内存报警静默', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Id' => [ + 'description' => '报警规则的id。', + 'type' => 'string', + 'example' => 'beec0d28-c81e-49f8-aa54-4fc1738be521', + ], + 'Enable' => [ + 'description' => '报警的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Statistics' => [ + 'description' => '报警统计。', + 'type' => 'string', + 'example' => 'Maximum', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"DC4B526D-D522-59AA-85E2-B6118D4941DC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Total\\": 27,\\n \\"AlarmList\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": 60,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": 3,\\n \\"Webhook\\": \\"{\\\\\\\\\\\\\\"method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"post\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://alidns-http-proxy.aliyuncs.com/api/gtm/alert/callback?sign=494b2a13b63a77def1b3b56d63b96d0a&aliUid=1763735399554991\\\\\\\\\\\\\\"}\\",\\n \\"State\\": \\"ok\\",\\n \\"ContactGroups\\": \\"云账号报警联系人,阿里_gccs告警\\",\\n \\"Namespace\\": \\"acs_event_sys\\",\\n \\"Period\\": 60,\\n \\"EndTime\\": 0,\\n \\"ComparisonOperator\\": \\"NotEqualToThreshold\\",\\n \\"StartTime\\": 0,\\n \\"NotifyType\\": 2,\\n \\"GroupId\\": \\"26519034\\",\\n \\"Dimensions\\": \\"[{instanceId:\'rm-zf83q02vh8r0bzr9c\'}]\\",\\n \\"Name\\": \\"emr测试集群CPU/内存报警静默\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Id\\": \\"beec0d28-c81e-49f8-aa54-4fc1738be521\\",\\n \\"Enable\\": true,\\n \\"Statistics\\": \\"Maximum\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询指定或全部报警规则设置', + ], + 'ListAlarmHistory' => [ + 'summary' => 'ListAlarmHistory', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Cursor' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'AlarmHistoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmHistory' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'EvaluationCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'State' => [ + 'type' => 'string', + ], + 'ContactGroups' => [ + 'type' => 'string', + ], + 'Namespace' => [ + 'type' => 'string', + ], + 'Dimension' => [ + 'type' => 'string', + ], + 'LastTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Value' => [ + 'type' => 'string', + ], + 'AlarmTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeInstall' => [ + 'summary' => 'NodeInstall', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeStatus' => [ + 'summary' => 'NodeStatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'AutoInstall' => [ + 'type' => 'boolean', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeStatusList' => [ + 'summary' => 'NodeStatusList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'NodeStatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeStatus' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'AutoInstall' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'PutCustomMetric' => [ + 'summary' => 'PutCustomMetric', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MetricList', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetricLast' => [ + 'summary' => '查询指定监控对象的最新监控数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人。', + 'type' => 'string', + 'required' => false, + 'example' => 'wn32reo1', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的project,用于查询监控数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '时间间隔。单位:秒。取值:60、300、900。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。', + 'type' => 'string', + 'required' => false, + 'example' => '{\'instanceId\': \'rm-bp12cn75qrjgpb9s5\'}', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '返回监控数据的每页大小,用于分页查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查出的现有结果进行时时计算的表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', + ], + 'RequestId' => [ + 'description' => '请求的ID,用于定位日志,排查问题。', + 'type' => 'string', + 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]', + ], + 'Code' => [ + 'description' => '状态码,200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Period' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '查询最新监控数据', + ], + 'QueryMetricList' => [ + 'summary' => '查询一段时间内指定产品实例的监控数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人。', + 'type' => 'string', + 'required' => false, + 'example' => 'urs879e', + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '名字空间,表明监控数据所属产品,如 “acs_ecs_dashboard”,“acs_rds_dashboard”等。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '时间间隔。单位:秒。取值:60、300、900。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间,可以传入距离1970年1月1日0点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。 ', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '可以传入距离1970年1月1日 0点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。 ', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId": "i-abcdefgh123456"}]', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询大小,用于分页查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询出的现有结果进行实时计算的表达式。目前仅支持groupby,类似数据库的groupby语句。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"groupby\\":[\\"instanceId\\"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', + ], + 'RequestId' => [ + 'description' => '请求的ID,用于定位日志,排查问题。', + 'type' => 'string', + 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]', + ], + 'Code' => [ + 'description' => '状态码,正常为"200"。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Period' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '查询产品实例监控数据', + ], + 'UpdateAlarm' => [ + 'summary' => 'UpdateAlarm', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'callby_cms_owner', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2017-08-24/api-docs.php b/data/zh_cn/cms/2017-08-24/api-docs.php new file mode 100644 index 0000000..9da8bd9 --- /dev/null +++ b/data/zh_cn/cms/2017-08-24/api-docs.php @@ -0,0 +1,505 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2017-08-24', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateTask', + 'GetAgentIspTrend', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'alertName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'taskId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'clientIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'taskName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'taskState', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'agentGroup', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'agentType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'reportProject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'address', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'interval', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ispCity', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'options', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'alertInfo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'alertRule', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ip', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 600 => [ + [ + 'errorCode' => 'IllegalAddress', + 'errorMessage' => 'Illegal HTTP address', + ], + ], + 605 => [ + [ + 'errorCode' => 'OperationError', + 'errorMessage' => 'Operation failed', + ], + ], + 615 => [ + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task does not exist', + ], + ], + 650 => [ + [ + 'errorCode' => 'OperatorInvalid', + 'errorMessage' => 'Operator invalid', + ], + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + ], + 655 => [ + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + ], + 660 => [ + [ + 'errorCode' => 'NameRepeat', + 'errorMessage' => 'Task name repeat', + ], + ], + 680 => [ + [ + 'errorCode' => 'CreateAlarmError', + 'errorMessage' => 'Create alarm error', + ], + ], + 695 => [ + [ + 'errorCode' => 'NameNotExists', + 'errorMessage' => 'Task name not exists', + ], + ], + ], + 'responseDemo' => '', + ], + 'GetAgentIspTrend' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'taskIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'type' => 'string', + ], + 'detail' => [ + 'type' => 'string', + ], + 'data' => [ + 'type' => 'string', + ], + 'msg' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2018-03-08/api-docs.php b/data/zh_cn/cms/2018-03-08/api-docs.php new file mode 100644 index 0000000..1cbbb6a --- /dev/null +++ b/data/zh_cn/cms/2018-03-08/api-docs.php @@ -0,0 +1,12340 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2018-03-08', + ], + 'directories' => [ + [ + 'id' => 59537, + 'title' => '云产品时序指标类监控数据', + 'type' => 'directory', + 'children' => [ + 'QueryMetricLast', + 'QueryMetricMeta', + 'QueryMetricList', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'AccessKeyGet', + 'AddMyGroupInstances', + 'CreateAlarm', + 'CreateMonitoringTemplate', + 'CreateMyGroups', + 'CreateTask', + 'DeleteAlarm', + 'DeleteCustomMetric', + 'DeleteMetricRuleTargets', + 'DeleteMetricRules', + 'DeleteMyGroupInstances', + 'DeleteMyGroups', + 'DeleteTasks', + 'DescribeAlarmHistory', + 'DescribeAlarms', + 'DescribeAlarmsForResources', + 'DescribeAlertHistoryList', + 'DescribeContact', + 'DescribeISPAreaCity', + 'DescribeMetricRuleList', + 'DescribeTaskDetail', + 'DescribeTasks', + 'DisableAlarm', + 'EnableAlarm', + 'GetContacts', + 'GetMonitoringTemplate', + 'GetMyGroups', + 'ListAlarm', + 'ListAlarmHistory', + 'ListContactGroup', + 'ListEventRules', + 'ListMyGroupInstances', + 'ListMyGroups', + 'ModifyTask', + 'NodeList', + 'NodeProcessCreate', + 'NodeProcesses', + 'NodeStatusList', + 'NodeUninstall', + 'PutCustomMetric', + 'PutEvent', + 'PutEventRule', + 'PutEventTargets', + 'PutMetricRuleTargets', + 'PutResourceMetricRule', + 'QueryCustomMetricList', + 'QueryMetricData', + 'QueryMetricTop', + 'QueryProjectMeta', + 'QueryStaticsAvailability', + 'QueryStaticsResponseTime', + 'QuerySystemEventCount', + 'QuerySystemEventDemo', + 'QueryTaskConfig', + 'QueryTaskMonitorData', + 'TaskConfigList', + 'UpdateAlarm', + 'UpdateMonitoringTemplate', + 'GetLogColumnTranslateResult', + 'GetLineSplitResult', + 'DeleteHybridDoubleWrite', + 'CreateHybridDoubleWrite', + 'DescribeHybridDoubleWrite', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'QueryMetricLast' => [ + 'summary' => '查询指定监控对象的最新监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '名字空间,表明监控数据所属产品,如 “acs_ecs_dashboard”,“acs_rds_dashboard”等 。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间,可以传入距离 1970 年 1 月 1 日 0 点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。 ', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。可以传入距离1970年1月1日0点的毫秒数,也可以传入format时间格式数据,如2015-10-2000:00:00。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。'."\n" + ."\n\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId":"XXX"}]', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询大小,用于分页查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查出的现有结果进行时时计算的表达式,例如` {"groupby":["instanceId"]}`', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"groupby\\":[\\"userId\\",\\"instanceId\\"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', + ], + 'RequestId' => [ + 'description' => '请求的ID,用于定位日志,排查问题。', + 'type' => 'string', + 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]', + ], + 'Code' => [ + 'description' => '状态码,200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Period' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Success\\": \\"true\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '查询指定监控对象最新监控数据', + ], + 'QueryMetricMeta' => [ + 'summary' => '查询云监控开放的时序类监控项的监控项描述。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '指标所属的Project,按等于匹配。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => '根据标签过滤,格式`[{"name":"标签名","value":"标签值"},{"name":"标签名","value":"标签值"}] `。'."\n" + .'已有的标签name说明: '."\n" + ."\n" + .'- MetricCategory:监控项分类的描述 '."\n" + .'- alertEnable:是否需要报警 '."\n" + .'- alertUnit:建议的报警单位 '."\n" + .'- unitFactor:单位转换系数 '."\n" + .'- minAlertPeriod:最小报警周期 '."\n" + .'- productCategory:产品类型分类 ', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"%\\"}]', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '指标名,按等于匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数,默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大数量,默认30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误码消息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '用于跟踪。', + 'type' => 'string', + 'example' => '0CCE0AF0-053C-4B13-A583-DC9A85785D49', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '状态码,200为成功,非200为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '返回的metric meta列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '监控项的描述。', + 'type' => 'string', + 'example' => 'ECS.CPUUtilization', + ], + 'Labels' => [ + 'description' => ' 监控项的标签,是一个json的string`[{"name":"标签名","value":"标签的值"}]`,可以是多个,name可以重复。'."\n" + .'已有的标签name说明: '."\n" + ."\n" + .'- metricCategory:指标分类 '."\n" + .'- alertEnable:是否可以报警 '."\n" + .'- alertUnit:报警单位 '."\n" + .'- unitFactor:单位转换系数 '."\n" + .'- minAlertPeriod:最小报警周期 '."\n" + .'- productCategory:产品 ', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"alertUnit\\",\\"value\\":\\"%\\"},{\\"name\\":\\"alertDefault\\",\\"value\\":\\"80\\"},{\\"name\\":\\"minAlertPeriod\\",\\"value\\":\\"60\\"},{\\"name\\":\\"metricCategory\\",\\"value\\":\\"instanceId\\"},{\\"name\\":\\"is_alarm\\",\\"value\\":\\"true\\"}]"', + ], + 'Unit' => [ + 'description' => '监控项的单位。', + 'type' => 'string', + 'example' => '%', + ], + 'Dimensions' => [ + 'description' => '监控项的Dimensions,多级用英文逗号分隔,例如:userId,instanceId', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Metric' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'CPUUtilization', + ], + 'Project' => [ + 'description' => '监控项的Project名称,用于查询监控数据。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Periods' => [ + 'description' => '监控项的所有统计周期,多个用英文逗号分隔:15,60,900', + 'type' => 'string', + 'example' => '60,300', + ], + 'Statistics' => [ + 'description' => '统计方法,多个用英文逗号分隔,例如:Maximum,Minimum,Average', + 'type' => 'string', + 'example' => 'Average,Minimum,Maximum', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"0CCE0AF0-053C-4B13-A583-DC9A85785D49\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"200\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Description\\": \\"ECS.CPUUtilization\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertUnit\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"%\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertDefault\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"80\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"minAlertPeriod\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"60\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metricCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"is_alarm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"}]\\\\\\"\\",\\n \\"Unit\\": \\"%\\",\\n \\"Dimensions\\": \\"instanceId\\",\\n \\"Metric\\": \\"CPUUtilization\\",\\n \\"Project\\": \\"acs_ecs_dashboard\\",\\n \\"Periods\\": \\"60,300\\",\\n \\"Statistics\\": \\"Average,Minimum,Maximum\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<QueryMetricMetaResponse>\\r\\n\\t<RequestId>60498C25-B5AE-48CD-B03D-207011F21E8A</RequestId>\\r\\n\\t<ErrorCode>200</ErrorCode>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Resources>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t<Labels>[{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"role"},{"name":"is_alarm","value":"true"}]</Labels>\\r\\n\\t\\t\\t<Metric>ActiveApplications</Metric>\\r\\n\\t\\t\\t<Dimensions>clusterId,role</Dimensions>\\r\\n\\t\\t\\t<Project>acs_hbase</Project>\\r\\n\\t\\t\\t<Periods>30,300</Periods>\\r\\n\\t\\t</Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t<Labels>[{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"role"},{"name":"is_alarm","value":"true"}]</Labels>\\r\\n\\t\\t\\t<Metric>ActiveApplications</Metric>\\r\\n\\t\\t\\t<Dimensions>clusterId,role</Dimensions>\\r\\n\\t\\t\\t<Project>acs_emr</Project>\\r\\n\\t\\t\\t<Periods>30,300,3600</Periods>\\r\\n\\t\\t</Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Description>端口当前活跃连接数</Description>\\r\\n\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t<Labels>[{"name":"alertUnit","value":"Count"},{"name":"minAlertPeriod","value":"60"},{"name":"metricCategory","value":"port"},{"name":"is_alarm","value":"true"}]</Labels>\\r\\n\\t\\t\\t<Metric>ActiveConnection</Metric>\\r\\n\\t\\t\\t<Dimensions>instanceId,port,protocol</Dimensions>\\r\\n\\t\\t\\t<Project>acs_slb_dashboard</Project>\\r\\n\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t<Unit>Count</Unit>\\r\\n\\t\\t</Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Description>高防IP活跃并发连接</Description>\\r\\n\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t<Labels>[{"name":"alertUnit","value":"count"},{"name":"minAlertPeriod","value":"60"}]</Labels>\\r\\n\\t\\t\\t<Metric>ActiveConnection</Metric>\\r\\n\\t\\t\\t<Dimensions>instanceId,ip</Dimensions>\\r\\n\\t\\t\\t<Project>acs_ddos</Project>\\r\\n\\t\\t\\t<Periods>30,60,300</Periods>\\r\\n\\t\\t\\t<Unit>count</Unit>\\r\\n\\t\\t</Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Description>活跃消息数</Description>\\r\\n\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t<Labels>[{"name":"alertUnit","value":"Count"},{"name":"minAlertPeriod","value":"300"},{"name":"metricCategory","value":"queue"},{"name":"is_alarm","value":"true"}]</Labels>\\r\\n\\t\\t\\t<Metric>ActiveMessages</Metric>\\r\\n\\t\\t\\t<Dimensions>region,queue</Dimensions>\\r\\n\\t\\t\\t<Project>acs_mns_new</Project>\\r\\n\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t<Unit>Count</Unit>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resources>\\r\\n\\t</QueryMetricMetaResponse>\\r\\n","errorExample":"\\n\\n{\\n\\"RequestId\\": \\"60498C25-B5AE-48CD-B03D-207011F21E8A\\",\\n\\"ErrorCode\\": 200,\\n\\"Success\\": true,\\n\\"Resources\\": {\\n\\"Resource\\": [\\n{\\n\\"Description\\": \\"\\",\\n\\"Statistics\\": \\"Average\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"role\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveApplications\\",\\n\\"Dimensions\\": \\"clusterId,role\\",\\n\\"Project\\": \\"acs_hbase\\",\\n\\"Periods\\": \\"30,300\\"\\n},\\n{\\n\\"Description\\": \\"\\",\\n\\"Statistics\\": \\"Average\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"role\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveApplications\\",\\n\\"Dimensions\\": \\"clusterId,role\\",\\n\\"Project\\": \\"acs_emr\\",\\n\\"Periods\\": \\"30,300,3600\\"\\n},\\n{\\n\\"Description\\": \\"端口当前活跃连接数\\",\\n\\"Statistics\\": \\"Average,Minimum,Maximum\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Count\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"port\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveConnection\\",\\n\\"Dimensions\\": \\"instanceId,port,protocol\\",\\n\\"Project\\": \\"acs_slb_dashboard\\",\\n\\"Periods\\": \\"60,300\\",\\n\\"Unit\\": \\"Count\\"\\n},\\n{\\n\\"Description\\": \\"高防IP活跃并发连接\\",\\n\\"Statistics\\": \\"Maximum\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveConnection\\",\\n\\"Dimensions\\": \\"instanceId,ip\\",\\n\\"Project\\": \\"acs_ddos\\",\\n\\"Periods\\": \\"30,60,300\\",\\n\\"Unit\\": \\"count\\"\\n},\\n{\\n\\"Description\\": \\"活跃消息数\\",\\n\\"Statistics\\": \\"Average,Minimum,Maximum\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Count\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Metric\\": \\"ActiveMessages\\",\\n\\"Dimensions\\": \\"region,queue\\",\\n\\"Project\\": \\"acs_mns_new\\",\\n\\"Periods\\": \\"300\\",\\n\\"Unit\\": \\"Count\\"\\n}\\n]\\n}\\n}"}]', + 'title' => '查询开放的时序类监控项的监控项描述', + 'description' => '通常配合查询监控项接口QueryMetricMeta和查询监控数据接口QueryProjectMeta/QueryMetricLast 一起使用。 '."\n" + .'##请求类型 '."\n" + .'POST|GET '."\n" + .' ', + ], + 'QueryMetricList' => [ + 'summary' => '查询一段时间内指定产品实例的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的project,用于查询监控数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间,可以传入距离1970年1月1日0点的毫秒数,也可以传入format时间格式数据,如2015-10-20 00:00:00。 ', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。支持的格式:Unix时间戳:从1970年1月1日开始所经过的毫秒数。Format格式:YYYY-MM-DDThh:mm:ssZ。 说明 StartTime和EndTime之间的间隔小于等于31天。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId": "i-abcdefgh123456"}]', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'required' => false, + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每次查询大小,用于分页查询。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询出的现有结果进行实时计算的表达式。目前仅支持groupby,类似数据库的groupby语句。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"groupby\\":[\\"instanceId\\"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0', + ], + 'RequestId' => [ + 'description' => '请求的ID,用于定位日志,排查问题。', + 'type' => 'string', + 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', + ], + 'Code' => [ + 'description' => '状态码,正常为"200"。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Period' => [ + 'description' => '时间间隔。单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Success\\": \\"true\\",\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"123\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abc\\\\\\",\\\\\\"Minimum\\\\\\":9.92,\\\\\\"Average\\\\\\":9.92,\\\\\\"Maximum\\\\\\":9.92}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Period\\": \\"60\\"\\n}","type":"json"}]', + 'title' => '查询产品实例监控数据', + ], + 'AccessKeyGet' => [ + 'summary' => 'AccessKeyGet', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SecretKey' => [ + 'type' => 'string', + ], + 'AccessKey' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'UserId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'AddMyGroupInstances' => [ + 'summary' => '添加个人分组内的资源实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '个人应用分组id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '93958859', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组的实例信息。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"instanceId\\":\\"f1c10843-a18f-11eb-b20e-f23797f49c09\\",\\"instanceName\\":\\"lvaccess-dahua-l2en6bwv1h9kx4r9-64fcd8cb6b-l975v\\",\\"category\\":\\"K8S_POD\\",\\"regionId\\":\\"cn-hangzhou\\"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8C397B67-530C-5074-8E5D-0076C6E3AA78', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:true:成功。false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '请求失败状态码,200为成功,非200为失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourcesOverLimit', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"8C397B67-530C-5074-8E5D-0076C6E3AA78\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200\\n}","type":"json"}]', + 'title' => '添加个人分组内的资源实例', + ], + 'CreateAlarm' => [ + 'summary' => '创建报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称,参考各产品对应的project,例如acs_ecs_dashboard, acs_rds_dashboard等 。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '相应产品对应的监控项名称,参考各产品metric定义。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则对应实例列表,为json array对应的string,例如`[{“instanceId”:”name1”},{“instanceId”:”name2”}]`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"instanceId":"i-2zecrzcri3d6fhd2ff7j "}]', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '查询指标的周期,必须与定义的metric一致,默认300,单位为秒 。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + 'default' => '300', + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => '统计方法,必须与定义的metric一致,例如Average。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Average', + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '报警比较符,只能为以下几种`<=,<,>,>=,==,!=`', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '>', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '报警阈值,目前只开放数值类型功能。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '90', + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => '连续探测几次都满足阈值条件时报警,默认3次。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'default' => '3', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则通知的联系组,必须在控制台上已创建,为json array对应的string,例如`[“联系组1”,”联系组2”]`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '["cms测试组"]', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效时间的开始时间,默认0,代表0点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效时间的结束时间,默认24,代表24点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + 'default' => '24', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '一直处于报警状态的通知沉默周期,默认86400,单位s,最小1小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + 'default' => '86400', + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '通知类型,为0是旺旺+邮件,为1是旺旺+邮件+短信。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '回调函数,只支持公网地址,回调参数请参考[使用报警回调](~~60714~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.net.cn/example_callback.htm', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要检查Webhook可用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '返回的报警规则id。', + 'type' => 'string', + 'example' => '0c4af0f1-a864-468b-bed3-15c7deff75ee', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志。', + 'type' => 'string', + 'example' => '910ABE4E-DC9D-4231-9DC0-C96835553327', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"0c4af0f1-a864-468b-bed3-15c7deff75ee\\",\\n \\"RequestId\\": \\"910ABE4E-DC9D-4231-9DC0-C96835553327\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"Data\\": \\"0c4af0f1-a864-468b-bed3-15c7deff75ee\\", \\n \\"RequestId\\": \\"910ABE4E-DC9D-4231-9DC0-C96835553327\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"<CreateAlarmResponse>\\n <Data>576fbae7-2fd1-411a-ae13-6f09f4fafdde</Data>\\n <RequestId>58C699ED-84BE-44D5-B55F-84AFE73932AB</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateAlarmResponse>","errorExample":"<CreateAlarmResponse>\\n <Data>576fbae7-2fd1-411a-ae13-6f09f4fafdde</Data>\\n <RequestId>58C699ED-84BE-44D5-B55F-84AFE73932AB</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateAlarmResponse>"}]', + 'title' => '创建报警规则', + 'description' => '可以为某一个实例创建报警规则,也可以为多个实例同时创建报警规则。', + ], + 'CreateMonitoringTemplate' => [ + 'summary' => '创建监控模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '监视模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Monitor_Template', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '模板命名空间,语义同metric master对外开放的命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard'."\n", + ], + ], + [ + 'name' => 'AlertTemplatesJson', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模版。', + 'type' => 'string', + 'required' => true, + 'example' => '{"rds":[{"displayName":"rds_rule_1111","category":"rds","namespace":"acs_rds_dashboard","metricName":"CpuUsage","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"98","times":3}}}],"ecs":[{"displayName":"ecs_rule1111","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_total","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":5}}},{"displayName":"ecs_rule2222","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_idle","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"89","times":4}}}],"mongodb":[{"displayName":"mongodb11","category":"mongodb","namespace":"acs_mongodb","metricName":"CPUUtilization","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"11111","times":3}}}],"mongodb_cluster":[{"displayName":"mongodb_cluster_t1","category":"mongodb_cluster","namespace":"acs_mongodb","metricName":"ShardingQPS","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999999","times":3}}}]}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '监视模板描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'SystemEventTemplates', + 'in' => 'query', + 'schema' => [ + 'description' => '系统事件模板。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]', + ], + ], + [ + 'name' => 'ProcessMonitorTemplates', + 'in' => 'query', + 'schema' => [ + 'description' => '进程监控模板。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"alert":{"comparisonOperator":"LessThanThreshold","escalationsLevel":"critical","silenceTime":0,"statistics":"Average","templateAlert":false,"threshold":"2","times":1},"matchExpress":{"filterRelation":"and","filters":[{"function":"all","name":"name","value":"*"}]},"processName":"FineBI"}]', + ], + ], + [ + 'name' => 'HostAvailabilityTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控模板。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"telnet","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"},{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"bbbbbbbbbb","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'InstanceIds is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78B915FD-01CA-5E38-8C4F-D3DC82598CE0', + ], + 'ErrorCode' => [ + 'description' => '错误码,200为成功,其他为失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '监视模板id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2224623', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"RequestId\\": \\"78B915FD-01CA-5E38-8C4F-D3DC82598CE0\\",\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"Id\\": 2224623\\n}","type":"json"}]', + 'title' => '创建监视模板', + ], + 'CreateMyGroups' => [ + 'summary' => '创建个人应用分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'monitor_group_2018_metric_ruleioaw', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '49****', + ], + ], + [ + 'name' => 'BindUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyun.com', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组。', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'schema' => [ + 'description' => '高级设置。', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A57FF18-32F1-5A95-97E0-8CD905DF417A', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '239811740', + ], + 'ErrorCode' => [ + 'description' => '错误码,200为成功,其他失败 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourcesOverLimit', + 'errorMessage' => 'Resources over limit.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3A57FF18-32F1-5A95-97E0-8CD905DF417A\\",\\n \\"GroupId\\": 239811740,\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建个人应用分组', + ], + 'CreateTask' => [ + 'summary' => '创建站点监控专业版任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '监控的地址,如 http://www.aliyun.com', + 'type' => 'string', + 'required' => true, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '1.http'."\n" + .'2.ping'."\n" + .'3.tcp'."\n" + .'4.udp'."\n" + .'5.dns'."\n" + .'6.smtp'."\n" + .'7.pop3'."\n" + .'8.ftp', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控的任务名4-50位中英文字符', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyunTest', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '探测频率,取值范围1、5、15,单位是分钟', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IspCity', + 'in' => 'query', + 'schema' => [ + 'description' => '探针的信息,需要从DescribeISPAreaCity 接口获得', + 'type' => 'string', + 'required' => true, + 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', + ], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'schema' => [ + 'description' => '监控对应协议的高级扩展选项', + 'type' => 'string', + 'required' => false, + 'example' => '{"http_method":"get","header":"xx=bb","cookie":"test=aa","time_out":30000,"match_rule":0,"response_content":"aa"}', + ], + ], + [ + 'name' => 'AlertRule', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'caller', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IntervalUnit', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态吗', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误或者成功的信息', + 'type' => 'string', + 'example' => 'successfull', + ], + 'AlertRule' => [ + 'type' => 'string', + ], + 'CreateResultList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'type' => 'string', + ], + 'TaskName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 600 => [ + [ + 'errorCode' => 'IllegalAddress', + 'errorMessage' => 'Illegal HTTP address', + ], + ], + 605 => [ + [ + 'errorCode' => 'OperationError', + 'errorMessage' => 'Operation failed', + ], + ], + 615 => [ + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task does not exist', + ], + ], + 650 => [ + [ + 'errorCode' => 'OperatorInvalid', + 'errorMessage' => 'Operator invalid', + ], + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + ], + 655 => [ + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + ], + 660 => [ + [ + 'errorCode' => 'NameRepeat', + 'errorMessage' => 'Task name repeat', + ], + ], + 680 => [ + [ + 'errorCode' => 'CreateAlarmError', + 'errorMessage' => 'Create alarm error', + ], + ], + 695 => [ + [ + 'errorCode' => 'NameNotExists', + 'errorMessage' => 'Task name not exists', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"a4e6f550-7eac-4a13-b11f-6742aa2d42d1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":"{\\n \\"Message\\": \\"请求失败\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"500\\"\\n}"},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建站点监控专业版任务', + 'description' => '用于创建一个站点监控任务', + ], + 'DeleteAlarm' => [ + 'summary' => '删除已创建的报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志', + 'type' => 'string', + 'example' => 'A9371CD8-369D-49FA-BED9-35050A0DC6A2', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"A9371CD8-369D-49FA-BED9-35050A0DC6A2\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlarmResponse>\\n <RequestId>A9371CD8-369D-49FA-BED9-35050A0DC6A2</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteAlarmResponse>","errorExample":"{\\n \\"RequestId\\": \\" A9371CD8-369D-49FA-BED9-35050A0DC6A2\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"}]', + 'title' => '删除监控告警', + ], + 'DeleteCustomMetric' => [ + 'summary' => 'DeleteCustomMetric', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'UUID', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Result' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteMetricRuleTargets' => [ + 'summary' => 'DeleteMetricRuleTargets', + 'methods' => [ + 'post', + 'get', + 'delete', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TargetIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'FailIds' => [ + 'type' => 'object', + 'properties' => [ + 'TargetIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetId' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteMetricRules' => [ + 'summary' => 'DeleteMetricRules', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'DeleteMyGroupInstances' => [ + 'summary' => 'deletemygroupinstances', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '个人分组id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '239847992', + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的实例ID列表', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'i-m5e0k0bexac8tykr****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '分类', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'InvalidAuthorization', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0857B44C-315F-5E40-AA6A-48096D1EB508', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。200为成功,其他失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"InvalidAuthorization\\",\\n \\"RequestId\\": \\"0857B44C-315F-5E40-AA6A-48096D1EB508\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200\\n}","type":"json"}]', + 'title' => '删除个人分组内的资源实例', + ], + 'DeleteMyGroups' => [ + 'summary' => '删除个人应用分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '174549092', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '107F0464-38F4-57F2-B1E0-237382F0FD72', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '状态码,200为成功,非200为失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Group' => [ + 'description' => '分组信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。', + 'type' => 'string', + 'example' => 'custom', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15055766', + ], + 'BindUrls' => [ + 'description' => '绑定URL', + 'type' => 'string', + 'example' => 'ehpc://i-dadfasdf/Login', + ], + 'ServiceId' => [ + 'description' => 'ServiceId', + 'type' => 'string', + 'example' => '1349', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警联系人的姓名。', + 'type' => 'string', + 'example' => 'xiaoming', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"107F0464-38F4-57F2-B1E0-237382F0FD72\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Group\\": {\\n \\"Type\\": \\"custom\\",\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"GroupId\\": 15055766,\\n \\"BindUrls\\": \\"ehpc://i-dadfasdf/Login\\",\\n \\"ServiceId\\": \\"1349\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"xiaoming\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '删除个人应用分组', + ], + 'DeleteTasks' => [ + 'summary' => '批量删除站点监控的任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控的任务Id,任务的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '["2b5e6f7d-108f-4117-85fb-b202ba033468"]', + 'docRequired' => true, + ], + ], + [ + 'name' => 'IsDeleteAlarms', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除任务关联的报警规则,默认值为1。'."\n" + ."\n" + .'1:同时删除报警规则'."\n" + .'0:不删除报警规则,只删除任务'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码消息', + 'type' => 'string', + 'example' => '请求成功', + ], + 'Data' => [ + 'description' => '返回信息'."\n", + 'type' => 'string', + 'example' => '{"count":1}', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task not exist', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": \\"{\\\\\\"count\\\\\\":1}\\",\\n \\"RequestId\\": \\"a4e6f550-7eac-4a13-b11f-6742aa2d42d1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '批量删除任务', + 'description' => '删除一个指定的站点监控任务', + ], + 'DescribeAlarmHistory' => [ + 'summary' => 'DescribeAlarmHistory', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AlertName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Ascending', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'OnlyCount', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Total' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'AlarmHistoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmHistory' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'EvaluationCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'State' => [ + 'type' => 'string', + ], + 'UserId' => [ + 'type' => 'string', + ], + 'PreLevel' => [ + 'type' => 'string', + ], + 'Namespace' => [ + 'type' => 'string', + ], + 'AlertName' => [ + 'type' => 'string', + ], + 'Webhooks' => [ + 'type' => 'string', + ], + 'RuleName' => [ + 'type' => 'string', + ], + 'LastTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Value' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'AlertTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'InstanceName' => [ + 'type' => 'string', + ], + 'Dimensions' => [ + 'type' => 'string', + ], + 'Level' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'string', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ContactALIIMs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactALIIM' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ContactMails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactMail' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ContactSmses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactSms' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError ', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '', + ], + 'DescribeAlarms' => [ + 'summary' => 'DescribeAlarms', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EnableState', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Names', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NameKeyword', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + 'Total' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'type' => 'string', + ], + 'MetricName' => [ + 'type' => 'string', + ], + 'EffectiveInterval' => [ + 'type' => 'string', + ], + 'NoEffectiveInterval' => [ + 'type' => 'string', + ], + 'ComparisonOperator' => [ + 'type' => 'string', + ], + 'Subject' => [ + 'type' => 'string', + ], + 'Dimensions' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Resources' => [ + 'type' => 'string', + ], + 'Threshold' => [ + 'type' => 'string', + ], + 'SilenceTime' => [ + 'type' => 'string', + ], + 'RuleType' => [ + 'type' => 'string', + ], + 'EvaluationCount' => [ + 'type' => 'string', + ], + 'Webhook' => [ + 'type' => 'string', + ], + 'State' => [ + 'type' => 'string', + ], + 'ContactGroups' => [ + 'type' => 'string', + ], + 'Namespace' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + 'RuleName' => [ + 'type' => 'string', + ], + 'Uuid' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'Level' => [ + 'type' => 'string', + ], + 'Enable' => [ + 'type' => 'boolean', + ], + 'Statistics' => [ + 'type' => 'string', + ], + 'Escalations' => [ + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'type' => 'string', + ], + 'PreCondition' => [ + 'type' => 'string', + ], + 'Times' => [ + 'type' => 'string', + ], + 'Threshold' => [ + 'type' => 'string', + ], + 'HistoryDataRange' => [ + 'type' => 'string', + ], + 'Statistics' => [ + 'type' => 'string', + ], + 'AlertSensitivity' => [ + 'type' => 'string', + ], + ], + ], + 'Warn' => [ + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'type' => 'string', + ], + 'PreCondition' => [ + 'type' => 'string', + ], + 'Times' => [ + 'type' => 'string', + ], + 'Threshold' => [ + 'type' => 'string', + ], + 'HistoryDataRange' => [ + 'type' => 'string', + ], + 'Statistics' => [ + 'type' => 'string', + ], + 'AlertSensitivity' => [ + 'type' => 'string', + ], + ], + ], + 'Critical' => [ + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'type' => 'string', + ], + 'PreCondition' => [ + 'type' => 'string', + ], + 'Times' => [ + 'type' => 'string', + ], + 'Threshold' => [ + 'type' => 'string', + ], + 'HistoryDataRange' => [ + 'type' => 'string', + ], + 'Statistics' => [ + 'type' => 'string', + ], + 'AlertSensitivity' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '', + ], + 'DescribeAlarmsForResources' => [ + 'summary' => 'describealarmsforresources', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'EnableState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的启用状态。取值:-true:启用。-false:禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的数据命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。 '."\n" + ."\n" + .'默认值:1 。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则状态。取值:'."\n" + .'- OK:正常。'."\n" + .'- ALARM:报警。'."\n" + .'- INSUFFICIENT_DATA:无数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', + 'type' => 'string', + 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Dimensions' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。', + 'type' => 'string', + 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'TraceId' => [ + 'description' => '调用链ID。', + 'type' => 'string', + 'example' => 'f1b83c3b-b6ea-4a4e-9087-b5752e7da052', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '22', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警规则对象的数组。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则对象。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '告警规则显示名称。', + 'type' => 'string', + 'example' => '磁盘使用率', + ], + 'SilenceTime' => [ + 'description' => '通道沉默时间。单位:秒。', + 'type' => 'string', + 'example' => '3600', + ], + 'MetricName' => [ + 'description' => '监控项名称', + 'type' => 'string', + 'example' => 'CPUUtilization', + ], + 'EvaluationCount' => [ + 'description' => '连续探测几次都满足阈值条件时报警。', + 'type' => 'string', + 'example' => '3', + ], + 'Webhook' => [ + 'description' => '报警发生时回调指定的URL地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb', + ], + 'State' => [ + 'description' => '报警状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ContactGroups' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => 'Server', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'example' => 'platform-acs-fc-metrics', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警规则不生效时间段。', + 'type' => 'string', + 'example' => '00:00-05:30', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间段。', + 'type' => 'string', + 'example' => '0:00-23:59', + ], + 'Period' => [ + 'description' => '监控数据的统计周期。', + 'type' => 'string', + 'example' => '60', + ], + 'ComparisonOperator' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanThreshold', + ], + 'Uuid' => [ + 'description' => '报警UUID。', + 'type' => 'string', + 'example' => 'abb18b9fc4ca45468a94763f24ddf898', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'edgeah-3ce900a3617747dcbd49cd7ff752b32a-iot-1wdrsc-ReplicaSet-lvmonitor-gf9bs0jt0dwdjlad-d6f999676', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '239757988', + ], + 'Subject' => [ + 'description' => '告警标题', + 'type' => 'string', + 'example' => 'Alibaba Cloud', + ], + 'Name' => [ + 'description' => '报警名称。', + 'type' => 'string', + 'example' => 'Ecs_Mem_Utilization', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '85', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + 'Resources' => [ + 'description' => '资源。', + 'type' => 'string', + 'example' => '[{\\"instanceId\\":\\"rmq-cn-o493nio5v0i\\",\\"userId\\":\\"1493622401794734\\"}]', + ], + 'Statistics' => [ + 'description' => 'Critical级别报警统计方法。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'example' => 'Average', + ], + 'Enable' => [ + 'description' => '报警的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Escalations' => [ + 'description' => '告警升级配置。', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'Info级别告警。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'example' => 'GreaterThanThreshold', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Info级别的阈值。', + 'type' => 'string', + 'example' => '99', + ], + 'Statistics' => [ + 'description' => '报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Warn' => [ + 'description' => 'warn级别告警。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Warn级别阈值的比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'LessThanOrEqualToThreshold', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'warn级别的阈值。', + 'type' => 'string', + 'example' => '100', + ], + 'Statistics' => [ + 'description' => '报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Critical' => [ + 'description' => 'Critical级别的告警。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => '阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'LessThanThreshold', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Critical级别的阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => '报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\",\\n \\"Success\\": true,\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp1cqhiw1za2****\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"TraceId\\": \\"f1b83c3b-b6ea-4a4e-9087-b5752e7da052\\",\\n \\"Total\\": \\"22\\",\\n \\"Datapoints\\": {\\n \\"Alarm\\": [\\n {\\n \\"DisplayName\\": \\"磁盘使用率\\",\\n \\"SilenceTime\\": \\"3600\\",\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Webhook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb\\",\\n \\"State\\": \\"OK\\",\\n \\"ContactGroups\\": \\"Server\\",\\n \\"Namespace\\": \\"platform-acs-fc-metrics\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"0:00-23:59\\",\\n \\"Period\\": \\"60\\",\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Uuid\\": \\"abb18b9fc4ca45468a94763f24ddf898\\",\\n \\"GroupName\\": \\"edgeah-3ce900a3617747dcbd49cd7ff752b32a-iot-1wdrsc-ReplicaSet-lvmonitor-gf9bs0jt0dwdjlad-d6f999676\\",\\n \\"GroupId\\": \\"239757988\\",\\n \\"Subject\\": \\"Alibaba Cloud\\",\\n \\"Name\\": \\"Ecs_Mem_Utilization\\",\\n \\"Threshold\\": \\"85\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rmq-cn-o493nio5v0i\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1493622401794734\\\\\\\\\\\\\\"}]\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": true,\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"99\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"LessThanOrEqualToThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"100\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"LessThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取资源警报', + ], + 'DescribeAlertHistoryList' => [ + 'summary' => '查询报警历史详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AlertName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'HighErrorRate', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Rule', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组id。', + 'type' => 'string', + 'required' => false, + 'example' => '35235226', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默状态。取值:'."\n" + .'- 2(默认值):通道沉默。'."\n" + .'- 0:报警或恢复。'."\n" + .'- 1:失效期。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '报警状态。取值:'."\n" + .'- ALARM(默认值):报警状态。'."\n" + .'- OK:正常状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'ok', + ], + ], + [ + 'name' => 'Ascending', + 'in' => 'query', + 'schema' => [ + 'description' => '时间排序。取值:true(默认值):表示时间倒序。false:表示时间正序。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OnlyCount', + 'in' => 'query', + 'schema' => [ + 'description' => '报警阈值是否满足条件。取值:-true:满足条件。-false:不满足条件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警的开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '1552209685596', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警的结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '1640608200000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'string', + 'example' => '2', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlarmHistoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmHistory' => [ + 'description' => '告警历史列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '报警状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'stopped', + ], + 'MetricName' => [ + 'description' => '监控项名称', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'EvaluationCount' => [ + 'description' => '连续探测几次都满足阈值条件时报警。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'State' => [ + 'description' => '报警状态。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'UserId' => [ + 'description' => '用户id', + 'type' => 'string', + 'example' => 'xxxxxx', + ], + 'PreLevel' => [ + 'description' => '上次告警级别', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'acs_vpc_eip', + ], + 'AlertName' => [ + 'description' => '告警名称。', + 'type' => 'string', + 'example' => '测评内测-数据库慢调用-低', + ], + 'Webhooks' => [ + 'description' => '报警发生时,回调的URL地址', + 'type' => 'string', + 'example' => '[\\"https://oapi.dingtalk.com/robot/send?access_token=cca17c14bbc6b81b35fdc7caa19fdda531b659eee2969cc35a6362e3b2d10c13\\"]', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'ecs 5分钟tcp连接数超过80%', + ], + 'LastTime' => [ + 'description' => '报警持续时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1744597658', + ], + 'Value' => [ + 'description' => '报警模板的标签值。', + 'type' => 'string', + 'example' => 'Server=tes-rds.infra.uat.altium365.com.cn%3BDatabase=tenant_directory%3BUid=ciiva%3BPwd=ZJJ6xvd!WeUjaVjvHWLU%3BAutoEnlist=False%3BSSLMode=None%3B', + ], + 'Expression' => [ + 'description' => '表达式。', + 'type' => 'string', + 'example' => '1', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => '239765677', + ], + 'AlertTime' => [ + 'description' => '发生报警的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552209685596', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'prd-sflocalizationapi-5855fd9d6d-8hhx9', + ], + 'Dimensions' => [ + 'description' => '维度。', + 'type' => 'string', + 'example' => '{\\"instanceId\\":\\"i-wz9fovee1h4jv7igaz8i\\"}', + ], + 'Level' => [ + 'description' => '报警级别。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Id' => [ + 'description' => '报警ID。', + 'type' => 'string', + 'example' => '3393FD4A10BD5723CD0DCFB4B25AC79928735672', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '联系人列表', + 'type' => 'array', + 'items' => [ + 'description' => '联系人', + 'type' => 'string', + 'example' => '185xxxx0307', + ], + ], + ], + ], + 'ContactALIIMs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactALIIM' => [ + 'description' => '阿里旺旺的联系人列表', + 'type' => 'array', + 'items' => [ + 'description' => '联系人的阿里旺旺', + 'type' => 'string', + 'example' => 'seller001', + ], + ], + ], + ], + 'ContactMails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactMail' => [ + 'description' => '邮箱的联系人列表', + 'type' => 'array', + 'items' => [ + 'description' => '联系人的邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'ContactSmses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactSms' => [ + 'description' => '短信的联系人列表', + 'type' => 'array', + 'items' => [ + 'description' => '联系人的手机号', + 'type' => 'string', + 'example' => '185xxxx0307', + ], + ], + ], + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => '开发运维报警组', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError ', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"C3C69FBE-2262-541F-A409-C52F380BAE63\\",\\n \\"Total\\": \\"2\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 0,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"Finished\\",\\n \\"UserId\\": \\"xxxxxx\\",\\n \\"PreLevel\\": \\"NORMAL\\",\\n \\"Namespace\\": \\"acs_vpc_eip\\",\\n \\"AlertName\\": \\"测评内测-数据库慢调用-低\\",\\n \\"Webhooks\\": \\"[\\\\\\\\\\\\\\"https://oapi.dingtalk.com/robot/send?access_token=cca17c14bbc6b81b35fdc7caa19fdda531b659eee2969cc35a6362e3b2d10c13\\\\\\\\\\\\\\"]\\",\\n \\"RuleName\\": \\"ecs 5分钟tcp连接数超过80%\\",\\n \\"LastTime\\": 1744597658,\\n \\"Value\\": \\"Server=tes-rds.infra.uat.altium365.com.cn%3BDatabase=tenant_directory%3BUid=ciiva%3BPwd=ZJJ6xvd!WeUjaVjvHWLU%3BAutoEnlist=False%3BSSLMode=None%3B\\",\\n \\"Expression\\": \\"1\\",\\n \\"GroupId\\": \\"239765677\\",\\n \\"AlertTime\\": 1552209685596,\\n \\"InstanceName\\": \\"prd-sflocalizationapi-5855fd9d6d-8hhx9\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-wz9fovee1h4jv7igaz8i\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": \\"NORMAL\\",\\n \\"Id\\": \\"3393FD4A10BD5723CD0DCFB4B25AC79928735672\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"185xxxx0307\\"\\n ]\\n },\\n \\"ContactALIIMs\\": {\\n \\"ContactALIIM\\": [\\n \\"seller001\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"[email protected]\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"185xxxx0307\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"开发运维报警组\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询报警历史详情', + ], + 'DescribeContact' => [ + 'summary' => '描述联系人', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人姓名。', + 'type' => 'string', + 'required' => true, + 'example' => 'SCRM报警群', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => '325232CF-6F24-513B-A55C-49B2071F72A3', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:true:成功。false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警联系人姓名。', + 'type' => 'string', + 'example' => 'hostName', + ], + 'Channels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Channel' => [ + 'description' => '报警推送渠道。', + 'type' => 'array', + 'items' => [ + 'description' => '订阅渠道。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '订阅类型', + 'type' => 'string', + 'example' => 'SMS', + ], + 'Value' => [ + 'description' => '值。', + 'type' => 'string', + 'example' => 'SMS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + [ + [ + 'errorCode' => 'InvalidAction', + 'errorMessage' => 'The specified GroupName does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"325232CF-6F24-513B-A55C-49B2071F72A3\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Name\\": \\"hostName\\",\\n \\"Channels\\": {\\n \\"Channel\\": [\\n {\\n \\"Type\\": \\"SMS\\",\\n \\"Value\\": \\"SMS\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取联系人信息', + ], + 'DescribeISPAreaCity' => [ + 'summary' => '获取站点监控的探测点。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISP名称或者Id', + 'type' => 'string', + 'required' => false, + 'example' => '阿里巴巴', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤出对应城市的探测点:如:杭州', + 'type' => 'string', + 'required' => false, + 'example' => '北京', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码消息', + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '[{\\"area\\":\\"华北\\",\\"areaCode\\":\\"159\\",\\"city\\":\\"呼和浩特市\\",\\"cityCode\\":\\"676\\",\\"cityIspCode\\":{\\"city\\":\\"676\\",\\"isp\\":\\"465\\"},\\"country\\":\\"中国\\",\\"countryCode\\":\\"629\\",\\"discard_count\\":0,\\"healthy\\":100,\\"idc_probe_count\\":2,\\"isp\\":\\"阿里巴巴\\",\\"ispCode\\":\\"465\\",\\"luyoubao_probe_count\\":0,\\"push_count\\":91093,\\"region\\":\\"内蒙古自治区\\",\\"regionCode\\":\\"87\\",\\"reportHealthy\\":100,\\"report_count\\":91136,\\"timestamp\\":1544609400716,\\"total_probe_count\\":2,\\"win_probe_count\\":0}]', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => '84C8BA48-7FD3-46F8-AEE3-E24657C22289', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"area\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"华北\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"areaCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"159\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"呼和浩特市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"676\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityIspCode\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"676\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"country\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"中国\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"countryCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"629\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"discard_count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"healthy\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"idc_probe_count\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"luyoubao_probe_count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"push_count\\\\\\\\\\\\\\":91093,\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"内蒙古自治区\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"regionCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"87\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"reportHealthy\\\\\\\\\\\\\\":100,\\\\\\\\\\\\\\"report_count\\\\\\\\\\\\\\":91136,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1544609400716,\\\\\\\\\\\\\\"total_probe_count\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"win_probe_count\\\\\\\\\\\\\\":0}]\\",\\n \\"RequestId\\": \\"84C8BA48-7FD3-46F8-AEE3-E24657C22289\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取探测点列表', + 'description' => '查询站点监控支持的探测点', + ], + 'DescribeMetricRuleList' => [ + 'summary' => '查询报警规则列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'EnableState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的启用状态。取值:'."\n" + .'- true:启用。'."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则状态。取值:'."\n" + .'- OK:正常。'."\n" + .'- ALARM:报警。'."\n" + .'- INSUFFICIENT_DATA:无数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则维度。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'该参数支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_CPU_Alarm', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'group-1234567890', + ], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则id列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'rule-1234567890,rule-2345678901', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'string', + 'example' => '96', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Alarms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警规则对象的数组。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则对象。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通知静默时间', + 'type' => 'string', + 'example' => '3600', + ], + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'Availability', + ], + 'Webhook' => [ + 'description' => '报警发生回调时指定的URL地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb', + ], + 'ContactGroups' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => 'test_monitor', + ], + 'SourceType' => [ + 'description' => '告警来源类型。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'MailSubject' => [ + 'description' => '邮件主题。', + 'type' => 'string', + 'example' => 'ECS CPU excessive usage rate', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警不生效的时间段。', + 'type' => 'string', + 'example' => '00:00-05:30', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间段。', + 'type' => 'string', + 'example' => '10:00-18:59', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'DefaultEventRule', + ], + 'AlertState' => [ + 'description' => '报警规则状态。取值:'."\n" + ."\n" + .'- OK:正常。'."\n" + ."\n" + .'- ALARM:报警。'."\n" + ."\n" + .'- INSUFFICIENT_DATA:无数据。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Period' => [ + 'description' => '监控数据的统计周期。'."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'rule-1234567890', + ], + 'GroupName' => [ + 'description' => '告警组名称。', + 'type' => 'string', + 'example' => 'ops_group', + ], + 'GroupId' => [ + 'description' => '告警组 ID。', + 'type' => 'string', + 'example' => 'group-1234567890', + ], + 'Dimensions' => [ + 'description' => '资源维度信息。', + 'type' => 'string', + 'example' => '{\'instanceId\': \'ts-2ze34h60m9pv0ck3v\'}', + ], + 'EnableState' => [ + 'description' => '报警规则的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resources' => [ + 'description' => '资源名称', + 'type' => 'string', + 'example' => '[{\\"instanceId\\": \\"i-bp17raa25u0rbg9xreti\\"}]', + ], + 'Escalations' => [ + 'description' => '告警升级策略对象。', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'Info级别对象。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'example' => 'GreaterThanThreshold', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => '报警阈值。'."\n" + .' ', + 'type' => 'string', + 'example' => '80', + ], + 'Statistics' => [ + 'description' => 'Info级别报警统计方法。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Warn' => [ + 'description' => 'Warn级别对象。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Warn级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'NotEqualToThreshold', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '70', + ], + 'Statistics' => [ + 'description' => 'Warn级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Critical' => [ + 'description' => 'Critical级别对象。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '85', + ], + 'Statistics' => [ + 'description' => 'Critical级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"386C6712-335F-5054-930A-CC92B851ECBA\\",\\n \\"Total\\": \\"96\\",\\n \\"Success\\": true,\\n \\"Alarms\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": \\"3600\\",\\n \\"MetricName\\": \\"Availability\\",\\n \\"Webhook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=54df4b27524b232ac4f745d14a099a63555826c71fe108b2233b1c1cca51e5cb\\",\\n \\"ContactGroups\\": \\"test_monitor\\",\\n \\"SourceType\\": \\"ecs\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MailSubject\\": \\"ECS CPU excessive usage rate\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"10:00-18:59\\",\\n \\"RuleName\\": \\"DefaultEventRule\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Period\\": \\"60\\",\\n \\"RuleId\\": \\"rule-1234567890\\",\\n \\"GroupName\\": \\"ops_group\\",\\n \\"GroupId\\": \\"group-1234567890\\",\\n \\"Dimensions\\": \\"{\'instanceId\': \'ts-2ze34h60m9pv0ck3v\'}\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"i-bp17raa25u0rbg9xreti\\\\\\\\\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"80\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"NotEqualToThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"70\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"85\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询报警规则列表', + ], + 'DescribeTaskDetail' => [ + 'summary' => '查询指定任务的配置详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控的任务Id,任务的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '339e0d96-2505-425f-a5c6-22e2c12f8fee', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码消息', + 'type' => 'string', + 'example' => '请求成功', + ], + 'Data' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '{\\"taskType\\":1,\\"address\\":\\"http://www.aliyun.com\\",\\"taskState\\":1,\\"ispCity\\":[{\\"city\\":\\"杭州市\\",\\"ispCode\\":\\"465\\",\\"cityCode\\":\\"546\\",\\"isp\\":\\"阿里巴巴\\",\\"citySpell\\":\\"hang2zhou1shi4\\",\\"ispSpell\\":\\"a1li3ba1ba1\\"},{\\"city\\":\\"青岛市\\",\\"ispCode\\":\\"465\\",\\"cityCode\\":\\"572\\",\\"isp\\":\\"阿里巴巴\\",\\"citySpell\\":\\"qing1dao3shi4\\",\\"ispSpell\\":\\"a1li3ba1ba1\\"},{\\"city\\":\\"北京市\\",\\"ispCode\\":\\"465\\",\\"cityCode\\":\\"738\\",\\"isp\\":\\"阿里巴巴\\",\\"citySpell\\":\\"bei3jing1shi4\\",\\"ispSpell\\":\\"a1li3ba1ba1\\"}],\\"alarms\\":[],\\"options\\":{\\"http_method\\":\\"get\\",\\"time_out\\":30000},\\"taskName\\":\\"江米测试2\\",\\"interval\\":1,\\"taskTypeName\\":\\"Http\\",\\"taskId\\":\\"339e0d96-2505-425f-a5c6-22e2c12f8fee\\"}"', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'a4e6f550-7eac-4a13-b11f-6742aa2d42d1', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 615 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Task Id does not exist', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"taskType\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"address\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://www.aliyun.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskState\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"ispCity\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"杭州市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"546\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"citySpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"hang2zhou1shi4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispSpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a1li3ba1ba1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"青岛市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"572\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"citySpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"qing1dao3shi4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispSpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a1li3ba1ba1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"738\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"citySpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bei3jing1shi4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispSpell\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"a1li3ba1ba1\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"alarms\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"options\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"http_method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"get\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"time_out\\\\\\\\\\\\\\":30000},\\\\\\\\\\\\\\"taskName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"江米测试2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"interval\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"taskTypeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Http\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"339e0d96-2505-425f-a5c6-22e2c12f8fee\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"RequestId\\": \\"a4e6f550-7eac-4a13-b11f-6742aa2d42d1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询任务详情', + 'description' => '查询指定任务的配置详情', + ], + 'DescribeTasks' => [ + 'summary' => '查询站点监控的任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控的任务Id,任务的唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => '18b0c27f-bab3-441d-a747-9cdcaa8bbac8', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务的类型,取值分别为1-8,各个值代表的如下 1.HTTP 2.PING 3.TCP 4.UDP 5.DNS 6.SMTP 7.POP3 8.FTP', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '要搜索的关键词,模糊查询监控监控点名称和地址', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码,默认值为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数,默认值为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '[{\\"shared\\":false,\\"taskType\\":1,\\"address\\":\\"http://www.aliyunq.com\\",\\"taskState\\":1,\\"createTime\\":\\"2018-04-01 16:46:53\\",\\"options\\":{\\"http_method\\":\\"get\\",\\"match_rule\\":0,\\"time_out\\":30000},\\"taskName\\":\\"站点监控demo\\",\\"interval\\":1,\\"taskTypeName\\":\\"Http\\",\\"taskId\\":\\"18b0c27f-bab3-441d-a747-9cdcaa8bbac8\\",\\"ts\\":\\"2018-12-12 15:55:12\\"}]', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => '6A46B8E4-D39E-4DB5-B422-231410654E8E', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误码消息', + 'type' => 'string', + 'example' => '请求成功', + ], + 'PageSize' => [ + 'description' => '分页条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '14', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"shared\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"taskType\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"address\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http://www.aliyunq.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskState\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"createTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-04-01 16:46:53\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"options\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"http_method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"get\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"match_rule\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"time_out\\\\\\\\\\\\\\":30000},\\\\\\\\\\\\\\"taskName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"站点监控demo\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"interval\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"taskTypeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Http\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"18b0c27f-bab3-441d-a747-9cdcaa8bbac8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ts\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-12-12 15:55:12\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"6A46B8E4-D39E-4DB5-B422-231410654E8E\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 14\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询指定任务对应的信息', + 'description' => '查询所有站点监控任务', + ], + 'DisableAlarm' => [ + 'summary' => '禁用报警规则。报警规则停止后,将停止探测关联实例的监控项数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志。', + 'type' => 'string', + 'example' => 'DEF01F10-E747-42FE-9152-85CB43B1B552', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"DEF01F10-E747-42FE-9152-85CB43B1B552\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"RequestId\\": \\"DEF01F10-E747-42FE-9152-85CB43B1B552\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"<DisableAlarmResponse>\\n <RequestId>CF9F20A2-D4CF-4FA0-B8A3-1F4C151B3C91</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DisableAlarmResponse>","errorExample":"<DisableAlarmResponse>\\n <RequestId>CF9F20A2-D4CF-4FA0-B8A3-1F4C151B3C91</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DisableAlarmResponse>"}]', + 'title' => '禁用报警规则', + 'description' => '报警规则停止后,将停止探测关联实例的监控项数据。', + ], + 'EnableAlarm' => [ + 'summary' => '启动报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志', + 'type' => 'string', + 'example' => '1C5E0E5D-76D5-469C-9FA8-D74799B24860', + ], + 'Success' => [ + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1C5E0E5D-76D5-469C-9FA8-D74799B24860\\",\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"RequestId\\": \\"1C5E0E5D-76D5-469C-9FA8-D74799B24860\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"<EnableAlarmResponse>\\n <RequestId>1B77FA9C-4E5A-4DF9-82CB-0E898C9FDA2F</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</EnableAlarmResponse>","errorExample":"<EnableAlarmResponse>\\n <RequestId>1B77FA9C-4E5A-4DF9-82CB-0E898C9FDA2F</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</EnableAlarmResponse>"}]', + 'title' => '启用报警规则', + 'description' => '当您的报警规则处于停止状态时,可以使用此接口启用报警规则。', + ], + 'GetContacts' => [ + 'summary' => '获取联系人', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'rabb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'FF66C10B-AA35-58FD-BD30-8CE1B275BA44', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + .'* true:成功。'."\n" + .'* false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '数据点。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'rabb', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '联系人列表', + 'type' => 'array', + 'items' => [ + 'description' => '联系人。', + 'type' => 'string', + 'example' => '188xxxx7155', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FF66C10B-AA35-58FD-BD30-8CE1B275BA44\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Name\\": \\"rabb\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"188xxxx7155\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取联系人', + ], + 'GetMonitoringTemplate' => [ + 'summary' => '获取监视模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '监控模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ft20180308_templateNameFail', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '监控模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2203505', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'InstanceIds is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '578B4400-4EF1-5A73-90A1-2EDE29B781AD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '状态码,200为成功,非200为失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Resource' => [ + 'description' => '模版资源信息', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '模板描述。', + 'type' => 'string', + 'example' => 'ECS模板', + ], + 'SystemEventTemplates' => [ + 'description' => '系统事件模板。', + 'type' => 'string', + 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]', + ], + 'AlertTemplatesJson' => [ + 'description' => '报警模版。', + 'type' => 'string', + 'example' => '{"rds":[{"displayName":"rds_rule_1111","category":"rds","namespace":"acs_rds_dashboard","metricName":"CpuUsage","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"98","times":3}}}],"ecs":[{"displayName":"ecs_rule1111","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_total","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":5}}},{"displayName":"ecs_rule2222","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_idle","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"89","times":4}}}],"mongodb":[{"displayName":"mongodb11","category":"mongodb","namespace":"acs_mongodb","metricName":"CPUUtilization","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"11111","times":3}}}],"mongodb_cluster":[{"displayName":"mongodb_cluster_t1","category":"mongodb_cluster","namespace":"acs_mongodb","metricName":"ShardingQPS","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999999","times":3}}}]}', + ], + 'Namespace' => [ + 'description' => '模板命名空间,语义同metric master对外开放的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'ProcessMonitorTemplates' => [ + 'description' => '进程监控模板', + 'type' => 'string', + 'example' => '[{"alert":{"comparisonOperator":"LessThanThreshold","escalationsLevel":"critical","silenceTime":0,"statistics":"Average","templateAlert":false,"threshold":"2","times":1},"matchExpress":{"filterRelation":"and","filters":[{"function":"all","name":"name","value":"*"}]},"processName":"FineBI"}]', + ], + 'HostAvailabilityTemplate' => [ + 'description' => '可用性监控模板', + 'type' => 'string', + 'example' => '[{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"telnet","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"},{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"bbbbbbbbbb","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"}]', + ], + 'RestVersion' => [ + 'description' => '数据版本号', + 'type' => 'string', + 'example' => '1', + ], + 'Name' => [ + 'description' => '模版名称', + 'type' => 'string', + 'example' => 'ECS_Template1', + ], + 'Id' => [ + 'description' => '模版ID', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"RequestId\\": \\"578B4400-4EF1-5A73-90A1-2EDE29B781AD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Resource\\": {\\n \\"Description\\": \\"ECS模板\\",\\n \\"SystemEventTemplates\\": \\"[{\\\\\\"alertName\\\\\\":\\\\\\"WAF_Event\\\\\\",\\\\\\"description\\\\\\":\\\\\\"WAF_Event\\\\\\",\\\\\\"eventPattern\\\\\\":{\\\\\\"eventType\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"levelList\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"nameList\\\\\\":[\\\\\\"*\\\\\\"],\\\\\\"product\\\\\\":\\\\\\"waf\\\\\\"},\\\\\\"fcParameterList\\\\\\":[],\\\\\\"mnsParameterList\\\\\\":[],\\\\\\"notifyLevel\\\\\\":3,\\\\\\"slsParameterList\\\\\\":[],\\\\\\"webhookParameterList\\\\\\":[]}]\\",\\n \\"AlertTemplatesJson\\": \\"{\\\\\\"rds\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"rds_rule_1111\\\\\\",\\\\\\"category\\\\\\":\\\\\\"rds\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_rds_dashboard\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"CpuUsage\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"99\\\\\\",\\\\\\"times\\\\\\":3},\\\\\\"warn\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"98\\\\\\",\\\\\\"times\\\\\\":3}}}],\\\\\\"ecs\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"ecs_rule1111\\\\\\",\\\\\\"category\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"cpu_total\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"99\\\\\\",\\\\\\"times\\\\\\":5}}},{\\\\\\"displayName\\\\\\":\\\\\\"ecs_rule2222\\\\\\",\\\\\\"category\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"cpu_idle\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"9999\\\\\\",\\\\\\"times\\\\\\":3},\\\\\\"warn\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"89\\\\\\",\\\\\\"times\\\\\\":4}}}],\\\\\\"mongodb\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"mongodb11\\\\\\",\\\\\\"category\\\\\\":\\\\\\"mongodb\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_mongodb\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"CPUUtilization\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"11111\\\\\\",\\\\\\"times\\\\\\":3}}}],\\\\\\"mongodb_cluster\\\\\\":[{\\\\\\"displayName\\\\\\":\\\\\\"mongodb_cluster_t1\\\\\\",\\\\\\"category\\\\\\":\\\\\\"mongodb_cluster\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"acs_mongodb\\\\\\",\\\\\\"metricName\\\\\\":\\\\\\"ShardingQPS\\\\\\",\\\\\\"selector\\\\\\":{},\\\\\\"escalations\\\\\\":{\\\\\\"critical\\\\\\":{\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"comparisonOperator\\\\\\":\\\\\\"GreaterThanOrEqualToThreshold\\\\\\",\\\\\\"threshold\\\\\\":\\\\\\"9999999\\\\\\",\\\\\\"times\\\\\\":3}}}]}\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"ProcessMonitorTemplates\\": \\"[{\\\\\\"alert\\\\\\":{\\\\\\"comparisonOperator\\\\\\":\\\\\\"LessThanThreshold\\\\\\",\\\\\\"escalationsLevel\\\\\\":\\\\\\"critical\\\\\\",\\\\\\"silenceTime\\\\\\":0,\\\\\\"statistics\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"templateAlert\\\\\\":false,\\\\\\"threshold\\\\\\":\\\\\\"2\\\\\\",\\\\\\"times\\\\\\":1},\\\\\\"matchExpress\\\\\\":{\\\\\\"filterRelation\\\\\\":\\\\\\"and\\\\\\",\\\\\\"filters\\\\\\":[{\\\\\\"function\\\\\\":\\\\\\"all\\\\\\",\\\\\\"name\\\\\\":\\\\\\"name\\\\\\",\\\\\\"value\\\\\\":\\\\\\"*\\\\\\"}]},\\\\\\"processName\\\\\\":\\\\\\"FineBI\\\\\\"}]\\",\\n \\"HostAvailabilityTemplate\\": \\"[{\\\\\\"alert\\\\\\":{\\\\\\"escalationList\\\\\\":[{\\\\\\"aggregate\\\\\\":\\\\\\"Value\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetStatus\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"400\\\\\\"},{\\\\\\"aggregate\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetLatency\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"notifyType\\\\\\":1,\\\\\\"silenceTime\\\\\\":86400},\\\\\\"taskName\\\\\\":\\\\\\"telnet\\\\\\",\\\\\\"taskOption\\\\\\":{\\\\\\"method\\\\\\":\\\\\\"HEAD\\\\\\",\\\\\\"negative\\\\\\":true,\\\\\\"resposeCharset\\\\\\":\\\\\\"utf-8\\\\\\",\\\\\\"uri\\\\\\":\\\\\\"telnet://xxx.com\\\\\\"},\\\\\\"taskType\\\\\\":\\\\\\"TELNET\\\\\\"},{\\\\\\"alert\\\\\\":{\\\\\\"escalationList\\\\\\":[{\\\\\\"aggregate\\\\\\":\\\\\\"Value\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetStatus\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"400\\\\\\"},{\\\\\\"aggregate\\\\\\":\\\\\\"Average\\\\\\",\\\\\\"metric\\\\\\":\\\\\\"TelnetLatency\\\\\\",\\\\\\"operator\\\\\\":\\\\\\">\\\\\\",\\\\\\"times\\\\\\":3,\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"notifyType\\\\\\":1,\\\\\\"silenceTime\\\\\\":86400},\\\\\\"taskName\\\\\\":\\\\\\"bbbbbbbbbb\\\\\\",\\\\\\"taskOption\\\\\\":{\\\\\\"method\\\\\\":\\\\\\"HEAD\\\\\\",\\\\\\"negative\\\\\\":true,\\\\\\"resposeCharset\\\\\\":\\\\\\"utf-8\\\\\\",\\\\\\"uri\\\\\\":\\\\\\"telnet://xxx.com\\\\\\"},\\\\\\"taskType\\\\\\":\\\\\\"TELNET\\\\\\"}]\\",\\n \\"RestVersion\\": \\"1\\",\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"Id\\": \\"123\\"\\n }\\n}","type":"json"}]', + 'title' => '获取监视模板', + ], + 'GetMyGroups' => [ + 'summary' => '获取个人应用分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '239765766', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + [ + 'name' => 'SelectContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回报警联系组。取值:-true:是。-false(默认值):否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-hp3hl3cx1pbahzy8****', + ], + ], + [ + 'name' => 'BindUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定URL', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc://i-dadfasdf/Login', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ECA294F7-7408-5069-B260-4896967D5131', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。200为成功,其他失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Group' => [ + 'description' => '应用分组信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。', + 'type' => 'string', + 'example' => 'custom', + ], + 'BindUrl' => [ + 'description' => '绑定URL', + 'type' => 'string', + 'example' => 'ehpc://i-dadfasdf/Login', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'GroupId' => [ + 'description' => '应用分组id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '58789173', + ], + 'ServiceId' => [ + 'description' => 'ServiceId', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'eds', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警联系人的姓名。', + 'type' => 'string', + 'example' => 'name', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + [ + 'errorCode' => 'UniqueResult', + 'errorMessage' => 'The query condition does not return the only result.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"ECA294F7-7408-5069-B260-4896967D5131\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"Group\\": {\\n \\"Type\\": \\"custom\\",\\n \\"BindUrl\\": \\"ehpc://i-dadfasdf/Login\\",\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"GroupId\\": 58789173,\\n \\"ServiceId\\": 0,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"name\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取个人应用分组', + ], + 'ListAlarm' => [ + 'summary' => '查询指定或全部报警规则设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的id。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称,支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '报警测试', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称,参考各产品对应的project,例如 acs_ecs_dashboard, acs_rds_dashboard等 。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => [ + 'description' => '规则关联的实例信息,为json object对应的字符串,例如{"instanceId":"name1"}。可以查询用于查询关联该实例的所有规则,应用该字段时必须指定Namespace。', + 'type' => 'string', + 'required' => false, + 'example' => '{"instanceId":"XXX"}', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则状态, ALARM, INSUFFICIENT_DATA,OK', + 'type' => 'string', + 'required' => false, + 'example' => 'ok', + ], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'true为启用,false为禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码,默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数,默认值:100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页,为空代表没有下一页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志。', + 'type' => 'string', + 'example' => 'EFD27F56-5799-4CE8-B625-56DF3332331C', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Total' => [ + 'description' => '符合条件数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'AlarmList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警规则详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '一直处于报警的沉默周期,单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '86400', + ], + 'MetricName' => [ + 'description' => '报警规则对应的监控项。', + 'type' => 'string', + 'example' => 'CPUUtilization', + ], + 'EvaluationCount' => [ + 'description' => '连续探测几次都满足阈值条件时报警,默认3次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Webhook' => [ + 'description' => '回调函数,只支持公网地址,回调参数请参考[使用报警回调](~~60714~~)。', + 'type' => 'string', + 'example' => 'null', + ], + 'State' => [ + 'description' => '报警规则的状态,有一个实例报警就是ALARM,所有都没数据是INSUFFICIENT_DATA,其它情况为OK。', + 'type' => 'string', + 'example' => 'ok', + ], + 'ContactGroups' => [ + 'description' => '通知的联系组,为json array对应的string,如`[“联系组1”,”联系组2”]`。', + 'type' => 'string', + 'example' => '["test4nudou"]', + ], + 'Namespace' => [ + 'description' => '报警规则对应的产品。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Period' => [ + 'description' => '查询指标的周期,单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'EndTime' => [ + 'description' => '生效时间的结束时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'ComparisonOperator' => [ + 'description' => '比较符', + 'type' => 'string', + 'example' => '>', + ], + 'StartTime' => [ + 'description' => '生效时间的开始时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotifyType' => [ + 'description' => '通知类型,值为0是旺旺+邮件,值为1是旺旺+邮件+短信。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Dimensions' => [ + 'description' => '报警规则关联的实例列表,为json array对应的字符串,例如`[{"instanceId":"name1"},{"instanceId":"name2"}]`。', + 'type' => 'string', + 'example' => '["{\\"instanceId\\":\\" i-abcdefgh123456\\"}"]', + ], + 'Name' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => '报警测试', + ], + 'Threshold' => [ + 'description' => '阈值', + 'type' => 'string', + 'example' => '90', + ], + 'Id' => [ + 'description' => '报警规则id。', + 'type' => 'string', + 'example' => 'i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf', + ], + 'Enable' => [ + 'description' => '该规则是否启用,true为启动。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Statistics' => [ + 'description' => '统计方法,例如Average、Maximum、Minimum。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"EFD27F56-5799-4CE8-B625-56DF3332331C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Total\\": 27,\\n \\"AlarmList\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": 86400,\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"EvaluationCount\\": 3,\\n \\"Webhook\\": \\"null\\",\\n \\"State\\": \\"ok\\",\\n \\"ContactGroups\\": \\"[\\\\\\"test4nudou\\\\\\"]\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Period\\": 300,\\n \\"EndTime\\": 24,\\n \\"ComparisonOperator\\": \\">\\",\\n \\"StartTime\\": 0,\\n \\"NotifyType\\": 0,\\n \\"Dimensions\\": \\"[\\\\\\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" i-abcdefgh123456\\\\\\\\\\\\\\"}\\\\\\"]\\",\\n \\"Name\\": \\"报警测试\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Id\\": \\"i-2ze3w55tr2rcpejpcfap_72071739-396b-497d-849c-59a73de44bcf\\",\\n \\"Enable\\": true,\\n \\"Statistics\\": \\"Average\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"NextToken\\": 2, \\n \\"RequestId\\": \\"EFD27F56-5799-4CE8-B625-56DF3332331C\\", \\n \\"AlarmList\\": {\\n \\"Alarm\\": [\\n {\\n \\"Period\\": 300, \\n \\"Statistics\\": \\"Average\\", \\n \\"Name\\": \\"ecs_cpu_total\\", \\n \\"MetricName\\": \\"cpu_total\\", \\n \\"State\\": \\"OK\\", \\n \\"Threshold\\": \\"90\\", \\n \\"Enable\\": true, \\n \\"SilenceTime\\": 86400, \\n \\"NotifyType\\": 1, \\n \\"Dimensions\\": \\"[\\\\\\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" i-abcdefgh123456\\\\\\\\\\\\\\"}\\\\\\"]\\", \\n \\"Namespace\\": \\"acs_ecs_dashboard\\", \\n \\"ContactGroups\\": \\"[\\\\\\"test4nudou\\\\\\"]\\", \\n \\"Id\\": \\"putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b\\", \\n \\"EndTime\\": 24, \\n \\"StartTime\\": 0, \\n \\"ComparisonOperator\\": \\">=\\"\\n }, \\n {\\n \\"Period\\": 300, \\n \\"Statistics\\": \\"Average\\", \\n \\"Name\\": \\"ecs_diskusage_utilization\\", \\n \\"MetricName\\": \\"diskusage_utilization\\", \\n \\"State\\": \\"OK\\", \\n \\"Threshold\\": \\"90\\", \\n \\"Enable\\": true, \\n \\"SilenceTime\\": 86400, \\n \\"NotifyType\\": 1, \\n \\"Dimensions\\": \\"[\\\\\\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\" i-abcdefgh123456\\\\\\\\\\\\\\"}\\\\\\"]\\", \\n \\"Namespace\\": \\"acs_ecs_dashboard\\", \\n \\"ContactGroups\\": \\"[\\\\\\"test4nudou\\\\\\"]\\", \\n \\"Id\\": \\"putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc\\", \\n \\"EndTime\\": 24, \\n \\"StartTime\\": 0, \\n \\"ComparisonOperator\\": \\">=\\"\\n }\\n ]\\n }, \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\", \\n \\"Total\\": 27\\n}"},{"type":"xml","example":"<ListAlarmResponse>\\n <NextToken>2</NextToken>\\n <RequestId>CC2CDD2B-4EA5-43CD-BEE3-758E93C36B7F</RequestId>\\n <AlarmList>\\n <Alarm>\\n <Period>300</Period>\\n <Statistics>Average</Statistics>\\n <Name>ecs_cpu_total</Name>\\n <MetricName>cpu_total</MetricName>\\n <State>OK</State>\\n <Threshold>90</Threshold>\\n <Enable>true</Enable>\\n <SilenceTime>86400</SilenceTime>\\n <NotifyType>1</NotifyType>\\n <Dimensions>[\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]</Dimensions>\\n <Namespace>acs_ecs_dashboard</Namespace>\\n <ContactGroups>[\\"test4nudou\\"]</ContactGroups>\\n <Id>putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b</Id>\\n <EndTime>24</EndTime>\\n <StartTime>0</StartTime>\\n <ComparisonOperator>>=</ComparisonOperator>\\n </Alarm>\\n <Alarm>\\n <Period>300</Period>\\n <Statistics>Average</Statistics>\\n <Name>ecs_diskusage_utilization</Name>\\n <MetricName>diskusage_utilization</MetricName>\\n <State>OK</State>\\n <Threshold>90</Threshold>\\n <Enable>true</Enable>\\n <SilenceTime>86400</SilenceTime>\\n <NotifyType>1</NotifyType>\\n <Dimensions>[\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]</Dimensions>\\n <Namespace>acs_ecs_dashboard</Namespace>\\n <ContactGroups>[\\"test4nudou\\"]</ContactGroups>\\n <Id>putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc</Id>\\n <EndTime>24</EndTime>\\n <StartTime>0</StartTime>\\n <ComparisonOperator>>=</ComparisonOperator>\\n </Alarm>\\n </AlarmList>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Total>27</Total>","errorExample":"<ListAlarmResponse>\\n <NextToken>2</NextToken>\\n <RequestId>CC2CDD2B-4EA5-43CD-BEE3-758E93C36B7F</RequestId>\\n <AlarmList>\\n <Alarm>\\n <Period>300</Period>\\n <Statistics>Average</Statistics>\\n <Name>ecs_cpu_total</Name>\\n <MetricName>cpu_total</MetricName>\\n <State>OK</State>\\n <Threshold>90</Threshold>\\n <Enable>true</Enable>\\n <SilenceTime>86400</SilenceTime>\\n <NotifyType>1</NotifyType>\\n <Dimensions>[\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]</Dimensions>\\n <Namespace>acs_ecs_dashboard</Namespace>\\n <ContactGroups>[\\"test4nudou\\"]</ContactGroups>\\n <Id>putNewAlarm_group_e8da18b9-bc95-4edf-a8bf-159eb6c8286b</Id>\\n <EndTime>24</EndTime>\\n <StartTime>0</StartTime>\\n <ComparisonOperator>>=</ComparisonOperator>\\n </Alarm>\\n <Alarm>\\n <Period>300</Period>\\n <Statistics>Average</Statistics>\\n <Name>ecs_diskusage_utilization</Name>\\n <MetricName>diskusage_utilization</MetricName>\\n <State>OK</State>\\n <Threshold>90</Threshold>\\n <Enable>true</Enable>\\n <SilenceTime>86400</SilenceTime>\\n <NotifyType>1</NotifyType>\\n <Dimensions>[\\"{\\\\\\"instanceId\\\\\\":\\\\\\" i-abcdefgh123456\\\\\\"}\\"]</Dimensions>\\n <Namespace>acs_ecs_dashboard</Namespace>\\n <ContactGroups>[\\"test4nudou\\"]</ContactGroups>\\n <Id>putNewAlarm_group_3233eba5-0dd4-4e80-a5d5-7399dec3d7cc</Id>\\n <EndTime>24</EndTime>\\n <StartTime>0</StartTime>\\n <ComparisonOperator>>=</ComparisonOperator>\\n </Alarm>\\n </AlarmList>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Total>27</Total>"}]', + 'title' => '查询指定或全部报警规则设置', + ], + 'ListAlarmHistory' => [ + 'summary' => '查询指定或全部报警规则设置历史。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的id。', + 'type' => 'string', + 'required' => false, + 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数,默认值:100。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据开始时间,默认24小时前,可以输入long型时间,也可以输入yyyy-MM-dd HH:mm:ss类型时间 ', + 'type' => 'string', + 'required' => false, + 'example' => '1548913091223', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据结束时间,默认当前时间,可以输入long型时间,也可以输入yyyy-MM-dd HH:mm:ss类型时间', + 'type' => 'string', + 'required' => false, + 'example' => '1548927491223', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数据的起始位置,为空则按时间查询前100条', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败。 ', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Cursor' => [ + 'description' => '下一页数据,为空代表没有下一页。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志。', + 'type' => 'string', + 'example' => '1DBBCE29-0F69-435C-B65C-53D1011D1D72', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlarmHistoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmHistory' => [ + 'description' => '报警历史详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '通知发送状态,0为已通知用户,1为不在生效期未通知,2为处于报警沉默期未通知。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'CPUUtilization', + ], + 'EvaluationCount' => [ + 'description' => '连续探测几次都满足阈值条件时报警。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'State' => [ + 'description' => '报警规则状态,有OK,ALARM,INSUFFICIENT_DATA三种状态。 ', + 'type' => 'string', + 'example' => 'ALARM', + ], + 'ContactGroups' => [ + 'description' => '发出的报警通知的通知对象,json array对应的字符串,例如`[“联系组1”:”联系组2”]`,只有通知状态为0才有该字段。 ', + 'type' => 'string', + 'example' => '["DB组"]', + ], + 'Namespace' => [ + 'description' => '产品的名称。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Dimension' => [ + 'description' => '报警规则对应实例,为json object对应的字符串,例如{“instance”:”name1”}。', + 'type' => 'string', + 'example' => '{"instanceId":"XXX"}', + ], + 'LastTime' => [ + 'description' => '报警持续时间,单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2851651669', + ], + 'Value' => [ + 'description' => '报警的当前值。', + 'type' => 'string', + 'example' => '84401454', + ], + 'AlarmTime' => [ + 'description' => '报警发生的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1548926982000', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test-demo', + ], + 'Name' => [ + 'description' => '报警规则的名称。', + 'type' => 'string', + 'example' => '报警测试', + ], + 'Id' => [ + 'description' => '报警规则的id。', + 'type' => 'string', + 'example' => '1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Cursor\\": \\"1\\",\\n \\"RequestId\\": \\"1DBBCE29-0F69-435C-B65C-53D1011D1D72\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2,\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"ALARM\\",\\n \\"ContactGroups\\": \\"[\\\\\\"DB组\\\\\\"]\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Dimension\\": \\"{\\\\\\"instanceId\\\\\\":\\\\\\"XXX\\\\\\"}\\",\\n \\"LastTime\\": 2851651669,\\n \\"Value\\": \\"84401454\\",\\n \\"AlarmTime\\": 1548926982000,\\n \\"InstanceName\\": \\"test-demo\\",\\n \\"Name\\": \\"报警测试\\",\\n \\"Id\\": \\"1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2, \\n \\"Value\\": \\"{\\\\\\"Maximum\\\\\\":301,\\\\\\"Minimum\\\\\\":301}\\", \\n \\"MetricName\\": \\"http.status_groupbyinstanceid#60\\", \\n \\"State\\": \\"ALARM\\", \\n \\"LastTime\\": 122088, \\n \\"AlarmTime\\": 1489568222088, \\n \\"Namespace\\": \\"acs_sitemonitor\\", \\n \\"ContactGroups\\": \\"null\\", \\n \\"Id\\": \\"1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\", \\n \\"EvaluationCount\\": 3\\n }, \\n {\\n \\"Status\\": 0, \\n \\"Value\\": \\"{\\\\\\"Maximum\\\\\\":301,\\\\\\"Minimum\\\\\\":301}\\", \\n \\"MetricName\\": \\"http.status_groupbyinstanceid#60\\", \\n \\"State\\": \\"ALARM\\", \\n \\"LastTime\\": 62078, \\n \\"AlarmTime\\": 1489568162078, \\n \\"Namespace\\": \\"acs_sitemonitor\\", \\n \\"ContactGroups\\": \\"[\\\\\\"云账号报警联系人\\\\\\"]\\", \\n \\"Id\\": \\"1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed\\", \\n \\"EvaluationCount\\": 3\\n }\\n ]\\n }, \\n \\"RequestId\\": \\"1DBBCE29-0F69-435C-B65C-53D1011D1D72\\", \\n \\"Success\\": true, \\n \\"Code\\": \\"200\\"\\n}"},{"type":"xml","example":"<ListAlarmHistoryResponse>\\n <AlarmHistoryList>\\n <AlarmHistory>\\n <Status>2</Status>\\n <Value>{\\"Maximum\\":301,\\"Minimum\\":301}</Value>\\n <MetricName>http.status_groupbyinstanceid#60</MetricName>\\n <State>ALARM</State>\\n <LastTime>122088</LastTime>\\n <AlarmTime>1489568222088</AlarmTime>\\n <Namespace>acs_sitemonitor</Namespace>\\n <ContactGroups>null</ContactGroups>\\n <Id>1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed</Id>\\n <EvaluationCount>3</EvaluationCount>\\n </AlarmHistory>\\n <AlarmHistory>\\n <Status>0</Status>\\n <Value>{\\"Maximum\\":301,\\"Minimum\\":301}</Value>\\n <MetricName>http.status_groupbyinstanceid#60</MetricName>\\n <State>ALARM</State>\\n <LastTime>62078</LastTime>\\n <AlarmTime>1489568162078</AlarmTime>\\n <Namespace>acs_sitemonitor</Namespace>\\n <ContactGroups>[\\"云账号报警联系人\\"]</ContactGroups>\\n <Id>1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed</Id>\\n <EvaluationCount>3</EvaluationCount>\\n </AlarmHistory>\\n </AlarmHistoryList>\\n <RequestId>7E7A6173-EC07-43A1-ABBF-1F05EBB4C2BB</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ListAlarmHistoryResponse>","errorExample":"<ListAlarmHistoryResponse>\\n <AlarmHistoryList>\\n <AlarmHistory>\\n <Status>2</Status>\\n <Value>{\\"Maximum\\":301,\\"Minimum\\":301}</Value>\\n <MetricName>http.status_groupbyinstanceid#60</MetricName>\\n <State>ALARM</State>\\n <LastTime>122088</LastTime>\\n <AlarmTime>1489568222088</AlarmTime>\\n <Namespace>acs_sitemonitor</Namespace>\\n <ContactGroups>null</ContactGroups>\\n <Id>1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed</Id>\\n <EvaluationCount>3</EvaluationCount>\\n </AlarmHistory>\\n <AlarmHistory>\\n <Status>0</Status>\\n <Value>{\\"Maximum\\":301,\\"Minimum\\":301}</Value>\\n <MetricName>http.status_groupbyinstanceid#60</MetricName>\\n <State>ALARM</State>\\n <LastTime>62078</LastTime>\\n <AlarmTime>1489568162078</AlarmTime>\\n <Namespace>acs_sitemonitor</Namespace>\\n <ContactGroups>[\\"云账号报警联系人\\"]</ContactGroups>\\n <Id>1a775e37-dfba-430c-ab9f-7036475c8bfb_2dbe619b-0483-402e-9437-7c7a38fba7ed</Id>\\n <EvaluationCount>3</EvaluationCount>\\n </AlarmHistory>\\n </AlarmHistoryList>\\n <RequestId>7E7A6173-EC07-43A1-ABBF-1F05EBB4C2BB</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ListAlarmHistoryResponse>"}]', + 'title' => '查询报警历史', + ], + 'ListContactGroup' => [ + 'summary' => '查询云账号下对应的报警规则联系人组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页,为空代表无数据', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'D3D03B0A-CF1A-4DAB-BF0D-D4B6ACD5677A', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Total' => [ + 'description' => '符合条件数据总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => '云账号报警联系人', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => 'Internal Server Error', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => 'Service Unavailable', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": 2,\\n \\"RequestId\\": \\"D3D03B0A-CF1A-4DAB-BF0D-D4B6ACD5677A\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Total\\": 2,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"云账号报警联系人\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询云账号下对应的报警规则联系人组', + ], + 'ListEventRules' => [ + 'summary' => '获取事件规则列表', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组id。', + 'type' => 'string', + 'required' => false, + 'example' => '239933048', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页,为空代表没有下一页。', + 'type' => 'string', + 'example' => '2', + ], + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求Id,用于排查问题', + 'type' => 'string', + 'example' => 'fd54aeca-cfb1-4900-a417-3d30de11cbb9', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Total' => [ + 'description' => '符合条件数据总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '101', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventRule' => [ + 'description' => '事件规则的列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'Exception', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'helloworld', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => '239677374', + ], + 'Name' => [ + 'description' => '事件报警规则名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'State' => [ + 'description' => '事件报警规则状态。取值:'."\n" + ."\n" + .'- ENABLED:启用。'."\n" + ."\n" + .'- DISABLED:禁用。', + 'type' => 'string', + 'example' => 'disabled', + ], + 'EventPattern' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventPattern' => [ + 'description' => '事件报警规则模式的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则模式。', + 'type' => 'object', + 'properties' => [ + 'Product' => [ + 'description' => '产品名称', + 'type' => 'string', + 'example' => 'RDS', + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => '事件报警类型的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警类型。', + 'type' => 'string', + 'example' => 'Alert', + ], + ], + ], + ], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => '事件报警规则级别的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件的等级。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + ."\n" + .'- WARN:警告。'."\n" + ."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + ], + ], + ], + 'StatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StatusList' => [ + 'description' => '事件状态的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件状态。', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => '事件名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'Instance:LiveMigrationAcrossDDH', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'ResourceNotFound', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"2\\",\\n \\"CurrentPage\\": 1,\\n \\"RequestId\\": \\"fd54aeca-cfb1-4900-a417-3d30de11cbb9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Total\\": 101,\\n \\"Datapoints\\": {\\n \\"EventRule\\": [\\n {\\n \\"EventType\\": \\"Exception\\",\\n \\"Description\\": \\"helloworld\\",\\n \\"GroupId\\": \\"239677374\\",\\n \\"Name\\": \\"test\\",\\n \\"State\\": \\"disabled\\",\\n \\"EventPattern\\": {\\n \\"EventPattern\\": [\\n {\\n \\"Product\\": \\"RDS\\",\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"Alert\\"\\n ]\\n },\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"CRITICAL\\"\\n ]\\n },\\n \\"StatusList\\": {\\n \\"StatusList\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"Instance:LiveMigrationAcrossDDH\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取事件规则列表', + ], + 'ListMyGroupInstances' => [ + 'summary' => '列出我的组实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Total', + 'in' => 'query', + 'schema' => [ + 'description' => '总记录条数。', + 'type' => 'boolean', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '4728420', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '分类', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID列表', + 'type' => 'string', + 'required' => false, + 'example' => 'i-hp3dunahluwajv6f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1B43E02C-8794-5E8A-9F8C-3874DF7AF03F', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'InstanceIds is mandatory for this action.', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '请求失败状态码,200为成功,非200为失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '资源列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源对象', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'teacher-redis-online', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Category' => [ + 'description' => '分类', + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'rm-bp1e012cy94o85355', + ], + 'Id' => [ + 'description' => '资源ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RegionId' => [ + 'description' => '实例对应的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B43E02C-8794-5E8A-9F8C-3874DF7AF03F\\",\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"InstanceName\\": \\"teacher-redis-online\\",\\n \\"AliUid\\": 123,\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"rm-bp1e012cy94o85355\\",\\n \\"Id\\": 123,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '列出我的组实例', + ], + 'ListMyGroups' => [ + 'summary' => '列举个人应用分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + [ + 'name' => 'SelectContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回报警联系组。取值:-true:是。-false(默认值):否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-m5e0k0bexac8tykr****', + ], + ], + [ + 'name' => 'BindUrls', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定URL', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc://i-dadfasdf/Login', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'fc_monitor_group_2018_ctNameFail', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '996A6748-2F6F-561F-971A-BB5928B24F3C', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'InstanceIds is mandatory for this action.', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。200为成功,其他失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '个人应用分组列表', + 'type' => 'array', + 'items' => [ + 'description' => '个人应用分组列表', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。', + 'type' => 'string', + 'example' => 'custom', + ], + 'BindUrl' => [ + 'description' => '绑定URL', + 'type' => 'string', + 'example' => 'ehpc://i-dadfasdf/Login', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '236889260', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'monitor_group_2018_metric_rulebemd', + ], + 'BindUrls' => [ + 'description' => '绑定URL', + 'type' => 'string', + 'example' => '["ehpc://i-dadfasdf/Login"]', + ], + 'ServiceId' => [ + 'description' => 'ServiceId', + 'type' => 'string', + 'example' => 'service-9b7395c020ae4e16825d', + ], + 'GmtCreate' => [ + 'description' => '创建应用分组的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2017-08-09 16:09:41', + ], + 'GmtModified' => [ + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2017-08-09 16:09:41', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警联系组的名称。', + 'type' => 'string', + 'example' => 'contact_group_01', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"996A6748-2F6F-561F-971A-BB5928B24F3C\\",\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Type\\": \\"custom\\",\\n \\"BindUrl\\": \\"ehpc://i-dadfasdf/Login\\",\\n \\"GroupId\\": 236889260,\\n \\"GroupName\\": \\"monitor_group_2018_metric_rulebemd\\",\\n \\"BindUrls\\": \\"[\\\\\\"ehpc://i-dadfasdf/Login\\\\\\"]\\",\\n \\"ServiceId\\": \\"service-9b7395c020ae4e16825d\\",\\n \\"GmtCreate\\": 0,\\n \\"GmtModified\\": 0,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"contact_group_01\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '列举个人应用分组', + ], + 'ModifyTask' => [ + 'summary' => '修改站点监控的探测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '地址', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.******', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8f880e3d-d924-47ab-84d2-fa1a72e24211', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyunTest', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '探测频率,单位是分钟, 取值范围1、5、15,默认值为1', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IspCity', + 'in' => 'query', + 'schema' => [ + 'description' => '探针的信息,需要从DescribeISPAreaCity 接口获得', + 'type' => 'string', + 'required' => false, + 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', + ], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'schema' => [ + 'description' => '监控对应协议的高级扩展选项', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"dns_type\\":\\"A\\",\\"expect_value\\":\\"171.222.205.250\\",\\"match_rule\\":\\"DNS_IN\\"}', + ], + ], + [ + 'name' => 'AlertRule', + 'in' => 'query', + 'schema' => [ + 'description' => '创建/修改任务的时候同时设置报警规则,格式为jsonArray,例如'."\n" + .'\\[{"alarmActions":["xxx"],"metricName":"Availability","expression":"$Availability<96"}]'."\n" + ."\n" + .'alarmActions:对应的报警联系组 '."\n" + ."\n" + .'metricName:对应的监控项,可以取值为Availability(可用探测点百分比), AvailableNumber(可用探测点数)', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + ], + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => [ + 'description' => '直接关联已经存在等报警规则, 这里直接写报警规则Id,多个用规则用逗号分割', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'caller', + 'in' => 'query', + 'schema' => [ + 'description' => '记录调用api的产品方,默认为云监控,您无需填写该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + [ + 'name' => 'IntervalUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '监控频率的单位。该参数需要与Interval配合使用,例如:该参数设置为ms,Interval最小设置为15000(15秒)。取值: s:秒。ms:毫秒。说明 您必须开通秒级监控,才能使用该参数。关于如何开通秒级监控,请参见开通企业云监控。', + 'type' => 'string', + 'required' => false, + 'example' => 'ms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'Data' => [ + 'description' => '返回信息', + 'type' => 'string', + 'example' => '[]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F3F87581-3656-5805-975B-3003699091AE', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 600 => [ + [ + 'errorCode' => 'IllegalAddress', + 'errorMessage' => 'Illegal HTTP address', + ], + ], + 605 => [ + [ + 'errorCode' => 'OperationError', + 'errorMessage' => 'Operation failed', + ], + ], + 615 => [ + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task does not exist', + ], + ], + 650 => [ + [ + 'errorCode' => 'OperatorInvalid', + 'errorMessage' => 'Operator invalid', + ], + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + ], + 655 => [ + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + ], + 660 => [ + [ + 'errorCode' => 'NameRepeat', + 'errorMessage' => 'Task name repeat', + ], + ], + 680 => [ + [ + 'errorCode' => 'CreateAlarmError', + 'errorMessage' => 'Create alarm error', + ], + ], + 695 => [ + [ + 'errorCode' => 'NameNotExists', + 'errorMessage' => 'Task name not exists', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"F3F87581-3656-5805-975B-3003699091AE\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '修改任务', + ], + 'NodeList' => [ + 'summary' => 'NodeList', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SerialNumbers', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceRegionId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'PageTotal' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Node' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => [ + 'type' => 'string', + ], + 'NatIp' => [ + 'type' => 'string', + ], + 'HostName' => [ + 'type' => 'string', + ], + 'AliUid' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'NetworkType' => [ + 'type' => 'string', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'AliyunHost' => [ + 'type' => 'boolean', + ], + 'EipAddress' => [ + 'type' => 'string', + ], + 'IpGroup' => [ + 'type' => 'string', + ], + 'EipId' => [ + 'type' => 'string', + ], + 'TianjimonVersion' => [ + 'type' => 'string', + ], + 'Region' => [ + 'type' => 'string', + ], + 'InstanceTypeFamily' => [ + 'type' => 'string', + ], + 'OperatingSystem' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeProcessCreate' => [ + 'summary' => 'NodeProcessCreate', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ProcessUser', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeProcesses' => [ + 'summary' => 'NodeProcesses', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'NodeProcesses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeProcess' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessName' => [ + 'type' => 'string', + ], + 'Command' => [ + 'type' => 'string', + ], + 'ProcessUser' => [ + 'type' => 'string', + ], + 'InstanceId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'NodeStatusList' => [ + 'summary' => '批量查询云监控插件状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id。 例如:i-22jja5c2l,多个id使用英文逗号分隔', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-abcdefgh123456,i-abcdefgh123457', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的唯一ID用于定位错误', + 'type' => 'string', + 'example' => '1BB8FE8E-9BBE-490F-82EC-BF70FB849D55', + ], + 'ErrorMessage' => [ + 'description' => '错误提示', + 'type' => 'string', + 'example' => 'InstanceIds is mandatory for this action.', + ], + 'ErrorCode' => [ + 'description' => '错误码,200为成功,其他为失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '本次操是否成功,等价于errorCode200', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeStatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeStatus' => [ + 'description' => 'Node状态的列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '参考NodeStatus Agent运行状态', + 'type' => 'string', + 'example' => 'running', + ], + 'InstanceId' => [ + 'description' => '实例id', + 'type' => 'string', + 'example' => 'i-abcdefgh123456', + ], + 'AutoInstall' => [ + 'description' => '是否可以使用安装接口自动安装', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1BB8FE8E-9BBE-490F-82EC-BF70FB849D55\\",\\n \\"ErrorMessage\\": \\"InstanceIds is mandatory for this action.\\",\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"i-abcdefgh123456\\",\\n \\"AutoInstall\\": true\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\", \\n \\"InstanceId\\": \\" i-abcdefgh123456\\", \\n \\"AutoInstall\\": true\\n }, \\n {\\n \\"Status\\": \\"uninstalled\\", \\n \\"InstanceId\\": \\" i-abcdefgh123457\\", \\n \\"AutoInstall\\": true\\n }\\n ]\\n }, \\n \\"ErrorCode\\": 200, \\n \\"Success\\": true\\n}"},{"type":"xml","example":"<NodeStatusListResponse>\\n <NodeStatusList>\\n <NodeStatus>\\n <Status>running</Status>\\n <InstanceId> i-abcdefgh123456</InstanceId>\\n <AutoInstall>true</AutoInstall>\\n </NodeStatus>\\n <NodeStatus>\\n <Status>uninstalled</Status>\\n <InstanceId> i-abcdefgh123457</InstanceId>\\n <AutoInstall>true</AutoInstall>\\n </NodeStatus>\\n </NodeStatusList>\\n <Success>true</Success>\\n <ErrorCode>200</ErrorCode>\\n</NodeStatusListResponse>","errorExample":"<NodeStatusListResponse>\\n <NodeStatusList>\\n <NodeStatus>\\n <Status>running</Status>\\n <InstanceId> i-abcdefgh123456</InstanceId>\\n <AutoInstall>true</AutoInstall>\\n </NodeStatus>\\n <NodeStatus>\\n <Status>uninstalled</Status>\\n <InstanceId> i-abcdefgh123457</InstanceId>\\n <AutoInstall>true</AutoInstall>\\n </NodeStatus>\\n </NodeStatusList>\\n <Success>true</Success>\\n <ErrorCode>200</ErrorCode>\\n</NodeStatusListResponse>"}]', + 'title' => '批量查询云监控插件状态', + ], + 'NodeUninstall' => [ + 'summary' => 'NodeUninstall', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 412 => [ + [ + 'errorCode' => 'AgentStateError', + 'errorMessage' => 'Expected agent running state is stopped.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'PutCustomMetric' => [ + 'summary' => 'PutCustomMetric', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MetricList', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'PutEvent' => [ + 'summary' => 'PutEvent', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EventInfo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'PutEventRule' => [ + 'summary' => '创建或修改事件的报警规则', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DBS_EVENT_RULE', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '分组id。', + 'type' => 'string', + 'required' => false, + 'example' => '240992827', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则的类型。取值:'."\n" + ."\n" + .'- SYSTEM:系统事件。'."\n" + .'- CUSTOM:自定义事件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SYSTEM' => 'SYSTEM', + 'CUSTOM' => 'CUSTOM', + ], + 'example' => 'SYSTEM', + 'default' => 'SYSTEM', + 'enum' => [ + 'SYSTEM', + 'BUSSINESS', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则描述。', + 'type' => 'string', + 'required' => false, + 'example' => '事件报警测试', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则的状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Enable', + 'default' => 'ENABLED', + 'enum' => [ + 'ENABLED', + 'DISABLED', + ], + ], + ], + [ + 'name' => 'EventPattern', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '事件报警规则的模式的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的模式。', + 'type' => 'object', + 'properties' => [ + 'EventTypeList' => [ + 'description' => '事件报警类型的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alert', + ], + 'required' => false, + 'maxItems' => 5, + ], + 'StatusList' => [ + 'description' => '事件报警规则的状态的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的状态。', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + ], + 'required' => false, + 'maxItems' => 5, + ], + 'Product' => [ + 'description' => '产品。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + 'LevelList' => [ + 'description' => '事件报警规则的等级的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的等级。', + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + 'required' => false, + 'maxItems' => 5, + ], + 'NameList' => [ + 'description' => '事件报警规则的名称的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Agent_Status_Stopped', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '返回的数据', + 'type' => 'string', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"100\\",\\n \\"RequestId\\": \\"0B47C47B-E68A-4429-BB23-370E91889C7D\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建或修改事件的报警规则', + ], + 'PutEventTargets' => [ + 'summary' => '设置事件目标', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DBS_EVENT_RULE', + ], + ], + [ + 'name' => 'FcParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '函数参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '函数的参数。', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'fcTest1', + ], + 'Region' => [ + 'description' => '函数对应的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'service1', + ], + 'Id' => [ + 'description' => '实体ID', + 'type' => 'string', + 'required' => false, + 'example' => '1911729', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ContactParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警联系组参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系组的参数。', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => [ + 'description' => '报警联系人组名称。', + 'type' => 'string', + 'required' => false, + 'example' => '云账号报警联系人', + ], + 'Id' => [ + 'description' => 'ID。', + 'type' => 'string', + 'required' => false, + 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', + ], + 'Level' => [ + 'description' => '报警级别。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'MnsParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Mns参数列表', + 'type' => 'array', + 'items' => [ + 'description' => '轻量消息队列(原 MNS)通知。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '地域id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Queue' => [ + 'description' => '消息队列。', + 'type' => 'string', + 'required' => false, + 'example' => 'testQueue', + ], + 'Id' => [ + 'description' => 'ID', + 'type' => 'string', + 'required' => false, + 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'WebhookParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'URL回调参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'URL回调参数。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'https', + ], + 'Url' => [ + 'description' => '回调的URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://alert.xxxxxxx.com:8080/callback', + ], + 'Method' => [ + 'description' => 'HTTP回调的请求方法。'."\n" + ."\n" + .'支持GET和POST。', + 'type' => 'string', + 'required' => false, + 'example' => 'POST', + ], + 'Id' => [ + 'description' => 'ID。', + 'type' => 'string', + 'required' => false, + 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'SlsParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '日志服务(SLS)参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志服务(SLS)参数。', + 'type' => 'object', + 'properties' => [ + 'LogStore' => [ + 'description' => '日志服务对应的日志库。', + 'type' => 'string', + 'required' => false, + 'example' => 'logstore_test', + ], + 'Region' => [ + 'description' => '日志服务对应的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Project' => [ + 'description' => '日志服务对应的project。', + 'type' => 'string', + 'required' => false, + 'example' => 'sls-rdscustom-event', + ], + 'Id' => [ + 'description' => 'ID。', + 'type' => 'string', + 'required' => false, + 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的唯一标识,用于后续错误排查使用。', + 'type' => 'string', + 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParameterCount' => [ + 'description' => '参数个数。', + 'type' => 'string', + 'example' => '132', + ], + 'FailedParameterCount' => [ + 'description' => '错误参数数量统计。', + 'type' => 'string', + 'example' => '2', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'ContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => '报警联系人组参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组参数。', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => [ + 'description' => '报警联系人组的名称。', + 'type' => 'string', + 'example' => '云账号报警联系人', + ], + 'Id' => [ + 'description' => '编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'ca66c5ae-8e46-445c-8ca9-7ccf10a0e183', + ], + 'Level' => [ + 'description' => '报警级别。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + ], + ], + ], + ], + ], + 'MnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => 'Mns参数列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Mns参数', + 'type' => 'object', + 'properties' => [ + 'Queue' => [ + 'description' => '轻量消息队列(原 MNS)的名称。', + 'type' => 'string', + 'example' => 'spotmax-spot-interruption-notice', + ], + 'Id' => [ + 'description' => '编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '91ace627-ed2c-4a35-8cd8-3a52b149c47e', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'FcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FcParameter' => [ + 'description' => '函数服务参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '函数服务参数。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '函数服务的服务名称。', + 'type' => 'string', + 'example' => 'esign-production-dba', + ], + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'cdn_waf', + ], + 'Id' => [ + 'description' => '编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'FailedContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => '失败报警联系人组参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '失败报警联系人组参数。', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => [ + 'description' => '报警联系人组的名称。', + 'type' => 'string', + 'example' => '云账号报警联系人', + ], + 'Id' => [ + 'description' => '编码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '933247bf-bded-4ad8-8653-403efad16cfd', + ], + 'Level' => [ + 'description' => '报警级别。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + ], + ], + ], + ], + ], + 'FailedMnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => '失败Mns参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '失败Mns参数。', + 'type' => 'object', + 'properties' => [ + 'Queue' => [ + 'description' => '轻量消息队列(原 MNS)的名称。', + 'type' => 'string', + 'example' => 'spotmax-spot-interruption-notice', + ], + 'Id' => [ + 'description' => '编码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'bc2cbb0f-c96b-45b7-81a1-b2356c232b79', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'FailedFcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FcParameter' => [ + 'description' => '失败函数服务参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '失败函数服务参数。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '函数服务的服务名称。', + 'type' => 'string', + 'example' => 'esign-production-dba', + ], + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'dba-alert-severity', + ], + 'Id' => [ + 'description' => '编码ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '98c049b7-f8f5-4001-ac4c-be21fd6d38e6', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'FailedSlsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FailedSlsParameter' => [ + 'description' => '失败SLS参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '失败SLS参数。', + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '日志服务对应的项目。', + 'type' => 'string', + 'example' => 'acs_disk', + ], + 'LogStore' => [ + 'description' => '日志服务对应的日志库。', + 'type' => 'string', + 'example' => 'alb_access_log', + ], + 'Id' => [ + 'description' => '编码。', + 'type' => 'string', + 'example' => 'be96c43d-b680-4ac5-aa21-1465e477e98f', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"84AC6F0B-7945-466A-AA44-99BB5A561F86\\",\\n \\"Success\\": true,\\n \\"ParameterCount\\": \\"132\\",\\n \\"FailedParameterCount\\": \\"2\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"ContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"云账号报警联系人\\",\\n \\"Id\\": 0,\\n \\"Level\\": \\"CRITICAL\\"\\n }\\n ]\\n },\\n \\"MnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"spotmax-spot-interruption-notice\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"esign-production-dba\\",\\n \\"FunctionName\\": \\"cdn_waf\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"云账号报警联系人\\",\\n \\"Id\\": 0,\\n \\"Level\\": \\"CRITICAL\\"\\n }\\n ]\\n },\\n \\"FailedMnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"spotmax-spot-interruption-notice\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedFcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"esign-production-dba\\",\\n \\"FunctionName\\": \\"dba-alert-severity\\",\\n \\"Id\\": 0,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedSlsParameters\\": {\\n \\"FailedSlsParameter\\": [\\n {\\n \\"Project\\": \\"acs_disk\\",\\n \\"LogStore\\": \\"alb_access_log\\",\\n \\"Id\\": \\"be96c43d-b680-4ac5-aa21-1465e477e98f\\",\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '设置事件目标', + ], + 'PutMetricRuleTargets' => [ + 'summary' => 'PutMetricRuleTargets', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Actions', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + 'required' => false, + ], + 'Arn' => [ + 'type' => 'string', + 'required' => false, + ], + 'Level' => [ + 'type' => 'string', + ], + ], + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'FailData' => [ + 'type' => 'object', + 'properties' => [ + 'Targets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Arn' => [ + 'type' => 'string', + ], + 'Level' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'PutResourceMetricRule' => [ + 'summary' => 'PutResourceMetricRule', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '86400', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => '300', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Warn.Statistics', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 499 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryCustomMetricList' => [ + 'summary' => '查询自定义指标列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组id。', + 'type' => 'string', + 'required' => true, + 'example' => '24232', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'GPUUtilization', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => [ + 'description' => '维度过滤条件,例如k1=v1&k2=v2。', + 'type' => 'string', + 'required' => false, + 'example' => 'sampleName1=value1&sampleName2=value2', + ], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => [ + 'description' => 'project + groupId + metricName + dimension 唯一值', + 'type' => 'string', + 'required' => false, + 'example' => '97c25982d9745a231276bff27469****', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。 默认值:1 。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', + ], + 'Result' => [ + 'description' => '自定义监控数据列表。', + 'type' => 'string', + 'example' => '{\\"data\\":[],\\"param\\":{\\"metric\\":\\"{\\\\\\"groupId\\\\\\":242135xxx,\\\\\\"project\\\\\\":\\\\\\"acs_customMetric_1672753017899xxx\\\\\\",\\\\\\"status\\\\\\":1}\\",\\"service\\":\\"metric-center.aliyun-inc.com\\"}}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"metric\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":242135xxx,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"acs_customMetric_1672753017899xxx\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"service\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metric-center.aliyun-inc.com\\\\\\\\\\\\\\"}}\\"\\n}","type":"json"}]', + 'title' => '查询自定义指标列表', + ], + 'QueryMetricData' => [ + 'summary' => 'QueryMetricData', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryMetricTop' => [ + 'summary' => 'QueryMetricTop', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Project', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Orderby', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'OrderDesc', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Period' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'QueryProjectMeta' => [ + 'summary' => '查询云监控支持的时序类监控项产品列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => ' 根据标签过滤,格式为`[{"name":"标签名","value":"标签值"},{"name":"标签名","value":"标签值"}]`。'."\n" + .'支持的标签名包括product、groupFlag。'."\n" + .'product 标签值为产品英文名称。 '."\n" + .'groupFlag含义为该产品是否支持应用分组,标签值为true或false 。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数,默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大数量,默认30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误码消息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '用于跟踪。', + 'type' => 'string', + 'example' => 'D3DBF9F5-7C4D-4A67-B869-097C069C481D', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码200成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'ProjectMeta列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '监控项的Project,用于查询监控数据。', + 'type' => 'string', + 'example' => 'acs_mongodb', + ], + 'Description' => [ + 'description' => '监控项的描述。', + 'type' => 'string', + 'example' => 'ApsaraDB for MongoDB', + ], + 'Labels' => [ + 'description' => '`[{"name":"标签名","value":"标签值"},{"name":"标签名","value":"标签值"}]`'."\n" + ."\n" + .'支持的标签名包括product、groupFlag。'."\n" + ."\n" + .'product 标签值为产品英文名称。'."\n" + ."\n" + .'groupFlag含义为该产品是否支持应用分组,标签值为true或false。', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"product\\",\\"value\\":\\"MongoDB\\"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"D3DBF9F5-7C4D-4A67-B869-097C069C481D\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"200\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Project\\": \\"acs_mongodb\\",\\n \\"Description\\": \\"ApsaraDB for MongoDB\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"product\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"MongoDB\\\\\\\\\\\\\\"]\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n\\t<RequestId>D3DBF9F5-7C4D-4A67-B869-097C069C481D</RequestId>\\n\\t<ErrorCode>200</ErrorCode>\\n\\t<Success>true</Success>\\n\\t<Resources>\\n\\t\\t<Resource>\\n\\t\\t\\t<Description>AnalyticDB</Description>\\n\\t\\t\\t<Labels>[{"name":"product","value":"ADS"},{"name":"groupFlag","value":"true"}]</Labels>\\n\\t\\t\\t<Project>acs_ads</Project>\\n\\t\\t</Resource>\\n\\t\\t<Resource>\\n\\t\\t\\t<Description>API Gateway</Description>\\n\\t\\t\\t<Labels>[{"name":"product","value":"APIGateway"},{"name":"groupFlag","value":"true"}]</Labels>\\n\\t\\t\\t<Project>acs_apigateway_dashboard</Project>\\n\\t\\t</Resource>\\n\\t\\t<Resource>\\n\\t\\t\\t<Description>Internet Shared Bandwidth</Description>\\n\\t\\t\\t<Labels>[{"name":"product","value":"InternetSharedBandwidth"},{"name":"groupFlag","value":"true"}]</Labels>\\n\\t\\t\\t<Project>acs_bandwidth_package</Project>\\n\\t\\t</Resource>\\n\\t\\t<Resource>\\n\\t\\t\\t<Description>CDN</Description>\\n\\t\\t\\t<Labels>[{"name":"product","value":"CDN"},{"name":"groupFlag","value":"true"}]</Labels>\\n\\t\\t\\t<Project>acs_cdn</Project>\\n\\t\\t</Resource>\\n\\t\\t<Resource>\\n\\t\\t\\t<Description>Cloud Enterprise Network</Description>\\n\\t\\t\\t<Labels>[{"name":"product","value":"CEN"},{"name":"groupFlag","value":"false"}]</Labels>\\n\\t\\t\\t<Project>acs_cen</Project>\\n\\t\\t</Resource>\\n\\t</Resources>\\n\\t\\n","errorExample":"\\n{\\n\\"RequestId\\": \\"D3DBF9F5-7C4D-4A67-B869-097C069C481D\\",\\n\\"ErrorCode\\": 200,\\n\\"Success\\": true,\\n\\"Resources\\": {\\n\\"Resource\\": [\\n{\\n\\"Description\\": \\"AnalyticDB\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ADS\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_ads\\"\\n},\\n{\\n\\"Description\\": \\"API Gateway\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"APIGateway\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_apigateway_dashboard\\"\\n},\\n{\\n\\"Description\\": \\"Internet Shared Bandwidth\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"InternetSharedBandwidth\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_bandwidth_package\\"\\n},\\n{\\n\\"Description\\": \\"CDN\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"CDN\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]\\",\\n\\"Project\\": \\"acs_cdn\\"\\n},\\n{\\n\\"Description\\": \\"Cloud Enterprise Network\\",\\n\\"Labels\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"product\\\\\\",\\\\\\"value\\\\\\":\\\\\\"CEN\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"groupFlag\\\\\\",\\\\\\"value\\\\\\":\\\\\\"false\\\\\\"}]\\",\\n\\"Project\\": \\"acs_cen\\"\\n}\\n]\\n}\\n}"}]', + 'title' => '查询时序类监控项产品列表', + 'description' => '通常配合查询监控项接口QueryMetricMeta和查询监控数据接口QueryMetricList/QueryMetricLast 一起使用。'."\n" + .'##请求类型 '."\n" + .'POST|GET '."\n" + .' ', + ], + 'QueryStaticsAvailability' => [ + 'summary' => '查询静态可用性', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '统计周期。', + 'type' => 'string', + 'required' => false, + 'example' => '1440', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Data' => [ + 'description' => '返回的可用性指标数据。', + 'type' => 'string', + 'example' => '[]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询静态可用性', + ], + 'QueryStaticsResponseTime' => [ + 'summary' => '查询静态响应时间', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务id。', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '响应时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '1440', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '[]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询静态响应时间', + ], + 'QuerySystemEventCount' => [ + 'summary' => 'QuerySystemEventCount', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'QueryJson', + 'in' => 'query', + 'schema' => [ + 'description' => '查询条件', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"timeEnd\\":1745461671353,\\"timeStart\\":1745375271353,\\"level\\":\\"WARN\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '( (userId:5024495213896020) ) and ( (level:WARN) )', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', + 'type' => 'string', + 'example' => '282127F4-2F58-5DE6-88CE-B71BDD085E8B', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"( (userId:5024495213896020) ) and ( (level:WARN) )\\",\\n \\"Data\\": \\"[{\\\\\\"Maximum\\\\\\":247,\\\\\\"Mimimum\\\\\\":61,\\\\\\"Average\\\\\\":154,\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"taskId\\\\\\":\\\\\\"49f7b317-7645-4cc9-94fd-ea42e522****\\\\\\",\\\\\\"timestamp\\\\\\":1551581760000}]\\",\\n \\"RequestId\\": \\"282127F4-2F58-5DE6-88CE-B71BDD085E8B\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询系统事件计数', + ], + 'QuerySystemEventDemo' => [ + 'summary' => '查询系统事件演示', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '事件的云服务名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Agent_Status_Stopped', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '返回的数据。', + 'type' => 'string', + 'example' => '{"count":1}', + ], + 'RequestId' => [ + 'description' => '请求的ID,用于定位日志,排查问题。', + 'type' => 'string', + 'example' => '90117AC0-01F8-562C-B8F3-17E4D81743AC', + ], + 'Success' => [ + 'description' => '是否成功,取值: '."\n" + .'- `true`:成功'."\n" + .'- `false`:失败', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"{\\\\\\"count\\\\\\":1}\\",\\n \\"RequestId\\": \\"90117AC0-01F8-562C-B8F3-17E4D81743AC\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询系统事件演示', + ], + 'QueryTaskConfig' => [ + 'summary' => '查询任务配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求失败状态码,200为成功,非200为失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'Data' => [ + 'description' => '返回的数据。', + 'type' => 'string', + 'example' => '[]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"Data\\": \\"[]\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询任务配置', + ], + 'QueryTaskMonitorData' => [ + 'summary' => 'QueryTaskMonitorData', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'metricName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Cursor' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'TraceId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '', + ], + 'TaskConfigList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '92****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'task2', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'MissingInstanceId', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BF120AD5-7D14-5EF6-8118-E3C2BCF849E1', + ], + 'ErrorCode' => [ + 'description' => '请求失败状态码,200为成功,非200为失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PageTotal' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'TaskList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeTaskConfig' => [ + 'description' => '任务配置信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '监控任务类型。', + 'type' => 'string', + 'example' => 'PING', + ], + 'JsonData' => [ + 'description' => '配置信息。', + 'type' => 'string', + 'example' => '[]', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'test-monitor-group-1758247893736-modified', + ], + 'GroupId' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123******', + ], + 'TaskName' => [ + 'description' => '监控任务名称。'."\n" + ."\n" + .'关于如何获取监控任务ID,请参见[DescribeHybridMonitorTaskList](~~428624~~)。', + 'type' => 'string', + 'example' => 'ft-task-20190101N***', + ], + 'Disabled' => [ + 'description' => '监控任务是否禁用。取值:'."\n" + .'- true:禁用。'."\n" + ."\n" + .'- false:启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertConfig' => [ + 'description' => '报警配置。', + 'type' => 'string', + 'example' => '[]', + ], + 'TaskScope' => [ + 'description' => '任务的探测范围。', + 'type' => 'string', + 'example' => '*', + ], + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123***', + ], + 'InstanceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。', + 'type' => 'string', + 'example' => 'i-x12er****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"MissingInstanceId\\",\\n \\"RequestId\\": \\"BF120AD5-7D14-5EF6-8118-E3C2BCF849E1\\",\\n \\"ErrorCode\\": 200,\\n \\"Success\\": true,\\n \\"PageTotal\\": 50,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100,\\n \\"TaskList\\": {\\n \\"NodeTaskConfig\\": [\\n {\\n \\"TaskType\\": \\"PING\\",\\n \\"JsonData\\": \\"[]\\",\\n \\"GroupName\\": \\"test-monitor-group-1758247893736-modified\\",\\n \\"GroupId\\": 0,\\n \\"TaskName\\": \\"ft-task-20190101N***\\",\\n \\"Disabled\\": true,\\n \\"AlertConfig\\": \\"[]\\",\\n \\"TaskScope\\": \\"*\\",\\n \\"Id\\": 0,\\n \\"InstanceList\\": {\\n \\"String\\": [\\n \\"i-x12er****\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '列举监控任务配置', + 'summary' => '查询站点监控的配置列表', + ], + 'UpdateAlarm' => [ + 'summary' => '修改已创建的报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_modify', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的Id。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '576fbae7-2fd1-411a-ae13-6f09f4fafdde', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '查询指标的周期,必须与定义的metric一致,默认300,单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '报警比较符,只能为以下几种`<=,<,>,>=,==,!=`', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '>', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '报警阈值,目前只开放数值类型功能。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '40', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则通知的联系组,必须在控制台上已创建,为json array对应的string,例如`[“联系组1”,”联系组2”]`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '["联系组"]', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效时间的开始时间,默认0,代表0点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效时间的结束时间,默认24,代表24点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '一直处于报警状态的通知沉默周期,默认86400,单位s,最小1小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => '连续探测几次都满足阈值条件时报警,默认3次。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '通知类型,为0是旺旺+邮件,为1是旺旺+邮件+短信。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '回调函数,只支持公网地址,回调参数请参考[使用报警回调](~~60714~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.net.cn/example_callback.htm', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要检查Webhook可用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志。', + 'type' => 'string', + 'example' => '945B9183-95C0-44FF-B30C-9ED37D44F6DC', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"945B9183-95C0-44FF-B30C-9ED37D44F6DC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlarmResponse>\\r\\n <RequestId>C08FADC4-CFDB-42F7-B9B8-0ED5391CD084</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</UpdateAlarmResponse>","errorExample":""}]', + 'title' => '修改已创建的报警规则', + ], + 'UpdateMonitoringTemplate' => [ + 'summary' => '更新监视模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => '常用基础模板', + ], + ], + [ + 'name' => 'AlertTemplatesJson', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模版。', + 'type' => 'string', + 'required' => true, + 'example' => '{"rds":[{"displayName":"rds_rule_1111","category":"rds","namespace":"acs_rds_dashboard","metricName":"CpuUsage","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"98","times":3}}}],"ecs":[{"displayName":"ecs_rule1111","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_total","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"99","times":5}}},{"displayName":"ecs_rule2222","category":"ecs","namespace":"acs_ecs_dashboard","metricName":"cpu_idle","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999","times":3},"warn":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"89","times":4}}}],"mongodb":[{"displayName":"mongodb11","category":"mongodb","namespace":"acs_mongodb","metricName":"CPUUtilization","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"11111","times":3}}}],"mongodb_cluster":[{"displayName":"mongodb_cluster_t1","category":"mongodb_cluster","namespace":"acs_mongodb","metricName":"ShardingQPS","selector":{},"escalations":{"critical":{"statistics":"Average","comparisonOperator":"GreaterThanOrEqualToThreshold","threshold":"9999999","times":3}}}]}', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '模板描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Description', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1097583', + ], + ], + [ + 'name' => 'RestVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '数据版本号。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '9', + ], + ], + [ + 'name' => 'SystemEventTemplates', + 'in' => 'query', + 'schema' => [ + 'description' => '系统事件模板。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"alertName":"WAF_Event","description":"WAF_Event","eventPattern":{"eventType":["*"],"levelList":["*"],"nameList":["*"],"product":"waf"},"fcParameterList":[],"mnsParameterList":[],"notifyLevel":3,"slsParameterList":[],"webhookParameterList":[]}]', + ], + ], + [ + 'name' => 'ProcessMonitorTemplates', + 'in' => 'query', + 'schema' => [ + 'description' => '进程监控模板。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"alert":{"comparisonOperator":"LessThanThreshold","escalationsLevel":"critical","silenceTime":0,"statistics":"Average","templateAlert":false,"threshold":"2","times":1},"matchExpress":{"filterRelation":"and","filters":[{"function":"all","name":"name","value":"*"}]},"processName":"FineBI"}]', + ], + ], + [ + 'name' => 'HostAvailabilityTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控模板。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"telnet","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"},{"alert":{"escalationList":[{"aggregate":"Value","metric":"TelnetStatus","operator":">","times":3,"value":"400"},{"aggregate":"Average","metric":"TelnetLatency","operator":">","times":3,"value":"500"}],"notifyType":1,"silenceTime":86400},"taskName":"bbbbbbbbbb","taskOption":{"method":"HEAD","negative":true,"resposeCharset":"utf-8","uri":"telnet://xxx.com"},"taskType":"TELNET"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '987CC16C-D1E4-5EB1-A1CD-27906161EFFA', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码,200为成功,其他失败 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"RequestId\\": \\"987CC16C-D1E4-5EB1-A1CD-27906161EFFA\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": 200\\n}","type":"json"}]', + 'title' => '更新监视模板', + ], + 'GetLogColumnTranslateResult' => [ + 'summary' => '获取日期提取结果的翻译', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ColumnValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'TranslateConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Resource' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Code' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'The parameter is missing or invalid. %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 429 => [ + [ + 'errorCode' => 'ResourceOverLimit', + 'errorMessage' => 'The resource has exceeded the limit. %s', + ], + ], + ], + ], + 'GetLineSplitResult' => [ + 'summary' => '获取行切分结果', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SplitType', + 'in' => 'query', + 'schema' => [ + 'title' => '切分类型', + 'type' => 'string', + 'example' => 'simple|regex', + ], + ], + [ + 'name' => 'Line', + 'in' => 'query', + 'schema' => [ + 'title' => '需要提取的行', + 'type' => 'string', + ], + ], + [ + 'name' => 'Prefix', + 'in' => 'query', + 'schema' => [ + 'title' => '已经完成提取的部分', + 'type' => 'string', + ], + ], + [ + 'name' => 'SelectContent', + 'in' => 'query', + 'schema' => [ + 'title' => '提取的内容', + 'type' => 'string', + ], + ], + [ + 'name' => 'Regex', + 'in' => 'query', + 'schema' => [ + 'title' => '提取完成的正则表达式', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Code' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'Resource' => [ + 'type' => 'object', + 'properties' => [ + 'StartSplitSymbol' => [ + 'type' => 'string', + ], + 'EndSplitSymbol' => [ + 'type' => 'string', + ], + 'StartSplitSymbolIndex' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Regex' => [ + 'type' => 'string', + ], + 'AdditionalRegex' => [ + 'type' => 'string', + ], + 'RegexSplitResult' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'The parameter is missing or invalid. %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 429 => [ + [ + 'errorCode' => 'ResourceOverLimit', + 'errorMessage' => 'The resource has exceeded the limit. %s', + ], + ], + ], + ], + 'DeleteHybridDoubleWrite' => [ + 'summary' => '调用DeleteHybridDoubleWrite接口删除企业云监控数据的双写任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SourceUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的源用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12706766********', + ], + ], + [ + 'name' => 'SourceNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的源指标仓库。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-source', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6F815BDC-9063-5417-BA88-E1BBD84BAA1E', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'InvalidAuthorization.', + ], + [ + 'errorCode' => 'NotAuthSLR', + 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F815BDC-9063-5417-BA88-E1BBD84BAA1E\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除企业云监控数据的双写任务', + 'description' => '请确保您已提交工单,获取该API的使用权限。', + ], + 'CreateHybridDoubleWrite' => [ + 'summary' => '调用CreateHybridDoubleWrite接口创建企业云监控数据的双写任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的目标指标仓库。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-target', + ], + ], + [ + 'name' => 'SourceUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的源用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12706766********', + ], + ], + [ + 'name' => 'SourceNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的源指标仓库。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-source', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的目标用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12706766********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FAAC3C5D-00BF-543A-9E08-FAAC3C5D', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'InvalidAuthorization.', + ], + [ + 'errorCode' => 'NotAuthSLR', + 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FAAC3C5D-00BF-543A-9E08-FAAC3C5D\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建企业云监控数据的双写任务', + 'description' => '请确保您已提交工单,获取该API的使用权限。', + ], + 'DescribeHybridDoubleWrite' => [ + 'summary' => '调用DescribeHybridDoubleWrite接口查询从指定账号写出的指标仓库。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SourceNamespace', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的源指标仓库。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-source', + ], + ], + [ + 'name' => 'SourceUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '双写的源指标仓库的账号。', + 'type' => 'string', + 'required' => false, + 'example' => '12706766**********', + ], + ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TargetNamespace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + .'* true:成功。'."\n" + .'* false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '从指定账号写出的目标指标仓库。', + 'type' => 'array', + 'items' => [ + 'description' => '从指定账号写出的目标指标仓库。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '双写的目标用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11234766**********', + ], + 'Namespace' => [ + 'description' => '双写的目标指标仓库。', + 'type' => 'string', + 'example' => 'test-target', + ], + 'SourceUserId' => [ + 'description' => '双写的源用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12706766**********', + ], + 'SourceNamespace' => [ + 'description' => '双写的源指标仓库。', + 'type' => 'string', + 'example' => 'test-source', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'InvalidAuthorization.', + ], + [ + 'errorCode' => 'NotAuthSLR', + 'errorMessage' => 'You are not authorized role AliyunServiceRoleForCloudMonitor.', + ], + ], + [ + [ + 'errorCode' => 'NotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"Result\\": [\\n {\\n \\"UserId\\": 0,\\n \\"Namespace\\": \\"test-target\\",\\n \\"SourceUserId\\": 0,\\n \\"SourceNamespace\\": \\"test-source\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询从指定账号写出的指标仓库', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2019-01-01/api-docs.php b/data/zh_cn/cms/2019-01-01/api-docs.php new file mode 100644 index 0000000..9d19690 --- /dev/null +++ b/data/zh_cn/cms/2019-01-01/api-docs.php @@ -0,0 +1,41518 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Cms', + 'version' => '2019-01-01', + ], + 'directories' => [ + [ + 'id' => 184857, + 'title' => '应用分组', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 59483, + 'title' => '管理应用分组', + 'type' => 'directory', + 'children' => [ + 'CreateMonitorGroup', + 'ModifyMonitorGroup', + 'DeleteMonitorGroup', + 'DescribeMonitorGroups', + 'CreateMonitorGroupInstances', + 'ModifyMonitorGroupInstances', + 'DescribeMonitorGroupInstances', + 'DescribeMonitorGroupDynamicRules', + 'DescribeMonitorGroupInstanceAttribute', + 'DeleteMonitorGroupDynamicRule', + 'DeleteMonitorGroupInstances', + 'DescribeMonitorGroupCategories', + 'PutMonitorGroupDynamicRule', + 'CreateGroupMonitoringAgentProcess', + 'ModifyGroupMonitoringAgentProcess', + 'DeleteGroupMonitoringAgentProcess', + 'DescribeGroupMonitoringAgentProcess', + 'CreateMonitorGroupNotifyPolicy', + 'DeleteMonitorGroupNotifyPolicy', + 'DescribeMonitorGroupNotifyPolicyList', + ], + ], + [ + 'id' => 59517, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'AddTags', + 'CreateDynamicTagGroup', + 'DeleteDynamicTagGroup', + 'DescribeTagValueList', + 'DescribeTagKeyList', + 'DescribeProductResourceTagKeyList', + 'DescribeDynamicTagRuleList', + 'RemoveTags', + ], + ], + [ + 'id' => 59436, + 'title' => '可用性监控', + 'type' => 'directory', + 'children' => [ + 'CreateHostAvailability', + 'DeleteHostAvailability', + 'EnableHostAvailability', + 'DisableHostAvailability', + 'ModifyHostAvailability', + 'DescribeUnhealthyHostAvailability', + 'DescribeHostAvailabilityList', + ], + ], + ], + ], + [ + 'id' => 59416, + 'title' => '主机监控', + 'type' => 'directory', + 'children' => [ + 'InstallMonitoringAgent', + 'DescribeMonitoringAgentHosts', + 'DescribeMonitoringAgentAccessKey', + 'DescribeMonitoringAgentConfig', + 'DescribeMonitoringAgentStatuses', + 'ModifyHostInfo', + 'DescribeMonitoringConfig', + 'PutMonitoringConfig', + 'UninstallMonitoringAgent', + 'CreateMonitoringAgentProcess', + 'CreateMonitorAgentProcess', + 'DescribeMonitoringAgentProcesses', + 'DeleteMonitoringAgentProcess', + ], + ], + [ + 'id' => 184858, + 'title' => '事件中心', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 59447, + 'title' => '系统事件', + 'type' => 'directory', + 'children' => [ + 'DescribeSystemEventHistogram', + 'DescribeSystemEventMetaList', + 'DescribeSystemEventAttribute', + 'DescribeSystemEventCount', + 'DescribeMonitorResourceQuotaAttribute', + 'SendDryRunSystemEvent', + ], + ], + [ + 'id' => 59478, + 'title' => '自定义事件', + 'type' => 'directory', + 'children' => [ + 'DescribeCustomEventCount', + 'DescribeCustomEventHistogram', + 'DescribeCustomEventAttribute', + 'PutCustomEvent', + ], + ], + ], + ], + [ + 'id' => 59473, + 'title' => '自定义监控', + 'type' => 'directory', + 'children' => [ + 'PutCustomMetric', + 'PutCustomMetricRule', + 'DescribeCustomMetricList', + 'DeleteCustomMetric', + ], + ], + [ + 'id' => 59526, + 'title' => '日志监控', + 'type' => 'directory', + 'children' => [ + 'PutLogMonitor', + 'DeleteLogMonitor', + 'DescribeLogMonitorList', + 'DescribeLogMonitorAttribute', + ], + ], + [ + 'id' => 184946, + 'title' => '站点监控', + 'type' => 'directory', + 'children' => [ + 'CreateMonitorGroupByResourceGroupId', + 'CreateSiteMonitor', + 'CreateInstantSiteMonitor', + 'BatchCreateInstantSiteMonitor', + 'DeleteSiteMonitors', + 'DisableSiteMonitors', + 'ModifySiteMonitor', + 'EnableSiteMonitors', + 'DescribeSiteMonitorQuota', + 'DescribeSiteMonitorAttribute', + 'DescribeSiteMonitorISPCityList', + 'DescribeSiteMonitorData', + 'DescribeSiteMonitorStatistics', + 'DescribeSiteMonitorList', + 'DescribeSiteMonitorLog', + ], + ], + [ + 'id' => 59386, + 'title' => '云产品监控', + 'type' => 'directory', + 'children' => [ + 'DescribeMetricLast', + 'DescribeMetricList', + 'DescribeMetricData', + 'DescribeMetricMetaList', + 'DescribeProjectMeta', + 'DeleteExporterOutput', + 'DeleteExporterRule', + 'DescribeExporterOutputList', + 'DescribeExporterRuleList', + 'DescribeMetricTop', + 'PutExporterOutput', + 'PutExporterRule', + ], + ], + [ + 'id' => 184862, + 'title' => '报警服务', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 184895, + 'title' => '报警历史', + 'type' => 'directory', + 'children' => [ + 'DescribeAlertHistoryList', + 'DescribeAlertLogCount', + 'DescribeAlertLogList', + 'DescribeAlertLogHistogram', + ], + ], + [ + 'id' => 184896, + 'title' => '一键报警', + 'type' => 'directory', + 'children' => [ + 'DescribeProductsOfActiveMetricRule', + 'DescribeActiveMetricRuleList', + 'EnableActiveMetricRule', + 'DisableActiveMetricRule', + ], + ], + [ + 'id' => 59454, + 'title' => '报警模板', + 'type' => 'directory', + 'children' => [ + 'CreateMetricRuleTemplate', + 'DeleteMetricRuleTemplate', + 'ModifyMetricRuleTemplate', + 'DescribeMetricRuleTemplateAttribute', + 'DescribeMetricRuleTemplateList', + 'ApplyMetricRuleTemplate', + ], + ], + [ + 'id' => 59396, + 'title' => '阈值报警规则', + 'type' => 'directory', + 'children' => [ + 'DescribeMetricRuleList', + 'CreateGroupMetricRules', + 'CreateMetricRuleResources', + 'DeleteMetricRuleTargets', + 'DeleteMetricRules', + 'DeleteMetricRuleResources', + 'EnableMetricRules', + 'DisableMetricRules', + 'DescribeMetricRuleTargets', + 'DescribeMetricRuleCount', + 'DescribeAlertingMetricRuleResources', + 'PutMetricRuleTargets', + 'PutResourceMetricRule', + 'PutResourceMetricRules', + 'PutGroupMetricRule', + ], + ], + [ + 'id' => 59461, + 'title' => '事件报警规则', + 'type' => 'directory', + 'children' => [ + 'DeleteEventRuleTargets', + 'DeleteEventRules', + 'EnableEventRules', + 'DisableEventRules', + 'DescribeEventRuleAttribute', + 'DescribeEventRuleList', + 'DescribeEventRuleTargetList', + 'PutEventRuleTargets', + 'PutEventRule', + 'PutCustomEventRule', + ], + ], + [ + 'id' => 184863, + 'title' => '报警黑名单', + 'type' => 'directory', + 'children' => [ + 'CreateMetricRuleBlackList', + 'ModifyMetricRuleBlackList', + 'DeleteMetricRuleBlackList', + 'DescribeMetricRuleBlackList', + 'EnableMetricRuleBlackList', + ], + ], + [ + 'id' => 59428, + 'title' => '报警联系人', + 'type' => 'directory', + 'children' => [ + 'DeleteContactGroup', + 'DeleteContact', + 'DescribeContactListByContactGroup', + 'DescribeContactGroupList', + 'DescribeContactList', + 'PutContact', + 'PutContactGroup', + ], + ], + ], + ], + [ + 'id' => 166246, + 'title' => '企业云监控', + 'type' => 'directory', + 'children' => [ + 'CreateHybridMonitorNamespace', + 'ModifyHybridMonitorNamespace', + 'DeleteHybridMonitorNamespace', + 'DescribeHybridMonitorNamespaceList', + 'CreateHybridMonitorTask', + 'ModifyHybridMonitorTask', + 'DeleteHybridMonitorTask', + 'DescribeHybridMonitorTaskList', + 'PutHybridMonitorMetricData', + 'DescribeHybridMonitorDataList', + 'CreateHybridMonitorSLSGroup', + 'ModifyHybridMonitorSLSGroup', + 'DeleteHybridMonitorSLSGroup', + 'DescribeHybridMonitorSLSGroup', + 'Cursor', + 'BatchExport', + ], + ], + [ + 'id' => 313480, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeSyntheticProbeList', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AlertEvent' => [ + 'title' => 'A short description of struct', + 'description' => '报警事件', + 'type' => 'object', + 'properties' => [ + 'TraceId' => [ + 'title' => '事件跟踪id', + 'type' => 'string', + ], + 'DeDupId' => [ + 'title' => '事件排重id', + 'type' => 'string', + ], + 'AlertStatus' => [ + 'title' => '报警状态', + 'type' => 'string', + ], + 'Source' => [ + 'title' => '报警来源', + 'type' => 'string', + ], + 'Severity' => [ + 'title' => '严重级别', + 'type' => 'string', + ], + 'ResourceInfo' => [ + 'title' => '报警资源', + 'type' => 'object', + ], + 'CustomLabels' => [ + 'title' => '自定义标签', + 'type' => 'object', + ], + 'Details' => [ + 'title' => '详细信息', + 'type' => 'string', + ], + 'AlertName' => [ + 'title' => '报警名称', + 'type' => 'string', + ], + 'RuleName' => [ + 'title' => '规则名称', + 'type' => 'string', + ], + 'EventName' => [ + 'title' => '事件名称', + 'type' => 'string', + ], + 'Summary' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'Timestamp' => [ + 'title' => '时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'Expression' => [ + 'title' => '表达式', + 'type' => 'string', + ], + 'Metrics' => [ + 'title' => '指标列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MetricNameEn' => [ + 'title' => '英文指标名', + 'type' => 'string', + ], + 'Unit' => [ + 'title' => '单位', + 'type' => 'string', + ], + 'MetricName' => [ + 'title' => '指标名', + 'type' => 'string', + ], + 'Threshold' => [ + 'title' => '阈值', + 'type' => 'string', + ], + 'UnitFactor' => [ + 'title' => '单位系数', + 'type' => 'number', + 'format' => 'float', + ], + 'Operator' => [ + 'title' => '比较方法', + 'type' => 'string', + ], + 'CurValue' => [ + 'title' => '当前值', + 'type' => 'string', + ], + 'Statistics' => [ + 'title' => '统计方法', + 'type' => 'string', + ], + 'MetricNameZh' => [ + 'title' => '中文指标名', + 'type' => 'string', + ], + ], + ], + ], + 'Content' => [ + 'title' => 'event raw content', + 'type' => 'string', + ], + 'EventType' => [ + 'title' => 'event type', + 'type' => 'string', + ], + 'Product' => [ + 'title' => 'product', + 'type' => 'string', + ], + 'Arn' => [ + 'title' => 'arn', + 'type' => 'string', + ], + ], + ], + 'AlertStrategyRelation' => [ + 'title' => 'A short description of struct', + 'description' => '报警通知策略关联对象', + 'type' => 'object', + 'properties' => [ + 'AlertName' => [ + 'title' => '报警规则名', + 'type' => 'string', + ], + 'StrategyUuid' => [ + 'title' => '通知策略uuid', + 'type' => 'string', + ], + ], + ], + 'Dimension' => [ + 'title' => 'Dimension', + 'description' => '监控项维度信息。', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'title' => 'Dimension label', + 'description' => '监控项维度的名称。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Value' => [ + 'title' => 'Dimension value', + 'description' => '监控项维度的值。', + 'type' => 'string', + 'example' => 'i-dferwret*****', + ], + ], + ], + 'EscalationRule' => [ + 'title' => '升级规则', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + 'required' => true, + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Uuid' => [ + 'title' => 'UUID', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + 'required' => false, + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'Escalations' => [ + 'title' => '升级设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EscalateMin' => [ + 'title' => '升级分钟数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ContactGroups' => [ + 'title' => '联系组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'ContactGroupsByLevel' => [ + 'title' => '自定义级别联系组', + 'type' => 'object', + 'properties' => [ + 'Critical' => [ + 'title' => 'critical', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Error' => [ + 'title' => 'error', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Warning' => [ + 'title' => 'warning', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Info' => [ + 'title' => 'info', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Resolve' => [ + 'title' => 'resolve', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'BackupContactGroups' => [ + 'title' => '备份联系组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '联系组', + ], + ], + ], + ], + 'required' => true, + 'maxItems' => 6, + ], + ], + ], + 'Incident' => [ + 'title' => 'A short description of struct', + 'description' => '报警 Incident', + 'type' => 'object', + 'properties' => [ + 'IncidentId' => [ + 'title' => 'Incident UUID', + 'type' => 'string', + ], + 'GroupingId' => [ + 'title' => '分组合并的id', + 'type' => 'string', + ], + 'GroupingKey' => [ + 'title' => '合并原始key', + 'type' => 'string', + ], + 'GroupingData' => [ + 'title' => '合并原始数据', + 'type' => 'object', + ], + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'Severity' => [ + 'title' => '严重程度', + 'type' => 'string', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ActionTime' => [ + 'title' => '最近操作时间', + 'type' => 'integer', + 'format' => 'int64', + ], + 'IncidentStatus' => [ + 'title' => '报警状态', + 'type' => 'string', + ], + 'AlertCount' => [ + 'title' => '报警次数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'StrategyUuid' => [ + 'title' => '通知策略uuid', + 'type' => 'string', + ], + ], + ], + 'Matcher' => [ + 'title' => 'mathcer', + 'description' => '监控项的维度。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => 'value', + 'description' => '监控项维度(dimension)的值。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Label' => [ + 'title' => 'label', + 'description' => '监控项维度(dimension)的名称。', + 'type' => 'string', + 'example' => 'i-fewrewr*****', + ], + 'Operator' => [ + 'title' => 'operator', + 'description' => '监控项维度(dimension)匹配的方式,目前只支持EQUALS。默认EQUALS。', + 'type' => 'string', + 'example' => 'EQUALS', + ], + ], + ], + 'MetricStat' => [ + 'title' => '查询数据点', + 'description' => 'BatchExport查询的数据。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => 'namespace', + 'description' => '云产品的数据命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Metric' => [ + 'title' => 'metric', + 'description' => '云产品的监控项名称。', + 'type' => 'string', + 'example' => 'cpu_idle', + ], + 'Period' => [ + 'title' => 'period', + 'description' => '监控项的时间间隔。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Timestamp' => [ + 'title' => 'timestamp', + 'description' => '监控数据的时间戳(单位:毫秒)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641454680000', + ], + 'Dimensions' => [ + 'title' => 'dimensions', + 'description' => '用于标识监控对象(实例)的Dimension信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用于标识监控对象(实例)的Dimension信息。', + '$ref' => '#/components/schemas/Dimension', + ], + ], + 'Associated' => [ + 'title' => 'associated', + 'description' => '监控对象(实例)的附加信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '监控对象(实例)的附加信息。', + 'type' => 'string', + 'example' => '{"group":"test****", "name":"Alice"}', + ], + ], + 'Measurements' => [ + 'title' => 'measurements', + 'description' => '指标的测量值(默认多值模式)。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '指标的测量值(默认多值模式)。', + 'type' => 'any', + 'example' => '{"Average":60,"Maximum":85}', + ], + ], + 'LogTime' => [ + 'title' => 'logTime', + 'description' => '监控数据的记录时间(单位:毫秒),对于非原始数据(聚合后的数据),LogTime为空(NULL)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1683686550073', + ], + ], + ], + 'MigrationJob' => [ + 'title' => 'MigrationJob', + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'title' => 'UUID', + 'type' => 'string', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'RuleNames' => [ + 'title' => '规则列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Detail' => [ + 'title' => '迁移结果详情', + 'type' => 'string', + ], + 'JobStatus' => [ + 'title' => '任务状态', + 'type' => 'string', + ], + 'Source' => [ + 'title' => '迁移源', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Rule' => [ + 'title' => '规则list', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'KeywordFilter' => [ + 'title' => 'keywordFilter', + 'type' => 'object', + 'properties' => [ + 'Relation' => [ + 'title' => 'relation', + 'type' => 'string', + ], + 'Keywords' => [ + 'title' => 'keywords', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'PrimaryFilters' => [ + 'title' => 'primaryFilters', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => 'field', + 'type' => 'string', + ], + 'OpType' => [ + 'title' => 'opType', + 'type' => 'string', + ], + 'Value' => [ + 'title' => 'value', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Targets' => [ + 'title' => '事件规则目标', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'type', + 'type' => 'string', + ], + 'Content' => [ + 'title' => 'Content', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'title' => 'level', + 'type' => 'string', + ], + 'Group' => [ + 'title' => 'group', + 'type' => 'string', + ], + 'Method' => [ + 'title' => 'method', + 'type' => 'string', + ], + 'Url' => [ + 'title' => 'url', + 'type' => 'string', + ], + 'Region' => [ + 'title' => 'region', + 'type' => 'string', + ], + 'ResourcePath' => [ + 'title' => 'resourcePath', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Plan' => [ + 'title' => '迁移计划', + 'type' => 'object', + 'properties' => [ + 'Subscriptions' => [ + 'title' => '订阅列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '订阅名称', + 'type' => 'string', + ], + 'StrategyUuid' => [ + 'title' => '通知配置Uuid', + 'type' => 'string', + ], + 'Conditions' => [ + 'title' => '条件列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => 'field', + 'type' => 'string', + ], + 'Op' => [ + 'title' => 'op', + 'type' => 'string', + ], + 'Value' => [ + 'title' => 'value', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'Strategies' => [ + 'title' => 'strategies', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EscalationSetting' => [ + 'title' => 'escalation', + 'type' => 'object', + 'properties' => [ + 'escalationUuid' => [ + 'title' => 'escalationUuid', + 'type' => 'string', + ], + ], + ], + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'PushingSetting' => [ + 'title' => 'pushingSetting', + 'type' => 'object', + 'properties' => [ + 'TargetUuids' => [ + 'title' => 'targetUuids', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'Escalations' => [ + 'title' => '通知配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Uuid' => [ + 'title' => '通知配置Uuid', + 'type' => 'string', + ], + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'Escalations' => [ + 'title' => 'Escalations', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Groups' => [ + 'title' => 'groups', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'LevelGroups' => [ + 'title' => 'level groups', + 'type' => 'object', + 'properties' => [ + 'Critical' => [ + 'title' => 'critical groups', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Warning' => [ + 'title' => 'warning groups', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Info' => [ + 'title' => 'info groups', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Resolved' => [ + 'title' => 'resolved groups', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Targets' => [ + 'title' => '事件规则目标', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'type' => 'string', + ], + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'Uuid' => [ + 'title' => 'uuid', + 'type' => 'string', + ], + 'HttpRequestTarget' => [ + 'title' => 'httpRequestTarget', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => 'method', + 'type' => 'string', + ], + 'Url' => [ + 'title' => 'url', + 'type' => 'string', + ], + 'ContentType' => [ + 'title' => 'contenttype', + 'type' => 'string', + ], + ], + ], + 'Arn' => [ + 'title' => 'arn', + 'type' => 'string', + ], + ], + ], + ], + 'Contacts' => [ + 'title' => 'contacts', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'contact', + 'type' => 'string', + ], + 'Channels' => [ + 'title' => 'channels', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'type', + 'type' => 'string', + ], + 'Value' => [ + 'title' => 'value', + 'type' => 'string', + ], + 'Level' => [ + 'title' => 'level', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + 'Groups' => [ + 'title' => 'groups', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'Contacts' => [ + 'title' => 'contacts', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'RuleNames' => [ + 'title' => 'RuleNames', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'NotificationStrategy' => [ + 'title' => '通知策略', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + 'required' => true, + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Uuid' => [ + 'title' => 'UUID', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'FilterSetting' => [ + 'title' => '过滤设置', + 'type' => 'object', + 'properties' => [ + 'WhiteList' => [ + 'title' => '白名单', + 'type' => 'array', + 'items' => [ + 'title' => '白名单', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '过滤字段', + 'type' => 'string', + 'required' => true, + ], + 'Op' => [ + 'title' => '过滤类型', + 'type' => 'string', + 'required' => true, + ], + 'Value' => [ + 'title' => '过滤数据', + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'required' => false, + 'maxItems' => 10, + ], + 'BlackList' => [ + 'title' => '黑名单', + 'type' => 'array', + 'items' => [ + 'title' => '黑名单', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '过滤字段', + 'type' => 'string', + 'required' => true, + ], + 'Op' => [ + 'title' => '过滤类型', + 'type' => 'string', + 'required' => true, + ], + 'Value' => [ + 'title' => '过滤数据', + 'type' => 'string', + 'required' => true, + ], + ], + ], + ], + 'maxItems' => 10, + ], + ], + ], + 'GroupingSetting' => [ + 'title' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'GroupingItems' => [ + 'title' => '合并项目', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '合并类型', + 'type' => 'string', + ], + 'Keys' => [ + 'title' => '合并keys', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'maxItems' => 10, + ], + 'SilenceSec' => [ + 'title' => '沉默秒数', + 'type' => 'integer', + 'format' => 'int32', + ], + 'PeriodMin' => [ + 'title' => '检查周期分钟数', + 'type' => 'integer', + 'format' => 'int32', + ], + 'Times' => [ + 'title' => '触发次数', + 'type' => 'integer', + 'format' => 'int32', + ], + 'EnableRawAlertDispatching' => [ + 'title' => '是否开启原始报警数据直接转发', + 'type' => 'boolean', + ], + ], + ], + 'EscalationSetting' => [ + 'title' => '升级设置', + 'type' => 'object', + 'properties' => [ + 'Range' => [ + 'title' => '数据范围', + 'type' => 'string', + 'required' => false, + ], + 'EscalationLevel' => [ + 'title' => '升级最低级别', + 'type' => 'string', + 'required' => false, + ], + 'EscalationUuid' => [ + 'title' => '升级规则uuid', + 'type' => 'string', + 'required' => false, + ], + 'AutoResolveMin' => [ + 'title' => '自动恢复分钟数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RetriggerMin' => [ + 'title' => '重复触发报警分钟数', + 'type' => 'integer', + 'format' => 'int64', + ], + 'CustomChannels' => [ + 'title' => '自定义通知策略', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChannelType' => [ + 'title' => '渠道类型', + 'type' => 'string', + 'required' => true, + ], + 'TemplateUuid' => [ + 'title' => '通知模板uuid', + 'type' => 'string', + ], + 'Severities' => [ + 'title' => '严重程度列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => '严重程度', + ], + ], + ], + ], + 'maxItems' => 20, + ], + ], + ], + 'PushingSetting' => [ + 'title' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'TemplateUuid' => [ + 'title' => '模板uuid', + 'type' => 'string', + 'required' => false, + ], + 'Range' => [ + 'title' => '数据范围', + 'type' => 'string', + 'required' => false, + ], + 'TargetUuids' => [ + 'title' => '推送目标uuid列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '推送目标uuid', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'PushingDataFormat' => [ + 'title' => '推送消息格式', + 'type' => 'string', + ], + ], + ], + 'RouteSetting' => [ + 'title' => '路由设置', + 'type' => 'object', + 'properties' => [ + 'Routes' => [ + 'title' => '路由分支列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Conditions' => [ + 'title' => '路由条件', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '字段', + 'type' => 'string', + ], + 'Op' => [ + 'title' => '比较符', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '比较值', + 'type' => 'string', + ], + ], + ], + ], + 'EscalationUuid' => [ + 'title' => '路由通知配置', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'Product' => [ + 'title' => '归属产品', + 'type' => 'string', + ], + ], + ], + 'NotificationTemplate' => [ + 'title' => '通知模板', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + 'required' => true, + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Uuid' => [ + 'title' => 'UUID', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'Type' => [ + 'title' => '模板类型', + 'type' => 'string', + 'example' => 'DATA, SMS, ONCALL, MAIL, DING, WEIXIN, FEISHU, SLACK', + ], + 'WraperType' => [ + 'title' => '封装类型', + 'type' => 'string', + 'example' => 'TEXT, MARKDOWN,CARD', + ], + 'ZhTitle' => [ + 'title' => '中文标题', + 'type' => 'string', + 'example' => '报警通知 $.alertName', + ], + 'EnTitle' => [ + 'title' => '英文标题', + 'type' => 'string', + 'example' => 'Alarm $.alertName', + ], + 'ZhContent' => [ + 'title' => '中文内容', + 'type' => 'string', + 'example' => '报警 $.alertName', + ], + 'EnContent' => [ + 'title' => '英文内容', + 'type' => 'string', + 'example' => 'Alarm $.alertName', + ], + 'ZhItemContent' => [ + 'title' => '中文单条关联报警模板格式', + 'type' => 'string', + 'example' => '报警 $.alertName', + ], + 'EnItemContent' => [ + 'title' => '英文关联报警模板格式', + 'type' => 'string', + 'example' => 'Alarm $.alertName', + ], + ], + ], + 'PushingTarget' => [ + 'title' => 'PushingTarget', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '渠道类型', + 'type' => 'string', + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Uuid' => [ + 'title' => 'UUID', + 'type' => 'string', + ], + 'UserId' => [ + 'title' => '用户id', + 'type' => 'string', + 'required' => false, + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'TemplateUuid' => [ + 'title' => 'template Uuid', + 'type' => 'string', + ], + 'HttpRequestTarget' => [ + 'title' => 'http请求设置', + 'type' => 'object', + 'properties' => [ + 'EncryptTimestampKey' => [ + 'type' => 'string', + ], + 'EncryptString' => [ + 'title' => '签名混淆字符串', + 'type' => 'string', + ], + 'ContentType' => [ + 'title' => 'content Type', + 'type' => 'string', + ], + 'EncryptSignatureKey' => [ + 'type' => 'string', + ], + 'Headers' => [ + 'title' => 'http 请求header', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => 'value', + 'type' => 'string', + ], + 'Key' => [ + 'title' => 'key', + 'type' => 'string', + ], + ], + ], + 'maxItems' => 10, + ], + 'Method' => [ + 'title' => 'http方法', + 'type' => 'string', + ], + 'Url' => [ + 'title' => 'url', + 'type' => 'string', + ], + ], + ], + 'Range' => [ + 'title' => '生效范围', + 'type' => 'string', + ], + 'Arn' => [ + 'title' => 'ARN', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'Subscription' => [ + 'title' => '报警订阅', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '名称', + 'type' => 'string', + 'required' => true, + ], + 'Description' => [ + 'title' => '描述', + 'type' => 'string', + ], + 'Uuid' => [ + 'title' => 'UUID', + 'type' => 'string', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'type' => 'string', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'type' => 'string', + ], + 'StrategyUuid' => [ + 'title' => '通知策略id', + 'type' => 'string', + ], + 'Conditions' => [ + 'title' => '订阅条件', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Field' => [ + 'title' => '字段', + 'type' => 'string', + ], + 'Operator' => [ + 'title' => '比较符', + 'type' => 'string', + ], + 'Value' => [ + 'title' => '值', + 'type' => 'string', + ], + ], + ], + 'maxItems' => 10, + ], + 'Relation' => [ + 'title' => '条件间关系', + 'type' => 'string', + ], + 'Enabled' => [ + 'title' => '是否启用', + 'type' => 'boolean', + ], + 'Product' => [ + 'title' => '归属产品', + 'type' => 'string', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateMonitorGroup' => [ + 'summary' => '调用CreateMonitorGroup接口创建应用分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组。应用分组的报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'> 报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~PutContact~~)和[PutContactGroup](~~PutContactGroup~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Alert_Group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '83C89BA6-ABD4-4398-A175-83E86C47A001', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'InvalidClientTokenId', + 'errorMessage' => 'not allow this operation.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourcesOverLimit', + 'errorMessage' => 'Resources over limit.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"83C89BA6-ABD4-4398-A175-83E86C47A001\\",\\n \\"GroupId\\": 1234567,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupResponse>\\n\\t<RequestId>83C89BA6-ABD4-4398-A175-83E86C47A001</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n\\t<GroupId>1234567</GroupId>\\n</CreateMonitorGroupResponse>\\t","errorExample":""}]', + 'title' => '创建应用分组', + 'description' => '本文将提供一个示例,创建应用分组`ECS_Group`。', + 'requestParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyMonitorGroup' => [ + 'summary' => '调用ModifyMonitorGroup接口修改应用分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs_group', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'required' => false, + 'example' => 'alarm_ecs_group', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C85A2870-5DF4-4269-BC50-ECB5E4591A80', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C85A2870-5DF4-4269-BC50-ECB5E4591A80\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改应用分组', + ], + 'DeleteMonitorGroup' => [ + 'summary' => '调用DeleteMonitorGroup接口删除指定的应用分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CA35B3AE-4FFD-4A33-AE67-67EF68711EFA', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Group' => [ + 'description' => '被删除应用分组列表。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'ECS_test', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警联系组名称。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + [ + 'errorCode' => 'InvalidClientTokenId', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"CA35B3AE-4FFD-4A33-AE67-67EF68711EFA\\",\\n \\"Success\\": true,\\n \\"Group\\": {\\n \\"GroupName\\": \\"ECS_test\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"ECS_Group\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroup>\\n\\t\\t<Group>\\n\\t\\t\\t<GroupName>ECS_test</GroupName>\\n\\t\\t\\t<ContactGroups>\\n\\t\\t\\t\\t<ContactGroup>\\n\\t\\t\\t\\t\\t<Name>ECS_Group</Name>\\n\\t\\t\\t\\t</ContactGroup>\\n\\t\\t\\t</ContactGroups>\\n\\t\\t</Group>\\n\\t\\t<RequestId>EFB8C3EC-3460-4EC9-8603-A9FE9D0A6C2C</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DeleteMonitorGroup>","errorExample":""}]', + 'title' => '删除指定的应用分组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorGroups' => [ + 'summary' => '调用DescribeMonitorGroups接口查询应用分组列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SelectContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果中是否需要包含报警联系组。取值:'."\n" + .'- true:是。'."\n" + .'- false:否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源实例ID。该参数用于查询指定实例所在的应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-abcdefgh12****', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testGroup124', + ], + ], + [ + 'name' => 'IncludeTemplateHistory', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果是否包含已应用到应用分组的报警模板历史。取值:'."\n" + .'- true:是。'."\n" + .'- false:否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。'."\n" + .'- kubernetes:从容器服务Kubernetes版同步的应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + 'enum' => [ + 'custom', + 'ehpc_cluster', + 'kubernetes', + 'tag', + 'aone_group', + 'resMgr', + 'ess', + ], + ], + ], + [ + 'name' => 'DynamicTagRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能标签规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', + ], + ], + [ + 'name' => 'GroupFounderTagKey', + 'in' => 'query', + 'schema' => [ + 'description' => '通过智能标签创建应用分组的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'GroupKey1', + ], + ], + [ + 'name' => 'GroupFounderTagValue', + 'in' => 'query', + 'schema' => [ + 'description' => '通过智能标签创建应用分组的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'GroupValue1', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。多个应用分组ID之间用半角逗号(,)分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '92****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用分组的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '应用分组的标签键。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagKey1', + ], + 'Value' => [ + 'description' => '应用分组的标签值。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagValue1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组类型。取值:'."\n" + ."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。'."\n" + .'- kubernetes:从容器服务Kubernetes版同步的应用分组。'."\n" + .'- tag:通过标签自动创建的应用分组。'."\n" + .'- resMgr:通过资源组创建的应用分组。'."\n" + .'- ess:从弹性伸缩ESS同步的应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F02B299A-D374-4595-9F55-7534D604F132', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '关联资源。', + 'type' => 'array', + 'items' => [ + 'description' => '关联资源。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '应用分组类型。取值:'."\n" + .'- custom:自建的应用分组。'."\n" + .'- ehpc_cluster:从EHPC集群同步的应用分组。'."\n" + .'- kubernetes:从容器服务Kubernetes版同步的应用分组。', + 'type' => 'string', + 'example' => 'custom', + ], + 'GroupFounderTagValue' => [ + 'description' => '通过智能标签创建应用分组的标签值。', + 'type' => 'string', + 'example' => 'GroupValue1', + ], + 'BindUrl' => [ + 'description' => '从容器服务Kubernetes版同步过来的URL地址。', + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'test123', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'ServiceId' => [ + 'description' => '阿里云服务ID。', + 'type' => 'string', + 'example' => '49****', + ], + 'DynamicTagRuleId' => [ + 'description' => '智能标签规则ID。', + 'type' => 'string', + 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', + ], + 'GmtCreate' => [ + 'description' => '创建应用分组的时间戳。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603181891000', + ], + 'GroupFounderTagKey' => [ + 'description' => '通过智能标签创建应用分组的标签键。', + 'type' => 'string', + 'example' => 'GroupKey1', + ], + 'GmtModified' => [ + 'description' => '修改应用分组的时间戳。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603181891000', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系组。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系组', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警联系组名称。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + ], + ], + ], + ], + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '应用分组绑定的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组绑定的标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '应用分组的标签键。', + 'type' => 'string', + 'example' => 'tagKey1', + ], + 'Value' => [ + 'description' => '应用分组的标签值。', + 'type' => 'string', + 'example' => 'tagValue1', + ], + ], + ], + ], + ], + ], + 'TemplateIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组应用过的报警模板。', + 'type' => 'string', + 'example' => '92****', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'rg-aek2hopjh*******', + ], + 'TemplateInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateInfo' => [ + 'description' => '模版信息。', + 'type' => 'array', + 'items' => [ + 'description' => '模版信息。', + 'type' => 'object', + 'properties' => [ + 'EffectTime' => [ + 'description' => '生效时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1603181891000', + ], + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '123***', + ], + 'Ver' => [ + 'description' => '版本。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F02B299A-D374-4595-9F55-7534D604F132\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Total\\": 10,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Type\\": \\"custom\\",\\n \\"GroupFounderTagValue\\": \\"GroupValue1\\",\\n \\"BindUrl\\": \\"https://aliyun.com\\",\\n \\"GroupName\\": \\"test123\\",\\n \\"GroupId\\": 12345,\\n \\"ServiceId\\": \\"49****\\",\\n \\"DynamicTagRuleId\\": \\"6b882d9a-5117-42e2-9d0c-4749a0c6****\\",\\n \\"GmtCreate\\": 1603181891000,\\n \\"GroupFounderTagKey\\": \\"GroupKey1\\",\\n \\"GmtModified\\": 1603181891000,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Name\\": \\"CloudMonitor\\"\\n }\\n ]\\n },\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"tagKey1\\",\\n \\"Value\\": \\"tagValue1\\"\\n }\\n ]\\n },\\n \\"TemplateIds\\": {\\n \\"TemplateId\\": [\\n \\"92****\\"\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-aek2hopjh*******\\",\\n \\"TemplateInfos\\": {\\n \\"TemplateInfo\\": [\\n {\\n \\"EffectTime\\": 1603181891000,\\n \\"TemplateId\\": \\"123***\\",\\n \\"Ver\\": \\"0\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupsResponse>\\n <RequestId>F02B299A-D374-4595-9F55-7534D604F132</RequestId>\\n <PageSize>30</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>2</Total>\\n <Resources>\\n <Resource>\\n <GroupName>testGroup124</GroupName>\\n <ContactGroups>\\n <ContactGroup>\\n <Name>CloudMonitor</Name>\\n </ContactGroup>\\n </ContactGroups>\\n <Type>custom</Type>\\n <GmtCreate>1603181891000</GmtCreate>\\n <GmtModified>1603181891000</GmtModified>\\n <GroupFounderTagKey>1204</GroupFounderTagKey>\\n <GroupFounderTagValue>001</GroupFounderTagValue>\\n <TemplateIds>\\n <TemplateId>92****</TemplateId>\\n </TemplateIds>\\n <Tags>\\n <Tag>\\n <Value>tagKey1</Value>\\n <Key>tagValue1</Key>\\n </Tag>\\n </Tags>\\n <GroupId>7301****</GroupId>\\n </Resource>\\n <Resource>\\n <GroupName>test123</GroupName>\\n <ContactGroups>\\n <ContactGroup>\\n <Name>CloudMonitor</Name>\\n </ContactGroup>\\n </ContactGroups>\\n <Type>tag</Type>\\n <GmtCreate>1603181891000</GmtCreate>\\n <DynamicTagRuleId>6b882d9a-5117-42e2-9d0c-4749a0c6****</DynamicTagRuleId>\\n <GmtModified>1603181891000</GmtModified>\\n <GroupFounderTagKey>GroupKey1</GroupFounderTagKey>\\n <GroupFounderTagValue>GroupValue1</GroupFounderTagValue>\\n <TemplateIds>\\n </TemplateIds>\\n <Tags>\\n </Tags>\\n <GroupId>92****</GroupId>\\n </Resource>\\n </Resources>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMonitorGroupsResponse>","errorExample":""}]', + 'title' => '查询应用分组列表', + 'description' => '本文将提供一个示例,查询当前账号的应用分组列表。返回结果显示当前账号存在两个应用分组`testGroup124`和`test123`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMonitorGroupInstances' => [ + 'summary' => '调用CreateMonitorGroupInstances接口添加指定资源到指定应用分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3607****', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-instance-ecs', + ], + 'Category' => [ + 'description' => '云服务名称缩写。'."\n" + ."\n" + .'关于如何获取云服务名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-2ze26xj5wwy12****', + ], + 'RegionId' => [ + 'description' => '实例所在地域。', + 'type' => 'string', + 'required' => true, + 'example' => ' cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1BC69FEB-56CD-4555-A0E2-02536A24A946', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'InvalidClientTokenId', + 'errorMessage' => 'not allow this operation.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourcesOverLimit', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"1BC69FEB-56CD-4555-A0E2-02536A24A946\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupInstancesResponse>\\n <RequestId>1BC69FEB-56CD-4555-A0E2-02536A24A946</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateMonitorGroupInstancesResponse>","errorExample":""}]', + 'title' => '添加指定资源到指定应用分组', + 'description' => '一个应用分组中,一个云服务最多添加3000个资源,单次最多添加1000个资源,应用分组中的总资源数无限制。'."\n" + ."\n" + .'本文将提供一个示例,将地域`cn-hangzhou`的云服务器ECS的实例(实例ID为`i-2ze26xj5wwy12****`,实例名称为`test-instance-ecs`)添加到应用分组`3607****`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyMonitorGroupInstances' => [ + 'summary' => '调用ModifyMonitorGroupInstances接口修改应用分组中的资源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。N的取值范围:1~2000。', + 'type' => 'string', + 'required' => true, + 'example' => 'HostName', + ], + 'Category' => [ + 'description' => '资源实例所属的云产品名称或规格。目前支持的产品如下:'."\n" + ."\n" + .'- ECS(包括阿里云和非阿里云主机)'."\n" + .'- RDS(云数据库RDS版)'."\n" + .'- ADS(分析型数据库)'."\n" + .'- SLB(负载均衡)'."\n" + .'- VPC(弹性IP)'."\n" + .'- APIGATEWAY(API网关)'."\n" + .'- CDN(内容分发网络)'."\n" + .'- CS(容器服务Swarm版)'."\n" + .'- DCDN(全站加速)'."\n" + .'- DDoS(DDoS防护)'."\n" + .'- EIP(弹性公网IP)'."\n" + .'- ELASTICSEARCH'."\n" + .'- EMR(E-MapReduce)'."\n" + .'- ESS(弹性伸缩)'."\n" + .'- HBASE(云数据库 HBase)'."\n" + .'- IOT_EDGE(IoT边缘计算)'."\n" + .'- K8S_POD(k8s pod)'."\n" + .'- KVSTORE_SHARDING(Redis集群版)'."\n" + .'- KVSTORE_SPLITRW(Redis读写分离版)'."\n" + .'- KVSTORE_STANDARD(Redis标准版)'."\n" + .'- MEMCACHE(云数据库Memcache)'."\n" + .'- MNS(轻量消息队列)(原 MNS)'."\n" + .'- MONGODB(MongoDB 副本实例)'."\n" + .'- MONGODB_CLUSTER(MongoDB集群版本)'."\n" + .'- MONGODB_SHARDING(MongoDB分片集群)'."\n" + .'- MQ_TOPIC(轻量消息队列(原 MNS)TOPIC)'."\n" + .'- OCS(旧版云数据库Memcache)'."\n" + .'- OPENSEARCH(开放搜索)'."\n" + .'- OSS(对象存储OSS)'."\n" + .'- POLARDB(云数据库PolarDB)'."\n" + .'- PETADATA(云数据库HybridDB for MySQL)'."\n" + .'- SHAREBANDWIDTHPACKAGES(共享带宽包)'."\n" + .'- SLS(日志服务)'."\n" + .'- VPN(VPN网关)'."\n" + .'N的取值范围:1~2000。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + ], + 'InstanceId' => [ + 'description' => '资源实例ID。N的取值范围:1~2000。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-a2d5q7pm12****', + ], + 'RegionId' => [ + 'description' => '地域ID(RegionId)。N的取值范围:1~2000。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 2000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourcesOverLimit', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FEC7EDB3-9B08-4AC0-A42A-329F5D14B95A\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMonitorGroupInstancesResponse>\\n <RequestId>02977C39-9E74-430A-B35B-04CFBF0E7F64</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ModifyMonitorGroupInstancesResponse>","errorExample":""}]', + 'title' => '修改应用分组中的资源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorGroupInstances' => [ + 'summary' => '调用DescribeMonitorGroupInstances接口查询指定应用分组内包含的资源列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品名称缩写。N的取值范围为1~200。'."\n" + ."\n" + .'> 关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '按照实例名称模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-s1', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '按照实例ID搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp12g4xbl4i0brkn****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '97F2A410-9412-499C-9AD1-76EF7EC02DF2', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>状态码为200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '应用分组资源的描述信息。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组资源的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '产品名称缩写。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceId' => [ + 'description' => '实例ID,实例的唯一标识。', + 'type' => 'string', + 'example' => 'i-bp12g4xbl4i0brkn****', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test-s1', + ], + 'Id' => [ + 'description' => '资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123****', + ], + 'RegionId' => [ + 'description' => '实例对应的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"97F2A410-9412-499C-9AD1-76EF7EC02DF2\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"i-bp12g4xbl4i0brkn****\\",\\n \\"InstanceName\\": \\"test-s1\\",\\n \\"Id\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PageNumber>1</PageNumber>\\n<PageSize>30</PageSize>\\n<RequestId>7670220A-0725-42EE-9252-8200C4F810D9</RequestId>\\n<Success>true</Success>\\n<Code>200</Code>\\n<Total>1</Total>\\n<Resources>\\n <Resource>\\n <Category>ECS</Category>\\n <InstanceId>i-2ze3w55tr2rcpejp****</InstanceId>\\n <RegionId>cn-beijing</RegionId>\\n <InstanceName>dynamic_group_1</InstanceName>\\n </Resource>\\n</Resources>","errorExample":""}]', + 'title' => '查询指定应用分组内包含的资源列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorGroupDynamicRules' => [ + 'summary' => '调用DescribeMonitorGroupDynamicRules接口查询指定应用分组的动态规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2170B94A-1576-4D65-900E-2093037CDAF3', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resource' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '关联资源。', + 'type' => 'array', + 'items' => [ + 'description' => '关联资源。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '动态规则对应的云服务类型。取值:'."\n" + ."\n" + .'- ecs:云服务器。'."\n" + ."\n" + .'- rds:关系型数据库。'."\n" + ."\n" + .'- slb:负载均衡。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'FilterRelation' => [ + 'description' => '筛选条件。取值:'."\n" + ."\n" + .'- and:应用分组中满足所有报警规则的实例。'."\n" + ."\n" + .'- or:应用分组中满足任意报警规则的实例。', + 'type' => 'string', + 'example' => 'and', + ], + 'Filters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Filter' => [ + 'description' => '应用分组的动态规则。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组的动态规则。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '动态规则值。', + 'type' => 'string', + 'example' => '1', + ], + 'Function' => [ + 'description' => '计算方法。取值:'."\n" + ."\n" + .'- contains:包含。'."\n" + ."\n" + .'- startWith:前缀。'."\n" + ."\n" + .'- endWith:后缀。', + 'type' => 'string', + 'example' => 'contains', + ], + 'Name' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'hostName', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"2170B94A-1576-4D65-900E-2093037CDAF3\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"Resource\\": [\\n {\\n \\"Category\\": \\"ecs\\",\\n \\"FilterRelation\\": \\"and\\",\\n \\"Filters\\": {\\n \\"Filter\\": [\\n {\\n \\"Value\\": \\"1\\",\\n \\"Function\\": \\"contains\\",\\n \\"Name\\": \\"hostName\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupDynamicRulesResponse>\\r\\n\\t<RequestId>38D0A8B4-7231-4E3E-A39F-D8CE3E242AC7</RequestId>\\r\\n\\t<Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<FilterRelation>and</FilterRelation>\\r\\n\\t\\t\\t<Filters>\\r\\n\\t\\t\\t\\t<Filter>\\r\\n\\t\\t\\t\\t\\t<Function>contains</Function>\\r\\n\\t\\t\\t\\t\\t<Value>1</Value>\\r\\n\\t\\t\\t\\t\\t<Name>hostName</Name>\\r\\n\\t\\t\\t\\t</Filter>\\r\\n\\t\\t\\t</Filters>\\r\\n\\t\\t\\t<Category>ecs</Category>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resource>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitorGroupDynamicRulesResponse>","errorExample":""}]', + 'title' => '查询指定应用分组的动态规则列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorGroupInstanceAttribute' => [ + 'summary' => '调用DescribeMonitorGroupInstanceAttribute接口查询应用分组的资源详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。'."\n" + ."\n" + .'取值范围:1~1000000000。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。'."\n" + ."\n" + .'取值范围:1~1000000000。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Total', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回指定应用分组内的资源总数。取值:'."\n" + ."\n" + .'- true(默认值):返回。'."\n" + ."\n" + .'- false:不返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务名称缩写。'."\n" + ."\n" + .'关于如何获取云服务名称缩写,请参见[DescribeProjectMeta](~~2513265~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '资源的搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'portal', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。多个资源ID之间用半角逗号(,)分隔,最多支持20个资源。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-m5e0k0bexac8tykr****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FB8EA79-7279-4482-8D6D-3D28EEDD871A', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '应用分组关联的资源。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'hostName', + ], + 'Dimension' => [ + 'description' => '应用分组关联资源的维度信息。', + 'type' => 'string', + 'example' => '{"instanceId":"i-m5e0k0bexac8tykr****"}', + ], + 'Category' => [ + 'description' => '云产品名称。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-m5e0k0bexac8tykr****', + ], + 'NetworkType' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'Desc' => [ + 'description' => '资源描述信息。', + 'type' => 'string', + 'example' => 'desc_test', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => '资源的标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'instanceNetworkType', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'VPC', + ], + ], + ], + ], + ], + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'object', + 'properties' => [ + 'AvailabilityZone' => [ + 'description' => '可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-f', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + 'Vpc' => [ + 'description' => 'VPC实例的描述信息。', + 'type' => 'object', + 'properties' => [ + 'VswitchInstanceId' => [ + 'description' => 'Vswitch实例ID。', + 'type' => 'string', + 'example' => 'vsw-2ze36seq79n992****', + ], + 'VpcInstanceId' => [ + 'description' => 'VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-2zew7etgiceg21****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FB8EA79-7279-4482-8D6D-3D28EEDD871A\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"Total\\": 12,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"InstanceName\\": \\"hostName\\",\\n \\"Dimension\\": \\"{\\\\\\"instanceId\\\\\\":\\\\\\"i-m5e0k0bexac8tykr****\\\\\\"}\\",\\n \\"Category\\": \\"ecs\\",\\n \\"InstanceId\\": \\"i-m5e0k0bexac8tykr****\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"Desc\\": \\"desc_test\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"instanceNetworkType\\",\\n \\"Value\\": \\"VPC\\"\\n }\\n ]\\n },\\n \\"Region\\": {\\n \\"AvailabilityZone\\": \\"cn-hangzhou-f\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n },\\n \\"Vpc\\": {\\n \\"VswitchInstanceId\\": \\"vsw-2ze36seq79n992****\\",\\n \\"VpcInstanceId\\": \\"vpc-2zew7etgiceg21****\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupInstanceAttributeResponse>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<PageSize>30</PageSize>\\r\\n\\t<RequestId>7DB8DA3D-EDA6-46F8-9222-70C52416AE7D</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Total>1</Total>\\r\\n\\t<Resources>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<Vpc>\\r\\n\\t\\t\\t\\t<VswitchInstanceId>vsw-2ze36seq79n992****</VswitchInstanceId>\\r\\n\\t\\t\\t\\t<VpcInstanceId>vpc-2zew7etgiceg21****</VpcInstanceId>\\r\\n\\t\\t\\t</Vpc>\\r\\n\\t\\t\\t<Tags>\\r\\n\\t\\t\\t\\t<Tag>\\r\\n\\t\\t\\t\\t\\t<Value>12345</Value>\\r\\n\\t\\t\\t\\t\\t<Key>aliUid</Key>\\r\\n\\t\\t\\t\\t</Tag>\\r\\n\\t\\t\\t\\t<Tag>\\r\\n\\t\\t\\t\\t\\t<Value>26842</Value>\\r\\n\\t\\t\\t\\t\\t<Key>bid</Key>\\r\\n\\t\\t\\t\\t</Tag>\\r\\n\\t\\t\\t</Tags>\\r\\n\\t\\t\\t<NetworkType>VPC</NetworkType>\\r\\n\\t\\t\\t<Category>RDS</Category>\\r\\n\\t\\t\\t<Region>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t\\t<AvailabilityZone>cn-hangzhou-MAZ8(f,g)</AvailabilityZone>\\r\\n\\t\\t\\t</Region>\\r\\n\\t\\t\\t<AliUid>127067667954****</AliUid>\\r\\n\\t\\t\\t<InstanceId>i-m5e0k0bexac8tykr****</InstanceId>\\r\\n\\t\\t\\t<Dimension>{\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"rm-bp179a8xfaz4i****\\\\\\"}</Dimension>\\r\\n\\t\\t\\t<Desc>test_name</Desc>\\r\\n\\t\\t\\t<InstanceName>test_name</InstanceName>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resources>\\r\\n</DescribeMonitorGroupInstanceAttributeResponse>","errorExample":""}]', + 'title' => '查询应用分组的资源详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMonitorGroupDynamicRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '动态规则对应的云产品类型,取值:ecs、rds、slb。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '56B4516A-EB44-4C66-8854-0393B35F636B', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"56B4516A-EB44-4C66-8854-0393B35F636B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroupDynamicRuleResponse>\\n <RequestId>56B4516A-EB44-4C66-8854-0393B35F636B</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitorGroupDynamicRuleResponse>","errorExample":""}]', + 'title' => '删除指定应用分组的动态规则', + 'summary' => '调用DeleteMonitorGroupDynamicRule接口删除指定应用分组的动态规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMonitorGroupInstances' => [ + 'summary' => '调用DeleteMonitorGroupInstances接口删除应用分组内的资源实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'InstanceIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的实例,多个实例之间用英文逗号分隔开。一次最多能够删除20个。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-a2d5q7pm3f912****,i-a2d5q7pm3f222****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'> 关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5351B0F2-26A9-4BC9-87FF-1B74034D12C3', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:表示成功。'."\n" + .'- false:表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"5351B0F2-26A9-4BC9-87FF-1B74034D12C3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroupInstancesResponse>\\n <RequestId>C5C6924C-237E-40B2-9510-41BF8F671102</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitorGroupInstancesResponse>","errorExample":""}]', + 'title' => '删除应用分组内的资源实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorGroupCategories' => [ + 'summary' => '调用DescribeMonitorGroupCategories接口查询指定应用分组的资源列表和每个云服务的资源数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E0347B0-EBC3-4769-A78D-D96F21C6BB52', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MonitorGroupCategories' => [ + 'description' => '应用分组中资源的云服务类型。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'MonitorGroupCategory' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CategoryItem' => [ + 'description' => '应用分组的云服务类型。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组的云服务类型。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '云服务的资源数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Category' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'> 关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"9E0347B0-EBC3-4769-A78D-D96F21C6BB52\\",\\n \\"Success\\": true,\\n \\"MonitorGroupCategories\\": {\\n \\"GroupId\\": 123456,\\n \\"MonitorGroupCategory\\": {\\n \\"CategoryItem\\": [\\n {\\n \\"Count\\": 1,\\n \\"Category\\": \\"ecs\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupCategoriesResponse>\\r\\n\\t<RequestId>B7C9F725-E743-4F2E-81A2-4CC19783DC42</RequestId>\\r\\n\\t<MonitorGroupCategories>\\r\\n\\t\\t<MonitorGroupCategory>\\r\\n\\t\\t\\t<CategoryItem>\\r\\n\\t\\t\\t\\t<Category>ECS</Category>\\r\\n\\t\\t\\t\\t<Count>39</Count>\\r\\n\\t\\t\\t</CategoryItem>\\r\\n\\t\\t</MonitorGroupCategory>\\r\\n\\t\\t<GroupId>123456</GroupId>\\r\\n\\t</MonitorGroupCategories>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitorGroupCategoriesResponse>","errorExample":""}]', + 'title' => '查询指定应用分组的资源列表和每个云服务的资源数量', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutMonitorGroupDynamicRule' => [ + 'summary' => '调用PutMonitorGroupDynamicRule接口创建或修改按照实例名称动态匹配的应用分组,满足匹配规则的所有实例自动添加到该应用分组中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'GroupRules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'FilterRelation' => [ + 'description' => '动态报警规则的组合条件。N的取值范围:1~3。取值:'."\n" + ."\n" + .'- and:满足所有报警规则的实例才会自动添加到应用分组。'."\n" + ."\n" + .'- or:满足任意报警规则的实例都会自动添加到应用分组。', + 'type' => 'string', + 'required' => true, + 'example' => 'and', + ], + 'Filters' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '满足报警条件的值。N的取值范围:1~3。', + 'type' => 'string', + 'required' => true, + 'example' => 'nginx', + ], + 'Name' => [ + 'description' => '实例匹配的字段名称。N的取值范围:1~3。'."\n" + ."\n" + .'目前仅支持主机名,例如:hostName。', + 'type' => 'string', + 'required' => true, + 'example' => 'hostName', + ], + 'Function' => [ + 'description' => '实例的过滤条件。N的取值范围:1~3。取值:'."\n" + .'- contains:包含。'."\n" + .'- notContains:不包含。'."\n" + .'- startWith:前缀。'."\n" + .'- endWith:后缀。', + 'type' => 'string', + 'required' => true, + 'example' => 'contains', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + 'Category' => [ + 'description' => '动态报警规则的云服务类型。N的取值范围:1~3。取值:'."\n" + ."\n" + .'- ecs:云服务器ECS。'."\n" + ."\n" + .'- rds:关系型数据库。'."\n" + ."\n" + .'- slb:负载均衡。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'IsAsync', + 'in' => 'query', + 'schema' => [ + 'description' => '创建动态报警规则的模式。取值:'."\n" + ."\n" + .'- true:异步创建。'."\n" + .'- false(默认值):同步创建。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3E73F1AB-D195-438A-BCA7-2F4355789C58', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => 'OverLimit', + 'errorMessage' => 'Matched instances count was over limit', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3E73F1AB-D195-438A-BCA7-2F4355789C58\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutMonitorGroupDynamicRuleResponse>\\n\\t<RequestId>3E73F1AB-D195-438A-BCA7-2F4355789C58</RequestId>\\n\\t<Success>true</Success>\\n\\t<Code>200</Code>\\n</PutMonitorGroupDynamicRuleResponse>\\t","errorExample":""}]', + 'title' => '创建或修改按照实例名称动态匹配的应用分组', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateGroupMonitoringAgentProcess' => [ + 'summary' => '调用CreateGroupMonitoringAgentProcess接口创建组进程监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3607****', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Process_Java', + ], + ], + [ + 'name' => 'MatchExpressFilterRelation', + 'in' => 'query', + 'schema' => [ + 'description' => '匹配实例的条件。取值:'."\n" + ."\n" + .'- all:全部。'."\n" + .'- and:与。'."\n" + .'- or:或。', + 'type' => 'string', + 'required' => false, + 'example' => 'and', + ], + ], + [ + 'name' => 'MatchExpress', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '匹配条件表达式列表。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'array', + 'items' => [ + 'description' => '匹配条件表达式列表。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '匹配实例名称。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'string', + 'required' => false, + 'example' => 'portalHost', + ], + 'Name' => [ + 'description' => '匹配条件的类型。'."\n" + ."\n" + .'N的取值范围:1~3。'."\n" + ."\n" + .'>目前仅支持Name,即实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name1', + ], + 'Function' => [ + 'description' => '匹配条件。取值:'."\n" + .'- all(默认值):全部。'."\n" + .'- startWith:前缀。'."\n" + .'- endWith:后缀。'."\n" + .'- contains:包含。'."\n" + .'- notContains:不包含。'."\n" + .'- equals:相等。'."\n" + ."\n" + .'N的取值范围:1~3。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'startWith', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'AlertConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '报警规则配置列表。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则配置列表。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通道沉默周期。单位:秒。最小值:3600秒(1小时),默认值:86400秒(1天)。'."\n" + ."\n" + .'N的取值范围:1~3。'."\n" + ."\n" + .'>当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'string', + 'required' => false, + 'example' => '86400', + 'default' => '86400', + ], + 'ComparisonOperator' => [ + 'description' => '阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'string', + 'required' => true, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Webhook' => [ + 'description' => '报警回调URL地址。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + 'Times' => [ + 'description' => '报警级别连续出现次数。默认:3次。'."\n" + ."\n" + .'N的取值范围:1~3。'."\n" + ."\n" + .'>只有当报警级别连续出现设定的次数且达到报警阈值才会触发报警。', + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + 'EscalationsLevel' => [ + 'description' => '报警级别。取值:'."\n" + .'- critical(默认值):故障。'."\n" + .'- warn:警告。'."\n" + .'- info:信息。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'string', + 'required' => true, + 'example' => 'warn', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间段。'."\n" + ."\n" + .'N的取值范围:1~3。', + 'type' => 'string', + 'required' => false, + 'example' => '07:00-22:59', + ], + 'NoEffectiveInterval' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-05:30', + ], + 'Threshold' => [ + 'description' => '报警阈值。'."\n" + ."\n" + .'N的取值范围:1~3。'."\n" + ."\n" + .'单位:个。', + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + 'Statistics' => [ + 'description' => '报警统计方式。'."\n" + ."\n" + .'N的取值范围:1~3。'."\n" + ."\n" + .'>目前仅支持Average。', + 'type' => 'string', + 'required' => true, + 'example' => 'Average', + ], + 'TargetList' => [ + 'description' => '报警触发列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警触发列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。'."\n" + ."\n" + .'关于如何获取报警触发目标ID,请参见[DescribeMetricRuleTargets](~~121592~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。'."\n" + ."\n" + .'关于如何获取资源ARN,请参见[DescribeMetricRuleTargets](~~121592~~)。'."\n" + ."\n" + .'资源ARN的格式为`acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。例如:`acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`。参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:目前仅支持轻量消息队列(原 MNS)。'."\n" + ."\n" + .'- {userId}:阿里云账号ID。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + ."\n" + .'- {资源类型}:接收报警的资源类型。取值:'."\n" + .' '."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'required' => false, + 'example' => '["INFO", "WARN", "CRITICAL"]', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 3, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '718FEA81-64C3-4F23-8F90-0531F7489FC1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resource' => [ + 'description' => '组进程信息。', + 'type' => 'object', + 'properties' => [ + 'GroupProcessId' => [ + 'description' => '组进程ID。', + 'type' => 'string', + 'example' => '7F2B0024-4F21-48B9-A764-211CEC48****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"718FEA81-64C3-4F23-8F90-0531F7489FC1\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"GroupProcessId\\": \\"7F2B0024-4F21-48B9-A764-211CEC48****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupMonitoringAgentProcessResponse>\\n <Code>200</Code>\\n <RequestId>718FEA81-64C3-4F23-8F90-0531F7489FC1</RequestId>\\n <Success>true</Success>\\n <Resource>\\n <GroupProcessId>7F2B0024-4F21-48B9-A764-211CEC48****</GroupProcessId>\\n </Resource>\\n</CreateGroupMonitoringAgentProcessResponse>","errorExample":""}]', + 'title' => '创建组进程监控', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyGroupMonitoringAgentProcess' => [ + 'summary' => '调用ModifyGroupMonitoringAgentProcess接口修改应用分组内的进程监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组内的进程监控任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '92E3065F-0980-4E31-9AA0-BA6****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '6780****', + ], + ], + [ + 'name' => 'MatchExpressFilterRelation', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => 'and', + ], + ], + [ + 'name' => 'AlertConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '报警规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通道沉默周期。N的取值范围:1~200。'."\n" + ."\n" + .'单位:秒。最小值:3600秒(1小时),默认值:86400秒(1天)。'."\n" + .'>当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'string', + 'required' => false, + 'example' => '86400', + ], + 'ComparisonOperator' => [ + 'description' => 'Critical级别阈值比较符。N的取值范围:1~200。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'required' => true, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Webhook' => [ + 'description' => '报警发生时回调指定的URL地址,向URL发送POST请求。N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + 'Times' => [ + 'description' => '报警级别连续出现次数。N的取值范围:1~200。默认值:3。'."\n" + ."\n" + .'>只有当报警级别连续出现设定的次数且达到报警阈值时,才会触发报警。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3', + ], + 'EscalationsLevel' => [ + 'description' => '报警的级别。N的取值范围:1~200。取值:'."\n" + .'- critical(默认值):故障。'."\n" + .'- warn:警告。'."\n" + .'- info:信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'warn', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间段。N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-22:59', + ], + 'NoEffectiveInterval' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-05:30', + ], + 'Threshold' => [ + 'description' => '报警阈值。N的取值范围:1~200。', + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + 'Statistics' => [ + 'description' => '报警统计方式。N的取值范围:1~200。'."\n" + ."\n" + .'>目前仅支持Average。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'TargetList' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。'."\n" + ."\n" + .'关于如何获取报警触发目标ID,请参见[DescribeMetricRuleTargets](~~121592~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。'."\n" + ."\n" + .'关于如何获取资源ARN,请参见[DescribeMetricRuleTargets](~~121592~~)。'."\n" + ."\n" + .'资源ARN的格式为`acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。例如:`acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`。参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:目前仅支持轻量消息队列(原 MNS)。'."\n" + ."\n" + .'- {userId}:阿里云账号ID。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + ."\n" + .'- {资源类型}:接收报警的资源类型。取值:'."\n" + ."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'required' => false, + 'example' => '["INFO", "WARN", "CRITICAL"]', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 3, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyGroupMonitoringAgentProcess>\\n\\t\\t<RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</ModifyGroupMonitoringAgentProcess>","errorExample":""}]', + 'title' => '修改应用分组内的进程监控', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteGroupMonitoringAgentProcess' => [ + 'summary' => '调用DeleteGroupMonitoringAgentProcess接口删除组进程监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '组进程ID。', + 'type' => 'string', + 'required' => true, + 'example' => '48F83746-C817-478C-9B06-7158F56B****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F6150F9-45C7-43F9-9578-A58B2E726C90', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"3F6150F9-45C7-43F9-9578-A58B2E726C90\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteGroupMonitoringAgentProcessResponse>\\n\\t\\t<RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</DeleteGroupMonitoringAgentProcessResponse>","errorExample":""}]', + 'title' => '删除组进程监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeGroupMonitoringAgentProcess' => [ + 'summary' => '调用DescribeGroupMonitoringAgentProcess接口获取组进程监控任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sshd', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7985D471-3FA8-4EE9-8F4B-45C19DF3D36F', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'PageNumber' => [ + 'description' => '分页码。默认值:1。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示记录条数。默认值:10。', + 'type' => 'string', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'string', + 'example' => '28', + ], + 'Processes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Process' => [ + 'description' => '进程任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '进程任务。', + 'type' => 'object', + 'properties' => [ + 'ProcessName' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'example' => 'sshd', + ], + 'MatchExpressFilterRelation' => [ + 'description' => '匹配实例的条件。取值:'."\n" + .'- all:全部。'."\n" + .'- and:与。'."\n" + .'- or:或。', + 'type' => 'string', + 'example' => 'and', + ], + 'GroupId' => [ + 'description' => '应用分组的ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'Id' => [ + 'description' => '进程任务的ID。', + 'type' => 'string', + 'example' => '3F6150F9-45C7-43F9-9578-A58B2E72****', + ], + 'MatchExpress' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchExpress' => [ + 'description' => '匹配条件。'."\n" + ."\n" + .'>只有符合匹配条件的应用分组,实例才能被添加到对应的进程中。', + 'type' => 'array', + 'items' => [ + 'description' => '匹配条件。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '匹配实例名称。', + 'type' => 'string', + 'example' => 'portalHost', + ], + 'Name' => [ + 'description' => '匹配条件的类型。'."\n" + ."\n" + .'>目前仅支持`name`,即实例名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'Function' => [ + 'description' => '匹配条件。取值:'."\n" + .'- all(默认值):全部。'."\n" + .'- startWith:前缀。'."\n" + .'- endWith:后缀。'."\n" + .'- contains:包含。'."\n" + .'- notContains:不包含。'."\n" + .'- equals:相等。'."\n" + ."\n" + .'>对于满足条件的规则,实例会添加对应的进程监控。', + 'type' => 'string', + 'example' => 'all', + ], + ], + ], + ], + ], + ], + 'AlertConfig' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertConfig' => [ + 'description' => '报警规则配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则配置信息。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'SilenceTime' => [ + 'description' => '通道沉默周期。单位:秒。最短:3600秒(1小时),默认值:86400秒(1天)。'."\n" + .'>当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'string', + 'example' => '86400', + ], + 'Webhook' => [ + 'description' => '报警发生时回调指定的URL地址,向URL发送POST请求。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + ], + 'Times' => [ + 'description' => '级别连续出现次数。'."\n" + ."\n" + .'>只有当级别连续出现设定的次数且超过阈值时,才会触发报警。', + 'type' => 'string', + 'example' => '3', + ], + 'EscalationsLevel' => [ + 'description' => '报警的级别。取值:'."\n" + .'- critical:故障。'."\n" + .'- warn:警告。'."\n" + .'- info:信息。', + 'type' => 'string', + 'example' => 'warn', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警规则不生效时间段。', + 'type' => 'string', + 'example' => '00:00-23:59', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间段。', + 'type' => 'string', + 'example' => '00:00-23:59', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '5', + ], + 'Statistics' => [ + 'description' => '报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + 'TargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => '报警触发目标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警触发目标。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。', + 'type' => 'string', + 'example' => '123', + ], + 'Arn' => [ + 'description' => '资源ARN。格式为acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message。例如:acs:mns:cn-hangzhou:120886317861****:/queues/test123/message。参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:目前仅支持轻量消息队列(原 MNS)。'."\n" + .'- {userId}:阿里云账号ID。'."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + .'- {资源类型}:接收报警的资源类型。取值: '."\n" + .' - **queues**:队列。 '."\n" + .' - **topics**:主题。 '."\n" + .'- {资源名称}:资源名称。 '."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。 '."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + 'JsonParmas' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7985D471-3FA8-4EE9-8F4B-45C19DF3D36F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"Total\\": \\"28\\",\\n \\"Processes\\": {\\n \\"Process\\": [\\n {\\n \\"ProcessName\\": \\"sshd\\",\\n \\"MatchExpressFilterRelation\\": \\"and\\",\\n \\"GroupId\\": \\"12345\\",\\n \\"Id\\": \\"3F6150F9-45C7-43F9-9578-A58B2E72****\\",\\n \\"MatchExpress\\": {\\n \\"MatchExpress\\": [\\n {\\n \\"Value\\": \\"portalHost\\",\\n \\"Name\\": \\"name\\",\\n \\"Function\\": \\"all\\"\\n }\\n ]\\n },\\n \\"AlertConfig\\": {\\n \\"AlertConfig\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"SilenceTime\\": \\"86400\\",\\n \\"Webhook\\": \\"http://www.aliyun.com\\",\\n \\"Times\\": \\"3\\",\\n \\"EscalationsLevel\\": \\"warn\\",\\n \\"NoEffectiveInterval\\": \\"00:00-23:59\\",\\n \\"EffectiveInterval\\": \\"00:00-23:59\\",\\n \\"Threshold\\": \\"5\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"TargetList\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"123\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:120886317861****:/queues/test/message\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"JsonParmas\\": \\"{\\\\\\"customField1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"customField2\\\\\\":\\\\\\"$.name\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeGroupMonitoringAgentProcess>\\r\\n\\t\\t<RequestId>7985D471-3FA8-4EE9-8F4B-45C19DF3D36F</RequestId>\\r\\n\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<Total>28</Total>\\r\\n\\t\\t<Processes>\\r\\n\\t\\t\\t<Process>\\r\\n\\t\\t\\t\\t<ProcessName>sshd</ProcessName>\\r\\n\\t\\t\\t\\t<MatchExpressFilterRelation>and</MatchExpressFilterRelation>\\r\\n\\t\\t\\t\\t<Id>3F6150F9-45C7-43F9-9578-A58B2E72****</Id>\\r\\n\\t\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t\\t</Process>\\r\\n\\t\\t\\t<Process>\\r\\n\\t\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t\\t\\t<Function>all</Function>\\r\\n\\t\\t\\t\\t\\t\\t<Value>portalHost</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Name>name</Name>\\r\\n\\t\\t\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t\\t\\t<NoEffectiveInterval>00:00-23:59</NoEffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Webhook>http://www.aliyun.com</Webhook>\\r\\n\\t\\t\\t\\t\\t\\t<EffectiveInterval>00:00-23:59</EffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<EscalationsLevel>warn</EscalationsLevel>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>5</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t\\t<Function>all</Function>\\r\\n\\t\\t\\t\\t\\t\\t<Value>portalHost</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Name>name</Name>\\r\\n\\t\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t\\t<NoEffectiveInterval>00:00-23:59</NoEffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Webhook>http://www.aliyun.com</Webhook>\\r\\n\\t\\t\\t\\t\\t\\t<EffectiveInterval>00:00-23:59</EffectiveInterval>\\r\\n\\t\\t\\t\\t\\t\\t<EscalationsLevel>warn</EscalationsLevel>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>5</Threshold>\\r\\n\\t\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t</Process>\\r\\n\\t\\t</Processes>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeGroupMonitoringAgentProcess>\\r\\n","errorExample":""}]', + 'title' => '获取组进程监控任务列表', + 'description' => '组进程监控用于为组内的所有ECS实例或满足条件的ECS实例同时添加一个进程监控并设置报警规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMonitorGroupNotifyPolicy' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停通知类型。目前仅支持PauseNotify。', + 'type' => 'string', + 'required' => true, + 'example' => 'PauseNotify', + 'enum' => [ + 'PauseNotify', + ], + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '7301****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停通知的开始时间戳。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1622949300000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停通知的结束时间戳。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1623208500000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '13356BCA-3EC3-4748-A771-2064DA69AEF1', + ], + 'Result' => [ + 'description' => '返回创建的结果数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"13356BCA-3EC3-4748-A771-2064DA69AEF1\\",\\n \\"Result\\": 1,\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupNotifyPolicyResponse>\\n\\t\\t<RequestId>13356BCA-3EC3-4748-A771-2064DA69AEF1</RequestId>\\n\\t\\t<Result>1</Result>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</CreateMonitorGroupNotifyPolicyResponse>","errorExample":""}]', + 'title' => '为应用分组创建暂停报警通知策略', + 'summary' => '调用CreateMonitorGroupNotifyPolicy接口为应用分组创建暂停报警通知策略。', + 'description' => '在策略的生效期间内,应用分组内发生的所有报警都不再发送通知。'."\n" + .' '."\n" + .'本文将提供一个示例,为应用分组`7301****`创建暂停报警通知策略`PauseNotify`,该应用分组将在`1622949300000`至`1623208500000`(北京时间`2021-06-06 11:15:00`至`2021-06-09 11:15:00`)期间暂停报警。 ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'extraInfo' => ' ', + ], + 'DeleteMonitorGroupNotifyPolicy' => [ + 'summary' => '调用DeleteMonitorGroupNotifyPolicy接口删除暂停指定应用分组报警通知策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停通知类型。'."\n" + ."\n" + .'目前仅支持PauseNotify。', + 'type' => 'string', + 'required' => true, + 'example' => 'PauseNotify', + 'enum' => [ + 'PauseNotify', + ], + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '6780****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B7AF834D-D38B-4A46-920B-FE974EB7E135', + ], + 'Result' => [ + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"B7AF834D-D38B-4A46-920B-FE974EB7E135\\",\\n \\"Result\\": 1,\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitorGroupNotifyPolicyResponse>\\n <Result>1</Result>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitorGroupNotifyPolicyResponse>","errorExample":""}]', + 'title' => '删除暂停指定应用分组报警通知策略', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorGroupNotifyPolicyList' => [ + 'summary' => '调用DescribeMonitorGroupNotifyPolicyList接口查询应用分组的报警通知暂停策略列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PolicyType', + 'in' => 'query', + 'schema' => [ + 'description' => '暂停通知类型。'."\n" + ."\n" + .'目前仅支持PauseNotify。', + 'type' => 'string', + 'required' => true, + 'example' => 'PauseNotify', + 'enum' => [ + 'PauseNotify', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录条数。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '6780****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6072F026-C441-41A6-B114-35A1E8F8FDD3', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'NotifyPolicyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NotifyPolicy' => [ + 'description' => '暂停通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1551761781273', + ], + 'Type' => [ + 'description' => '禁用类型。', + 'type' => 'string', + 'example' => 'PauseNotify', + ], + 'StartTime' => [ + 'description' => '开始时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1551761781273', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '6780****', + ], + 'Id' => [ + 'description' => '暂停通知ID。', + 'type' => 'string', + 'example' => '123****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6072F026-C441-41A6-B114-35A1E8F8FDD3\\",\\n \\"Total\\": 11,\\n \\"Success\\": \\"true\\",\\n \\"NotifyPolicyList\\": {\\n \\"NotifyPolicy\\": [\\n {\\n \\"EndTime\\": 1551761781273,\\n \\"Type\\": \\"PauseNotify\\",\\n \\"StartTime\\": 1551761781273,\\n \\"GroupId\\": \\"6780****\\",\\n \\"Id\\": \\"123****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorGroupNotifyPolicyListResponse>\\n <NotifyPolicyList>\\n <NotifyPolicy>\\n <Type>PauseNotify</Type>\\n <EndTime>1551763581273</EndTime>\\n <Id>123****</Id>\\n <StartTime>1551761781273</StartTime>\\n <GroupId>6780****</GroupId>\\n </NotifyPolicy>\\n </NotifyPolicyList>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Total>1</Total>\\n</DescribeMonitorGroupNotifyPolicyListResponse>","errorExample":""}]', + 'title' => '查询应用分组的报警通知暂停策略列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddTags' => [ + 'summary' => '调用AddTags接口为指定应用分组绑定标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + ."\n" + .'N的取值范围:1~3。Key的取值范围:1~64个字符。'."\n" + ."\n" + .'您可以输入新标签键,也可以使用云监控已存在的标签键。关于如何获取标签键,请参见[DescribeTagKeyList](~~2513189~~)。'."\n" + ."\n" + .'> Key不能以`aliyun`和`acs:`开头,且标签键(`Tag.N.Key`)和标签值(`Tag.N.Value`)必须同时设置。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'N的取值范围:1~3。Value的取值范围:1~64个字符。'."\n" + ."\n" + .'您可以输入新标签值,也可以使用云监控已存在的标签值。关于如何获取标签值,请参见[DescribeTagValueList](~~2513188~~)。'."\n" + ."\n" + .'> Value不能以`aliyun`和`acs:`开头,且标签键(`Tag.N.Key`)和标签值(`Tag.N.Value`)必须同时设置。', + 'type' => 'string', + 'required' => true, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'N的取值范围:1~20。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~2513168~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组id。', + 'type' => 'string', + 'required' => false, + 'example' => '7301****', + ], + 'required' => true, + 'example' => '7301****', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DAE4B115-3847-5438-8709-423627F0A3A3', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"DAE4B115-3847-5438-8709-423627F0A3A3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddTagsResponse>\\r\\n\\t<RequestId>DAE4B115-3847-5438-8709-423627F0A3A3</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</AddTagsResponse>\\t","errorExample":""}]', + 'title' => '为指定应用分组绑定标签', + 'description' => '本文将提供一个示例,为应用分组`7301****`绑定一个标签,其中标签键为`key1`,标签值为`value1`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~315526~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDynamicTagGroup' => [ + 'summary' => '调用CreateDynamicTagGroup接口通过标签自动创建应用分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => [ + 'description' => '资源的标签键。'."\n" + ."\n" + .'关于如何查询资源的标签键,请参见[DescribeTagKeyList](~~145558~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs_instance', + ], + ], + [ + 'name' => 'ContactGroupList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警联系组。N的取值范围:1~100。应用分组的报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~114923~~)和[PutContactGroup](~~114929~~)。关于如何获取报警联系组,请参见[DescribeContactGroupList](~~114922~~)。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '报警联系组。N的取值范围:1~100。应用分组的报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~114923~~)和[PutContactGroup](~~114929~~)。关于如何获取报警联系组,请参见[DescribeContactGroupList](~~114922~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ECS_Group', + ], + 'required' => true, + 'docRequired' => true, + 'example' => 'ECS_Group', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'MatchExpress', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签生成应用分组的匹配表达式。', + 'type' => 'array', + 'items' => [ + 'description' => '标签生成应用分组的匹配表达式。N取值为1~3。', + 'type' => 'object', + 'properties' => [ + 'TagValueMatchFunction' => [ + 'description' => '资源标签值的匹配方法。N的取值为1。取值:'."\n" + .'- contains:包含。'."\n" + .'- startWith:前缀。'."\n" + .'- endWith:后缀。'."\n" + .'- notContains:不包含。'."\n" + .'- equals:等于。'."\n" + .'- all:全部。'."\n" + ."\n" + .'> 参数`MatchExpress.N.TagValueMatchFunction`和`MatchExpress.N.TagValue`必须同时设置。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'contains', + ], + 'TagValue' => [ + 'description' => '资源标签值。N取值为1。'."\n" + ."\n" + .'> 参数`MatchExpress.N.TagValueMatchFunction`和`MatchExpress.N.TagValue`必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'instance', + ], + 'TagName' => [ + 'description' => '用来创建分组的Tag的Key。如果包含此Key的资源有多个,那么会根据过滤条件,把符合的资源按相同的Key-Value,添加到相同的分组内。', + 'type' => 'string', + 'required' => false, + 'example' => 'appname', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 3, + ], + ], + [ + 'name' => 'TagRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签归属的地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnableSubscribeEvent', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组是否开启自动订阅事件通知。当应用分组内资源发生严重和警告级别的事件时,云监控发送报警通知。取值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false(默认值):关闭。'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableInstallAgent', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组是否开启自动安装云监控插件。云监控自动为应用分组内的主机安装云监控插件。取值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false(默认值):关闭。'."\n" + ."\n\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MatchExpressFilterRelation', + 'in' => 'query', + 'schema' => [ + 'description' => '资源标签值的条件表达式之间的关系。取值:'."\n" + ."\n" + .'- and(默认值):和。'."\n" + .'- or:或。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'and', + 'default' => 'and', + ], + ], + [ + 'name' => 'TemplateIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警模板ID。'."\n" + ."\n" + .'关于如何查询报警模板ID,请参见[DescribeMetricRuleTemplateList](~~114982~~)。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '报警模板ID。'."\n" + ."\n" + .'关于如何查询报警模板ID,请参见[DescribeMetricRuleTemplateList](~~114982~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '70****', + ], + 'required' => false, + 'example' => '85****', + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'> 200表示成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '84AC6F0B-7945-466A-AA44-99BB5A561F86', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '标签匹配规则ID。', + 'type' => 'string', + 'example' => '2534dc0a-e3e5-4ae1-a2fc-75ef166c****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 429 => [ + [ + 'errorCode' => 'ResourceOverLimit', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"84AC6F0B-7945-466A-AA44-99BB5A561F86\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"2534dc0a-e3e5-4ae1-a2fc-75ef166c****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDynamicTagGroupResponse>\\r\\n\\t<RequestId>84AC6F0B-7945-466A-AA44-99BB5A561F86</RequestId>\\r\\n\\t<Id>2534dc0a-e3e5-4ae1-a2fc-75ef166c****</Id>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</CreateDynamicTagGroupResponse>\\t","errorExample":""}]', + 'title' => '通过标签自动创建应用分组', + 'description' => '本接口支持的云服务包括:云服务器ECS、云数据库RDS和负载均衡SLB。'."\n" + ."\n" + .'本文将提供一个示例,为绑定了标签键`ecs_instance`的资源自动创建应用分组,应用分组的报警联系组为`ECS_Group`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDynamicTagGroup' => [ + 'summary' => '调用DeleteDynamicTagGroup接口删除智能标签规则。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DynamicTagRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能标签规则ID。'."\n" + ."\n" + .'关于如何获取智能标签ID,请参见[DescribeDynamicTagRuleList](~~150126~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '6b882d9a-5117-42e2-9d0c-4749a0c6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '08AAE67E-77B5-485B-9C79-D7C8C059150A', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"08AAE67E-77B5-485B-9C79-D7C8C059150A\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteDynamicTagGroupResponse>\\n <RequestId>08AAE67E-77B5-485B-9C79-D7C8C059150A</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteDynamicTagGroupResponse>","errorExample":""}]', + 'title' => '删除智能标签规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTagValueList' => [ + 'summary' => '调用DescribeTagValueList接口查询指定标签键对应的标签值列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1,默认值:1。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。'."\n" + ."\n" + .'关于如何获取标签键,请参见[DescribeTagKeyList](~~145558~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'tagKey1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B04B8CF3-4489-432D-83BA-6F128E4F2295', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagValues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'si-65d55ff37d6c4b4ea3b3', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"B04B8CF3-4489-432D-83BA-6F128E4F2295\\",\\n \\"Success\\": true,\\n \\"TagValues\\": {\\n \\"TagValue\\": [\\n \\"si-65d55ff37d6c4b4ea3b3\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询指定标签键对应的标签值列表', + ], + 'DescribeTagKeyList' => [ + 'summary' => '调用DescribeTagKeyList接口查询标签键列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Specified parameter PageSize is not valid.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B04B8CF3-4489-432D-83BA-6F128E5F2293', + ], + 'Success' => [ + 'description' => '用于标识本次调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 't0et07752s_', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"RequestId\\": \\"B04B8CF3-4489-432D-83BA-6F128E5F2293\\",\\n \\"Success\\": true,\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"t0et07752s_\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询标签键列表', + ], + 'DescribeProductResourceTagKeyList' => [ + 'summary' => '调用DescribeProductResourceTagKeyList接口获取对应地域下云资源的所有标签键列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'dbc2826f237e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The request processing has failed due to some unknown error.', + ], + 'NextToken' => [ + 'description' => '下一个查询开始的token。', + 'type' => 'string', + 'example' => 'dbc2826f237e****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '945ACAA9-89F2-4A62-8913-076FDEDAA8DB', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TagKeys' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag_******', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"NextToken\\": \\"dbc2826f237e****\\",\\n \\"RequestId\\": \\"945ACAA9-89F2-4A62-8913-076FDEDAA8DB\\",\\n \\"Success\\": true,\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"tag_******\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取对应地域下云资源的所有标签键列表', + ], + 'DescribeDynamicTagRuleList' => [ + 'summary' => '调用DescribeDynamicTagRuleList接口查询智能标签的规则列表。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TagRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '标签归属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。'."\n" + ."\n" + .'关于如何获取标签键,请参见[DescribeTagKeyList](~~145558~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagkey1', + ], + ], + [ + 'name' => 'TagValue', + 'in' => 'query', + 'schema' => [ + 'description' => '标签值。'."\n" + ."\n" + .'关于如何获取标签值,请参见[DescribeTagValueList](~~145557~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:30。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'DynamicTagRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能标签规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '004155fa-15ba-466d-b61a-***********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0D50523D-8D59-4A61-B58E-E2286ECFB3A9', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'string', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Total' => [ + 'description' => '标签列表的条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TagGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagGroup' => [ + 'description' => '应用分组的规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组的规则。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '标签同步到应用分组的状态。'."\n" + .'- `RUNNING`:进行中。'."\n" + .'- `FINISH`:已完成。', + 'type' => 'string', + 'example' => 'FINISH', + ], + 'MatchExpressFilterRelation' => [ + 'description' => '条件表达式之间的关系。取值:'."\n" + ."\n" + .'- `and`:和。'."\n" + .'- `or`:或。'."\n" + ."\n" + .'> 目前仅支持一种组合条件。', + 'type' => 'string', + 'example' => 'or', + ], + 'RegionId' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tagkey1', + ], + 'DynamicTagRuleId' => [ + 'description' => '标签规则ID。', + 'type' => 'string', + 'example' => '1536df65-a719-429d-8813-73cc40d7****', + ], + 'MatchExpress' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MatchExpress' => [ + 'description' => '标签生成应用分组的匹配表达式。', + 'type' => 'array', + 'items' => [ + 'description' => '标签生成应用分组的匹配表达式。', + 'type' => 'object', + 'properties' => [ + 'TagValue' => [ + 'description' => '标签值。'."\n" + ."\n" + .'`TagValue`和`TagValueMatchFunction`配合使用。', + 'type' => 'string', + 'example' => '*', + ], + 'TagValueMatchFunction' => [ + 'description' => '标签值的匹配方法。取值:'."\n" + .'- all:全部。 '."\n" + .'- startWith:前缀。'."\n" + .'- endWith:后缀。'."\n" + .'- contains:包含。'."\n" + .'- notContains:不包含。'."\n" + .'- equals:相等。', + 'type' => 'string', + 'example' => 'all', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'azone-version', + ], + ], + ], + ], + ], + ], + 'TemplateIdList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TemplateIdList' => [ + 'description' => '报警模板ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警模板ID。', + 'type' => 'string', + 'example' => '71****', + ], + ], + ], + ], + 'ContactGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroupList' => [ + 'description' => '报警联系组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系组。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + ], + ], + ], + 'TagValueBlacklist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagValueBlacklist' => [ + 'description' => '动态规则不处理的TagValue。当用户删除动态Tag分组的时候,分组对应的TagValue会添加到黑名单;在之后有新的资源新增此TagValue时,不会创建对应的分组。', + 'type' => 'array', + 'items' => [ + 'description' => '某个标签的值。', + 'type' => 'string', + 'example' => 'test、offline', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D50523D-8D59-4A61-B58E-E2286ECFB3A9\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageSize\\": \\"30\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Total\\": 2,\\n \\"TagGroupList\\": {\\n \\"TagGroup\\": [\\n {\\n \\"Status\\": \\"FINISH\\",\\n \\"MatchExpressFilterRelation\\": \\"or\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"TagKey\\": \\"tagkey1\\",\\n \\"DynamicTagRuleId\\": \\"1536df65-a719-429d-8813-73cc40d7****\\",\\n \\"MatchExpress\\": {\\n \\"MatchExpress\\": [\\n {\\n \\"TagValue\\": \\"*\\",\\n \\"TagValueMatchFunction\\": \\"all\\",\\n \\"TagKey\\": \\"azone-version\\"\\n }\\n ]\\n },\\n \\"TemplateIdList\\": {\\n \\"TemplateIdList\\": [\\n \\"71****\\"\\n ]\\n },\\n \\"ContactGroupList\\": {\\n \\"ContactGroupList\\": [\\n \\"CloudMonitor\\"\\n ]\\n },\\n \\"TagValueBlacklist\\": {\\n \\"TagValueBlacklist\\": [\\n \\"test、offline\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDynamicTagRuleListResponse>\\r\\n\\t<PageSize>30</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Total>2</Total>\\r\\n\\t<TagGroupList>\\r\\n\\t\\t<TagGroup>\\r\\n\\t\\t\\t<Status>FINISH</Status>\\r\\n\\t\\t\\t<ContactGroupList>\\r\\n\\t\\t\\t\\t<ContactGroupList>CloudMonitor</ContactGroupList>\\r\\n\\t\\t\\t</ContactGroupList>\\r\\n\\t\\t\\t<MatchExpressFilterRelation>or</MatchExpressFilterRelation>\\r\\n\\t\\t\\t<DynamicTagRuleId>1536df65-a719-429d-8813-73cc40d7****</DynamicTagRuleId>\\r\\n\\t\\t\\t<TemplateIdList>\\r\\n\\t\\t\\t\\t<TemplateIdList>71****</TemplateIdList>\\r\\n\\t\\t\\t</TemplateIdList>\\r\\n\\t\\t\\t<TagKey>tagkey1</TagKey>\\r\\n\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t<TagValue>*</TagValue>\\r\\n\\t\\t\\t\\t\\t<TagValueMatchFunction>all</TagValueMatchFunction>\\r\\n\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t</TagGroup>\\r\\n\\t\\t<TagGroup>\\r\\n\\t\\t\\t<Status>FINISH</Status>\\r\\n\\t\\t\\t<ContactGroupList>\\r\\n\\t\\t\\t\\t<ContactGroupList>CloudMonitor</ContactGroupList>\\r\\n\\t\\t\\t</ContactGroupList>\\r\\n\\t\\t\\t<MatchExpressFilterRelation>or</MatchExpressFilterRelation>\\r\\n\\t\\t\\t<DynamicTagRuleId>56e8cebb-b3d7-4a91-9880-78a8c84f****</DynamicTagRuleId>\\r\\n\\t\\t\\t<TemplateIdList>\\r\\n\\t\\t\\t\\t<TemplateIdList>71****</TemplateIdList>\\r\\n\\t\\t\\t</TemplateIdList>\\r\\n\\t\\t\\t<TagKey>tagkey1</TagKey>\\r\\n\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t<MatchExpress>\\r\\n\\t\\t\\t\\t\\t<TagValue>*</TagValue>\\r\\n\\t\\t\\t\\t\\t<TagValueMatchFunction>all</TagValueMatchFunction>\\r\\n\\t\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t</MatchExpress>\\r\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t</TagGroup>\\r\\n\\t</TagGroupList>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeDynamicTagRuleListResponse>\\t","errorExample":""}]', + 'title' => '查询智能标签的规则列表', + 'description' => '本文将提供一个示例,查找标签键`tagkey1`的规则列表。返回结果显示,共有2条规则,规则ID分别为`1536df65-a719-429d-8813-73cc40d7****`和`56e8cebb-b3d7-4a91-9880-78a8c84f****`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveTags' => [ + 'summary' => '调用RemoveTags接口删除标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。'."\n" + .'> 标签键(`Tag.N.Key`)和标签值(`Tag.N.Value`)需要同时设置。', + 'type' => 'string', + 'required' => true, + 'example' => 'Key1', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + .'> 标签键(`Tag.N.Key`)和标签值(`Tag.N.Value`)需要同时设置。', + 'type' => 'string', + 'required' => true, + 'example' => 'Value1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + 'required' => true, + 'example' => '12345', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Illegal parameters.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '195390D2-69D0-4D9E-81AA-A7F5BC1B91EB', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tag' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '被删除的标签列表。', + 'type' => 'string', + 'example' => 'tag1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"195390D2-69D0-4D9E-81AA-A7F5BC1B91EB\\",\\n \\"Success\\": true,\\n \\"Tag\\": {\\n \\"Tags\\": [\\n \\"tag1\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RemoveTagsResponse>\\n\\t\\t<RequestId>E15C718E-067E-49D0-86F7-BC7242230091</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</RemoveTagsResponse>","errorExample":""}]', + 'title' => '删除标签', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateHostAvailability' => [ + 'summary' => '调用CreateHostAvailability接口创建可用性监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务名称。取值范围:4~100个字符,支持英文字母、数字、下划线(_)和汉字。', + 'type' => 'string', + 'required' => true, + 'example' => 'task1', + ], + ], + [ + 'name' => 'TaskScope', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务的探测范围。取值:'."\n" + ."\n" + .'- GROUP:表示将当前应用分组内的所有ECS实例作为探测任务的探针。'."\n" + .'- GROUP_SPEC_INSTANCE:表示将当前应用分组内的指定ECS实例作为探测任务的探针。设置该参数时,需要同时设置InstanceList(发起探测的ECS实例列表)。', + 'type' => 'string', + 'required' => false, + 'example' => 'GROUP', + 'default' => 'GROUP', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务的探测类型。取值:'."\n" + ."\n" + .'- PING'."\n" + .'- TELNET'."\n" + .'- HTTP', + 'type' => 'string', + 'required' => true, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'TaskOption.HttpURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP、Telnet探测类型的探测URI地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com'."\n" + .'telnet://127.0.0.1:80', + ], + ], + [ + 'name' => 'TaskOption.TelnetOrPingHost', + 'in' => 'query', + 'schema' => [ + 'description' => '探测的域名或地址。'."\n" + .'>如果探测任务类型为PING,则需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + ], + [ + 'name' => 'TaskOption.HttpResponseCharset', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP探测类型的响应字符集。'."\n" + ."\n" + .'> 仅支持UTF-8。', + 'type' => 'string', + 'required' => false, + 'example' => 'UTF-8', + ], + ], + [ + 'name' => 'TaskOption.HttpPostContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP探测类型探测请求的Post内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'params1=paramsValue1', + ], + ], + [ + 'name' => 'TaskOption.HttpResponseMatchContent', + 'in' => 'query', + 'schema' => [ + 'description' => '匹配响应的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'ok', + ], + ], + [ + 'name' => 'TaskOption.HttpMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '探测类型的方法。取值:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD'."\n" + ."\n" + .'>如果任务的探测类型为HTTP,则需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + ], + [ + 'name' => 'TaskOption.HttpNegative', + 'in' => 'query', + 'schema' => [ + 'description' => '匹配HTTP响应内容的报警规则。取值:'."\n" + .'- true:如果HTTP响应内容包含设置的报警规则,则报警。'."\n" + .'- false:如果HTTP响应内容不包含设置的报警规则,则报警。'."\n" + ."\n" + .'>如果任务的探测类型为HTTP,则该参数生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TaskOption.HttpHeader', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求的Header。格式为`参数名:参数`,多个参数之间用回车符分隔,例如:'."\n" + .'```'."\n" + .'params1:value1'."\n" + .'params2:value2'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => 'token:testTokenValue', + ], + ], + [ + 'name' => 'TaskOption.Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '探测频率。单位:秒。取值:15、30、60、120、300、900、1800和3600。'."\n" + ."\n" + .'> 仅3.5.1及以上版本的云监控插件支持该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'AlertConfig.NotifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知类型。取值:'."\n" + ."\n" + .'<props="china">- 2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 1:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 0:邮件+钉钉机器人。</props>'."\n" + ."\n\n" + .'<props="intl">0:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">0:邮件+钉钉机器人。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AlertConfig.StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效的开始时间。取值范围:0~23。'."\n" + ."\n" + .'例如:`AlertConfig.StartTime`为0,`AlertConfig.EndTime`为22,表示报警生效时间为00:00:00至22:00:00。'."\n" + ."\n" + .'>如果报警不在生效时间内,则超过阈值也不会发送报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AlertConfig.EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效的结束时间。取值范围:0~23。'."\n" + ."\n" + .'例如:`AlertConfig.StartTime`为0,`AlertConfig.EndTime`为22,表示报警生效时间为00:00:00至22:00:00。'."\n" + ."\n" + .'>如果报警不在生效时间内,则超过阈值也不会发送报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'AlertConfig.SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默时间。单位:秒,默认值:86400(1天)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'AlertConfig.WebHook', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/webhook.json', + ], + ], + [ + 'name' => 'AlertConfigEscalationList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '报警的监控项。N的取值范围:1~21。取值:'."\n" + ."\n" + .'- HttpStatus:HTTP状态码。'."\n" + .'- HttpLatency:HTTP等待时间。'."\n" + .'- TelnetStatus:Telnet状态码。'."\n" + .'- TelnetLatency:Telnet等待时间。'."\n" + .'- PingLostRate:Ping丢包率。', + 'type' => 'string', + 'required' => true, + 'example' => 'HttpStatus', + ], + 'Value' => [ + 'description' => '报警阈值。N的取值范围:1~21。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + 'Times' => [ + 'description' => '报警重试次数。N的取值范围:1~21。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Operator' => [ + 'description' => '报警规则比较符号。N的取值范围:1~21。取值:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Aggregate' => [ + 'description' => '报警统计方法。N的取值范围:1~21。不同监控项的取值如下:'."\n" + ."\n" + .'- HttpStatus:Value。'."\n" + .'- HttpLatency:Average。'."\n" + .'- TelnetStatus:Value。'."\n" + .'- TelnetLatency:Average。'."\n" + .'- PingLostRate:Average。'."\n" + ."\n" + .'>状态码类的统计方法为原始值(Value),延时时间或丢包率的统计方法为平均值(Average)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Value', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '发起探测的ECS实例列表。N的取值范围:1~21。'."\n" + ."\n" + .'> 当`TaskScope`为`GROUP_SPEC_INSTANCE`时,需要设置该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '发起探测的ECS实例列表。N的取值范围:1~21。'."\n" + ."\n" + .'> 当`TaskScope`为`GROUP_SPEC_INSTANCE`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'example' => 'i-absdfkwl321****', + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'AlertConfigTargetList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '报警触发目标。', + 'type' => 'array', + 'items' => [ + 'description' => '报警触发目标。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。格式为`acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。例如:`acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`。参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:目前仅支持轻量消息队列(原 MNS)。'."\n" + ."\n" + .'- {userId}:阿里云账号ID。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + ."\n" + .'- {资源类型}`:接收报警的资源类型。取值:'."\n" + ."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'required' => false, + 'example' => '["INFO", "WARN", "CRITICAL"]', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', + ], + 'TaskId' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResouceOverLimit', + 'errorMessage' => 'The task over limit', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"TaskId\\": 12345,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateHostAvailabilityResponse>\\n\\t<TaskId>12345</TaskId>\\n\\t<RequestId>CDA78493-F10F-485F-98AD-B4C0B40AB225</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CreateHostAvailabilityResponse>","errorExample":""}]', + 'title' => '创建可用性监控任务', + 'description' => '本文将提供一个示例,在应用分组`123456`中创建探测类型为`HTTP`的可用性监控任务`task1`,通过邮件和钉钉机器人给您发送报警。'."\n" + ."\n", + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteHostAvailability' => [ + 'summary' => '调用DeleteHostAvailability接口删除可用性监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务id。', + 'type' => 'array', + 'items' => [ + 'description' => '任务id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12456', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '57C782E6-B235-4842-AD2B-DB94961761EB', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"57C782E6-B235-4842-AD2B-DB94961761EB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除可用性监控任务', + ], + 'EnableHostAvailability' => [ + 'summary' => '调用EnableHostAvailability接口启用指定可用性监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '启用指定可用性监控任务', + ], + 'DisableHostAvailability' => [ + 'summary' => '调用DisableHostAvailability接口禁用指定可用性监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:-true:成功。-false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '禁用指定可用性监控任务', + ], + 'ModifyHostAvailability' => [ + 'summary' => '调用ModifyHostAvailability接口修改可用性监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'task2', + ], + ], + [ + 'name' => 'TaskScope', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务的探测范围。取值:'."\n" + ."\n" + .'- GROUP:表示将当前应用分组内的所有ECS实例作为探测任务的探针。'."\n" + .'- GROUP_SPEC_INSTANCE:表示将当前应用分组内的指定ECS实例作为探测任务的探针。设置该参数时,需要同时设置InstanceList(发起探测的ECS实例列表)。', + 'type' => 'string', + 'required' => false, + 'example' => 'GROUP', + 'default' => 'GROUP', + ], + ], + [ + 'name' => 'TaskOption.HttpURI', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP、Telnet探测类型的探测URI地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com'."\n" + .'telnet://127.0.0.1:80', + ], + ], + [ + 'name' => 'TaskOption.TelnetOrPingHost', + 'in' => 'query', + 'schema' => [ + 'description' => '探测的域名或地址。'."\n" + ."\n" + .'>如果探测任务类型为PING,则需要设置该参数。关于探测任务类型的设置方法,请参见[CreateHostAvailability](~~115317~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + ], + [ + 'name' => 'TaskOption.HttpResponseCharset', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP探测类型的响应字符集。'."\n" + ."\n" + .'> 仅支持UTF-8。', + 'type' => 'string', + 'required' => false, + 'example' => 'UTF-8', + ], + ], + [ + 'name' => 'TaskOption.HttpPostContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP探测类型探测请求的Post内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'params1=value1', + ], + ], + [ + 'name' => 'TaskOption.HttpResponseMatchContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP探测类型探测响应的Post内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'ok', + ], + ], + [ + 'name' => 'TaskOption.HttpMethod', + 'in' => 'query', + 'schema' => [ + 'description' => '探测类型的方法。取值:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD'."\n" + ."\n" + .'>如果探测任务类型为HTTP,则需要设置该参数。关于探测任务类型的设置方法,请参见[CreateHostAvailability](~~115317~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + ], + [ + 'name' => 'TaskOption.HttpNegative', + 'in' => 'query', + 'schema' => [ + 'description' => '匹配HTTP响应内容的报警规则。取值:'."\n" + .'- true:如果HTTP响应内容包含设置的报警规则,则报警。'."\n" + .'- false:如果HTTP响应内容不包含设置的报警规则,则报警。'."\n" + ."\n" + .'>如果探测任务类型为HTTP,则需要设置该参数。关于探测任务类型的设置方法,请参见[CreateHostAvailability](~~115317~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TaskOption.HttpHeader', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求的Header。格式为`参数名:参数`,多个参数之间用回车符分隔,例如:'."\n" + .'```'."\n" + .'params1:value1'."\n" + .'params2:value2'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => 'params1:value1', + ], + ], + [ + 'name' => 'TaskOption.Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '探测频率。单位:秒。取值:15、30、60、120、300、900、1800和3600。'."\n" + ."\n" + .'> 仅3.5.1及以上版本的云监控插件支持该参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'AlertConfig.NotifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知类型。取值:'."\n" + ."\n" + .'<props="china">- 2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 1:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 0:邮件+钉钉机器人。</props>'."\n" + ."\n\n" + .'<props="intl">0:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">0:邮件+钉钉机器人。</props>'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'AlertConfig.StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效的开始时间。取值范围:0~23。'."\n" + ."\n" + .'例如:`AlertConfig.StartTime`为0,`AlertConfig.EndTime`为22,表示报警生效时间为00:00:00至22:00:00。'."\n" + ."\n" + .'>如果报警不在生效时间内,则超过阈值也不会发送报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AlertConfig.EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效的结束时间。取值范围:0~23。'."\n" + ."\n" + .'例如:`AlertConfig.StartTime`为0,`AlertConfig.EndTime`为22,表示报警生效时间为00:00:00至22:00:00。'."\n" + ."\n" + .'>如果报警不在生效时间内,则超过阈值也不会发送报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + ], + [ + 'name' => 'AlertConfig.SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默时间。单位:秒,默认值:86400(1天)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'AlertConfig.WebHook', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com/webhook.json', + ], + ], + [ + 'name' => 'AlertConfigEscalationList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警配置列表。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '报警的监控项。N的取值范围:1~21。取值:'."\n" + ."\n" + .'- HttpStatus:HTTP状态码。'."\n" + .'- HttpLatency:HTTP等待时间。'."\n" + .'- TelnetStatus:TELNET状态码。'."\n" + .'- TelnetLatency:TELNET等待时间。'."\n" + .'- PingLostRate:PING丢包率。', + 'type' => 'string', + 'required' => true, + 'example' => 'HttpStatus', + ], + 'Value' => [ + 'description' => '报警阈值。N的取值范围:1~21。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + 'Times' => [ + 'description' => '报警重试次数。N的取值范围:1~21。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Operator' => [ + 'description' => '报警规则比较符号。N的取值范围:1~21。取值:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Aggregate' => [ + 'description' => '报警统计方法。N的取值范围:1~21。不同监控项的统计方法取值如下:'."\n" + ."\n" + .'- HttpStatus:Value。'."\n" + .'- HttpLatency:Average。'."\n" + .'- TelnetStatus:Value。'."\n" + .'- TelnetLatency:Average。'."\n" + .'- PingLostRate:Average。'."\n" + ."\n" + .'>状态码类的统计方法为原始值(Value),延时时间或丢包率的统计方法为平均值(Average)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Value', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '发起探测的ECS实例列表。N的取值范围:1~21。'."\n" + ."\n" + .'> 当`TaskScope`为`GROUP_SPEC_INSTANCE`时,需要设置该参数。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '发起探测的ECS实例列表。N的取值范围:1~21。'."\n" + ."\n" + .'> 当`TaskScope`为`GROUP_SPEC_INSTANCE`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'required' => false, + 'example' => 'i-absdfkwl321****', + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'AlertConfigTargetList', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '报警触发目标。', + 'type' => 'array', + 'items' => [ + 'description' => '报警触发目标。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。'."\n" + ."\n" + .'格式为`acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。例如:`acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`。参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:目前仅支持轻量消息队列(原 MNS)。'."\n" + ."\n" + .'- {userId}:阿里云账号ID。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + ."\n" + .'- {资源类型}`:接收报警的资源类型。取值:'."\n" + ."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'required' => false, + 'example' => '["INFO", "WARN", "CRITICAL"]', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16E815A3-47E1-4290-87F9-D5C99471FF45', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"16E815A3-47E1-4290-87F9-D5C99471FF45\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyHostAvailabilityResponse>\\n\\t\\t<RequestId>16E815A3-47E1-4290-87F9-D5C99471FF45</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</ModifyHostAvailabilityResponse>","errorExample":""}]', + 'title' => '修改可用性监控任务', + 'description' => '本文将提供一个示例,将应用分组`123456`中可用性监控任务`12345`的名称修改为`task2`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUnhealthyHostAvailability' => [ + 'summary' => '调用DescribeUnhealthyHostAvailability接口查询探测结果异常的服务器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务id。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123***', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ACBDBB40-DFB6-4F4C-8957-51FFB233969C', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:-true:成功。-false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnhealthyList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeTaskInstance' => [ + 'description' => '异常的服务器列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123******', + ], + 'InstanceList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'String' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表。', + 'type' => 'string', + 'example' => 'i-*****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"ACBDBB40-DFB6-4F4C-8957-51FFB233969C\\",\\n \\"Success\\": true,\\n \\"UnhealthyList\\": {\\n \\"NodeTaskInstance\\": [\\n {\\n \\"Id\\": 0,\\n \\"InstanceList\\": {\\n \\"String\\": [\\n \\"i-*****\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询探测结果异常的服务器列表', + ], + 'DescribeHostAvailabilityList' => [ + 'summary' => '调用DescribeHostAvailabilityList接口查询可用性监控任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '单个可用性监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '多个可用性监控任务ID。多个可用性监控任务ID之间用半角逗号(,)分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123456,345678', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '可用性监控任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs_instance', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4A288E86-45C3-4858-9DB0-6D85B10BD92A', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeTaskConfig' => [ + 'description' => '可用性监控任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用性监控任务列表。', + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '任务类型。取值:'."\n" + ."\n" + .'- PING'."\n" + .'- TELNET'."\n" + .'- HTTP', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'Group_ECS', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'TaskName' => [ + 'description' => '可用性监控任务名称。', + 'type' => 'string', + 'example' => 'ecs_instance', + ], + 'Disabled' => [ + 'description' => '可用性监控任务是否禁用。取值:'."\n" + ."\n" + .'- true:禁用。'."\n" + ."\n" + .'- false:启用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TaskScope' => [ + 'description' => '可用性监控任务的探测范围。取值:'."\n" + ."\n" + .'- GROUP:表示将当前应用分组内的所有ECS实例作为探测任务的探针。'."\n" + .'- GROUP_SPEC_INSTANCE:表示将当前应用分组内的指定ECS实例作为探测任务的探针。', + 'type' => 'string', + 'example' => 'GROUP', + ], + 'Id' => [ + 'description' => '可用性监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => '发起探测的ECS实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发起探测的ECS实例列表。', + 'type' => 'string', + 'example' => 'i-abcdefgh12****', + ], + ], + ], + ], + 'TaskOption' => [ + 'description' => '可用性监控任务的参数选项。', + 'type' => 'object', + 'properties' => [ + 'HttpMethod' => [ + 'description' => '探测类型的方法。取值:'."\n" + ."\n" + .'- GET'."\n" + .'- POST'."\n" + .'- HEAD', + 'type' => 'string', + 'example' => 'GET', + ], + 'Interval' => [ + 'description' => '探测频率。单位:秒。 ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'HttpURI' => [ + 'description' => 'HTTP探测类型的探测URI地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'TelnetOrPingHost' => [ + 'description' => '探测的域名或地址。', + 'type' => 'string', + 'example' => 'ssh.aliyun.com', + ], + 'HttpResponseCharset' => [ + 'description' => 'HTTP探测类型的响应字符集。', + 'type' => 'string', + 'example' => 'UTF-8', + ], + 'HttpPostContent' => [ + 'description' => 'HTTP探测类型探测请求的Post内容。', + 'type' => 'string', + 'example' => 'params1=paramsValue1', + ], + 'HttpNegative' => [ + 'description' => '匹配HTTP响应内容的报警规则。取值:'."\n" + .'- true:如果HTTP响应内容包含设置的报警规则,则报警。'."\n" + .'- false:如果HTTP响应内容不包含设置的报警规则,则报警。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpKeyword' => [ + 'description' => 'HTTP探测类型匹配响应内容。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + 'AlertConfig' => [ + 'description' => '报警规则配置。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通道沉默时间。单位:秒。默认值:86400。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '86400', + ], + 'EndTime' => [ + 'description' => '报警生效的结束时间。取值范围:0~23。'."\n" + ."\n" + .'例如:`AlertConfig.StartTime`为0,`AlertConfig.EndTime`为22,表示报警生效时间为00:00:00至22:00:00。'."\n" + ."\n" + .'>如果报警不在生效时间内,则超过阈值也不会发送报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'StartTime' => [ + 'description' => '报警生效的开始时间。取值范围:0~23。'."\n" + ."\n" + .'例如:`AlertConfig.StartTime`为0,`AlertConfig.EndTime`为22,表示报警生效时间为00:00:00至22:00:00。'."\n" + ."\n" + .'>如果报警不在生效时间内,则超过阈值也不会发送报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WebHook' => [ + 'description' => '报警发生回调时的URL地址。'."\n" + ."\n" + .'云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'NotifyType' => [ + 'description' => '报警通知类型。取值:'."\n" + ."\n" + .'<props="china">- 2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 1:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 0:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- 2:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- 1:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- 0:邮件+钉钉机器人。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EscalationList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'escalationList' => [ + 'description' => '报警触发条件。', + 'type' => 'array', + 'items' => [ + 'description' => '报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '400', + ], + 'MetricName' => [ + 'description' => '报警监控项。取值:'."\n" + ."\n" + .'- HttpStatus:HTTP状态码。'."\n" + .'- HttpLatency:HTTP等待时间。'."\n" + .'- TelnetStatus:TELNET状态码。'."\n" + .'- TelnetLatency:TELNET等待时间。'."\n" + .'- PingLostRate:PING丢包率。', + 'type' => 'string', + 'example' => 'HttpStatus', + ], + 'Operator' => [ + 'description' => '报警规则比较符号。取值:'."\n" + ."\n" + .'- `>`'."\n" + .'- `>=`'."\n" + .'- `<`'."\n" + .'- `<=`'."\n" + .'- `=`', + 'type' => 'string', + 'example' => '=', + ], + 'Times' => [ + 'description' => '报警周期。即连续几个周期超过阈值。', + 'type' => 'string', + 'example' => '3', + ], + 'Aggregate' => [ + 'description' => '报警统计方法。不同监控项的取值如下:'."\n" + ."\n" + .'- Value:HTTP状态码的值。'."\n" + .'- Average:HTTP等待时间的平均值。'."\n" + .'- Value:TELNET状态码的值。'."\n" + .'- TelnetLatency:TELNET等待时间的平均值。'."\n" + .'- Average:PING丢包率的平均值。', + 'type' => 'string', + 'example' => 'Value', + ], + ], + ], + ], + ], + ], + 'TargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => '报警目标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警目标列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。', + 'type' => 'string', + 'example' => '1', + ], + 'Arn' => [ + 'description' => 'ARN资源描述。'."\n" + ."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + ."\n" + .'- Service:云服务Code。'."\n" + ."\n" + .'- Region:地域ID。'."\n" + ."\n" + .'- Account:阿里云账号ID。'."\n" + ."\n" + .'- ResourceType:资源类型。'."\n" + ."\n" + .'- ResourceId:资源ID。', + 'type' => 'string', + 'example' => 'acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'example' => 'INFO', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'example' => '{"key1":"value1"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"4A288E86-45C3-4858-9DB0-6D85B10BD92A\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"TaskList\\": {\\n \\"NodeTaskConfig\\": [\\n {\\n \\"TaskType\\": \\"HTTP\\",\\n \\"GroupName\\": \\"Group_ECS\\",\\n \\"GroupId\\": 12345,\\n \\"TaskName\\": \\"ecs_instance\\",\\n \\"Disabled\\": false,\\n \\"TaskScope\\": \\"GROUP\\",\\n \\"Id\\": 123456,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n \\"i-abcdefgh12****\\"\\n ]\\n },\\n \\"TaskOption\\": {\\n \\"HttpMethod\\": \\"GET\\",\\n \\"Interval\\": 60,\\n \\"HttpURI\\": \\"https://www.aliyun.com\\",\\n \\"TelnetOrPingHost\\": \\"ssh.aliyun.com\\",\\n \\"HttpResponseCharset\\": \\"UTF-8\\",\\n \\"HttpPostContent\\": \\"params1=paramsValue1\\",\\n \\"HttpNegative\\": true,\\n \\"HttpKeyword\\": \\"OK\\"\\n },\\n \\"AlertConfig\\": {\\n \\"SilenceTime\\": 86400,\\n \\"EndTime\\": 22,\\n \\"StartTime\\": 0,\\n \\"WebHook\\": \\"https://www.aliyun.com\\",\\n \\"NotifyType\\": 1,\\n \\"EscalationList\\": {\\n \\"escalationList\\": [\\n {\\n \\"Value\\": \\"400\\",\\n \\"MetricName\\": \\"HttpStatus\\",\\n \\"Operator\\": \\"=\\",\\n \\"Times\\": \\"3\\",\\n \\"Aggregate\\": \\"Value\\"\\n }\\n ]\\n },\\n \\"TargetList\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages\\",\\n \\"Level\\": \\"INFO\\",\\n \\"JsonParams\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeHostAvailabilityListResponse>\\r\\n\\t<RequestId>4A288E86-45C3-4858-9DB0-6D85B10BD92A</RequestId>\\r\\n\\t<Total>1</Total>\\r\\n\\t<TaskList>\\r\\n\\t\\t<NodeTaskConfig>\\r\\n\\t\\t\\t<GroupName>Group_ECS</GroupName>\\r\\n\\t\\t\\t<TaskOption>\\r\\n\\t\\t\\t\\t<HttpURI>https://aliyun.com</HttpURI>\\r\\n\\t\\t\\t\\t<HttpMethod>GET</HttpMethod>\\r\\n\\t\\t\\t</TaskOption>\\r\\n\\t\\t\\t<AlertConfig>\\r\\n\\t\\t\\t\\t<NotifyType>1</NotifyType>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<EndTime>22</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>0</StartTime>\\r\\n\\t\\t\\t\\t<EscalationList>\\r\\n\\t\\t\\t\\t\\t<escalationList>\\r\\n\\t\\t\\t\\t\\t\\t<Operator>=</Operator>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>HttpStatus</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Value>400</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Aggregate>Value</Aggregate>\\r\\n\\t\\t\\t\\t\\t</escalationList>\\r\\n\\t\\t\\t\\t\\t<escalationList>\\r\\n\\t\\t\\t\\t\\t\\t<Operator>=</Operator>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>HttpLatency</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Value>500</Value>\\r\\n\\t\\t\\t\\t\\t\\t<Aggregate>Average</Aggregate>\\r\\n\\t\\t\\t\\t\\t</escalationList>\\r\\n\\t\\t\\t\\t</EscalationList>\\r\\n\\t\\t\\t</AlertConfig>\\r\\n\\t\\t\\t<TaskName>ecs_instance</TaskName>\\r\\n\\t\\t\\t<TaskScope>GROUP</TaskScope>\\r\\n\\t\\t\\t<TaskType>HTTP</TaskType>\\r\\n\\t\\t\\t<Id>123456</Id>\\r\\n\\t\\t\\t<Disabled>false</Disabled>\\r\\n\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t</NodeTaskConfig>\\r\\n\\t</TaskList>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeHostAvailabilityListResponse>\\t","errorExample":""}]', + 'title' => '查询可用性监控任务列表', + 'description' => '本文将提供一个示例,查询当前账号的可用性监控任务列表。返回结果显示,当前账号存在一条可用性监控任务记录`ecs_instance`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InstallMonitoringAgent' => [ + 'summary' => '调用InstallMonitoringAgent接口为指定阿里云主机安装云监控插件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制安装云监控插件。取值:'."\n" + .'- true(默认值):强制安装。'."\n" + .'- false:不强制安装。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '阿里云主机ID。'."\n" + ."\n" + .'N的取值范围:1~10。'."\n" + ."\n" + .'> `InstallCommand`和`InstanceIds`必须二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '阿里云主机ID。'."\n" + ."\n" + .'N的取值范围:1~10。'."\n" + ."\n" + .'> `InstallCommand`和`InstanceIds`必须二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-m5e0k0bexac8tykr****', + ], + 'required' => false, + 'example' => 'i-m5e0k0bexac8tykr****', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstallCommand', + 'in' => 'query', + 'schema' => [ + 'description' => '为当前阿里云账号下的所有阿里云主机安装云监控插件。取值:'."\n" + ."\n" + .'- `onlyInstallNotHasAgent` : 仅为未安装云监控插件的阿里云主机安装最新版本插件。'."\n" + ."\n" + .'- `onlyUpgradeAgent`:仅为已安装非最新版本云监控插件的阿里云主机升级插件。'."\n" + ."\n" + .'- `installAndUpgrade`:不仅为未安装云监控插件的阿里云主机安装最新版本插件,且为已安装非最新版本云监控插件的阿里云主机升级插件。'."\n" + ."\n" + .'> 如果您已设置该参数,参数`InstanceIds`的设置无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'onlyInstallNotHasAgent', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C41945', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C41945\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<InstallMonitoringAgentResponse>\\r\\n\\t<RequestId>0BDAF8A8-04DC-5F0C-90E4-724D42C41945</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</InstallMonitoringAgentResponse>","errorExample":""}]', + 'title' => '为指定阿里云主机安装云监控插件', + 'description' => '## 前提条件'."\n" + .'请确保阿里云主机已安装云助手。关于如何安装云助手,请参见[云助手概述](~~64601~~)。'."\n" + ."\n" + .'## 背景信息'."\n" + .'本接口仅适用于阿里云主机,即ECS实例。'."\n" + .'通过API安装云监控插件的成功率约为95%,如果安装失败,则请手动安装。关于如何安装云监控插件,请参见[安装和卸载C++版本插件](~~183482~~)。'."\n" + ."\n" + .'## 使用说明'."\n" + .'本文将提供一个示例,强制为阿里云主机`i-m5e0k0bexac8tykr****`安装最新版本云监控插件。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitoringAgentHosts' => [ + 'summary' => '调用DescribeMonitoringAgentHosts接口查询所有已安装和未安装云监控插件的主机列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'host1', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hostNam1', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-a3d1q1pm2f9yr29e****', + ], + ], + [ + 'name' => 'SerialNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => '主机序列号。'."\n" + ."\n" + .'每台主机成功安装云监控插件之后会生成一个SerialNumber,具备全局唯一性。非阿里云主机无实例ID,有SerialNumber。'."\n" + ."\n" + .'>该参数可用于精准查找监控的任何一台主机。', + 'type' => 'string', + 'required' => false, + 'example' => 'a1ab31a3-1234-40f2-9e95-c8caa8f0****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。取值:'."\n" + ."\n" + .'- 10'."\n" + .'- 20'."\n" + .'- 50'."\n" + .'- 100'."\n" + ."\n" + .'>虽然目前阿里云未限制该参数的最大值,但是不建议设置的值过大,可能会导致超时无法正常获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'InstanceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunHost', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云主机(ECS)。取值:'."\n" + .'- true(默认值):过滤出所有阿里云主机(ECS)。'."\n" + .'- false:过滤出所有非阿里云主机。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '主机状态。取值:'."\n" + .'- Running:运行中。'."\n" + .'- Stopped:已停止、未安装或安装失败。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'SysomStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'SysOM的开启状态。取值:'."\n" + ."\n" + .'- installing:开启中。'."\n" + .'- running:运行中。'."\n" + .'- stopped:已停止。'."\n" + .'- uninstalling:关闭中。', + 'type' => 'string', + 'required' => false, + 'example' => 'running', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageTotal' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Hosts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Host' => [ + 'description' => '主机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主机。', + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => [ + 'description' => '主机序列号。非阿里云主机无实例ID,有SerialNumber。'."\n" + ."\n" + .'>该参数可用于精准查找监控的任何一台主机。', + 'type' => 'string', + 'example' => 'x12335-6cc8-4a22-9f21-1a00a719****', + ], + 'NatIp' => [ + 'description' => 'NAT IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'HostName' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'example' => 'hostIP', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '103201326074****', + ], + 'NetworkType' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-a2d5q7pm3f9yr212****', + ], + 'isAliyunHost' => [ + 'description' => '是否为阿里云主机。取值:'."\n" + ."\n" + .'- true:是。'."\n" + ."\n" + .'- false:否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EipAddress' => [ + 'description' => 'EIP的IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AgentVersion' => [ + 'description' => '插件版本。', + 'type' => 'string', + 'example' => '3.4.6', + ], + 'IpGroup' => [ + 'description' => '主机IP地址。'."\n" + ."\n" + .'>多个IP地址之前用半角逗号(,)分隔。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'EipId' => [ + 'description' => 'EIP的ID。', + 'type' => 'string', + 'example' => 'eip-bp16i16k9gcezyfrp****', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceTypeFamily' => [ + 'description' => 'ECS实例规格。', + 'type' => 'string', + 'example' => 'ecs.n4', + ], + 'OperatingSystem' => [ + 'description' => '操作系统。', + 'type' => 'string', + 'example' => 'Linux', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageTotal\\": 50,\\n \\"Total\\": 10,\\n \\"Hosts\\": {\\n \\"Host\\": [\\n {\\n \\"SerialNumber\\": \\"x12335-6cc8-4a22-9f21-1a00a719****\\",\\n \\"NatIp\\": \\"192.168.XX.XX\\",\\n \\"HostName\\": \\"hostIP\\",\\n \\"AliUid\\": 0,\\n \\"NetworkType\\": \\"vpc\\",\\n \\"InstanceId\\": \\"i-a2d5q7pm3f9yr212****\\",\\n \\"isAliyunHost\\": true,\\n \\"EipAddress\\": \\"192.168.XX.XX\\",\\n \\"AgentVersion\\": \\"3.4.6\\",\\n \\"IpGroup\\": \\"192.168.XX.XX\\",\\n \\"EipId\\": \\"eip-bp16i16k9gcezyfrp****\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"InstanceTypeFamily\\": \\"ecs.n4\\",\\n \\"OperatingSystem\\": \\"Linux\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentHostsResponse>\\r\\n\\t\\t<Hosts>\\r\\n\\t\\t\\t<Host>\\r\\n\\t\\t\\t\\t<OperatingSystem>Windows</OperatingSystem>\\r\\n\\t\\t\\t\\t<SerialNumber>f0a434f2-632b-4588-95e6-202d4396****</SerialNumber>\\r\\n\\t\\t\\t\\t<isAliyunHost>true</isAliyunHost>\\r\\n\\t\\t\\t\\t<InstanceId>i-uf6hm9lnlzsarrc7****</InstanceId>\\r\\n\\t\\t\\t\\t<AgentVersion>3.4.6</AgentVersion>\\r\\n\\t\\t\\t\\t<NetworkType>vpc</NetworkType>\\r\\n\\t\\t\\t\\t<InstanceTypeFamily>ecs.g6</InstanceTypeFamily>\\r\\n\\t\\t\\t\\t<Region>cn-shanghai</Region>\\r\\n\\t\\t\\t\\t<IpGroup>192.168.XX.XX,192.168.XX.XX</IpGroup>\\r\\n\\t\\t\\t\\t<HostName>iZlzsarrc78****</HostName>\\r\\n\\t\\t\\t\\t<AliUid>103201326074****</AliUid>\\r\\n\\t\\t\\t</Host>\\r\\n\\t\\t\\t<Host>\\r\\n\\t\\t\\t\\t<OperatingSystem>Linux</OperatingSystem>\\r\\n\\t\\t\\t\\t<SerialNumber>9c336dc5-1802-4db0-b7a0-2d46ad4f****</SerialNumber>\\r\\n\\t\\t\\t\\t<isAliyunHost>true</isAliyunHost>\\r\\n\\t\\t\\t\\t<InstanceId>i-uf6hn19s56zumk9w****</InstanceId>\\r\\n\\t\\t\\t\\t<AgentVersion>3.4.4</AgentVersion>\\r\\n\\t\\t\\t\\t<NetworkType>vpc</NetworkType>\\r\\n\\t\\t\\t\\t<InstanceTypeFamily>ecs.g5</InstanceTypeFamily>\\r\\n\\t\\t\\t\\t<Region>cn-shanghai</Region>\\r\\n\\t\\t\\t\\t<IpGroup>192.168.XX.XX,192.168.XX.XX</IpGroup>\\r\\n\\t\\t\\t\\t<HostName>launch-advisor-2019****</HostName>\\r\\n\\t\\t\\t\\t<AliUid>103201326074****</AliUid>\\r\\n\\t\\t\\t</Host>\\r\\n\\t\\t</Hosts>\\r\\n\\t\\t<PageSize>100</PageSize>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<PageTotal>1</PageTotal>\\r\\n\\t\\t<Total>5</Total>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeMonitoringAgentHostsResponse>","errorExample":""}]', + 'title' => '查询所有已安装和未安装云监控插件的主机列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitoringAgentAccessKey' => [ + 'summary' => '调用DescribeMonitoringAgentAccessKey接口查询非阿里云主机安装云监控插件时所需要的AccessKey和AccessSecret。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessKey' => [ + 'description' => '安装插件需要的AccessKey。', + 'type' => 'string', + 'example' => 'E7A27f9****', + ], + 'SecretKey' => [ + 'description' => '安装插件需要的AccessSecret。', + 'type' => 'string', + 'example' => 'sBjNOUhLylrxMX-Xv1****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C0F655E9-D793-51E6-BD78-CABBCCFC1047', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKey\\": \\"E7A27f9****\\",\\n \\"SecretKey\\": \\"sBjNOUhLylrxMX-Xv1****\\",\\n \\"RequestId\\": \\"C0F655E9-D793-51E6-BD78-CABBCCFC1047\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentAccessKeyResponse>\\n <SecretKey>sBjNOUhLylrxMX-Xv1****</SecretKey>\\n <RequestId>C0F655E9-D793-51E6-BD78-CABBCCFC1047</RequestId>\\n <AccessKey>E7A27f9****</AccessKey>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeMonitoringAgentAccessKeyResponse>","errorExample":""}]', + 'title' => '查询非阿里云主机安装云监控插件时所需要的AccessKey和AccessSecret', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitoringAgentConfig' => [ + 'summary' => '调用DescribeMonitoringAgentConfig接口查询云监控插件的配置信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EnableActiveAlert' => [ + 'description' => '开通一键告警的云服务。', + 'type' => 'string', + 'example' => 'redis,rds,ecs', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D', + ], + 'AutoInstall' => [ + 'description' => '现有ECS主机是否自动安装云监控插件。取值:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableInstallAgentNewECS' => [ + 'description' => '新购ECS主机是否自动安装云监控插件。取值:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"EnableActiveAlert\\": \\"redis,rds,ecs\\",\\n \\"RequestId\\": \\"E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D\\",\\n \\"AutoInstall\\": true,\\n \\"Success\\": true,\\n \\"EnableInstallAgentNewECS\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentConfigResponse>\\r\\n\\t<AutoInstall>true</AutoInstall>\\r\\n\\t<EnableActiveAlert></EnableActiveAlert>\\r\\n\\t<EnableInstallAgentNewECS>true</EnableInstallAgentNewECS>\\r\\n\\t<RequestId>B4EB0F95-3181-4E8F-B32E-8C3734E8F88E</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitoringAgentConfigResponse>","errorExample":""}]', + 'title' => '查询云监控插件的配置信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitoringAgentStatuses' => [ + 'summary' => '调用DescribeMonitoringAgentStatuses接口查询云监控插件运行状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance IDs. Separate multiple instance IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'i-hp3dunahluwajv6f****', + ], + ], + [ + 'name' => 'HostAvailabilityTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the availability monitoring task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '126****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeStatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeStatus' => [ + 'description' => 'The host status information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the CloudMonitor agent. Valid values:'."\n" + ."\n" + .'* running: The CloudMonitor agent is running.'."\n" + .'* stopped: The CloudMonitor agent is stopped.'."\n" + .'* installing: The CloudMonitor agent is being installed.'."\n" + .'* install_faild: The CloudMonitor agent fails to be installed.'."\n" + .'* abnormal: The CloudMonitor agent is not properly installed.'."\n" + .'* not_installed: The CloudMonitor agent is not installed.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-hp3dunahluwajv6f****', + ], + 'AutoInstall' => [ + 'description' => 'Indicates whether the CloudMonitor agent is automatically installed. Valid values:'."\n" + ."\n" + .'* true: The CloudMonitor agent is automatically installed.'."\n" + .'* false: The CloudMonitor agent is not automatically installed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OsMonitorStatus' => [ + 'description' => 'The status of SysOM. Valid values:'."\n" + ."\n" + .'* installing: SysOM is being installed.'."\n" + .'* running: SysOM is running.'."\n" + .'* stopped: SysOM is stopped.'."\n" + .'* uninstalling: SysOM is being uninstalled.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'OsMonitorErrorCode' => [ + 'description' => 'The error status of SysOM. Valid values:'."\n" + ."\n" + .'* `install_fail`: SysOM fails to be installed or an unknown error occurs.'."\n" + .'* `install_assist_invalid`: SysOM fails to be installed because the status of Cloud Assistant is invalid.'."\n" + .'* `install_assist_command_fail`: SysOM fails to be installed because the installation command fails to run.'."\n" + .'* `uninstall_fail`: SysOM fails to be uninstalled or an unknown error occurs.'."\n" + .'* `uninstall_assist_invalid`: SysOM fails to be uninstalled because the status of Cloud Assistant is invalid.'."\n" + .'* `uninstall_assist_command_fail`: SysOM fails to be uninstalled because the uninstallation command fails to run.'."\n", + 'type' => 'string', + 'example' => 'install_fail', + ], + 'OsMonitorErrorDetail' => [ + 'description' => 'The details of the execution error. Valid values:'."\n" + ."\n" + .'* `Command.ErrorCode.Fail.Downlaod.REGIN_ID`: Failed to obtain the region ID.'."\n" + .'* `Command.ErrorCode.Fail.Downlaod.SYSAK`: Failed to download the .rpm package of System Analyse Kit (SysAK).'."\n" + .'* `Command.ErrorCode.Fail.Downlaod.CMON_FILE`: Failed to download the CMON file.'."\n" + .'* `Command.ErrorCode.Fail.Downlaod.BTF`: Failed to start SysAK because the BTF file is not found.'."\n" + .'* `Command.ErrorCode.Fail.Start.SYSAK`: Failed to start SysAK due to an unknown error.'."\n", + 'type' => 'string', + 'example' => 'Command.ErrorCode.Fail.Downlaod.REGIN_ID', + ], + 'OsMonitorVersion' => [ + 'description' => 'The SysOM version.'."\n", + 'type' => 'string', + 'example' => '1.3.0-12', + ], + 'OsMonitorConfig' => [ + 'description' => 'Indicates whether the SysAK monitoring feature is enabled.`` Valid values:'."\n" + ."\n" + .'* `true`: The SysAK monitoring feature is enabled.'."\n" + .'* `false`: the SysAK monitoring feature is disabled.'."\n", + 'type' => 'string', + 'example' => '{"sysak":true}', + ], + 'AgentInstallErrorCode' => [ + 'description' => 'The error code returned when the CloudMonitor agent is installed. Valid values:'."\n" + .'- Common.Timeout: The installation timed out.'."\n" + .'- Common.SLR: The service-linked role for CloudMonitor is unauthorized.'."\n" + .'- Common.OS: The operating system is not supported.'."\n" + .'- Assist.Invalid: Cloud Assistant is not running.'."\n" + .'- Assist.Invoke: An error occurred when the installation program is started.'."\n" + .'- Assist.Execute: An error occurred when the installation program is running.', + 'type' => 'string', + 'example' => 'Assist.Invalid', + ], + 'LoongCollectorVersion' => [ + 'description' => 'LoongCollector Version', + 'type' => 'string', + 'example' => '0.1.0', + ], + 'LoongCollectorStatus' => [ + 'description' => 'LoongCollector Status', + 'type' => 'string', + 'enumValueTitles' => [ + 'running' => '正常', + 'stopped' => '停止', + ], + 'example' => 'running', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F\\",\\n \\"Success\\": true,\\n \\"NodeStatusList\\": {\\n \\"NodeStatus\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"InstanceId\\": \\"i-hp3dunahluwajv6f****\\",\\n \\"AutoInstall\\": true,\\n \\"OsMonitorStatus\\": \\"running\\",\\n \\"OsMonitorErrorCode\\": \\"install_fail\\",\\n \\"OsMonitorErrorDetail\\": \\"Command.ErrorCode.Fail.Downlaod.REGIN_ID\\",\\n \\"OsMonitorVersion\\": \\"1.3.0-12\\",\\n \\"OsMonitorConfig\\": \\"{\\\\\\"sysak\\\\\\":true}\\",\\n \\"AgentInstallErrorCode\\": \\"Assist.Invalid\\",\\n \\"LoongCollectorVersion\\": \\"0.1.0\\",\\n \\"LoongCollectorStatus\\": \\"running\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringAgentStatusesResponse>\\n\\t<RequestId>6F8371DF-AB81-41B8-9E1B-5493B3FF0E4F</RequestId>\\n\\t<NodeStatusList>\\n\\t\\t<NodeStatus>\\n\\t\\t\\t<Status>running</Status>\\n\\t\\t\\t<AutoInstall>true</AutoInstall>\\n\\t\\t\\t<InstanceId>i-hp3dunahluwajv6f****</InstanceId>\\n\\t\\t</NodeStatus>\\n\\t</NodeStatusList>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeMonitoringAgentStatusesResponse>\\t","errorExample":""}]', + 'title' => '查询云监控插件运行状态', + 'description' => 'This topic describes how to query the status of the CloudMonitor agent that is installed on the `i-hp3dunahluwajv6f****` instance. The result indicates that the CloudMonitor agent is in the `running` state.'."\n", + 'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~199331~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyHostInfo' => [ + 'summary' => '调用ModifyHostInfo接口修改非阿里云的主机显示信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。仅支持非阿里云主机。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'host-R_NSWNV****', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'portalHost', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EBB5215C-44AB-4000-A2D7-48634FDC4F04', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"EBB5215C-44AB-4000-A2D7-48634FDC4F04\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyHostInfo>\\n\\t\\t<RequestId>EBB5215C-44AB-4000-A2D7-48634FDC4F04</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</ModifyHostInfo>","errorExample":""}]', + 'title' => '修改非阿里云的主机显示信息', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitoringConfig' => [ + 'summary' => '调用DescribeMonitoringConfig接口查询云监控插件的全局配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F35654DB-0C9D-4FB3-903F-479BA7663061', + ], + 'AutoInstall' => [ + 'description' => '现有ECS主机是否自动安装云监控插件。取值:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableInstallAgentNewECS' => [ + 'description' => '新购ECS主机是否自动安装云监控插件。取值:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F35654DB-0C9D-4FB3-903F-479BA7663061\\",\\n \\"AutoInstall\\": false,\\n \\"Success\\": true,\\n \\"EnableInstallAgentNewECS\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitoringConfigResponse>\\r\\n\\t<AutoInstall>false</AutoInstall>\\r\\n\\t<EnableInstallAgentNewECS>true</EnableInstallAgentNewECS>\\r\\n\\t<RequestId>BA76F154-DE3F-442C-94D3-895E7ABC1BDE</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMonitoringConfigResponse>","errorExample":""}]', + 'title' => '查询云监控插件的全局配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutMonitoringConfig' => [ + 'summary' => '调用PutMonitoringConfig接口设置云监控插件的全局配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AutoInstall', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableInstallAgentNewECS', + 'in' => 'query', + 'schema' => [ + 'description' => '新购ECS主机是否自动安装云监控插件。取值:'."\n" + .'- true(默认值):新购ECS主机自动安装云监控插件。'."\n" + ."\n" + .'- false:新购ECS主机不自动安装云监控插件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Specified parameter EnableInstallAgentNewECS is not valid.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '109C8095-6FAD-4DBB-B013-6ED18CE4C0B1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Specified parameter EnableInstallAgentNewECS is not valid.\\",\\n \\"RequestId\\": \\"109C8095-6FAD-4DBB-B013-6ED18CE4C0B1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutMonitoringConfigResponse>\\n <RequestId>109C8095-6FAD-4DBB-B013-6ED18CE4C0B1</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</PutMonitoringConfigResponse>","errorExample":""}]', + 'title' => '设置云监控插件的全局配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UninstallMonitoringAgent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '非阿里云主机的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'host-****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Successfully', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '466902B9-2842-40B0-B796-00FE772B6EF3', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 412 => [ + [ + 'errorCode' => 'AgentStateError', + 'errorMessage' => 'Expected agent running state is stopped.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successfully\\",\\n \\"RequestId\\": \\"466902B9-2842-40B0-B796-00FE772B6EF3\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UninstallMonitoringAgentResponse>\\n <RequestId>466902B9-2842-40B0-B796-00FE772B6EF3</RequestId>\\n <Code>200</Code>\\n <Message>Successfully</Message>\\n</UninstallMonitoringAgentResponse>","errorExample":""}]', + 'title' => '卸载非阿里云主机的云监控插件', + 'summary' => '调用UninstallMonitoringAgent接口卸载非阿里云主机的云监控插件。', + 'description' => '> 本接口不适用于阿里云主机的云监控插件。卸载阿里云主机的云监控插件的方法,请参见[安装和卸载插件](~~183482~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMonitoringAgentProcess' => [ + 'summary' => '调用CreateMonitoringAgentProcess接口创建进程监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'java', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => ' i-2ze51wjtwox01r8g****', + ], + ], + [ + 'name' => 'ProcessUser', + 'in' => 'query', + 'schema' => [ + 'description' => '执行进程的用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0DFCB47D-E7E1-4CBE-A381-8339F7B300EF', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '进程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"0DFCB47D-E7E1-4CBE-A381-8339F7B300EF\\",\\n \\"Success\\": true,\\n \\"Id\\": 12345\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitoringAgentProcessResponse>\\n <RequestId>0DFCB47D-E7E1-4CBE-A381-8339F7B300EF</RequestId>\\n <Id>171894</Id>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateMonitoringAgentProcessResponse>","errorExample":""}]', + 'title' => '创建进程监控', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMonitorAgentProcess' => [ + 'summary' => '调用CreateMonitorAgentProcess接口创建进程监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'AliYunDun', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-2ze2d6j5uhg20x47****', + ], + ], + [ + 'name' => 'ProcessUser', + 'in' => 'query', + 'schema' => [ + 'description' => '执行进程的用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '进程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true,\\n \\"Id\\": 123456\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorAgentProcessResponse>\\n <RequestId>971CC023-5A96-452A-BB7C-2483F948BCFD</RequestId>\\n <Id>123456</Id>\\n <Success>true</Success>\\n <Code>200</Code>\\n</CreateMonitorAgentProcessResponse>","errorExample":""}]', + 'title' => '创建进程监控', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitoringAgentProcesses' => [ + 'summary' => '调用DescribeMonitoringAgentProcesses接口查询指定资源的进程数列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-hp3hl3cx1pbahzy8****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C11C0E85-6862-4F25-8D66-D6A5E0882984', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeProcesses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeProcess' => [ + 'description' => '进程信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProcessName' => [ + 'description' => '进程名称。', + 'type' => 'string', + 'example' => 'java', + ], + 'ProcessId' => [ + 'description' => '进程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4550102', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '239708487', + ], + 'Command' => [ + 'description' => '命令。', + 'type' => 'string', + 'example' => '/bin/sh', + ], + 'ProcessUser' => [ + 'description' => '进程用户', + 'type' => 'string', + 'example' => 'admin', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'host-gdsmvinvmh6fu', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C11C0E85-6862-4F25-8D66-D6A5E0882984\\",\\n \\"Success\\": true,\\n \\"NodeProcesses\\": {\\n \\"NodeProcess\\": [\\n {\\n \\"ProcessName\\": \\"java\\",\\n \\"ProcessId\\": 4550102,\\n \\"GroupId\\": \\"239708487\\",\\n \\"Command\\": \\"/bin/sh\\",\\n \\"ProcessUser\\": \\"admin\\",\\n \\"InstanceId\\": \\"host-gdsmvinvmh6fu\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询指定资源的进程数列表', + 'description' => '> '."\n" + .'> 调用本接口之前,您需要先调用 CreateMonitoringAgentProcess 接口创建进程数。更多信息,请参见 [CreateMonitoringAgentProcess](~~2513212~~)。'."\n" + ."\n" + .'本文将提供一个示例,查询资源i-hp3hl3cx1pbahzy8****的进程数列表。返回结果显示进程数Nginx和HTTP的详细信息。', + ], + 'DeleteMonitoringAgentProcess' => [ + 'summary' => '调用DeleteMonitoringAgentProcess接口删除指定主机中的指定进程监控。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-KpVny6l****', + ], + ], + [ + 'name' => 'ProcessName', + 'in' => 'query', + 'schema' => [ + 'description' => '进程名称。'."\n" + ."\n" + .'> `ProcessId`和`ProcessName`必须设置一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'http', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '进程ID。'."\n" + ."\n" + .'> `ProcessId`和`ProcessName`必须设置一个。', + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '971CC023-5A96-452A-BB7C-2483F948BCFD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"971CC023-5A96-452A-BB7C-2483F948BCFD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMonitoringAgentProcessResponse>\\n <RequestId>EBB5215C-44AB-4000-A2D7-48634FDC4F04</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteMonitoringAgentProcessResponse>","errorExample":""}]', + 'title' => '删除指定主机中的指定进程监控', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSystemEventHistogram' => [ + 'summary' => '调用DescribeSystemEventHistogram接口查询系统事件的时段数量分布图(柱状图)。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '产品的名称缩写。'."\n" + .'>关于产品名称缩写的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'OSS', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '事件类型。'."\n" + .'>关于事件类型的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Exception', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。'."\n" + .'>关于事件名称的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'BucketIngressBandwidth', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '事件级别,取值:'."\n" + ."\n" + .'- CRITICAL:严重'."\n" + .'- WARN:警告'."\n" + .'- INFO:信息', + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。'."\n" + ."\n" + .'>关于事件状态的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索事件内容包含的关键字。取值:'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括a和b,可以搜索`a and b`。'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括a或b,可以搜索`a or b`。', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552209685596', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552220485596', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'SystemEventHistograms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemEventHistogram' => [ + 'description' => '事件分段统计详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552225753000', + ], + 'StartTime' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552225770000', + ], + 'Count' => [ + 'description' => '事件发生数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEventHistograms\\": {\\n \\"SystemEventHistogram\\": [\\n {\\n \\"EndTime\\": 1552225753000,\\n \\"StartTime\\": 1552225770000,\\n \\"Count\\": 2\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventHistogram>\\r\\n\\t\\t<RequestId>E38CA81A-A012-4C59-B694-42AAFBE27ED2</RequestId>\\r\\n\\t\\t<SystemEventHistograms>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671700000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671684000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671730000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671700000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671760000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671730000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671790000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671760000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671820000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671790000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671850000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671820000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671880000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671850000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671910000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671880000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671940000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671910000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593671970000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671940000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672000000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593671970000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672030000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672000000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672060000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672030000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672090000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672060000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672120000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672090000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672150000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672120000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672180000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672150000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672210000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672180000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672240000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672210000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672270000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672240000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672300000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672270000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672330000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672300000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672360000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672330000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672390000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672360000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672420000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672390000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672450000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672420000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672480000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672450000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672510000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672480000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672540000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672510000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672570000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672540000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t\\t<SystemEventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1593672584000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1593672570000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</SystemEventHistogram>\\r\\n\\t\\t</SystemEventHistograms>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeSystemEventHistogram>\\r\\n","errorExample":""}]', + 'title' => '查询系统事件的时段数量分布图(柱状图)', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSystemEventMetaList' => [ + 'summary' => '调用DescribeSystemEventMetaList接口查询系统事件的Meta信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A6582C8B-E67C-4A19-BC15-EAEFEBDC7995', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => 'Meta返回信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'failed', + ], + 'EventType' => [ + 'description' => '事件类型。取值:'."\n" + ."\n" + .'- StatusNotification:故障通知。'."\n" + ."\n" + .'- Exception:异常。'."\n" + ."\n" + .'- Maintenance:运维。', + 'type' => 'string', + 'example' => 'Exception', + ], + 'Product' => [ + 'description' => '产品名称缩写。', + 'type' => 'string', + 'example' => 'ADS', + ], + 'NameDesc' => [ + 'description' => '事件名称的描述信息。', + 'type' => 'string', + 'example' => '查询失败率高', + ], + 'NameDesc.En' => [ + 'description' => '英文事件名称的描述信息。', + 'type' => 'string', + 'example' => 'High query failure rate.', + ], + 'Name' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'SelectFailureRate', + ], + 'StatusDesc' => [ + 'description' => '事件状态描述。', + 'type' => 'string', + 'example' => 'Operation Failed', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- CRITICAL:紧急。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'INFO', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"A6582C8B-E67C-4A19-BC15-EAEFEBDC7995\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Resource\\": [\\n {\\n \\"Status\\": \\"failed\\",\\n \\"EventType\\": \\"Exception\\",\\n \\"Product\\": \\"ADS\\",\\n \\"NameDesc\\": \\"查询失败率高\\",\\n \\"NameDesc.En\\": \\"High query failure rate.\\",\\n \\"Name\\": \\"SelectFailureRate\\",\\n \\"StatusDesc\\": \\"Operation Failed\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventMetaListResponse>\\r\\n\\t\\t<RequestId>46350DCE-3399-473B-875F-1340DC97186C</RequestId>\\r\\n\\t\\t<Message>success</Message>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>Failed</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>OperationFailed</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>插入失败率10%</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>InsertFailureRate</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>Exception</EventType>\\r\\n\\t\\t\\t\\t<Product>ADS</Product>\\r\\n\\t\\t\\t\\t<Level>CRITICAL</Level>\\r\\n\\t\\t\\t\\t<Name>InsertFailureRate</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>Failed</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>OptionFailed</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>查询失败率10%</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>SelectFailureRate</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>Exception</EventType>\\r\\n\\t\\t\\t\\t<Product>ADS</Product>\\r\\n\\t\\t\\t\\t<Level>CRITICAL</Level>\\r\\n\\t\\t\\t\\t<Name>SelectFailureRate</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>Failed</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>Operation Failed</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>磁盘使用率80%</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>StorageUsage</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>Maintenance</EventType>\\r\\n\\t\\t\\t\\t<Product>ADS</Product>\\r\\n\\t\\t\\t\\t<Level>CRITICAL</Level>\\r\\n\\t\\t\\t\\t<Name>StorageUsage</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>EightyPercentQuotaExceeded</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>超过Quota 80%事件</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>超过Quota 80%事件</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>EightyPercentQuotaExceeded:Route</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>80%QuotaExceeded</EventType>\\r\\n\\t\\t\\t\\t<Product>CEN</Product>\\r\\n\\t\\t\\t\\t<Level>WARN</Level>\\r\\n\\t\\t\\t\\t<Name>EightyPercentQuotaExceeded:Route</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Status>NinetyEightPercentQuotaExceeded</Status>\\r\\n\\t\\t\\t\\t<StatusDesc>超过Quota 98%事件</StatusDesc>\\r\\n\\t\\t\\t\\t<NameDesc>超过Quota 98%事件</NameDesc>\\r\\n\\t\\t\\t\\t<NameDesc.En>NinetyEightPercentQuotaExceeded:Route</NameDesc.En>\\r\\n\\t\\t\\t\\t<EventType>98%QuotaExceeded</EventType>\\r\\n\\t\\t\\t\\t<Product>CEN</Product>\\r\\n\\t\\t\\t\\t<Level>WARN</Level>\\r\\n\\t\\t\\t\\t<Name>NinetyEightPercentQuotaExceeded:Route</Name>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeSystemEventMetaListResponse>","errorExample":""}]', + 'title' => '查询系统事件的Meta信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSystemEventAttribute' => [ + 'summary' => '调用DescribeSystemEventAttribute接口查询系统事件详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名称缩写。'."\n" + ."\n" + .'>关于产品名称缩写的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '事件类型。'."\n" + ."\n" + .'>关于事件类型的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Exception', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。'."\n" + ."\n" + .'>关于事件名称的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'BucketIngressBandwidth', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '事件级别。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。'."\n" + ."\n" + .'>关于事件状态的取值,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12346', + ], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索事件内容包含的关键字。取值:'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括a和b,可以搜索`a and b`。'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括a或b,可以搜索`a or b`。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552199984949', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552221584949', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'取值范围:1~100000000。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。'."\n" + ."\n" + .'取值范围:1~100。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。当操作成功时,返回`success`;当操作失败时,返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'SystemEvents' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemEvent' => [ + 'description' => '事件内容详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'normal', + ], + 'Time' => [ + 'description' => '事件发生的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552199984000', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'Product' => [ + 'description' => '产品名称缩写。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'instanceId1', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'xxxxx-1', + ], + 'Name' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'Agent_Status_Stopped', + ], + 'Content' => [ + 'description' => '事件内容详情。', + 'type' => 'string', + 'example' => '[{"product":"CloudMonitor","content":"{\\"ipGroup\\":\\"112.126.XX.XX,10.163.XX.XX\\",\\"tianjimonVersion\\":\\"1.2.22\\"}","groupId":"176,177,178,179,180,692,120812,1663836,96,2028302","time":"1552209568000","resourceId":"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****","level":"CRITICAL","status":"stopped","instanceName":"cmssiteprobebj-6","name":"Agent_Status_Stopped","regionId":"cn-beijing"}]', + ], + 'Level' => [ + 'description' => '事件级别。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'WARN', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Id' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'b936efc9-f621-4e8a-a6eb-076be40e****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEvents\\": {\\n \\"SystemEvent\\": [\\n {\\n \\"Status\\": \\"normal\\",\\n \\"Time\\": 1552199984000,\\n \\"GroupId\\": \\"12345\\",\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"InstanceName\\": \\"instanceId1\\",\\n \\"ResourceId\\": \\"xxxxx-1\\",\\n \\"Name\\": \\"Agent_Status_Stopped\\",\\n \\"Content\\": \\"[{\\\\\\"product\\\\\\":\\\\\\"CloudMonitor\\\\\\",\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ipGroup\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"112.126.XX.XX,10.163.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tianjimonVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.2.22\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"groupId\\\\\\":\\\\\\"176,177,178,179,180,692,120812,1663836,96,2028302\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1552209568000\\\\\\",\\\\\\"resourceId\\\\\\":\\\\\\"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****\\\\\\",\\\\\\"level\\\\\\":\\\\\\"CRITICAL\\\\\\",\\\\\\"status\\\\\\":\\\\\\"stopped\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"cmssiteprobebj-6\\\\\\",\\\\\\"name\\\\\\":\\\\\\"Agent_Status_Stopped\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\"}]\\",\\n \\"Level\\": \\"WARN\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"b936efc9-f621-4e8a-a6eb-076be40e****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventAttribute>\\r\\n\\t\\t<SystemEvents>\\r\\n\\t\\t\\t<SystemEvent>\\r\\n\\t\\t\\t\\t<Status>normal</Status>\\r\\n\\t\\t\\t\\t<InstanceName>instanceId1</InstanceName>\\r\\n\\t\\t\\t\\t<ResourceId>xxxxx-1</ResourceId>\\r\\n\\t\\t\\t\\t<Content>[{\\\\\\"product\\\\\\":\\\\\\"CloudMonitor\\\\\\",\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"ipGroup\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"112.126.XX.XX,10.163.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tianjimonVersion\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.2.22\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"groupId\\\\\\":\\\\\\"176,177,178,179,180,692,120812,1663836,96,2028302\\\\\\",\\\\\\"time\\\\\\":\\\\\\"1552209568000\\\\\\",\\\\\\"resourceId\\\\\\":\\\\\\"acs:ecs:cn-beijing:173651113438****:instance/i-25k35****\\\\\\",\\\\\\"level\\\\\\":\\\\\\"CRITICAL\\\\\\",\\\\\\"status\\\\\\":\\\\\\"stopped\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"cmssiteprobebj-6\\\\\\",\\\\\\"name\\\\\\":\\\\\\"Agent_Status_Stopped\\\\\\",\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\"}]</Content>\\r\\n\\t\\t\\t\\t<Product>CloudMonitor</Product>\\r\\n\\t\\t\\t\\t<Level>WARN</Level>\\r\\n\\t\\t\\t\\t<Time>1552199984000</Time>\\r\\n\\t\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\r\\n\\t\\t\\t\\t<Name>Agent_Status_Stopped</Name>\\r\\n\\t\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t\\t</SystemEvent>\\r\\n\\t\\t</SystemEvents>\\r\\n\\t\\t<Message>success</Message>\\r\\n\\t\\t<RequestId>60912C8D-B340-4253-ADE7-61ACDFD25CFC</RequestId>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeSystemEventAttribute>","errorExample":""}]', + 'title' => '查询系统事件详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSystemEventCount' => [ + 'summary' => '调用DescribeSystemEventCount接口查询当前账号下各云服务发生事件的数量。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务名称。'."\n" + ."\n" + .'调用DescribeSystemEventMetaList接口,获取返回参数`Product`的值,即可获得当前阿里云账号下所有事件的云服务名称。更多信息,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '事件类型。'."\n" + ."\n" + .'调用DescribeSystemEventMetaList接口,获取返回参数`EventType`的值,即可获得当前阿里云账号下所有云服务的事件类型。更多信息,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'StatusNotification', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。'."\n" + ."\n" + .'调用DescribeSystemEventMetaList接口,获取返回参数`Name`的值,即可获得当前阿里云账号下所有云服务的事件名称。更多信息,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Instance:StateChange', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '事件级别。取值:'."\n" + ."\n" + .'- Critical:严重。'."\n" + ."\n" + .'- Warn:警告。'."\n" + ."\n" + .'- Info:信息。'."\n" + ."\n" + .'调用DescribeSystemEventMetaList接口,获取返回参数`Level`的值,即可获得当前阿里云账号下所有云服务的事件级别。更多信息,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Info', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '事件状态。'."\n" + ."\n" + .'调用DescribeSystemEventMetaList接口,获取返回参数`Status`的值,即可获得当前阿里云账号下所有云服务的事件状态。更多信息,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '17285****', + ], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索事件内容包含的关键字。取值:'."\n" + ."\n" + .'- 如果您需要搜索事件的内容中包括a和b,则可以搜索`a and b`。'."\n" + ."\n" + .'- 如果您需要搜索事件的内容中包括a或b,可以搜索`a or b`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询事件开始的时间戳。单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1635993541000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询事件结束的时间戳。单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1635993921000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。'."\n" + ."\n" + .'当请求成功时,返回成功信息;当请求失败时,返回失败原因。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'SystemEventCounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SystemEventCount' => [ + 'description' => '事件详情。', + 'type' => 'array', + 'items' => [ + 'description' => '事件详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Time' => [ + 'description' => '事件发生的时间戳。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1635993751000', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '17285****', + ], + 'Product' => [ + 'description' => '事件的云服务名称。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'ECS-test', + ], + 'Num' => [ + 'description' => '发生事件的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-rj99xc6cptkk64ml****', + ], + 'Name' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'Instance:StateChange', + ], + 'Content' => [ + 'description' => '事件描述。', + 'type' => 'string', + 'example' => '实例状态改变通知', + ], + 'Level' => [ + 'description' => '事件级别。取值:'."\n" + ."\n" + .'- Critical:严重。'."\n" + ."\n" + .'- Warn:警告。'."\n" + ."\n" + .'- Info:信息。', + 'type' => 'string', + 'example' => 'Info', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF\\",\\n \\"Success\\": \\"true\\",\\n \\"SystemEventCounts\\": {\\n \\"SystemEventCount\\": [\\n {\\n \\"Status\\": \\"Normal\\",\\n \\"Time\\": 1635993751000,\\n \\"GroupId\\": \\"17285****\\",\\n \\"Product\\": \\"ECS\\",\\n \\"InstanceName\\": \\"ECS-test\\",\\n \\"Num\\": 3,\\n \\"ResourceId\\": \\"i-rj99xc6cptkk64ml****\\",\\n \\"Name\\": \\"Instance:StateChange\\",\\n \\"Content\\": \\"实例状态改变通知\\",\\n \\"Level\\": \\"Info\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSystemEventCountResponse>\\r\\n\\t<Message>success</Message>\\r\\n\\t<RequestId>C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF</RequestId>\\r\\n\\t<SystemEventCounts>\\r\\n\\t\\t<SystemEventCount>\\r\\n\\t\\t\\t<Num>3</Num>\\r\\n\\t\\t\\t<Product>ECS</Product>\\r\\n\\t\\t\\t<Time>1635993751000</Time>\\r\\n\\t\\t\\t<Name>Instance:StateChange</Name>\\r\\n\\t\\t</SystemEventCount>\\r\\n\\t</SystemEventCounts>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeSystemEventCountResponse>\\t","errorExample":""}]', + 'title' => '查询当前账号下各云服务发生事件的数量', + 'description' => '### 背景信息'."\n" + .'您可以调用[DescribeSystemEventMetaList](~~114972~~),获取云监控支持的各云服务及其系统事件。'."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,查询当前账号云服务器`ECS`发生事件的数量,返回结果显示,发生事件的数量共3条。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。'."\n" + ."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMonitorResourceQuotaAttribute' => [ + 'summary' => '调用DescribeMonitorResourceQuotaAttribute接口查询云监控各个资源的配额。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ShowUsed', + 'in' => 'query', + 'schema' => [ + 'description' => '返回值是否包含已使用配额。取值:'."\n" + .'- true(默认值):包含。'."\n" + .'- false:不包含。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '31BC7201-00F2-47B2-B7B9-6A173076ACE', + ], + 'ResourceQuota' => [ + 'description' => '云监控的配额详情。', + 'type' => 'object', + 'properties' => [ + 'SuitInfo' => [ + 'description' => '云监控当前版本。取值:'."\n" + .'- free:免费版。'."\n" + .'- pro:专业版。'."\n" + .'- cms_post:后付费。', + 'type' => 'string', + 'example' => 'pro', + ], + 'InstanceId' => [ + 'description' => '预付费套餐ID。', + 'type' => 'string', + 'example' => 'cms_edition-cn-n6w20rn****', + ], + 'ExpireTime' => [ + 'description' => '套餐到期时间。', + 'type' => 'string', + 'example' => '2021-02-28', + ], + 'SiteMonitorEcsProbe' => [ + 'description' => '站点监控ECS探测点配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '站点监控ECS探测点的总配额。'."\n" + ."\n" + .'> 单个站点监控任务能够选择的最大ECS探测点的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'QuotaPackage' => [ + 'description' => '套餐包内站点监控ECS探测点的配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'QuotaUsed' => [ + 'description' => '套餐包内站点监控ECS探测点的配额使用量。'."\n" + ."\n" + .'> 目前已创建的所有站点监控任务的总ECS探测点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'SiteMonitorOperatorProbe' => [ + 'description' => '站点监控运营商探测点配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '站点监控运营商探测点的总配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'QuotaPackage' => [ + 'description' => '套餐包内站点监控运营商探测点的配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'QuotaUsed' => [ + 'description' => '套餐包内站点监控运营商探测点的配额使用量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'SiteMonitorTask' => [ + 'description' => '站点监控任务配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '站点监控任务的总配额。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + 'QuotaPackage' => [ + 'description' => '套餐包内站点监控任务的配额。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'QuotaUsed' => [ + 'description' => '套餐包内站点监控任务的配额使用量。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + ], + ], + 'SiteMonitorBrowser' => [ + 'description' => '浏览器拨测任务数配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '浏览器拨测任务数的总配额。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'QuotaPackage' => [ + 'description' => '套餐内浏览器拨测任务数的配额。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'QuotaUsed' => [ + 'description' => '套餐内浏览器拨测任务数的配额用量。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + ], + ], + 'SiteMonitorMobile' => [ + 'description' => '移动端拨测任务数配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '移动端拨测任务数配额总量。 单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'QuotaPackage' => [ + 'description' => '套餐内移动端拨测任务数配额。 单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'QuotaUsed' => [ + 'description' => '套餐内移动端拨测任务数配额用量。 单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + ], + ], + 'CustomMonitor' => [ + 'description' => '自定义监控配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '自定义监控时间序列的总配额。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1200', + ], + 'QuotaPackage' => [ + 'description' => '套餐内自定义监控时间序列的配额。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'QuotaUsed' => [ + 'description' => '套餐内自定义监控时间序列的配额用量。单位:个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + ], + ], + 'EventMonitor' => [ + 'description' => '事件监控配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '事件监控的总配额。单位:万。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '55', + ], + 'QuotaPackage' => [ + 'description' => '套餐包内事件监控的配额。单位:万。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'QuotaUsed' => [ + 'description' => '套餐包内事件监控的配额用量。单位:万。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'LogMonitor' => [ + 'description' => '日志监控配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '日志监控的总配额。单位:MByte/Min。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'QuotaPackage' => [ + 'description' => '套餐包内日志监控的配额。单位:MByte/Min。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'QuotaUsed' => [ + 'description' => '套餐包内日志监控的配额使用量。单位:MByte/Min。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + 'Api' => [ + 'description' => 'API配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => 'API总配额。单位:万次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'QuotaPackage' => [ + 'description' => '套餐内API的配额。单位:万次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'QuotaUsed' => [ + 'description' => '套餐内API的配额用量。单位:次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9987', + ], + ], + ], + 'SMS' => [ + 'description' => '报警短信包配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '报警短信的总配额。单位:条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '550', + ], + 'QuotaPackage' => [ + 'description' => '报警短信包的配额。单位:条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'QuotaUsed' => [ + 'description' => '报警短信包的配额使用量。单位:条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '38', + ], + ], + ], + 'Phone' => [ + 'description' => '报警电话包配额。', + 'type' => 'object', + 'properties' => [ + 'QuotaLimit' => [ + 'description' => '报警电话的总配额。单位:通。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '550', + ], + 'QuotaPackage' => [ + 'description' => '报警电话包的配额。单位:通。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + 'QuotaUsed' => [ + 'description' => '报警电话包的配额使用量。单位:通。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'EnterpriseQuota' => [ + 'description' => '企业云监控配额详情。', + 'type' => 'object', + 'properties' => [ + 'SuitInfo' => [ + 'description' => '企业云监控描述。', + 'type' => 'string', + 'example' => 'ENTERPRISE', + ], + 'InstanceId' => [ + 'description' => '企业云监控实例ID。', + 'type' => 'string', + 'example' => 'cms_enterprise_public_cn-7mz27pd****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"31BC7201-00F2-47B2-B7B9-6A173076ACE\\",\\n \\"ResourceQuota\\": {\\n \\"SuitInfo\\": \\"pro\\",\\n \\"InstanceId\\": \\"cms_edition-cn-n6w20rn****\\",\\n \\"ExpireTime\\": \\"2021-02-28\\",\\n \\"SiteMonitorEcsProbe\\": {\\n \\"QuotaLimit\\": 5,\\n \\"QuotaPackage\\": 5,\\n \\"QuotaUsed\\": 20\\n },\\n \\"SiteMonitorOperatorProbe\\": {\\n \\"QuotaLimit\\": 5,\\n \\"QuotaPackage\\": 5,\\n \\"QuotaUsed\\": 0\\n },\\n \\"SiteMonitorTask\\": {\\n \\"QuotaLimit\\": 25,\\n \\"QuotaPackage\\": 20,\\n \\"QuotaUsed\\": 15\\n },\\n \\"SiteMonitorBrowser\\": {\\n \\"QuotaLimit\\": 50,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 15\\n },\\n \\"SiteMonitorMobile\\": {\\n \\"QuotaLimit\\": 50,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 15\\n },\\n \\"CustomMonitor\\": {\\n \\"QuotaLimit\\": 1200,\\n \\"QuotaPackage\\": 1000,\\n \\"QuotaUsed\\": 8\\n },\\n \\"EventMonitor\\": {\\n \\"QuotaLimit\\": 55,\\n \\"QuotaPackage\\": 50,\\n \\"QuotaUsed\\": 2\\n },\\n \\"LogMonitor\\": {\\n \\"QuotaLimit\\": 150,\\n \\"QuotaPackage\\": 150,\\n \\"QuotaUsed\\": 80\\n },\\n \\"Api\\": {\\n \\"QuotaLimit\\": 500,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 9987\\n },\\n \\"SMS\\": {\\n \\"QuotaLimit\\": 550,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 38\\n },\\n \\"Phone\\": {\\n \\"QuotaLimit\\": 550,\\n \\"QuotaPackage\\": 500,\\n \\"QuotaUsed\\": 100\\n },\\n \\"EnterpriseQuota\\": {\\n \\"SuitInfo\\": \\"ENTERPRISE\\",\\n \\"InstanceId\\": \\"cms_enterprise_public_cn-7mz27pd****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMonitorResourceQuotaAttributeResponse>\\r\\n\\t<RequestId>1E1961C4-B340-45D7-8CC3-F7D0BF19F2E0</RequestId>\\r\\n\\t<ResourceQuota>\\r\\n\\t\\t<SiteMonitorOperatorProbe>\\r\\n\\t\\t\\t<QuotaUsed>0</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>5</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>5</QuotaLimit>\\r\\n\\t\\t</SiteMonitorOperatorProbe>\\r\\n\\t\\t<InstanceId>cms_edition-cn-n6w20rn****</InstanceId>\\r\\n\\t\\t<Phone>\\r\\n\\t\\t\\t<QuotaUsed>100</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>500</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>550</QuotaLimit>\\r\\n\\t\\t</Phone>\\r\\n\\t\\t<SuitInfo>pro</SuitInfo>\\r\\n\\t\\t<SiteMonitorTask>\\r\\n\\t\\t\\t<QuotaUsed>7</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>20</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>20</QuotaLimit>\\r\\n\\t\\t</SiteMonitorTask>\\r\\n\\t\\t<SMS>\\r\\n\\t\\t\\t<QuotaUsed>38</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>500</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>550</QuotaLimit>\\r\\n\\t\\t</SMS>\\r\\n\\t\\t<LogMonitor>\\r\\n\\t\\t\\t<QuotaUsed>0</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>50</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>50</QuotaLimit>\\r\\n\\t\\t</LogMonitor>\\r\\n\\t\\t<Api>\\r\\n\\t\\t\\t<QuotaUsed>9987</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>500</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>500</QuotaLimit>\\r\\n\\t\\t</Api>\\r\\n\\t\\t<ExpireTime>2021-02-28</ExpireTime>\\r\\n\\t\\t<SiteMonitorEcsProbe>\\r\\n\\t\\t\\t<QuotaUsed>20</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>5</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>5</QuotaLimit>\\r\\n\\t\\t</SiteMonitorEcsProbe>\\r\\n\\t\\t<CustomMonitor>\\r\\n\\t\\t\\t<QuotaUsed>8</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>1000</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>1200</QuotaLimit>\\r\\n\\t\\t</CustomMonitor>\\r\\n\\t\\t<EventMonitor>\\r\\n\\t\\t\\t<QuotaUsed>2</QuotaUsed>\\r\\n\\t\\t\\t<QuotaPackage>50</QuotaPackage>\\r\\n\\t\\t\\t<QuotaLimit>55</QuotaLimit>\\r\\n\\t\\t</EventMonitor>\\r\\n\\t</ResourceQuota>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMonitorResourceQuotaAttributeResponse>\\t","errorExample":""}]', + 'title' => '查询云监控各个资源的配额', + 'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SendDryRunSystemEvent' => [ + 'summary' => '调用SendDryRunSystemEvent接口调试云资源的系统事件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务名称。'."\n" + ."\n" + .'>事件支持的云服务,详细信息请参见[云服务系统事件](~~167388~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。'."\n" + ."\n" + .'>详细信息请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Agent_Status_Stopped', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'EventContent', + 'in' => 'query', + 'schema' => [ + 'description' => '事件内容。'."\n" + ."\n" + .'>该参数的取值可以为任意一个合法的JSON,建议JSON中包含关键字值`product`、`resourceId`和`regionId`。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"product":"CloudMonitor","resourceId":"acs:ecs:cn-hongkong:173651113438****:instance/{instanceId}","level":"CRITICAL","instanceName":"instanceName","regionId":"cn-hangzhou","name":"Agent_Status_Stopped","content":{"ipGroup":"0.0.0.0,0.0.0.1","tianjimonVersion":"1.2.11"},"status":"stopped"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<SendDryRunSystemEventResponse>\\r\\n\\t<Message>success</Message>\\r\\n\\t<RequestId>590FB642-5FFE-4AE0-883B-E1323DD20541</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</SendDryRunSystemEventResponse>\\t","errorExample":""}]', + 'title' => '调试云资源的系统事件', + 'description' => '本接口用于调试资源配置的触发逻辑是否符合预期,即通过调用该接口发送一条测试事件,帮助您验证对应的事件触发报警后返回的内容是否符合预期。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCustomEventCount' => [ + 'summary' => '调用DescribeCustomEventCount接口查询自定义事件的统计结果。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'BABEL_BUY', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索事件内容包含的关键字。'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括A和B,则可以搜索A和B。'."\n" + .'- 如果您待搜索事件的内容中包括A或B,则可以搜索A或B。', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552209685596', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552220485596', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。当请求成功时,返回成功信息;当请求失败时,返回失败原因。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CustomEventCounts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomEventCount' => [ + 'description' => '自定义事件详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '事件发生的时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552267615000', + ], + 'Num' => [ + 'description' => '事件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Name' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'BABEL_BUY', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": true,\\n \\"CustomEventCounts\\": {\\n \\"CustomEventCount\\": [\\n {\\n \\"Time\\": 1552267615000,\\n \\"Num\\": 20,\\n \\"Name\\": \\"BABEL_BUY\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomEventCount>\\n\\t\\t<CustomEventCounts>\\n\\t\\t\\t<CustomEventCount>\\n\\t\\t\\t\\t<Name>BABEL_BUY</Name>\\n\\t\\t\\t\\t<Time>1552267615000</Time>\\n\\t\\t\\t\\t<Num>20</Num>\\n\\t\\t\\t</CustomEventCount>\\n\\t\\t</CustomEventCounts>\\n\\t\\t<Message>success</Message>\\n\\t\\t<RequestId>38D3C270-6799-4461-AA55-7975352140C1</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DescribeCustomEventCount>","errorExample":""}]', + 'title' => '查询自定义事件的统计结果', + 'description' => '>此API以产品为维度统计每个产品自定义事件的数量。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCustomEventHistogram' => [ + 'summary' => '调用DescribeCustomEventHistogram接口查询自定义上报事件的分时段数量分布图。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'BucketIngressBandwidth', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '事件级别。取值:'."\n" + .'- CRITICAL:严重'."\n" + .'- WARN:警告'."\n" + .'- INFO:信息', + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索事件内容包含的关键字。'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括A和B,则可以搜索A和B。'."\n" + .'- 如果您待搜索事件的内容中包括A或B,则可以搜索A或B。', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552209685596', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552220485596', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。当请求成功时,返回成功信息;当请求失败时,返回失败原因。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '486029C9-53E1-44B4-85A8-16A571A043FD', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'EventHistograms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventHistogram' => [ + 'description' => '自定义事件统计数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552226750000', + ], + 'StartTime' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552226740000', + ], + 'Count' => [ + 'description' => '事件发生的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"486029C9-53E1-44B4-85A8-16A571A043FD\\",\\n \\"Success\\": \\"true\\",\\n \\"EventHistograms\\": {\\n \\"EventHistogram\\": [\\n {\\n \\"EndTime\\": 1552226750000,\\n \\"StartTime\\": 1552226740000,\\n \\"Count\\": 3\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomEventHistogramResponse>\\r\\n\\t\\t<Message>success</Message>\\r\\n\\t\\t<RequestId>5977C7EE-E727-4EC4-B756-ECC8CB820CF4</RequestId>\\r\\n\\t\\t<EventHistograms>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000690000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000689000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000720000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000690000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000930000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000900000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000960000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000930000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t\\t<EventHistogram>\\r\\n\\t\\t\\t\\t<EndTime>1596000990000</EndTime>\\r\\n\\t\\t\\t\\t<StartTime>1596000960000</StartTime>\\r\\n\\t\\t\\t\\t<Count>0</Count>\\r\\n\\t\\t\\t</EventHistogram>\\r\\n\\t\\t</EventHistograms>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeCustomEventHistogramResponse>\\r\\n","errorExample":""}]', + 'title' => '查询自定义上报事件的分时段数量分布图', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCustomEventAttribute' => [ + 'summary' => '调用DescribeCustomEventAttribute接口查询自定义事件的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'SearchKeywords', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索事件内容包含的关键字。'."\n" + ."\n" + .'- 如果您待搜索事件的内容中包括A和B,则可以搜索A和B。'."\n" + .'- 如果您待搜索事件的内容中包括A或B,则可以搜索A或B。', + 'type' => 'string', + 'required' => false, + 'example' => 'cms', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552224365971', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1552227965971', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'userId:173651113438**** and name:"BABEL_CHECK"', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '60912C8D-B340-4253-ADE7-61ACDFD25CFC', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'CustomEvents' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CustomEvent' => [ + 'description' => '事件详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '事件发生的时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'string', + 'example' => '1552199984000', + ], + 'Name' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'BABEL_CHECK', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'Content' => [ + 'description' => '上报事件详情。', + 'type' => 'string', + 'example' => 'requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{"autoPay":false,"autoUseCoupon":false,"bid":"26842","buyerId":118935342242****,"commodities":[{"aliyunProduceCode":"cms","chargeType":"PREPAY","commodityCode":"cms_call_num","components":[{"componentCode":"phone_count","instanceProperty":[{"code":"phone_count","value":"500"}],"moduleAttrStatus":1}],"duration":6,"free":false,"orderParams":{"aliyunProduceCode":"cms"},"orderType":"BUY","prePayPostCharge":false,"pricingCycle":"Month","quantity":1,"refundSpecCode":"","renewChange":false,"specCode":"cms_call_num","specUpdate":false,"syncToSubscription":false,"upgradeInquireFinancialValue":true}],"fromApp":"commonbuy","orderParams":{"priceCheck":"true"},"payerId":118935342242****,"requestId":"ade3ad32-f58b-45d7-add4-ac542be3d8ec","skipChannel":false,"userId":118935342242****}', + ], + 'Id' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"userId:173651113438**** and name:\\\\\\"BABEL_CHECK\\\\\\"\\",\\n \\"RequestId\\": \\"60912C8D-B340-4253-ADE7-61ACDFD25CFC\\",\\n \\"Success\\": \\"true\\",\\n \\"CustomEvents\\": {\\n \\"CustomEvent\\": [\\n {\\n \\"Time\\": \\"1552199984000\\",\\n \\"Name\\": \\"BABEL_CHECK\\",\\n \\"GroupId\\": \\"12345\\",\\n \\"Content\\": \\"requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{\\\\\\"autoPay\\\\\\":false,\\\\\\"autoUseCoupon\\\\\\":false,\\\\\\"bid\\\\\\":\\\\\\"26842\\\\\\",\\\\\\"buyerId\\\\\\":118935342242****,\\\\\\"commodities\\\\\\":[{\\\\\\"aliyunProduceCode\\\\\\":\\\\\\"cms\\\\\\",\\\\\\"chargeType\\\\\\":\\\\\\"PREPAY\\\\\\",\\\\\\"commodityCode\\\\\\":\\\\\\"cms_call_num\\\\\\",\\\\\\"components\\\\\\":[{\\\\\\"componentCode\\\\\\":\\\\\\"phone_count\\\\\\",\\\\\\"instanceProperty\\\\\\":[{\\\\\\"code\\\\\\":\\\\\\"phone_count\\\\\\",\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}],\\\\\\"moduleAttrStatus\\\\\\":1}],\\\\\\"duration\\\\\\":6,\\\\\\"free\\\\\\":false,\\\\\\"orderParams\\\\\\":{\\\\\\"aliyunProduceCode\\\\\\":\\\\\\"cms\\\\\\"},\\\\\\"orderType\\\\\\":\\\\\\"BUY\\\\\\",\\\\\\"prePayPostCharge\\\\\\":false,\\\\\\"pricingCycle\\\\\\":\\\\\\"Month\\\\\\",\\\\\\"quantity\\\\\\":1,\\\\\\"refundSpecCode\\\\\\":\\\\\\"\\\\\\",\\\\\\"renewChange\\\\\\":false,\\\\\\"specCode\\\\\\":\\\\\\"cms_call_num\\\\\\",\\\\\\"specUpdate\\\\\\":false,\\\\\\"syncToSubscription\\\\\\":false,\\\\\\"upgradeInquireFinancialValue\\\\\\":true}],\\\\\\"fromApp\\\\\\":\\\\\\"commonbuy\\\\\\",\\\\\\"orderParams\\\\\\":{\\\\\\"priceCheck\\\\\\":\\\\\\"true\\\\\\"},\\\\\\"payerId\\\\\\":118935342242****,\\\\\\"requestId\\\\\\":\\\\\\"ade3ad32-f58b-45d7-add4-ac542be3d8ec\\\\\\",\\\\\\"skipChannel\\\\\\":false,\\\\\\"userId\\\\\\":118935342242****}\\",\\n \\"Id\\": \\"123\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomEventAttributeResponse>\\r\\n <Message>userId:173651113438**** and name:\\"BABEL_CHECK\\"</Message>\\r\\n <RequestId>194A3F1D-8EA6-4922-BBF2-5F213AC7B648</RequestId>\\r\\n <CustomEvents>\\r\\n <CustomEvent>\\r\\n <Name>BABEL_CHECK</Name>\\r\\n <Time>1553422490000</Time>\\r\\n <Id>E4407D77-72BA-4818-8644-39D119D7****</Id>\\r\\n <Content>requestId:BD524A26-A3DA-4133-A863-FF56B335797E, info:{\\"autoPay\\":false,\\"autoUseCoupon\\":false,\\"bid\\":\\"26842\\",\\"buyerId\\":118935342242****,\\"commodities\\":[{\\"aliyunProduceCode\\":\\"cms\\",\\"chargeType\\":\\"PREPAY\\",\\"commodityCode\\":\\"cms_edition\\",\\"components\\":[{\\"componentCode\\":\\"suggest_type\\",\\"instanceProperty\\":[{\\"code\\":\\"suggest_type\\",\\"value\\":\\"pro\\"}],\\"moduleAttrStatus\\":1},{\\"componentCode\\":\\"pay_type\\",\\"instanceProperty\\":[{\\"code\\":\\"pay_type\\",\\"value\\":\\"suggest\\"}],\\"moduleAttrStatus\\":1}],\\"duration\\":1,\\"free\\":false,\\"orderParams\\":{\\"aliyunProduceCode\\":\\"cms\\"},\\"orderType\\":\\"BUY\\",\\"prePayPostCharge\\":false,\\"pricingCycle\\":\\"Month\\",\\"quantity\\":1,\\"refundSpecCode\\":\\"\\",\\"renewChange\\":false,\\"specCode\\":\\"cms_edition\\",\\"specUpdate\\":false,\\"syncToSubscription\\":false,\\"upgradeInquireFinancialValue\\":true}],\\"fromApp\\":\\"commonbuy\\",\\"orderParams\\":{\\"priceCheck\\":\\"true\\"},\\"payerId\\":118935342242****,\\"requestId\\":\\"57d81d14-3c60-468e-b50a-1dfdb1594673\\",\\"skipChannel\\":false,\\"userId\\":118935342242****}</Content>\\r\\n <GroupId>12345</GroupId>\\r\\n </CustomEvent>\\r\\n <CustomEvent>\\r\\n <Name>BABEL_CHECK</Name>\\r\\n <Time>1553422498000</Time>\\r\\n <Id>D44FAC44-EB81-470A-909D-BD963FF9****</Id>\\r\\n <Content>requestId:14CC5306-0BAB-464F-B340-CF33AD306510, info:{\\"autoPay\\":false,\\"autoUseCoupon\\":false,\\"bid\\":\\"26842\\",\\"buyerId\\":118935342242****,\\"commodities\\":[{\\"aliyunProduceCode\\":\\"cms\\",\\"chargeType\\":\\"PREPAY\\",\\"commodityCode\\":\\"cms_smspackage\\",\\"components\\":[{\\"componentCode\\":\\"sms_count\\",\\"instanceProperty\\":[{\\"code\\":\\"sms_count\\",\\"value\\":\\"1000\\"}],\\"moduleAttrStatus\\":1}],\\"duration\\":6,\\"free\\":false,\\"orderParams\\":{\\"aliyunProduceCode\\":\\"cms\\"},\\"orderType\\":\\"BUY\\",\\"prePayPostCharge\\":false,\\"pricingCycle\\":\\"Month\\",\\"quantity\\":1,\\"refundSpecCode\\":\\"\\",\\"renewChange\\":false,\\"specCode\\":\\"cms_smspackage\\",\\"specUpdate\\":false,\\"syncToSubscription\\":false,\\"upgradeInquireFinancialValue\\":true}],\\"fromApp\\":\\"commonbuy\\",\\"orderParams\\":{\\"priceCheck\\":\\"true\\"},\\"payerId\\":118935342242****,\\"requestId\\":\\"64461412-31f2-4e52-a875-43bf1410bdf0\\",\\"skipChannel\\":false,\\"userId\\":118935342242****}</Content>\\r\\n <GroupId>12345</GroupId>\\r\\n </CustomEvent>\\r\\n <CustomEvent>\\r\\n <Name>BABEL_CHECK</Name>\\r\\n <Time>1553422506000</Time>\\r\\n <Id>3AF6FE15-4F6E-459A-96F6-45C74F765209</Id>\\r\\n <Content>requestId:4975A6F3-19AC-4C01-BAD2-034DA07FEBB5, info:{\\"autoPay\\":false,\\"autoUseCoupon\\":false,\\"bid\\":\\"26842\\",\\"buyerId\\":118935342242****,\\"commodities\\":[{\\"aliyunProduceCode\\":\\"cms\\",\\"chargeType\\":\\"PREPAY\\",\\"commodityCode\\":\\"cms_call_num\\",\\"components\\":[{\\"componentCode\\":\\"phone_count\\",\\"instanceProperty\\":[{\\"code\\":\\"phone_count\\",\\"value\\":\\"500\\"}],\\"moduleAttrStatus\\":1}],\\"duration\\":6,\\"free\\":false,\\"orderParams\\":{\\"aliyunProduceCode\\":\\"cms\\"},\\"orderType\\":\\"BUY\\",\\"prePayPostCharge\\":false,\\"pricingCycle\\":\\"Month\\",\\"quantity\\":1,\\"refundSpecCode\\":\\"\\",\\"renewChange\\":false,\\"specCode\\":\\"cms_call_num\\",\\"specUpdate\\":false,\\"syncToSubscription\\":false,\\"upgradeInquireFinancialValue\\":true}],\\"fromApp\\":\\"commonbuy\\",\\"orderParams\\":{\\"priceCheck\\":\\"true\\"},\\"payerId\\":118935342242****,\\"requestId\\":\\"ade3ad32-f58b-45d7-add4-ac542be3d8ec\\",\\"skipChannel\\":false,\\"userId\\":118935342242****}</Content>\\r\\n <GroupId>12345</GroupId>\\r\\n </CustomEvent>\\r\\n </CustomEvents>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</DescribeCustomEventAttributeResponse>","errorExample":""}]', + 'title' => '查询自定义事件的详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutCustomEvent' => [ + 'summary' => '调用PutCustomEvent接口上报自定义事件的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EventInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '事件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件信息列表。', + 'type' => 'object', + 'properties' => [ + 'EventName' => [ + 'description' => '事件名称。N的取值范围:1~50。', + 'type' => 'string', + 'required' => true, + 'example' => 'myEvent', + ], + 'Time' => [ + 'description' => '发生事件的时间。'."\n" + ."\n" + .'格式:`yyyyMMddTHHmmss.SSSZ`(年月日时分秒.毫秒时区)。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 您还可以输入Unix时间(例如:1552199984000)。单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '20171013T170923.456+0800', + ], + 'GroupId' => [ + 'description' => '应用分组ID。N的取值范围:0~50。'."\n" + ."\n" + .'默认值:0.0表示上报的事件不属于任何一个应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + 'Content' => [ + 'description' => '事件内容。N的取值范围:1~50。', + 'type' => 'string', + 'required' => true, + 'example' => 'IOException', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '131DD9C8-9A32-4428-AD2E-4E3013B6E3A7', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"131DD9C8-9A32-4428-AD2E-4E3013B6E3A7\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>success</Message>\\n<RequestId>131DD9C8-9A32-4428-AD2E-4E3013B6E3A7</RequestId>\\n<Code>200</Code>","errorExample":""}]', + 'title' => '上报自定义事件的监控数据', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutCustomMetric' => [ + 'summary' => '调用PutCustomMetric接口上报自定义监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MetricList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监控数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '上报数值类型。N的取值范围:1~21。取值:'."\n" + ."\n" + .'- 0:原始数据。'."\n" + .'- 1:聚合数据。'."\n" + ."\n" + .'>当上报聚合数据时,建议周期为60秒和300秒的数据均上报,否则无法正常查询跨度大于7天的监控数据。', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + 'MetricName' => [ + 'description' => '监控项名称。N的取值范围:1~21。详情请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_total', + ], + 'Time' => [ + 'description' => '指标发生的时间。N的取值范围:1~21。支持以下两种类型:'."\n" + .'- UTC时间。格式:YYYY-MM-DDThh:mm:ssZ,例如:20171012T132456.888+0800。'."\n" + .'- Long型时间戳。例如:1508136760000。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1508136760000', + ], + 'GroupId' => [ + 'description' => '应用分组ID。N的取值范围:1~21。'."\n" + ."\n" + .'> 如果监控项不属于任何应用分组, 则输入0。', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + 'Values' => [ + 'description' => '指标值集合。N的取值范围:1~21。'."\n" + ."\n" + .'>如果上报数值的类型为0,则上报的是原始值,云监控会按周期将原始值聚合为多个值,例如:最大、计数、求和等。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{"value":10.5}', + ], + 'Dimensions' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。N的取值范围:1~21。'."\n" + ."\n" + .'格式:key-value键值对形式的集合,常用的key-value集合为:`{"Key":"Value"}`。'."\n" + ."\n" + .'Key和Value的长度为1~64个字符,超过64个字符时截取前64个。'."\n" + ."\n" + .'Key和Value的取值可包含英文字母、数字、点号(.)、短划线(-)、下划线(_)、正斜线(/)和反斜线(\\)。'."\n" + ."\n" + .'>Dimensions传入时需要使用JSON字符串表示该Map对象,必须按顺序传入。 ', + 'type' => 'string', + 'required' => true, + 'example' => '{"sampleName1":"value1","sampleName2":"value2"}', + ], + 'Period' => [ + 'description' => '聚合周期。N的取值范围:1~21。单位:秒,取值:60或300。'."\n" + ."\n" + .'>如果上报数值的类型为1,则需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","errorExample":""},{"type":"xml","example":"<PutCustomMetricResponse>\\n\\t<RequestId>75D115CE-5DA8-4647-9073-8F72BB85B6F7</RequestId>\\n\\t<Message>success</Message>\\n\\t<Code>200</Code>\\n</PutCustomMetricResponse>","errorExample":""}]', + 'title' => '上报自定义监控数据', + 'description' => '> 推荐您使用企业云监控中的接口[PutHybridMonitorMetricData](~~383455~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutCustomMetricRule' => [ + 'summary' => '调用PutCustomMetricRule接口创建自定义监控报警规则。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义监控数据所属应用分组ID。'."\n" + ."\n" + .'> 0表示上报的自定义监控数据不属于任何一个应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => '7378****', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'> 如果报警规则ID已存在,则表示修改报警规则;如果报警规则ID不存在,则表示创建报警规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'MyRuleId1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'CpuUsage', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'> 获取方法请参见[DescribeCustomMetricList](~~115005~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则作用的自定义监控数据。由自定义监控数据所属应用分组ID和监控项所属维度组成。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"groupId":7378****,"dimension":"instanceId=i-hp3543t5e4sudb3s****"}]', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组。多个联系人组之间用英文逗号(,)分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '报警发生回调时指定的URL地址,向URL发送POST请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则生效的时间范围。取值范围:00:00-23:59。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-23:59', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默周期。单位:秒,默认值:86400(1天)。'."\n" + ."\n" + .'> 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + 'default' => '86400', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义监控数据的聚合周期。单位:秒。取值为60或60的整数倍。默认为自定义监控数据的原始上报周期。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => [ + 'description' => '报警邮件主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS实例', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'required' => true, + 'example' => '90', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'CRITICAL', + ], + ], + [ + 'name' => 'EvaluationCount', + 'in' => 'query', + 'schema' => [ + 'description' => '报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => '报警统计方法。', + 'type' => 'string', + 'required' => true, + 'example' => 'Average', + ], + ], + [ + 'name' => 'ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => '阈值比较符号。取值:'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `!=`', + 'type' => 'string', + 'required' => true, + 'example' => '>=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。接口调用成功时,返回为空;接口调用失败时,返回失败原因。', + 'type' => 'string', + 'example' => 'ComparisonOperator is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9432', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 499 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"ComparisonOperator is mandatory for this action.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9432\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutCustomMetricRuleResponse>\\n\\t<Message></Message>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</PutCustomMetricRuleResponse>","errorExample":""}]', + 'title' => '创建自定义监控报警规则', + 'description' => '调用本接口前,请先调用PutCustomMetric接口上报自定义监控数据,详情请参见 [PutCustomMetric](~~115004~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCustomMetricList' => [ + 'summary' => '调用DescribeCustomMetricList接口查询上报的自定义监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '7378****', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义监控项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'Dimension', + 'in' => 'query', + 'schema' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{sampleName1=value1&sampleName2=value2}', + ], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => [ + 'description' => '消息摘要算法,可以产生一个128位(16字节)的散列值,用来校验上报的自定义监控数据的唯一性。', + 'type' => 'string', + 'required' => false, + 'example' => '97c25982d9745a231276bff27469****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AF425E4-1DEA-54F2-910A-8117C9686140', + ], + 'Result' => [ + 'description' => '自定义监控数据查询结果。', + 'type' => 'string', + 'example' => '{\\"all\\":0,\\"size\\":10,\\"param\\":{\\"metric\\":\\"{\\\\\\"metricName\\\\\\":\\\\\\"cpu_total\\\\\\",\\\\\\"groupId\\\\\\":7378****,\\\\\\"project\\\\\\":\\\\\\"acs_customMetric_120886317861****\\\\\\",\\\\\\"dimension\\\\\\":\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\",\\\\\\"status\\\\\\":1}\\",\\"service\\":\\"metric-center.aliyun-inc.com\\"},\\"page\\":1,\\"list\\":[]}', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1AF425E4-1DEA-54F2-910A-8117C9686140\\",\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"all\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"size\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"param\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"metric\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"metricName\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"cpu_total\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":7378****,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"acs_customMetric_120886317861****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"dimension\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"sampleName1=value1&sampleName2=value2\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"service\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metric-center.aliyun-inc.com\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"page\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"list\\\\\\\\\\\\\\":[]}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCustomMetricListResponse>\\r\\n\\t<Message>success</Message>\\r\\n\\t<RequestId>1AF425E4-1DEA-54F2-910A-8117C9686140</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Result>{\\\\\\"all\\\\\\":0,\\\\\\"size\\\\\\":10,\\\\\\"param\\\\\\":{\\\\\\"metric\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"metricName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cpu_total\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"groupId\\\\\\\\\\\\\\":7378****,\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"acs_customMetric_120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dimension\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sampleName1=value1&=value2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"service\\\\\\":\\\\\\"metric-center.aliyun-inc.com\\\\\\"},\\\\\\"page\\\\\\":1,\\\\\\"list\\\\\\":[]}</Result>\\r\\n</DescribeCustomMetricListResponse>\\t","errorExample":""}]', + 'title' => '查询上报的自定义监控数据', + 'description' => '> 建议您通过DescribeMetricList接口查询监控数据。更多信息,请参见[DescribeMetricList](~~51936~~)。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCustomMetric' => [ + 'summary' => '调用DeleteCustomMetric接口删除自定义监控上报数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3607****', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'AdvanceCredit', + ], + ], + [ + 'name' => 'Md5', + 'in' => 'query', + 'schema' => [ + 'description' => '消息摘要算法,可以产生一个128位(16字节)的散列值,用来校验上报的自定义监控数据的唯一性。'."\n" + ."\n" + .'> 当查询自定义监控项时,会返回`Md5`。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '38796C8CFFEB8F89BB2A626C7BD7****', + ], + ], + [ + 'name' => 'UUID', + 'in' => 'query', + 'schema' => [ + 'description' => '发起请求申请时的UUID。'."\n" + ."\n" + .'> 查询自定义监控项时,会返回`UUID`,建议您使用`Md5`。', + 'type' => 'string', + 'required' => false, + 'example' => '5497633c-66c5-4eae-abaa-89db5adb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomMetric>\\n\\t\\t<Message>success</Message>\\n\\t\\t<RequestId>05B36C2C-5F6E-48D5-8B41-CE36DD7EE8E0</RequestId>\\n\\t\\t<Code>200</Code>\\n</DeleteCustomMetric>","errorExample":""}]', + 'title' => '删除自定义监控上报数据', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutLogMonitor' => [ + 'summary' => '调用PutLogMonitor接口创建或修改日志监控。', + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'LogId', + 'in' => 'query', + 'schema' => [ + 'description' => '日志监控ID。', + 'type' => 'string', + 'required' => false, + 'example' => '16****', + ], + ], + [ + 'name' => 'SlsRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务中日志项目(Project)所在地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SlsProject', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务中日志项目的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-project', + ], + ], + [ + 'name' => 'SlsLogstore', + 'in' => 'query', + 'schema' => [ + 'description' => '日志服务中日志库的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-logstore', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。关于云监控支持云服务的监控项,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'MetricExpress', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展字段。 扩展字段为统计方法中的结果提供四则运算的功能。'."\n" + ."\n" + .'例如:在统计方法中配置了HTTP状态码请求总数TotalNumber和HTTP状态码大于499的请求数5xxNumber,则可以通过扩展字段计算出服务端的错误率:5xxNumber/TotalNumber*100。'."\n" + ."\n" + .'JSON格式:{"extend":{"errorPercent":"5xxNumber/TotalNumber*100"}}。字段说明如下:'."\n" + ."\n" + .'- extend:必填字段。'."\n" + ."\n" + .'- errorPercent:计算结果生成新字段的别名,您可以根据真实情况自行命名。 '."\n" + ."\n" + .'- errorPercent:现有字段的计算表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7301****', + ], + ], + [ + 'name' => 'ValueFilterRelation', + 'in' => 'query', + 'schema' => [ + 'description' => '日志筛选的过滤条件。取值:'."\n" + ."\n" + .'- and:和。'."\n" + ."\n" + .'- or:或。'."\n" + ."\n" + .'> 本参数需要与`ValueFilter.N.Key`配合使用。', + 'type' => 'string', + 'required' => true, + 'example' => 'and', + ], + ], + [ + 'name' => 'Tumblingwindows', + 'in' => 'query', + 'schema' => [ + 'description' => '预计算窗口时间。单位:秒。云监控将在定义的预计算时间对数据做一次聚合计算。', + 'type' => 'string', + 'required' => false, + 'example' => '60,300', + ], + ], + [ + 'name' => 'Unit', + 'in' => 'query', + 'schema' => [ + 'description' => '单位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Percent', + ], + ], + [ + 'name' => 'Aggregates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '聚合计算定义。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => '聚合计算原始的字段名称。N的取值范围:1~10。', + 'type' => 'string', + 'required' => true, + 'example' => 'sourceCount', + ], + 'Function' => [ + 'description' => '在计算周期内根据选定的统计方法对日志数据进行聚合处理。N的取值范围:1~10。取值:'."\n" + .'- count:计数。'."\n" + .'- sum:求和。'."\n" + .'- avg:平均值。'."\n" + .'- max:最大值。'."\n" + .'- min:最小值。'."\n" + .'- countps:计算统计周期内指定字段求count后的每秒平均值。'."\n" + .'- sumps:计算统计周期内指定字段求sum后的每秒平均值。'."\n" + .'- distinct:去重后计算统计周期内指定字段出现的次数。', + 'type' => 'string', + 'required' => true, + 'example' => 'count', + ], + 'Alias' => [ + 'description' => '聚合计算别名。N的取值范围:1~10。', + 'type' => 'string', + 'required' => true, + 'example' => 'Count', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'Groupbys', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '对数据进行空间维度聚合。相当于SQL中的Group By,根据指定的维度,对监控数据进行分组。如果Group By不选择任何维度,则根据聚合方法对全部监控数据进行聚合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FieldName' => [ + 'description' => 'GroupBy字段名称。N的取值范围:1~10。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu', + ], + 'Alias' => [ + 'description' => 'GroupBy别名。N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'CPUUtilization', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ValueFilter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '筛选的过滤规则,配合ValueFilterRelation使用。相当于SQL中的Where条件。如果不填写,则表示对全部数据进行处理。例如:日志中有Level和Error字段,如果需要统计每分钟Error出现的次数,则统计方法可以定义为对Level求和,并且Level=Error。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '日志匹配的字段名名称。N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'lh_source', + ], + 'Value' => [ + 'description' => '日志匹配的字段值。N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Operator' => [ + 'description' => '字段值的匹配方式。N的取值范围:1~10。取值:'."\n" + .'- `contain`:包含。'."\n" + .'- `notContain`:不包含。'."\n" + .'- `>`:大于。'."\n" + .'- `<`:小于。'."\n" + .'- `>=`:大于等于。'."\n" + .'- `<=`:小于等于。', + 'type' => 'string', + 'required' => false, + 'example' => 'contain', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。结果如下:'."\n" + ."\n" + .'- 当操作成功时,返回`successful`。'."\n" + ."\n" + .'- 当操作失败时,返回错误信息,例如:`alias of aggreate must be set value.`。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '91561287-0802-5F9C-9BDE-404C50D41B06', + ], + 'LogId' => [ + 'description' => '日志监控ID。', + 'type' => 'string', + 'example' => '16****', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'LimitorError', + 'errorMessage' => 'Log monitor limit is not enough', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"91561287-0802-5F9C-9BDE-404C50D41B06\\",\\n \\"LogId\\": \\"16****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutLogMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>91561287-0802-5F9C-9BDE-404C50D41B06</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<LogId>16****</LogId>\\r\\n\\t<Success>true</Success>\\r\\n</PutLogMonitorResponse>","errorExample":""}]', + 'title' => '创建或修改日志监控', + 'description' => '本文将提供一个示例,创建一个日志监控`cpu_total`。返回结果显示,创建日志监控成功,日志监控ID为`16****`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLogMonitor' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'LogId', + 'in' => 'query', + 'schema' => [ + 'description' => '日志监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'metric not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"metric not exist.\\",\\n \\"RequestId\\": \\"42BFFC2B-5E4D-4FDE-BCC6-E91EE33C5967\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteLogMonitorResponse>\\n\\t\\t<RequestId>EBB5215C-44AB-4000-A2D7-48634FDC4F04</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</DeleteLogMonitorResponse>","errorExample":""}]', + 'title' => '删除日志监控', + 'summary' => '调用DeleteLogMonitor接口删除日志监控。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogMonitorList' => [ + 'summary' => '调用DescribeLogMonitorList接口获取日志监控列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。默认:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SearchValue', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项搜索。支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '01E90080-4300-4FAA-B9AE-161956BC350D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'LogMonitorList' => [ + 'description' => '日志监控列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ValueFilterRelation' => [ + 'description' => '日志筛选的过滤条件。需要和ValueFilter配合使用。取值:'."\n" + .'- and:表示和的关系。'."\n" + .'- or :表示或的关系。', + 'type' => 'string', + 'example' => 'and', + ], + 'SlsLogstore' => [ + 'description' => '日志服务名称。', + 'type' => 'string', + 'example' => 'testSlS****', + ], + 'MetricName' => [ + 'description' => '监控项名称。详情请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'LogId' => [ + 'description' => '日志监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'SlsRegionId' => [ + 'description' => '日志服务所在的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '创建时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1577766395000', + ], + 'SlsProject' => [ + 'description' => '日志Project。', + 'type' => 'string', + 'example' => 'sls-project-test****', + ], + 'ValueFilter' => [ + 'description' => '筛选的过滤规则,配合ValueFilterRelation使用。相当于SQL中的Where条件。'."\n" + .'如果不填写,则表示对全部数据进行处理。例如:日志中有Level和Error字段,如果需要统计每分钟Error出现的次数,则统计方法可以定义为对Level求和,并且Level=Error。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '日志匹配的字段名称。', + 'type' => 'string', + 'example' => 'hostName', + ], + 'Value' => [ + 'description' => '日志匹配的字段值。', + 'type' => 'string', + 'example' => 'portal', + ], + 'Operator' => [ + 'description' => '字段值的匹配方式。取值:'."\n" + .'- contain:包含。'."\n" + .'- notContain:不包含。'."\n" + .'- `>`:大于。'."\n" + .'- `<`:小于。'."\n" + .'- `>=`:大于等于。'."\n" + .'- `<=`:小于等于。', + 'type' => 'string', + 'example' => 'contain', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"01E90080-4300-4FAA-B9AE-161956BC350D\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 15,\\n \\"LogMonitorList\\": [\\n {\\n \\"ValueFilterRelation\\": \\"and\\",\\n \\"SlsLogstore\\": \\"testSlS****\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"GroupId\\": 12345,\\n \\"LogId\\": 12345,\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 1577766395000,\\n \\"SlsProject\\": \\"sls-project-test****\\",\\n \\"ValueFilter\\": [\\n {\\n \\"Key\\": \\"hostName\\",\\n \\"Value\\": \\"portal\\",\\n \\"Operator\\": \\"contain\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeLogMonitorListResponse>\\r\\n\\t\\t<Message>successful</Message>\\r\\n\\t\\t<RequestId>C085617E-7A64-402E-877D-410E86174B0C</RequestId>\\r\\n\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t<Total>2</Total>\\r\\n\\t\\t<LogMonitorList>\\r\\n\\t\\t\\t<SlsProject>sls-project-test****</SlsProject>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<GmtCreate>1591175112000</GmtCreate>\\r\\n\\t\\t\\t<ValueFilterRelation>and</ValueFilterRelation>\\r\\n\\t\\t\\t<LogId>12345</LogId>\\r\\n\\t\\t\\t<SlsRegionId>cn-hangzhou</SlsRegionId>\\r\\n\\t\\t\\t<SlsLogstore>testSlS****</SlsLogstore>\\r\\n\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t</LogMonitorList>\\r\\n\\t\\t<LogMonitorList>\\r\\n\\t\\t\\t<SlsProject>sls-project-test****</SlsProject>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<GmtCreate>1586826787000</GmtCreate>\\r\\n\\t\\t\\t<ValueFilterRelation>and</ValueFilterRelation>\\r\\n\\t\\t\\t<ValueFilter>\\r\\n\\t\\t\\t\\t<Operator>=</Operator>\\r\\n\\t\\t\\t\\t<Value>1</Value>\\r\\n\\t\\t\\t\\t<Key>lh_source</Key>\\r\\n\\t\\t\\t</ValueFilter>\\r\\n\\t\\t\\t<LogId>12345</LogId>\\r\\n\\t\\t\\t<SlsRegionId>cn-hangzhou</SlsRegionId>\\r\\n\\t\\t\\t<SlsLogstore>internal-alert-history</SlsLogstore>\\r\\n\\t\\t\\t<GroupId>12345</GroupId>\\r\\n\\t\\t</LogMonitorList>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeLogMonitorListResponse>\\r\\n","errorExample":""}]', + 'title' => '获取日志监控列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeLogMonitorAttribute' => [ + 'summary' => '调用DescribeLogMonitorAttribute接口获取日志监控详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '指标名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_total_******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C6718537-E673-4A58-8EE1-24B8B38C7AAE', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LogMonitor' => [ + 'description' => '日志监控详情。', + 'type' => 'object', + 'properties' => [ + 'ValueFilterRelation' => [ + 'description' => '日志筛选的过滤条件。需要和ValueFilter配合使用。取值:'."\n" + .'- and:和。'."\n" + .'- or:或。', + 'type' => 'string', + 'example' => 'and', + ], + 'SlsLogstore' => [ + 'description' => '日志服务 Logstore名称。', + 'type' => 'string', + 'example' => 'logstore_******', + ], + 'MetricName' => [ + 'description' => '监控项的名称。', + 'type' => 'string', + 'example' => 'cpu_total_******', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123******', + ], + 'LogId' => [ + 'description' => '日志监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123******', + ], + 'MetricExpress' => [ + 'description' => '指标表达式。', + 'type' => 'string', + 'example' => '{}', + ], + 'SlsRegionId' => [ + 'description' => '日志服务所在的地域id。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GmtCreate' => [ + 'description' => '创建时间。'."\n" + ."\n" + .'格式为Unix时间戳,即从1970年1月1日开始所经过的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1678440033000', + ], + 'SlsProject' => [ + 'description' => '日志服务 Project名称。', + 'type' => 'string', + 'example' => 'project_******', + ], + 'Aggregates' => [ + 'description' => '聚合计算定义。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合计算定义。', + 'type' => 'object', + 'properties' => [ + 'Max' => [ + 'description' => '最大值。', + 'type' => 'string', + 'example' => '0', + ], + 'Min' => [ + 'description' => '最小值。', + 'type' => 'string', + 'example' => '0', + ], + 'Function' => [ + 'description' => '统计方法,即在统计周期内计算日志数据的函数方法。取值:'."\n" + .'- count:计数值。'."\n" + .'- sum:求和。'."\n" + .'- avg:平均值。'."\n" + .'- max:最大值。'."\n" + .'- min:最小值。'."\n" + .'- countps:计算统计周期内指定字段求count后的每秒平均值。'."\n" + .'- sumps:计算统计周期内指定字段求sum后的每秒平均值。'."\n" + .'- distinct:去重后计算统计周期内指定字段出现的次数。', + 'type' => 'string', + 'example' => 'count', + ], + 'Alias' => [ + 'description' => '字段别名。', + 'type' => 'string', + 'example' => 'alias_******', + ], + 'FieldName' => [ + 'description' => '日志中原始的字段名。', + 'type' => 'string', + 'example' => 'field_******', + ], + ], + ], + ], + 'ValueFilter' => [ + 'description' => '筛选的过滤规则,配合ValueFilterRelation使用。相当于SQL中的Where条件。'."\n" + ."\n" + .'如果不填写,则表示对全部数据进行处理。例如:日志中有Level和Error字段,如果需要统计每分钟Error出现的次数,则统计方法可以定义为对Level求和,并且Level=Error。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '筛选的过滤规则。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'key', + 'type' => 'string', + 'example' => 'key_******', + ], + 'Value' => [ + 'description' => 'value', + 'type' => 'string', + 'example' => 'value_******', + ], + 'Operator' => [ + 'description' => '字段值的匹配方式。取值:'."\n" + .'- `contain`:包含。'."\n" + .'- `notContain`:不包含。'."\n" + .'- `>`:大于。'."\n" + .'- `<`:小于。'."\n" + .'- `>=`:大于等于。'."\n" + .'- `<=`:小于等于。', + 'type' => 'string', + 'example' => 'contain', + ], + ], + ], + ], + 'Tumblingwindows' => [ + 'description' => '预计算窗口时间。单位:秒。云监控将在定义的预计算时间对数据做一次聚合计算。', + 'type' => 'array', + 'items' => [ + 'description' => '预计算窗口时间。单位:秒。云监控将在定义的预计算时间对数据做一次聚合计算。', + 'type' => 'string', + 'example' => '60', + ], + ], + 'Groupbys' => [ + 'description' => '对数据进行空间维度聚合。相当于SQL中的Group By,根据指定的维度,对监控数据进行分组。如果Group By不选择任何维度,则根据聚合方法对全部监控数据进行聚合。', + 'type' => 'array', + 'items' => [ + 'description' => 'group by定义', + 'type' => 'string', + 'example' => 'userId', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"C6718537-E673-4A58-8EE1-24B8B38C7AAE\\",\\n \\"Success\\": true,\\n \\"LogMonitor\\": {\\n \\"ValueFilterRelation\\": \\"and\\",\\n \\"SlsLogstore\\": \\"logstore_******\\",\\n \\"MetricName\\": \\"cpu_total_******\\",\\n \\"GroupId\\": 0,\\n \\"LogId\\": 0,\\n \\"MetricExpress\\": \\"{}\\",\\n \\"SlsRegionId\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": 1678440033000,\\n \\"SlsProject\\": \\"project_******\\",\\n \\"Aggregates\\": [\\n {\\n \\"Max\\": \\"0\\",\\n \\"Min\\": \\"0\\",\\n \\"Function\\": \\"count\\",\\n \\"Alias\\": \\"alias_******\\",\\n \\"FieldName\\": \\"field_******\\"\\n }\\n ],\\n \\"ValueFilter\\": [\\n {\\n \\"Key\\": \\"key_******\\",\\n \\"Value\\": \\"value_******\\",\\n \\"Operator\\": \\"contain\\"\\n }\\n ],\\n \\"Tumblingwindows\\": [\\n \\"60\\"\\n ],\\n \\"Groupbys\\": [\\n \\"userId\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取日志监控详情', + ], + 'CreateMonitorGroupByResourceGroupId' => [ + 'summary' => '调用CreateMonitorGroupByResourceGroupId接口通过资源组创建应用分组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EnableSubscribeEvent', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组是否开启自动订阅事件通知。当应用分组内资源发生严重和警告级别的事件时,云监控发送报警通知。取值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false(默认值):关闭。'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableInstallAgent', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组是否开启自动安装云监控插件。云监控自动为应用分组内的主机安装云监控插件。取值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false(默认值):关闭。'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组对应的地域ID。'."\n" + ."\n" + .'关于如何获取资源组对应的地域ID,请参见[GetResourceGroup](~~158866~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'关于如何获取资源组ID,请参见[ListResourceGroups](~~158855~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'rg-acfmw3ty5y7****', + ], + ], + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。'."\n" + ."\n" + .'关于如何获取资源组名称,请参见[ListResourceGroups](~~158855~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CloudMonitor', + ], + ], + [ + 'name' => 'ContactGroupList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警联系组。应用分组的报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~114923~~)和[PutContactGroup](~~114929~~)。关于如何获取报警联系组,请参见[DescribeContactGroupList](~~114922~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系组。应用分组的报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~114923~~)和[PutContactGroup](~~114929~~)。关于如何获取报警联系组,请参见[DescribeContactGroupList](~~114922~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Group', + ], + 'required' => true, + 'example' => 'ECS_Group', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '784CAB3C-F613-5BCE-8469-6DCB29B18A20', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3607****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 4092 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'ResourceGroupId already create group', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"784CAB3C-F613-5BCE-8469-6DCB29B18A20\\",\\n \\"Success\\": true,\\n \\"Id\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateMonitorGroupByResourceGroupIdResponse>\\n <RequestId>784CAB3C-F613-5BCE-8469-6DCB29B18A20</RequestId>\\n <Id>3607****</Id>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateMonitorGroupByResourceGroupIdResponse>","errorExample":""}]', + 'title' => '通过资源组创建应用分组', + 'description' => '本文将提供一个示例,为地域`cn-hangzhou`的资源组`CloudMonitor`创建一个应用分组,应用分组的报警联系人组为`ECS_Group`。'."\n" + ."\n", + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSiteMonitor' => [ + 'summary' => '创建站点监控任务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务的URL或IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务的监控类型。'."\n" + ."\n" + .'目前站点监控任务的类型包括:HTTP(S)、PING、TCP、UDP、DNS、SMTP、POP3、FTP、WEBSOCKET。', + 'type' => 'string', + 'required' => true, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务的名称。'."\n" + ."\n" + .'长度4~100个字符,取值可包含英文字母、数字、下划线(_)和汉字。', + 'type' => 'string', + 'required' => true, + 'example' => 'HanZhou_ECS1', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '监控频率。'."\n" + ."\n" + .'取值:1分钟、5分钟、15分钟、30分钟和60分钟。'."\n" + ."\n" + .'默认值:1分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => [ + 'description' => '探针信息。如果该参数取值为空,则系统随机选择3个探测点。'."\n" + ."\n" + .'格式为JSONArray,例如:`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`,分别对应北京、杭州、青岛。'."\n" + ."\n" + .'关于如何获取探测点信息,请参见[DescribeSiteMonitorISPCityList](~~115045~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', + ], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务对应协议类型的高级扩展选项。不同监控任务的协议类型对应不同的扩展选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{"time_out":5000}', + ], + ], + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'关于如何获取云监控中已存在的报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', + ], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测任务使用的拨测点组。不同的选项对应不同的探测点类型。PC对应PC端,MOBIEL对应移动端,FC对应VPC内网探测。不设置的话默认为PC。', + 'type' => 'string', + 'required' => false, + 'example' => 'PC', + ], + ], + [ + 'name' => 'CustomSchedule', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '自定义探测周期。只能选择周一至周日的某个时间段进行探测。', + 'type' => 'string', + 'required' => false, + 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', + ], + ], + [ + 'name' => 'VpcConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '创建vpc内网拨测任务时需要提供的网络信息。需要提供一个JSON,里边必须包含vpcId,vswitchId,securityGroupId和region四个字段。', + 'type' => 'string', + 'required' => false, + 'example' => '{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '监控任务的结果详情。', + 'type' => 'object', + 'properties' => [ + 'AttachAlertResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '关联已有报警规则的结果。', + 'type' => 'array', + 'items' => [ + 'description' => '关联已有报警规则的结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '关联报警规则的状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '关联报警规则的返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '关联报警规则的请求ID。', + 'type' => 'string', + 'example' => '5dd33455-4f65-4b0c-9200-33d66f3f340b', + ], + 'Success' => [ + 'description' => '关联报警规则是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RuleId' => [ + 'description' => '关联报警规则的ID。', + 'type' => 'string', + 'example' => 'SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent', + ], + ], + ], + ], + ], + ], + ], + ], + 'CreateResultList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CreateResultList' => [ + 'description' => '返回结果。'."\n" + ."\n" + .'当创建监控任务成功时,有返回结果;当创建监控任务失败时,无返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。'."\n" + ."\n" + .'当创建监控任务成功时,有返回结果;当创建监控任务失败时,无返回结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '监控任务ID。', + 'type' => 'string', + 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', + ], + 'TaskName' => [ + 'description' => '监控任务名称。', + 'type' => 'string', + 'example' => 'HanZhou_ECS1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IllegalAddress', + 'errorMessage' => 'Illegal HTTP address', + ], + [ + 'errorCode' => 'OperationError', + 'errorMessage' => 'Operation failed', + ], + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task does not exist', + ], + [ + 'errorCode' => 'OperatorInvalid', + 'errorMessage' => 'Operator invalid', + ], + [ + 'errorCode' => 'NameRepeat', + 'errorMessage' => 'Task name repeat', + ], + [ + 'errorCode' => 'CreateAlarmError', + 'errorMessage' => 'Create alarm error', + ], + [ + 'errorCode' => 'NameNotExists', + 'errorMessage' => 'Task name not exists', + ], + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Invalid Isp.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'RestrictedUser', + 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"AttachAlertResult\\": {\\n \\"Contact\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"5dd33455-4f65-4b0c-9200-33d66f3f340b\\",\\n \\"Success\\": \\"true\\",\\n \\"RuleId\\": \\"SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent\\"\\n }\\n ]\\n }\\n },\\n \\"CreateResultList\\": {\\n \\"CreateResultList\\": [\\n {\\n \\"TaskId\\": \\"2c8dbdf9-a3ab-46a1-85a4-f094965e****\\",\\n \\"TaskName\\": \\"HanZhou_ECS1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateSiteMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<AttachAlertResult>\\r\\n\\t\\t\\t<Contact>\\r\\n\\t\\t\\t\\t<Message>successful</Message>\\r\\n\\t\\t\\t\\t<RequestId>5dd33455-4f65-4b0c-9200-33d66f3f340b</RequestId>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent</RuleId>\\r\\n\\t\\t\\t\\t<Code>200</Code>\\r\\n\\t\\t\\t\\t<Success>true</Success>\\r\\n\\t\\t\\t</Contact>\\r\\n\\t\\t</AttachAlertResult>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<CreateResultList>\\r\\n\\t\\t<CreateResultList>\\r\\n\\t\\t\\t<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>\\r\\n\\t\\t\\t<TaskName>HanZhou_ECS1</TaskName>\\r\\n\\t\\t</CreateResultList>\\r\\n\\t</CreateResultList>\\r\\n\\t<Success>true</Success>\\r\\n</CreateSiteMonitorResponse>","errorExample":""}]', + 'title' => '创建站点监控任务', + 'description' => '本文将提供一个示例,创建一个站点监控任务`HanZhou_ECS1`,该监控任务的监控地址为`https://www.aliyun.com`、监控类型为`HTTPS`。', + 'requestParamsDescription' => 'TaskType中HTTP(S)、PING、TCP、UDP、DNS、WEBSOCKET、SMTP、POP3和FTP的高级参数的设置方法如下表所示。'."\n" + ."\n" + .'- HTTP(S)'."\n" + ."\n" + .'|参数 |类型 |描述|'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |HTTP或HTTPS请求方式。支持三种请求方式:GET、POST、HEAD。默认值:GET。 |'."\n" + .'|header |String |换行符(\\n)分隔的自定义HTTP header。<br>每行Header格式需符合HTTP协议(使用半角冒号分隔的键值)。 |'."\n" + .'|cookie |String |Cookie和HTTP请求标准的写法一致。 |'."\n" + .'|request_content |String |请求内容。支持两种格式:JSON和表单。不提供时,请求中不含正文。 |'."\n" + .'|response_content |String |期望的回应内容。探测时会在HTTP服务器返回的前64个字节进行检查。 |'."\n" + .'|match_rule |String |0:回应中不含response_content时,探测成功。<br>1:回应中含response_content时,探测成功。 |'."\n" + .'|username |String |如果提供用户名,则会在HTTP请求中携带BasicAuth header。 |'."\n" + .'|password |String |HTTP或HTTPS请求验证密码。 |'."\n" + .'|time_out |int |超时时间。单位:毫秒。默认值:5 。 |'."\n" + .'|max_redirect |int |最大跳转次数。ECS探针默认5次,运营商探针默认2次。<br>如果需要禁止跳转,则将该参数设置为:0。<br>取值范围:0~50 。 |'."\n" + ."\n" + .' '."\n" + .'- PING'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |文本 |当PING失败率超过该参数时,探测失败,返回610(PingAllFail)或615(PingPartialFail)。<br>默认值:0.1。 |'."\n" + .'|ping_num |int |PING次数,默认值:10。<br>取值范围:1~100。 |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |DNS服务器地址,可以为域名或IP地址。 |'."\n" + .'|dns_type |string |DNS查询类型。取值:A、NS、CNAME、MX、TXT、ANY、AAAA。 |'."\n" + .'|expect_value |string |英文空白符分隔的期望值列表。 |'."\n" + .'|match_rule |string |期望值列表与DNS列表的关系,当不满足指定关系时,探测失败。 <br>空字符串或IN_DNS:期望值列表是DNS列表的子集。 <br>DNS_IN:DNS列表是期望值列表的子集。 <br>EQUAL:DNS列表与期望值列表相等。 <br>ANY:DNS列表与期望值列表有交集(交集不为空)。 |'."\n" + ."\n" + .'- FTP'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |FTP服务器端口号。如果不提供,则使用默认值。FTP默认值:21,FTPS默认值:990。 |'."\n" + .'|username |string |FTP用户名。 如果未提供,则匿名登录。 |'."\n" + .'|password |string |FTP密码。 |'."\n" + ."\n" + .'- POP3或SMTP'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |POP3或SMTP服务器的端口号。POP3默认值:110,POP3S默认值:995,SMTP默认值:25。 |'."\n" + .'|username |string |POP3或SMTP的用户名。POP3或SMTP的用户名和密码必填。 |'."\n" + .'|password |string |POP3或SMTP的密码。POP3或SMTP的用户名和密码必填。 |'."\n" + ."\n" + .'- TCP或UDP'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |TCP或UDP服务器的端口。 |'."\n" + .'|request_content |string |请求内容。当request_format为hex时,request_content内容为十六进制紧凑格式。 |'."\n" + .'|request_format |string |当request_format为其他值时,request_content作为普通字符串发送给TCP或UDP服务器。 |'."\n" + .'|response_content |string |回应内容。当TCP或UDP服务器返回的内容中不含response_content时,探测失败。<br>当response_format为hex时,response_content中的内容为十六进制紧凑格式。<br>当response_content为其他值时,response_content为普通字符串。 |'."\n" + ."\n" + .'- WEBSOCKET'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|request_content |string |消息内容。 |'."\n" + .'|empty_message |boolean |允许服务端不返回消息或返回空字符串。 |', + ], + 'CreateInstantSiteMonitor' => [ + 'summary' => '调用CreateSiteMonitor接口创建一次性探测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '探测任务的URL或IP地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '探测任务的类型。'."\n" + .'目前探测任务的类型包括:HTTP、PING、TCP、UDP和DNS。', + 'type' => 'string', + 'required' => true, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '探测任务的名称。'."\n" + ."\n" + .'<props="china">长度4~100个字符,取值可包含英文字母、数字、下划线(_)和汉字。</props>'."\n" + ."\n\n" + .'<props="intl">长度4~100个字符,取值可包含英文字母、数字和下划线(_)。</props>'."\n" + ."\n" + .'<props="partner">长度4~100个字符,取值可包含英文字母、数字和下划线(_)。</props>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'task1', + ], + ], + [ + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => [ + 'description' => '探测点信息。如果该参数取值为空,则系统随机选择3个探测点。'."\n" + ."\n" + .'格式为`JSONArray`,例如:[{"city":"546","isp":"465", "type":"IDC"},{"city":"572","isp":"465", "type":"LASTMILE"},{"city":"738","isp":"465"}],分别对应北京、杭州、青岛。'."\n" + ."\n" + .'type指示拨测点类型。当AgentGroup为PC时,可选值为IDC和LASTMILE。IDC指的是部署在数据中心的拨测点,LASTMILE指的是部署在网民家里,使用固网的拨测点。type为非必填选项,默认值为IDC。当AgentGroup为MOBILE时,无需填写。'."\n" + ."\n" + .'关于如何获取探测点信息,请参见[DescribeSiteMonitorISPCityList](~~115045~~)。'."\n" + ."\n" + .'> `IspCities`和`RandomIspCity`必须二选一。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', + ], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => [ + 'description' => '探测任务对应协议类型的高级扩展选项。不同探测任务的协议类型对应不同的扩展选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{"time_out":5000}', + ], + ], + [ + 'name' => 'RandomIspCity', + 'in' => 'query', + 'schema' => [ + 'description' => '探测点的数量。'."\n" + ."\n" + .'> - `IspCities`和`RandomIspCity`必须二选一。- 如果您设置了参数`RandomIspCity`,参数`IspCities`自动失效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '探测点类型,可选值为PC和MOBILE。PC为固网探测点,MOBILE为移动端探测点。默认值为PC。', + 'type' => 'string', + 'required' => false, + 'example' => 'PC', + 'enum' => [ + 'PC', + 'MOBILE', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + .'* true:成功。'."\n" + .'* false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'CreateResultList' => [ + 'description' => '创建一次性探测任务的结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '创建一次性探测任务的结果列表。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '探测任务ID。', + 'type' => 'string', + 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', + ], + 'TaskName' => [ + 'description' => '探测任务名称。', + 'type' => 'string', + 'example' => 'task1', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IllegalAddress', + 'errorMessage' => 'Illegal HTTP address', + ], + [ + 'errorCode' => 'OperationError', + 'errorMessage' => 'Operation failed', + ], + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task does not exist', + ], + [ + 'errorCode' => 'OperatorInvalid', + 'errorMessage' => 'Operator invalid', + ], + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Operator City invalid', + ], + [ + 'errorCode' => 'NameRepeat', + 'errorMessage' => 'Task name repeat', + ], + [ + 'errorCode' => 'CreateAlarmError', + 'errorMessage' => 'Create alarm error', + ], + [ + 'errorCode' => 'NameNotExists', + 'errorMessage' => 'Task name not exists', + ], + [ + 'errorCode' => 'Illegal Task Name', + 'errorMessage' => 'The task name of the sitemonitor task is illegal.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"CreateResultList\\": [\\n {\\n \\"TaskId\\": \\"2c8dbdf9-a3ab-46a1-85a4-f094965e****\\",\\n \\"TaskName\\": \\"task1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateInstantSiteMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<CreateResultList>\\r\\n\\t\\t<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>\\r\\n\\t\\t<TaskName>task1</TaskName>\\r\\n\\t</CreateResultList>\\r\\n\\t<Success>true</Success>\\r\\n</CreateInstantSiteMonitorResponse>\\t","errorExample":""}]', + 'title' => '创建一次性探测任务', + 'description' => '仅开通网络分析与监控的阿里云账号,才能创建一次性探测任务。'."\n" + ."\n" + .'本文将提供一个示例,创建一次性探测任务,该探测任务的名称为`task1`,探测地址为`http://www.aliyun.com`,探测类型为`HTTP`,探测点数量为`1`。', + 'requestParamsDescription' => '## TaskType的高级参数说明'."\n" + ."\n" + .'`TaskType`中HTTP、PING、TCP、UDP和DNS的高级参数的设置方法如下表所示。'."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'|参数 |类型 |描述|'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |HTTP请求方式。支持三种请求方式:GET、POST、HEAD。默认值:GET。 |'."\n" + .'|header |String |换行符(\\n)分隔的自定义HTTP header。<br>每行Header格式需符合HTTP协议(使用半角冒号分隔的键值)。 |'."\n" + .'|cookie |String |Cookie和HTTP请求标准的写法一致。 |'."\n" + .'|request_content |String |请求内容。支持两种格式:JSON和表单。不提供时,请求中不含正文。 |'."\n" + .'|response_content |String |期望的回应内容。探测时会检查HTTP服务器返回的前64个字节。 |'."\n" + .'|match_rule |String |0:回应中不含response_content时,探测成功。<br>1:回应中含response_content时,探测成功。 |'."\n" + .'|username |String |如果提供用户名,则会在HTTP请求中携带BasicAuth header。 |'."\n" + .'|password |String |HTTP请求验证密码。 |'."\n" + .'|time_out |int |超时时间。单位:毫秒。默认值:30000。 |'."\n" + .'|max_redirect |int |最大跳转次数。ECS探针默认5次,运营商探针默认2次。<br>如果需要禁止跳转,则将该参数设置为0。<br>取值范围:0~50 。 |'."\n" + ."\n" + .' '."\n" + .'- PING'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |int |当PING失败率超过该参数时,探测失败,返回610(PingAllFail)或615(PingPartialFail)。<br>默认值:0.1。 |'."\n" + .'|ping_num |int |PING次数,默认值:20。<br>取值范围:1~100。 |'."\n" + ."\n" + .'- TCP或UDP'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |TCP或UDP服务器的端口。 |'."\n" + .'|request_content |string |请求内容。当request_format为hex时,request_content内容为十六进制紧凑格式。 |'."\n" + .'|request_format |string |当request_format为其他值时,request_content作为普通字符串发送给TCP或UDP服务器。 |'."\n" + .'|response_content |string |回应内容。当TCP或UDP服务器返回的内容中不含response_content时,探测失败。<br>当response_format为hex时,response_content中的内容为十六进制紧凑格式。<br>当response_content为其他值时,response_content为普通字符串。 |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'|参数 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |DNS服务器地址,可以为域名或IP地址。 |'."\n" + .'|dns_type |string |DNS查询类型。取值:A、NS、CNAME、MX、TXT、ANY。 |'."\n" + .'|expect_value |string |英文空白符分隔的期望值列表。 |'."\n" + .'|match_rule |string |期望值列表与DNS列表的关系,当不满足指定关系时,探测失败。 <br>空字符串或IN_DNS:期望值列表是DNS列表的子集。 <br>DNS_IN:DNS列表是期望值列表的子集。 <br>EQUAL:DNS列表与期望值列表相等。 <br>ANY:DNS列表与期望值列表有交集(交集不为空)。 |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchCreateInstantSiteMonitor' => [ + 'summary' => '调用BatchCreateInstantSiteMonitor接口批量创建站点监控任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '站点监控任务列表。'."\n" + ."\n" + .'> 至少需要创建一条站点监控任务,且`Address`、`TaskName`和`TaskType`必须设置。', + 'type' => 'array', + 'items' => [ + 'description' => '站点监控任务列表。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '站点监控任务的URL或IP地址。'."\n" + ."\n" + .'> 至少需要创建一条站点监控任务,且`Address`、`TaskName`和`TaskType`必须设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + 'IspCities' => [ + 'description' => '探测点信息。如果该参数取值为空,则系统随机选择3个探测点。'."\n" + ."\n" + .'格式为`JSONArray`,例如:`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`,分别对应北京、杭州、青岛。'."\n" + ."\n" + .'关于如何获取探测点信息,请参见[DescribeSiteMonitorISPCityList](~~115045~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', + ], + 'OptionsJson' => [ + 'description' => '站点监控任务对应协议类型的高级扩展选项。不同探测任务的协议类型对应不同的扩展选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{"time_out":5000}', + ], + 'TaskName' => [ + 'description' => '站点监控任务的名称。'."\n" + ."\n" + .'<props="china">长度4~100个字符,取值可包含英文字母、数字、短划线(_)和汉字。</props>'."\n" + ."\n\n" + .'<props="intl">长度4~100个字符,取值可包含英文字母、数字和短划线(_)。</props>'."\n" + ."\n" + .'<props="partner">长度4~100个字符,取值可包含英文字母、数字和短划线(_)。</props>'."\n" + ."\n" + .'> 至少需要创建一条站点监控任务,且`Address`、`TaskName`和`TaskType`必须设置。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'HangZhou_ECS1', + ], + 'TaskType' => [ + 'description' => '监控任务的监控类型。'."\n" + ."\n" + .'目前站点监控任务的类型包括:HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。'."\n" + ."\n" + .'> 至少需要创建一条站点监控任务,且`Address`、`TaskName`和`TaskType`必须设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 200, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7AE72720-2C96-5446-9F2B-308C7CEDFF1A', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + .'* true:成功。'."\n" + .'* false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '站点监控任务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '站点监控任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '站点监控任务名称。', + 'type' => 'string', + 'example' => 'HangZhou_ECS1', + ], + 'TaskId' => [ + 'description' => '站点监控任务ID。', + 'type' => 'string', + 'example' => '679fbe4f-b80b-4706-91b2-5427b43e****', + ], + ], + ], + 'example' => '[{"taskName": "HangZhou_ECS1", "taskId": "679fbe4f-b80b-4706-91b2-5427b43e****"}]', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'The parameter is missing or invalid. %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 429 => [ + [ + 'errorCode' => 'ResourceOverLimit', + 'errorMessage' => 'The resource has exceeded the limit. %s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7AE72720-2C96-5446-9F2B-308C7CEDFF1A\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"HangZhou_ECS1\\",\\n \\"TaskId\\": \\"679fbe4f-b80b-4706-91b2-5427b43e****\\"\\n }\\n ],\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<BatchCreateInstantSiteMonitorResponse>\\n <RequestId>7AE72720-2C96-5446-9F2B-308C7CEDFF1A</RequestId>\\n <Message>successful</Message>\\n <Data>\\n <taskName>HangZhou_ECS1</taskName>\\n <taskId>679fbe4f-b80b-4706-91b2-5427b43e****</taskId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</BatchCreateInstantSiteMonitorResponse>","errorExample":""}]', + 'title' => '批量创建站点监控任务', + 'description' => '本文将提供一个示例,创建一个站点监控任务`HangZhou_ECS1`,该任务的监控地址为`https://www.aliyun.com`,监控类型为`HTTP`。返回结果显示,创建站点监控任务成功,该站点监控任务的名称为`HangZhou_ECS1`,ID为`679fbe4f-b80b-4706-91b2-5427b43e****`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSiteMonitors' => [ + 'summary' => '调用DeleteSiteMonitors接口删除站点监控的探测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的任务ID。多个任务ID之间用半角逗号(,)分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '01adacc2-ece5-41b6-afa2-3143ab5d****,43bd1ead-514f-4524-813e-228ce091****', + ], + ], + [ + 'name' => 'IsDeleteAlarms', + 'in' => 'query', + 'schema' => [ + 'description' => '删除任务的同时是否删除报警规则。取值:'."\n" + ."\n" + .'- true(默认值):删除报警规则。'."\n" + ."\n" + .'- false:不删除报警规则。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。当请求成功时,返回成功信息;当请求失败时,返回失败原因,例如:`TaskId not found`。', + 'type' => 'string', + 'example' => '请求成功', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '123BCC5D-8B63-48EA-B747-9A8995BE7AA6', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回受影响的行数。', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '受影响的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + [ + 'errorCode' => 'UnauthorizedTasks', + 'errorMessage' => 'You are not permitted to operate the specified tasks.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => 'TaskId not found', + ], + [ + 'errorCode' => 'TaskNotExist', + 'errorMessage' => 'The specified task does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"123BCC5D-8B63-48EA-B747-9A8995BE7AA6\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteSiteMonitorsResponse>\\n\\t\\t<Data>\\n\\t\\t\\t<count>0</count>\\n\\t\\t</Data>\\n\\t\\t<Message>请求成功</Message>\\n\\t\\t<RequestId>123BCC5D-8B63-48EA-B747-9A8995BE7AA6</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n<DeleteSiteMonitorsResponse>","errorExample":""}]', + 'title' => '删除站点监控的探测任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableSiteMonitors' => [ + 'summary' => '调用DisableSiteMonitors接口禁用一个或多个站点监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控任务ID。多个ID之间用英文逗号(,)分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '站点监控任务影响探测点的记录数。', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '探测点的记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + [ + 'errorCode' => 'UnauthorizedTasks', + 'errorMessage' => 'You are not permitted to operate the specified tasks.', + ], + ], + [ + [ + 'errorCode' => 'TaskNotExist', + 'errorMessage' => 'The specified task does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DisableSiteMonitorsResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>EC3F33C8-9149-493C-92A8-9B33A9DA951C</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<count>0</count>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DisableSiteMonitorsResponse>","errorExample":""}]', + 'title' => '禁用一个或多个站点监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySiteMonitor' => [ + 'summary' => '调用ModifySiteMonitor接口修改站点监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务的URL或IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2c8dbdf9-a3ab-46a1-85a4-f094965e****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务名称。长度4~100个字符,取值可包含英文字母、数字、下划线(_)和汉字。', + 'type' => 'string', + 'required' => false, + 'example' => 'HanZhou_ECS2', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '监控频率。取值:1、5、15。单位:分钟。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IspCities', + 'in' => 'query', + 'schema' => [ + 'description' => '探针信息。格式为JSONArray,例如:`[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`,`city`分别对应北京、杭州和青岛。'."\n" + ."\n" + .'> 您可以通过DescribeSiteMonitorISPCityList接口获取探测点信息,请参见[DescribeSiteMonitorISPCityList](~~115045~~)。如果该参数取值为空,则系统随机选择3个探测点。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]', + ], + ], + [ + 'name' => 'OptionsJson', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务对应协议类型的高级扩展选项。不同监控任务的协议类型对应不同的扩展选项。', + 'type' => 'string', + 'required' => false, + 'example' => '{"time_out":5000}', + ], + ], + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。云监控中已存在的报警规则ID,可通过DescribeMetricRuleList接口查询,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '49f7c317-7645-4cc9-94fd-ea42e122****', + ], + ], + [ + 'name' => 'IntervalUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '监控指标的单位。'."\n" + ."\n" + .'单位:毫秒(ms)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ms', + ], + ], + [ + 'name' => 'CustomSchedule', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '自定义探测周期。只能选择周一至周日的某个时间段进行探测。', + 'type' => 'string', + 'required' => false, + 'example' => '{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '68192f5d-0d45-4b98-9724-892813f86c71', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '修改任务结果详情。', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '监控任务数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'IllegalAddress', + 'errorMessage' => 'Illegal HTTP address', + ], + [ + 'errorCode' => 'OperationError', + 'errorMessage' => 'Operation failed', + ], + [ + 'errorCode' => 'TaskNotExists', + 'errorMessage' => 'Task does not exist', + ], + [ + 'errorCode' => 'OperatorInvalid', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'NameRepeat', + 'errorMessage' => 'Task name repeat', + ], + [ + 'errorCode' => 'CreateAlarmError', + 'errorMessage' => 'Create alarm error', + ], + [ + 'errorCode' => 'NameNotExists', + 'errorMessage' => 'Task name not exists', + ], + [ + 'errorCode' => 'OperatorCityInvalid', + 'errorMessage' => 'Invalid Isp.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + [ + 'errorCode' => 'RestrictedUser', + 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', + ], + [ + 'errorCode' => 'UnauthorizedTasks', + 'errorMessage' => 'You are not permitted to operate the specified tasks.', + ], + ], + [ + [ + 'errorCode' => 'TaskNotExist', + 'errorMessage' => 'The specified task does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternetServerError', + 'errorMessage' => 'System internal error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"68192f5d-0d45-4b98-9724-892813f86c71\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifySiteMonitorResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>32E77F32-B86E-4763-A0BB-0311581ABE67</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<count>1</count>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ModifySiteMonitorResponse>","errorExample":""}]', + 'title' => '修改站点监控任务', + 'requestParamsDescription' => '站点监控支持以下8种任务类型,每种任务类型对应的扩展参数(OptionsJson)如下表所示。 '."\n" + ."\n" + .'- HTTP'."\n" + ."\n" + .'|名称 |类型 |描述|'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|http_method |String |HTTP请求方式,支持三种:GET、POST、HEAD。默认值:GET。 |'."\n" + .'|header |String |换行符(\\n)分隔的自定义HTTP header。<br>每行header格式需符合HTTP协议(使用英文冒号分隔的键值)。 |'."\n" + .'|cookie |String |cookie和HTTP请求标准的写法一致。 |'."\n" + .'|request_content |String |请求内容。支持两种格式:JSON和表单。不提供时,请求中不含正文。 |'."\n" + .'|response_content |String |期望的响应内容。探测时会在HTTP服务器返回的前64个字节进行检查。 |'."\n" + .'|match_rule |String |0:响应中不含response_content时,探测成功。<br>1:响应中含response_content时,探测成功。 |'."\n" + .'|username |String |如果提供username,则会在HTTP请求中携带BasicAuth header。 |'."\n" + .'|password |String |HTTP请求验证密码。 |'."\n" + .'|time_out |int |超时时间。单位:毫秒。默认值:5 。 |'."\n" + .'|max_redirect |int |大跳转次数。ECS探针默认5次,运营商探针默认2次。<br>如果需要禁止跳转,则将该参数设置为:0。<br>取值范围:0~50 。 |'."\n" + ."\n" + .' '."\n" + .'- PING'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|failure_rate |int |当PING失败率超过该参数时,探测失败,返回610(PingAllFail)或615(PingPartialFail)。<br>默认值:0.1。 |'."\n" + .'|ping_num |int |PING次数,默认值:20。<br>取值范围:1~100。 |'."\n" + ."\n" + .'- DNS'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|dns_server |string |DNS服务器地址,可以为域名或IP地址。 |'."\n" + .'|dns_type |string |DNS查询类型。取值:A、NS、CNAME、MX、TXT、ANY。 |'."\n" + .'|expect_value |string |英文空白符分隔的期望值列表。 |'."\n" + .'|match_rule |string |期望值列表与DNS列表的关系,当不满足指定关系时,探测失败。 <br>空字符串或IN_DNS:期望值列表是DNS列表的子集。 <br>DNS_IN:DNS列表是期望值列表的子集。 <br>EQUAL:DNS列表与期望值列表相等。 <br>ANY:DNS列表与期望值列表有交集(交集不为空)。 |'."\n" + ."\n" + .'- FTP'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |FTP服务器端口号。如果不提供,则使用默认值。FTP默认值:21,FTPs默认值:990。 |'."\n" + .'|username |string |FTP用户名。 如果未提供,则匿名登录。 |'."\n" + .'|password |string |FTP密码。 |'."\n" + ."\n" + .'- POP3/SMTP'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |POP3服务器端口号。POP3默认值:110,POP3s默认值:995。 |'."\n" + .'|username |string |POP3/SMTP的用户名。 |'."\n" + .'|password |string |POP3/SMTP的密码 。 |'."\n" + ."\n" + .'- TCP/UDP'."\n" + ."\n" + .'|名称 |类型 |描述 |'."\n" + .'| ----- | -------------- | ----------- |'."\n" + .'|port |int |TCP/UDP服务器的端口。 |'."\n" + .'|request_content |string |请求内容。当request_format为hex时,request_content内容为十六进制紧凑格式。 |'."\n" + .'|request_format |string |当request_format为其他值时,request_content作为普通字符串发送给TCP/UDP服务器。 |'."\n" + .'|response_content |string |响应内容。当TCP/UDP服务器返回的内容中不含response_content时,探测失败。<br>当response_format为hex时,response_content中的内容为十六进制紧凑格式。<br>当response_content为其他值时,response_content为普通字符串。 |'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableSiteMonitors' => [ + 'summary' => '调用EnableSiteMonitors接口启用一个或多个站点监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控任务ID。多个ID之间用英文逗号(,)分隔。', + 'type' => 'string', + 'required' => true, + 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****,49f7b317-7645-4cc9-94fd-ea42e522****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3fcd12e7-d387-42ee-b77e-661c775bb17f', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '站点监控任务影响探测点的记录数。', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'description' => '探测点的记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + [ + 'errorCode' => 'RestrictedUser', + 'errorMessage' => 'The user\'s operation is restricted, please register NAAM product code.', + ], + [ + 'errorCode' => 'UnauthorizedTasks', + 'errorMessage' => 'You are not permitted to operate the specified tasks.', + ], + ], + [ + [ + 'errorCode' => 'TaskNotExist', + 'errorMessage' => 'The specified task does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3fcd12e7-d387-42ee-b77e-661c775bb17f\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"count\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<DisableSiteMonitorsResponse>\\n\\t<Message>successful</Message>\\n\\t<RequestId>7AB49ADD-3276-4161-B9F9-8662CAA800D6</RequestId>\\n\\t<Data>\\n\\t\\t<count>0</count>\\n\\t</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DisableSiteMonitorsResponse>","errorExample":""}]', + 'title' => '启用一个或多个站点监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorQuota' => [ + 'summary' => '调用DescribeSiteMonitorQuota接口查询站点监控的配额以及版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '请求成功', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '26860260-76C6-404E-AB7A-EB98D36A6885', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '配额。', + 'type' => 'object', + 'properties' => [ + 'SiteMonitorOperatorQuotaQuota' => [ + 'description' => '非阿里巴巴探测点配额。默认值:0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SecondMonitor' => [ + 'description' => '是否开启秒级监控。取值:'."\n" + ."\n" + .'- true:开启。'."\n" + ."\n" + .'- false:关闭。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SiteMonitorQuotaTaskUsed' => [ + 'description' => '站点监控探测任务配额使用数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'SiteMonitorTaskQuota' => [ + 'description' => '站点监控探测任务配额。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'SiteMonitorVersion' => [ + 'description' => '站点监控版本。取值:'."\n" + ."\n" + .'- V1:老版本。'."\n" + .' '."\n" + .'- V2:新版本。', + 'type' => 'string', + 'example' => 'V1', + ], + 'SiteMonitorIdcQuota' => [ + 'description' => '阿里巴巴探测点配额。免费配额5个。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"26860260-76C6-404E-AB7A-EB98D36A6885\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"SiteMonitorOperatorQuotaQuota\\": 0,\\n \\"SecondMonitor\\": false,\\n \\"SiteMonitorQuotaTaskUsed\\": 6,\\n \\"SiteMonitorTaskQuota\\": 10,\\n \\"SiteMonitorVersion\\": \\"V1\\",\\n \\"SiteMonitorIdcQuota\\": 5\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorQuotaResponse>\\n\\t\\t<Message>请求成功</Message>\\n\\t\\t<RequestId>C1359088-B0D3-4344-BA51-FB920425D836</RequestId>\\n\\t\\t<Data>\\n\\t\\t\\t<SiteMonitorVersion>V2</SiteMonitorVersion>\\n\\t\\t\\t<SiteMonitorQuotaTaskUsed>2</SiteMonitorQuotaTaskUsed>\\n\\t\\t\\t<SecondMonitor>false</SecondMonitor>\\n\\t\\t\\t<SiteMonitorOperatorQuotaQuota>0</SiteMonitorOperatorQuotaQuota>\\n\\t\\t\\t<SiteMonitorTaskQuota>100</SiteMonitorTaskQuota>\\n\\t\\t\\t<SiteMonitorIdcQuota>5</SiteMonitorIdcQuota>\\n\\t\\t</Data>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DescribeSiteMonitorQuotaResponse>","errorExample":""}]', + 'title' => '查询站点监控的配额以及版本', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorAttribute' => [ + 'summary' => '调用DescribeSiteMonitorAttribute接口查询站点监控任务的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', + ], + ], + [ + 'name' => 'IncludeAlert', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的任务详情是否包含报警规则。'."\n" + ."\n" + .'- true:如果该参数的取值为true,则返回报警规则。'."\n" + .'- false(默认值):如果该参数的取值为false,则不返回报警规则。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'MetricRules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MetricRule' => [ + 'description' => '监控任务的报警规则。', + 'type' => 'array', + 'items' => [ + 'description' => '监控任务的报警规则。', + 'type' => 'object', + 'properties' => [ + 'ActionEnable' => [ + 'description' => '报警规则的状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + .'- false:禁用。', + 'type' => 'string', + 'example' => 'true', + ], + 'AlarmActions' => [ + 'description' => '报警规则通知的报警联系组。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + 'ComparisonOperator' => [ + 'description' => '报警规则的阈值比较符。取值:'."\n" + ."\n" + .'- `>=`'."\n" + .'- `>`'."\n" + .'- `<=`'."\n" + .'- `<`'."\n" + .'- `=`'."\n" + .'- `!=`'."\n" + .'- GreaterThanYesterday:同比昨天同时间上涨。'."\n" + .'- LessThanYesterday:同比昨天同时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanYesterday', + ], + 'Dimensions' => [ + 'description' => '报警规则对应的维度。', + 'type' => 'string', + 'example' => '[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]', + ], + 'EvaluationCount' => [ + 'description' => '报警重试次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Expression' => [ + 'description' => '报警规则的表达式。', + 'type' => 'string', + 'example' => '$Availability=30', + ], + 'Level' => [ + 'description' => '报警规则的级别。取值:'."\n" + ."\n" + .'- 1:紧急。'."\n" + ."\n" + .'- 2:警告。'."\n" + ."\n" + .'- 3:信息。', + 'type' => 'string', + 'example' => '2', + ], + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'Availability', + ], + 'Namespace' => [ + 'description' => '云服务的数据命名空间。', + 'type' => 'string', + 'example' => 'acs_networkmonitor', + ], + 'OkActions' => [ + 'description' => '收到报警的联系人组。', + 'type' => 'string', + 'example' => '[ "CloudMonitor"]', + ], + 'Period' => [ + 'description' => '时间间隔。通常是监控项的上报周期,单位:秒。'."\n" + ."\n" + .'>如果您设置了统计周期,则会按照此周期查询对应的统计数据 。', + 'type' => 'string', + 'example' => '15s', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'bf071ae_7b7aec3817b0fdf****', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'rule1', + ], + 'StateValue' => [ + 'description' => '报警的状态。取值:'."\n" + ."\n" + .'- OK:正常。'."\n" + ."\n" + .'- ALARM:报警。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Statistics' => [ + 'description' => '报警的统计方法。取值:'."\n" + ."\n" + .'- Availability:可用探测点百分比。'."\n" + .'- AvailableNumber:可用探测点数量。'."\n" + .'- ErrorCodeMaximum:任意状态码(独立报警)。'."\n" + .'- ErrorCodeMinimum:所有状态码(组合报警)。'."\n" + .'- Average:响应时间。', + 'type' => 'string', + 'example' => 'Availability', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '30', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D17DF650-7EBD-54D0-903A-1D4E624D7402', + ], + 'SiteMonitors' => [ + 'description' => '监控任务详情。', + 'type' => 'object', + 'properties' => [ + 'Address' => [ + 'description' => '监控任务的探测地址。', + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'AgentGroup' => [ + 'description' => '探测点类型。默认为PC。'."\n" + .'取值:'."\n" + ."\n" + .'- PC 固网'."\n" + ."\n" + .'- MOBILE 移动端', + 'type' => 'string', + 'example' => 'PC', + ], + 'CustomSchedule' => [ + 'description' => '自定义探测周期。只能选择周一至周日的某个时间段进行探测。', + 'type' => 'object', + 'properties' => [ + 'days' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'days' => [ + 'description' => '探测日。', + 'type' => 'array', + 'items' => [ + 'description' => '探测日。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'end_hour' => [ + 'description' => '自定义探测结束时间。'."\n" + ."\n" + .'单位:小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + ], + 'start_hour' => [ + 'description' => '自定义探测开始时间。'."\n" + ."\n" + .'单位:小时。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'time_zone' => [ + 'description' => '自定义探测的时区。', + 'type' => 'string', + 'example' => 'local', + ], + ], + ], + 'Interval' => [ + 'description' => '监控任务的周期。单位:分钟。取值:1、 5、15、30和60。', + 'type' => 'string', + 'example' => '1', + ], + 'IspCities' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IspCity' => [ + 'description' => '探测点的运营商和城市。', + 'type' => 'array', + 'items' => [ + 'description' => '探测点的运营商和城市。', + 'type' => 'object', + 'properties' => [ + 'City' => [ + 'description' => '城市ID。', + 'type' => 'string', + 'example' => '738', + ], + 'CityName' => [ + 'description' => '城市名称。', + 'type' => 'string', + 'example' => '北京市', + ], + 'Isp' => [ + 'description' => '运营商ID。', + 'type' => 'string', + 'example' => '465', + ], + 'IspName' => [ + 'description' => '运营商名称。', + 'type' => 'string', + 'example' => '阿里巴巴', + ], + 'Type' => [ + 'description' => '探测点网络类型。取值:'."\n" + .'IDC: IDC机房'."\n" + .'LASTMILE: 网民家宽'."\n" + .'MOBILE: 移动蜂窝网', + 'type' => 'string', + 'example' => 'IDC', + ], + ], + ], + ], + ], + ], + 'OptionJson' => [ + 'description' => '扩展选项。每一种探测类型有不同的扩展类型,详情请参见[CreateSiteMonitor](~~115048~~)。', + 'type' => 'object', + 'properties' => [ + 'assertions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'assertions' => [ + 'description' => '断言配置组。', + 'type' => 'array', + 'items' => [ + 'description' => '断言配置组。', + 'type' => 'object', + 'properties' => [ + 'operator' => [ + 'description' => '断言比较操作符。取值:'."\n" + .'- contains:包含。'."\n" + .'- doesNotContain:不包含。'."\n" + .'- matches:正则匹配。'."\n" + .'- doesNotMatch:正则不匹配。'."\n" + .'- is:数值等于或字符匹配相等。'."\n" + .'- isNot:不等于。'."\n" + .'- lessThan:小于。'."\n" + .'- moreThan:大于。', + 'type' => 'string', + 'example' => 'lessThan', + ], + 'property' => [ + 'description' => '断言内容解析路径。'."\n" + ."\n" + .'- 如果断言类型为`body_json`,则路径为`json path`。'."\n" + ."\n" + .'- 如果断言类型是`body_xml`,则路径为`xml path`', + 'type' => 'string', + 'example' => 'json path', + ], + 'target' => [ + 'description' => '断言匹配比较的目标数值或字符。', + 'type' => 'string', + 'example' => '0', + ], + 'type' => [ + 'description' => '断言类型。取值:'."\n" + .'- response_time:判定响应时间是否符合预期。'."\n" + .'- status_code:判断HTTP响应状态码是否符合预期。'."\n" + .'- header:判定响应Header中的字段是否符合预期。'."\n" + .'- body_text:通过文本字符匹配判断返回Body中的内容是否符合预期。'."\n" + .'- body_json:通过JSON解析(JSON Path)判断返回Body中的内容是否符合预期。'."\n" + .'- body_xml:通过XML解析(XPath)判断返回Body中的内容是否符合预期。', + 'type' => 'string', + 'example' => 'response_time', + ], + ], + ], + ], + ], + ], + 'attempts' => [ + 'description' => 'DNS失败后重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'auth_info' => [ + 'description' => '鉴权信息', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '鉴权信息,目前支持HTTP Basic Authentication。可选值为basic。', + 'type' => 'string', + 'example' => 'basic', + ], + 'username' => [ + 'description' => 'HTTP Basic Authentication使用的用户名', + 'type' => 'string', + 'example' => 'test_username', + ], + 'password' => [ + 'description' => 'HTTP Basic Authentication使用的密码', + 'type' => 'string', + 'example' => 'test_password', + ], + 'use_cookie_session_key' => [ + 'description' => 'digest认证中,该参数指示密钥是否存储在客户端的Cookie中。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'grant_type' => [ + 'description' => 'Oauth2.0认证中,使用的鉴权类型。可选值为client_credentials和password', + 'type' => 'string', + 'example' => 'password', + ], + 'client_id' => [ + 'description' => 'Oauth2.0中使用的客户端鉴权时的客户端id', + 'type' => 'string', + 'example' => 'client_id', + ], + 'client_secret' => [ + 'description' => 'Oauth2.0中使用的客户端鉴权时的客户端密钥', + 'type' => 'string', + 'example' => 'client_secret', + ], + 'scopes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'scopes' => [ + 'description' => 'Oauth2.0中的申请的权限范围。', + 'type' => 'array', + 'items' => [ + 'description' => 'Oauth2.0中的申请的单个权限', + 'type' => 'string', + 'example' => 'test_operation', + ], + ], + ], + ], + 'token_url' => [ + 'description' => 'OAuth2.0中的认证服务器地址', + 'type' => 'string', + 'example' => 'https://www.example.com', + ], + 'auth_style' => [ + 'description' => 'OAuth2.0认证风格,可选值为ROA和RPC', + 'type' => 'string', + 'example' => 'ROA', + ], + 'access_key_id' => [ + 'description' => '仅在多步拨测中支持,使用阿里云鉴权时,传入的accessKey,建议使用加密存储', + 'type' => 'string', + 'example' => 'testAk', + ], + 'access_key_secret' => [ + 'description' => '仅在多步拨测中支持,使用阿里云鉴权时,传入的accessKey Secret,建议使用加密存储', + 'type' => 'string', + 'example' => 'testSk', + ], + 'region_id' => [ + 'description' => '仅在多步拨测中支持,使用阿里云鉴权时,请求的regionId', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'api_action' => [ + 'description' => '仅在多步拨测中支持,使用阿里云操作时,请求api', + 'type' => 'string', + 'example' => 'example_api', + ], + 'api_version' => [ + 'description' => '仅在多步拨测中支持,使用阿里云操作时,请求api版本', + 'type' => 'string', + 'example' => '2019-01-01', + ], + 'with_addon_resources' => [ + 'description' => '仅在多步拨测中支持,当该步使用阿里云鉴权时,操作是否存在额外资源', + 'type' => 'boolean', + 'example' => 'false', + ], + 'service_name' => [ + 'description' => '使用AWS鉴权时,请求的服务名称。', + 'type' => 'string', + 'example' => 'example_service_name', + ], + 'session_token' => [ + 'description' => '使用AWS鉴权时的session_token', + 'type' => 'string', + 'example' => 'example_token', + ], + ], + ], + 'blocked_url_list' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'blocked_url_list' => [ + 'description' => '屏蔽的资源URL列表。支持路径通配符。', + 'type' => 'array', + 'items' => [ + 'description' => '屏蔽的资源URL列表。支持路径通配符。', + 'type' => 'string', + 'example' => 'www.taobao.com/**', + ], + ], + ], + ], + 'browser_headers' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_headers' => [ + 'description' => '自定义Header。结构为`{"key": "somekey", "value":"somevalue"}`', + 'type' => 'array', + 'items' => [ + 'description' => '自定义Header。结构为`{"key": "somekey", "value":"somevalue"}`', + 'type' => 'object', + 'example' => '{"key":"value"}', + ], + ], + ], + ], + 'browser_hosts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_hosts' => [ + 'description' => '自定义Host。结构为`{"url":"someurl", "ip":"someip"}`。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义Host。结构为`{"url":"someurl", "ip":"someip"}`。', + 'type' => 'string', + 'example' => '{"url":"www.taobao.com","ip":"127.0.0.1"}', + ], + ], + ], + ], + 'browser_info' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'browser_info' => [ + 'description' => '浏览器信息。', + 'type' => 'array', + 'items' => [ + 'description' => '浏览器信息。', + 'type' => 'object', + 'properties' => [ + 'browser' => [ + 'description' => '浏览器类型。', + 'type' => 'string', + 'example' => 'Chrome', + ], + 'device' => [ + 'description' => '屏幕类型。', + 'type' => 'string', + 'example' => 'laptop', + ], + ], + ], + ], + ], + ], + 'browser_insecure' => [ + 'description' => '是否忽略证书错误。取值:'."\n" + ."\n" + .'- false:不忽略证书错误。'."\n" + .'- true:忽略证书错误。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'browser_task_version' => [ + 'description' => '浏览器拨测版本。取值:'."\n" + ."\n" + .'- 1:单页拨测。'."\n" + .'- 2:多页拨测。', + 'type' => 'string', + 'example' => '1', + ], + 'cookie' => [ + 'description' => '发送HTTP请求的Cookie。', + 'type' => 'string', + 'example' => 'lang=en', + ], + 'diagnosis_mtr' => [ + 'description' => '是否开启任务失败后的自动MTR网络诊断。取值:'."\n" + .'- false:不开启自动MTR网络诊断。'."\n" + .'- true 开启自动MTR网络诊断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'diagnosis_ping' => [ + 'description' => '是否开启任务失败后自动PING网络延时探测。取值:'."\n" + .'- false:不开启自动PING网络延时探测。'."\n" + .'- true:开启自动PING网络延时探测。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'dns_hijack_whitelist' => [ + 'description' => 'DNS劫持配置列表。', + 'type' => 'string', + 'example' => 'www.taobao.com:www.taobao.com.danuoyi.tbcache.com', + ], + 'dns_match_rule' => [ + 'description' => 'DNS的匹配规则。取值:'."\n" + ."\n" + .'- IN_DNS:期望解析的别名或IP地址均在DNS应答中。'."\n" + .'- DNS_IN:所有的DNS应答都出现在期望解析的别名或IP地址中。'."\n" + .'- EQUAL:DNS应答和期望解析的别名或IP地址完全相同。'."\n" + .'- ANY:DNS应答和期望解析的别名或IP地址有交集。', + 'type' => 'string', + 'example' => 'IN_DNS', + ], + 'dns_server' => [ + 'description' => 'DNS服务器的IP地址。'."\n" + ."\n" + .'> 仅适用于DNS探测类型。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'dns_type' => [ + 'description' => 'DNS解析类型。仅适用于DNS探测类型。取值:'."\n" + .'- A:指定主机名或域名对应的IP地址。'."\n" + .'- CNAME:将多个域名映射到另外一个域名。'."\n" + .'- NS:指定域名由某个DNS服务器解析。'."\n" + .'- MX:将域名指向一个邮件服务器地址。'."\n" + .'- TXT:主机名或域名的说明。文本长度限制512字节,通常用做SPF(Sender Policy Framework)记录,即反垃圾邮件。', + 'type' => 'string', + 'example' => 'A', + ], + 'empty_message' => [ + 'description' => '是否允许WebSocket任务不返回消息或返回空消息。取值:'."\n" + .'- false(默认):否。'."\n" + .'- true: 是。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'expect_exist_string' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'expect_exist_string' => [ + 'description' => '期待页面中存在的字符串列表。', + 'type' => 'array', + 'items' => [ + 'description' => '期待页面中存在的字符串列表。', + 'type' => 'string', + 'example' => 'expected string', + ], + ], + ], + ], + 'expect_non_exist_string' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'expect_non_exist_string' => [ + 'description' => '期待页面中不存在的字符串列表。', + 'type' => 'array', + 'items' => [ + 'description' => '期待页面中不存在的字符串列表。', + 'type' => 'string', + 'example' => 'unexpected string', + ], + ], + ], + ], + 'expect_value' => [ + 'description' => '待解析的别名或地址。'."\n" + ."\n" + .'> 该参数仅适用于DNS探测类型。', + 'type' => 'string', + 'example' => 'dns_server', + ], + 'failure_rate' => [ + 'description' => '丢包率。'."\n" + ."\n" + .'> 该参数仅适用于PING探测类型。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.4', + ], + 'header' => [ + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'example' => 'testKey:testValue', + ], + 'http_method' => [ + 'description' => 'HTTP请求方法。取值:'."\n" + .'- get '."\n" + .'- post'."\n" + .'- head', + 'type' => 'string', + 'example' => 'get', + ], + 'ip_network' => [ + 'description' => 'ip_network指示该任务的网络类型,可选值为v4,v6,auto,默认值为v4', + 'type' => 'string', + 'example' => 'v4', + 'enum' => [], + ], + 'isBase64Encode' => [ + 'description' => '是否对密码进行base64解码存储。取值:'."\n" + .'- true:对密码进行base64解码存储。'."\n" + .'- false:不对密码进行base64解码存储。', + 'type' => 'string', + 'example' => 'false', + ], + 'match_rule' => [ + 'description' => '是否包含报警规则。取值:'."\n" + .'- 0:是。'."\n" + .'- 1:否。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'min_tls_version' => [ + 'description' => '最低TLS版本。默认支持TLS1.2及以上版本,TLS1.0和1.1已被禁用,如仍需支持可更改配置', + 'type' => 'string', + 'example' => 'tlsv1.2', + ], + 'password' => [ + 'description' => 'SMTP、POP3或FTP探测类型的密码。', + 'type' => 'string', + 'example' => '123****', + ], + 'ping_num' => [ + 'description' => 'PING探测类型的心跳。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '29', + ], + 'ping_port' => [ + 'description' => 'PING端口。适用于TCP PING。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ping_type' => [ + 'description' => 'PING协议类型。取值:'."\n" + ."\n" + .'- icmp'."\n" + ."\n" + .'- tcp'."\n" + ."\n" + .'- udp', + 'type' => 'string', + 'example' => 'icmp', + 'default' => 'icmp', + ], + 'port' => [ + 'description' => 'TCP、UDP、SMTP、POP3探测类型的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '110', + ], + 'protocol' => [ + 'description' => '探测协议。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'quic_enabled' => [ + 'description' => '浏览器拨测是否使用quic协议,取值:'."\n" + .'true,使用quic协议'."\n" + .'false,不实用quic协议'."\n" + .'默认值为false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'quic_target' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'quic_target' => [ + 'description' => '强制使用quic协议的站点列表', + 'type' => 'array', + 'items' => [ + 'description' => '强制使用quic协议的站点,格式为url:port,port可以不填,默认为443', + 'type' => 'string', + 'example' => 'www.taobao.com', + ], + ], + ], + ], + 'request_content' => [ + 'description' => 'HTTP探测类型的请求内容。', + 'type' => 'string', + 'example' => 'aa=bb', + ], + 'request_format' => [ + 'description' => 'HTTP请求内容格式。取值:'."\n" + .'- hex:十六进制格式。'."\n" + .'- txt:文本格式。', + 'type' => 'string', + 'example' => 'txt', + ], + 'response_content' => [ + 'description' => '匹配响应内容。', + 'type' => 'string', + 'example' => 'txt', + ], + 'response_format' => [ + 'description' => 'HTTP响应内容格式。取值:'."\n" + .'- hex:十六进制格式。'."\n" + .'- txt:文本格式。', + 'type' => 'string', + 'example' => 'txt', + ], + 'retry_delay' => [ + 'description' => '探测失败后重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'screen_shot' => [ + 'description' => '是否开启页面截图', + 'type' => 'boolean', + 'example' => 'false', + ], + 'time_out' => [ + 'description' => '超时时间。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'traffic_hijack_element_blacklist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'traffic_hijack_element_blacklist' => [ + 'description' => '当发生重定向时,如果浏览器加载资源的URL与该列表中的表达能匹配,则认为发生流量劫持。', + 'type' => 'array', + 'items' => [ + 'description' => '当发生重定向时,如果浏览器加载资源的URL与该列表中的表达能匹配,则认为发生流量劫持。', + 'type' => 'string', + 'example' => 'www.taobao.com', + ], + ], + ], + ], + 'traffic_hijack_element_count' => [ + 'description' => '当发生重定向时,如果浏览器加载资源数超过这个值,则认为发生流量劫持。当该值为0时,不进行校验,默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'traffic_hijack_element_whitelist' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'traffic_hijack_element_whitelist' => [ + 'description' => '当发生重定向时,如果浏览器加载资源的URL与该列表中的任意一个表达式都不匹配,则认为发生流量劫持。', + 'type' => 'array', + 'items' => [ + 'description' => '当发生重定向时,如果浏览器加载资源的URL与该列表中的任意一个表达式都不匹配,则认为发生流量劫持。', + 'type' => 'string', + 'example' => 'www.taobao.com', + ], + ], + ], + ], + 'username' => [ + 'description' => 'FTP、SMTP或POP3的用户名。', + 'type' => 'string', + 'example' => 'testUser', + ], + 'waitTime_after_completion' => [ + 'description' => '浏览器拨测任务中,页面打开后的额外等待时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'scroll_end' => [ + 'description' => '当任务为浏览器探测任务时,scroll_end代表打开页面之后是否滚动到页面最下端。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'host_binding' => [ + 'description' => 'HTTP任务自定义host,格式为ip1,ip2:address,可以配置多行映射。冒号左边是域名可被解析的A记录或者cname,使用逗号隔开,冒号右边是域名。', + 'type' => 'string', + 'example' => '127.0.0.1:www.aliyun.com', + ], + 'host_binding_type' => [ + 'description' => 'host_binding_type的可选值为0或1,指示自定义host的生效方式。0表示随机,1表示轮询。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '0', + ], + 'hops' => [ + 'description' => '指定PING任务失败时,执行traceroute诊断的跳数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'icmp_timeout_millis' => [ + 'description' => '指定使用ICMP协议进行的PING任务的单次PING超时时间,单位为毫秒', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3000', + ], + 'config_variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'config_variables' => [ + 'description' => '环境变量配置,对多步探测生效。', + 'type' => 'array', + 'items' => [ + 'description' => '环境变量可以在不同测试步骤的参数中被引用(使用占位符 {{$.变量名称}} ,也可以从一步测试结果中解析返回内容并对对应的变量更新赋值且在下一步的测试中引用。 对于敏感信息,如API密钥,可勾选加密存储。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '环境变量名称', + 'type' => 'string', + 'example' => 'variable_name', + ], + 'value' => [ + 'description' => '变量值', + 'type' => 'string', + 'example' => 'variable_value', + ], + 'secure' => [ + 'description' => '加密存储', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'steps' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'steps' => [ + 'description' => '对多步探测生效。多步探测中的步骤配置。', + 'type' => 'array', + 'items' => [ + 'description' => '多步探测中的单步配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '步骤名称(已废弃)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'step1', + ], + 'step_type' => [ + 'description' => '该步骤的拨测类型。可选类型有'."\n" + .'- http'."\n" + .'- ping'."\n" + .'- tcp'."\n" + .'- udp'."\n" + .'- dns'."\n" + .'- smtp'."\n" + .'- pop3'."\n" + .'- ftp'."\n" + .'- wait'."\n" + ."\n" + .'其中wait为等待步骤。', + 'type' => 'string', + 'example' => 'http', + ], + 'url' => [ + 'description' => '多步拨测中,单步拨测的url', + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'allow_failure' => [ + 'description' => '当前步骤如果失败,是否还继续下一步探测。默认值为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'is_critical' => [ + 'description' => '如果当前步骤失败,则会标记整个探测为失败。默认值为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'wait_time_in_secs' => [ + 'description' => '等待时间,单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'extracted_variables' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'extracted_variables' => [ + 'description' => '变量提取配置', + 'type' => 'array', + 'items' => [ + 'description' => '单个变量提取配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '变量名。', + 'type' => 'string', + 'example' => 'test_variable', + ], + 'parser' => [ + 'description' => '变量提取方法设置', + 'type' => 'object', + 'properties' => [ + 'parser_type' => [ + 'description' => '提取变量的模式。0为json,1为xml,2为正则。', + 'type' => 'string', + 'example' => '0', + ], + 'value' => [ + 'description' => '变量提取表达式'."\n" + .'提取方式为json和xml时,变量提取表达式支持xml格式。'."\n" + .'提取方式为正则表达式时,提取和该值匹配的字符串。', + 'type' => 'string', + 'example' => 'x.testkey.arrayvalue[0].innerkey', + ], + ], + ], + 'field' => [ + 'description' => '当变量位置为http header时,该选项生效。提取header中该选项所指向的key。', + 'type' => 'string', + 'example' => 'request_id', + ], + 'extracted_type' => [ + 'description' => '提取变量的位置。0为http body,1为http header。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'option' => [ + 'description' => '该步骤的扩展选项。每一种探测类型有不同的扩展类型,详情请参见[CreateSiteMonitor](~~115048~~)。', + 'type' => 'string', + 'example' => '{"enable_operator_dns": true}', + ], + 'step_name' => [ + 'description' => '步骤名称。', + 'type' => 'string', + 'example' => 'step1', + ], + 'use_generated_cookie' => [ + 'description' => '是否使用该步之前提取出的cookie。默认值为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_extract_cookie' => [ + 'description' => '自动提取cookie,这一步http的单步拨测返回的header里的set-cookie将会被解析,并在之后的拨测步骤里可见。默认值为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'trace_region' => [ + 'description' => '设置与可观测链路OpenTelemetry版本集成时,目标应用的部署地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'trace_type' => [ + 'description' => '设置与可观测链路OpenTelemetry版本集成时,使用的链路追踪协议。'."\n" + .'可选值为'."\n" + .'- OpenTelemetry'."\n" + .'- Zipkin'."\n" + .'- Jaeger', + 'type' => 'string', + 'example' => 'OpenTelemetry', + ], + 'safe_link' => [ + 'description' => '对SMTP类型的任务生效。设置为1时,使用安全连接。默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'enable_packet_capture' => [ + 'description' => '该任务是否开启抓包', + 'type' => 'boolean', + 'example' => 'true', + ], + 'use_private_crt' => [ + 'title' => '是否使用私有证书', + 'description' => '是否使用私有证书', + 'type' => 'boolean', + ], + 'private_crt_file_name' => [ + 'title' => '私有证书文件名', + 'description' => '私有证书文件名', + 'type' => 'string', + 'example' => 'cert.pem', + ], + 'use_ssl' => [ + 'title' => '执行TCP任务时是否进行SSL连接', + 'description' => '执行TCP任务时是否进行SSL连接', + 'type' => 'boolean', + 'example' => 'tlsv1.0', + ], + 'max_tls_version' => [ + 'title' => '最高TLS版本', + 'description' => '最高TLS版本', + 'type' => 'string', + 'example' => 'tlsv1.3', + ], + 'server_name' => [ + 'title' => '服务器名称指示', + 'description' => '服务器名称指示', + 'type' => 'string', + 'example' => 'www.aliyun.com', + ], + 'supported_cipher_suits' => [ + 'title' => '支持的加密套件', + 'description' => '支持的加密套件', + 'type' => 'string', + 'example' => 'TLS_AES_256_GCM_SHA384', + ], + ], + ], + 'TaskId' => [ + 'description' => '监控任务ID。', + 'type' => 'string', + 'example' => 'cc641dff-c19d-45f3-ad0a-818a0c4f****', + ], + 'TaskName' => [ + 'description' => '监控任务名称。', + 'type' => 'string', + 'example' => 'test123', + ], + 'TaskState' => [ + 'description' => '监控任务的状态。取值:'."\n" + ."\n" + .'- 1:启用。'."\n" + .'- 2:禁用。', + 'type' => 'string', + 'example' => '1', + ], + 'TaskType' => [ + 'description' => '监控任务类型。目前站点监控任务的类型包括:HTTP(S)、PING、TCP、UDP、DNS、SMTP、POP3、FTP。', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'VpcConfig' => [ + 'description' => '内网拨测任务的VPC配置信息。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '内网拨测任务的目标站点所在地域。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'SecurityGroupId' => [ + 'description' => '该内网拨测任务受限于的安全组id。', + 'type' => 'string', + 'example' => 'sg-xxxxxx', + ], + 'VpcId' => [ + 'description' => '该内网拨测任务挂载的vpc id。', + 'type' => 'string', + 'example' => 'vpc-xxxxxx', + ], + 'VswitchId' => [ + 'description' => '该内网拨测任务挂载的vswitch id。', + 'type' => 'string', + 'example' => 'vsw-xxxxxx', + ], + ], + ], + ], + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'The parameter is missing or invalid. %s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'Task Id does not exist', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"MetricRules\\": {\\n \\"MetricRule\\": [\\n {\\n \\"ActionEnable\\": \\"true\\",\\n \\"AlarmActions\\": \\"CloudMonitor\\",\\n \\"ComparisonOperator\\": \\"GreaterThanYesterday\\",\\n \\"Dimensions\\": \\"[{\\\\\\"taskId\\\\\\": \\\\\\"cc641dff-c19d-45f3-ad0a-818a0c4f****\\\\\\" }]\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Expression\\": \\"$Availability=30\\",\\n \\"Level\\": \\"2\\",\\n \\"MetricName\\": \\"Availability\\",\\n \\"Namespace\\": \\"acs_networkmonitor\\",\\n \\"OkActions\\": \\"[ \\\\\\"CloudMonitor\\\\\\"]\\",\\n \\"Period\\": \\"15s\\",\\n \\"RuleId\\": \\"bf071ae_7b7aec3817b0fdf****\\",\\n \\"RuleName\\": \\"rule1\\",\\n \\"StateValue\\": \\"OK\\",\\n \\"Statistics\\": \\"Availability\\",\\n \\"Threshold\\": \\"30\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D17DF650-7EBD-54D0-903A-1D4E624D7402\\",\\n \\"SiteMonitors\\": {\\n \\"Address\\": \\"https://aliyun.com\\",\\n \\"AgentGroup\\": \\"PC\\",\\n \\"CustomSchedule\\": {\\n \\"days\\": {\\n \\"days\\": [\\n 1\\n ]\\n },\\n \\"end_hour\\": 18,\\n \\"start_hour\\": 8,\\n \\"time_zone\\": \\"local\\"\\n },\\n \\"Interval\\": \\"1\\",\\n \\"IspCities\\": {\\n \\"IspCity\\": [\\n {\\n \\"City\\": \\"738\\",\\n \\"CityName\\": \\"北京市\\",\\n \\"Isp\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"Type\\": \\"IDC\\"\\n }\\n ]\\n },\\n \\"OptionJson\\": {\\n \\"assertions\\": {\\n \\"assertions\\": [\\n {\\n \\"operator\\": \\"lessThan\\",\\n \\"property\\": \\"json path\\",\\n \\"target\\": \\"0\\",\\n \\"type\\": \\"response_time\\"\\n }\\n ]\\n },\\n \\"attempts\\": 3,\\n \\"auth_info\\": {\\n \\"type\\": \\"basic\\",\\n \\"username\\": \\"test_username\\",\\n \\"password\\": \\"test_password\\",\\n \\"use_cookie_session_key\\": false,\\n \\"grant_type\\": \\"password\\",\\n \\"client_id\\": \\"client_id\\",\\n \\"client_secret\\": \\"client_secret\\",\\n \\"scopes\\": {\\n \\"scopes\\": [\\n \\"test_operation\\"\\n ]\\n },\\n \\"token_url\\": \\"https://www.example.com\\",\\n \\"auth_style\\": \\"ROA\\",\\n \\"access_key_id\\": \\"testAk\\",\\n \\"access_key_secret\\": \\"testSk\\",\\n \\"region_id\\": \\"cn-hangzhou\\",\\n \\"api_action\\": \\"example_api\\",\\n \\"api_version\\": \\"2019-01-01\\",\\n \\"with_addon_resources\\": false,\\n \\"service_name\\": \\"example_service_name\\",\\n \\"session_token\\": \\"example_token\\"\\n },\\n \\"blocked_url_list\\": {\\n \\"blocked_url_list\\": [\\n \\"www.taobao.com/**\\"\\n ]\\n },\\n \\"browser_headers\\": {\\n \\"browser_headers\\": [\\n {\\n \\"key\\": \\"value\\"\\n }\\n ]\\n },\\n \\"browser_hosts\\": {\\n \\"browser_hosts\\": [\\n \\"{\\\\\\"url\\\\\\":\\\\\\"www.taobao.com\\\\\\",\\\\\\"ip\\\\\\":\\\\\\"127.0.0.1\\\\\\"}\\"\\n ]\\n },\\n \\"browser_info\\": {\\n \\"browser_info\\": [\\n {\\n \\"browser\\": \\"Chrome\\",\\n \\"device\\": \\"laptop\\"\\n }\\n ]\\n },\\n \\"browser_insecure\\": false,\\n \\"browser_task_version\\": \\"1\\",\\n \\"cookie\\": \\"lang=en\\",\\n \\"diagnosis_mtr\\": false,\\n \\"diagnosis_ping\\": false,\\n \\"dns_hijack_whitelist\\": \\"www.taobao.com:www.taobao.com.danuoyi.tbcache.com\\",\\n \\"dns_match_rule\\": \\"IN_DNS\\",\\n \\"dns_server\\": \\"192.168.XX.XX\\",\\n \\"dns_type\\": \\"A\\",\\n \\"empty_message\\": false,\\n \\"expect_exist_string\\": {\\n \\"expect_exist_string\\": [\\n \\"expected string\\"\\n ]\\n },\\n \\"expect_non_exist_string\\": {\\n \\"expect_non_exist_string\\": [\\n \\"unexpected string\\"\\n ]\\n },\\n \\"expect_value\\": \\"dns_server\\",\\n \\"failure_rate\\": 0.4,\\n \\"header\\": \\"testKey:testValue\\",\\n \\"http_method\\": \\"get\\",\\n \\"ip_network\\": \\"v4\\",\\n \\"isBase64Encode\\": \\"false\\",\\n \\"match_rule\\": 1,\\n \\"min_tls_version\\": \\"tlsv1.2\\",\\n \\"password\\": \\"123****\\",\\n \\"ping_num\\": 29,\\n \\"ping_port\\": 80,\\n \\"ping_type\\": \\"icmp\\",\\n \\"port\\": 110,\\n \\"protocol\\": \\"TCP\\",\\n \\"quic_enabled\\": true,\\n \\"quic_target\\": {\\n \\"quic_target\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"request_content\\": \\"aa=bb\\",\\n \\"request_format\\": \\"txt\\",\\n \\"response_content\\": \\"txt\\",\\n \\"response_format\\": \\"txt\\",\\n \\"retry_delay\\": 0,\\n \\"screen_shot\\": false,\\n \\"strict_mode\\": false,\\n \\"time_out\\": 3,\\n \\"traffic_hijack_element_blacklist\\": {\\n \\"traffic_hijack_element_blacklist\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"traffic_hijack_element_count\\": 0,\\n \\"traffic_hijack_element_whitelist\\": {\\n \\"traffic_hijack_element_whitelist\\": [\\n \\"www.taobao.com\\"\\n ]\\n },\\n \\"username\\": \\"testUser\\",\\n \\"waitTime_after_completion\\": 3,\\n \\"scroll_end\\": false,\\n \\"host_binding\\": \\"127.0.0.1:www.aliyun.com\\",\\n \\"host_binding_type\\": 0,\\n \\"hops\\": 20,\\n \\"icmp_timeout_millis\\": 3000,\\n \\"config_variables\\": {\\n \\"config_variables\\": [\\n {\\n \\"name\\": \\"variable_name\\",\\n \\"value\\": \\"variable_value\\",\\n \\"secure\\": true\\n }\\n ]\\n },\\n \\"steps\\": {\\n \\"steps\\": [\\n {\\n \\"name\\": \\"step1\\",\\n \\"step_type\\": \\"http\\",\\n \\"url\\": \\"https://aliyun.com\\",\\n \\"allow_failure\\": true,\\n \\"is_critical\\": true,\\n \\"wait_time_in_secs\\": 5,\\n \\"extracted_variables\\": {\\n \\"extracted_variables\\": [\\n {\\n \\"name\\": \\"test_variable\\",\\n \\"parser\\": {\\n \\"parser_type\\": \\"0\\",\\n \\"value\\": \\"x.testkey.arrayvalue[0].innerkey\\"\\n },\\n \\"field\\": \\"request_id\\",\\n \\"extracted_type\\": \\"1\\"\\n }\\n ]\\n },\\n \\"option\\": \\"{\\\\\\"enable_operator_dns\\\\\\": true}\\",\\n \\"step_name\\": \\"step1\\",\\n \\"use_generated_cookie\\": true,\\n \\"auto_extract_cookie\\": true\\n }\\n ]\\n },\\n \\"trace_region\\": \\"cn-hangzhou\\",\\n \\"trace_type\\": \\"OpenTelemetry\\",\\n \\"safe_link\\": 0,\\n \\"enable_packet_capture\\": true,\\n \\"use_private_crt\\": true,\\n \\"private_crt_file_name\\": \\"cert.pem\\",\\n \\"use_ssl\\": true,\\n \\"max_tls_version\\": \\"tlsv1.3\\",\\n \\"server_name\\": \\"www.aliyun.com\\",\\n \\"supported_cipher_suits\\": \\"TLS_AES_256_GCM_SHA384\\"\\n },\\n \\"TaskId\\": \\"cc641dff-c19d-45f3-ad0a-818a0c4f****\\",\\n \\"TaskName\\": \\"test123\\",\\n \\"TaskState\\": \\"1\\",\\n \\"TaskType\\": \\"HTTP\\",\\n \\"VpcConfig\\": {\\n \\"Region\\": \\"cn-beijing\\",\\n \\"SecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"VpcId\\": \\"vpc-xxxxxx\\",\\n \\"VswitchId\\": \\"vsw-xxxxxx\\"\\n }\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorAttributeResponse>\\r\\n\\t<MetricRules>\\r\\n\\t\\t<MetricRule>\\r\\n\\t\\t\\t<ComparisonOperator>GreaterThanYesterday</ComparisonOperator>\\r\\n\\t\\t\\t<RuleId>bf071ae_7b7aec3817b0fdf****</RuleId>\\r\\n\\t\\t\\t<Period>15s</Period>\\r\\n\\t\\t\\t<EvaluationCount>3</EvaluationCount>\\r\\n\\t\\t\\t<Dimensions>\\r\\n\\t\\t\\t\\t<taskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</taskId>\\r\\n\\t\\t\\t</Dimensions>\\r\\n\\t\\t\\t<Statistics>Availability</Statistics>\\r\\n\\t\\t\\t<Namespace>acs_networkmonitor</Namespace>\\r\\n\\t\\t\\t<AlarmActions>CloudMonitor</AlarmActions>\\r\\n\\t\\t\\t<MetricName>Availability</MetricName>\\r\\n\\t\\t\\t<OkActions>CloudMonitor</OkActions>\\r\\n\\t\\t\\t<Expression>$Availability=30</Expression>\\r\\n\\t\\t\\t<ActionEnable>true</ActionEnable>\\r\\n\\t\\t\\t<StateValue>OK</StateValue>\\r\\n\\t\\t\\t<Level>2</Level>\\r\\n\\t\\t\\t<RuleName>rule1</RuleName>\\r\\n\\t\\t\\t<Threshold>30</Threshold>\\r\\n\\t\\t</MetricRule>\\r\\n\\t</MetricRules>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>D17DF650-7EBD-54D0-903A-1D4E624D7402</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<SiteMonitors>\\r\\n\\t\\t<OptionJson>\\r\\n\\t\\t\\t<time_out>30000</time_out>\\r\\n\\t\\t\\t<http_method>get</http_method>\\r\\n\\t\\t</OptionJson>\\r\\n\\t\\t<TaskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</TaskId>\\r\\n\\t\\t<Address>https://aliyun.com</Address>\\r\\n\\t\\t<TaskName>test123</TaskName>\\r\\n\\t\\t<TaskType>HTTP</TaskType>\\r\\n\\t\\t<IspCities>\\r\\n\\t\\t\\t<IspCity>\\r\\n\\t\\t\\t\\t<IspName>阿里巴巴</IspName>\\r\\n\\t\\t\\t\\t<Isp>465</Isp>\\r\\n\\t\\t\\t\\t<CityName>北京市</CityName>\\r\\n\\t\\t\\t\\t<City>738</City>\\r\\n\\t\\t\\t</IspCity>\\r\\n\\t\\t</IspCities>\\r\\n\\t\\t<TaskState>1</TaskState>\\r\\n\\t\\t<Interval>1</Interval>\\r\\n\\t</SiteMonitors>\\r\\n</DescribeSiteMonitorAttributeResponse>\\t","errorExample":""}]', + 'title' => '查询站点监控任务的详细信息', + 'description' => '本文将提供一个示例,查询站点监控任务`cc641dff-c19d-45f3-ad0a-818a0c4f****`的详细信息,返回结果显示,站点监控任务的名称为`test123`、探测地址为`https://aliyun.com`、运营商为`阿里巴巴`等信息。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorISPCityList' => [ + 'summary' => '调用DescribeSiteMonitorISPCityList接口查询所有运营商探测点详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商探测点的名称或ID。'."\n" + ."\n" + .'> 运营商名称支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '联通', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商探测点所在城市的名称或ID。'."\n" + ."\n" + .'> 城市名称支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => '贵阳市', + ], + ], + [ + 'name' => 'IPV6', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询IPv6探针。取值:'."\n" + .'- true(默认值):查询IPv6探针。'."\n" + .'- false:不查询IPv6探针。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IPV4', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询IPv4探针。取值:'."\n" + .'- true(默认值):查询IPv4探针。'."\n" + .'- false:不查询IPv4探针。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ViewAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回所有探测点。取值:'."\n" + ."\n" + .'- true(默认值):返回所有探测点。'."\n" + .'- false:只返回可用探测点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B35D7D84-547B-4E61-B909-48A1F8A0C756', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'IspCityList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IspCity' => [ + 'description' => '探测点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '探测点列表。', + 'type' => 'object', + 'properties' => [ + 'CityName.en' => [ + 'description' => '城市名称(英文)。', + 'type' => 'string', + 'example' => 'Guiyang', + ], + 'IPV4ProbeCount' => [ + 'description' => 'IPv4探针数量。', + 'type' => 'string', + 'example' => '4', + ], + 'City' => [ + 'description' => '城市ID。', + 'type' => 'string', + 'example' => '4', + ], + 'Isp' => [ + 'description' => '运营商ID。', + 'type' => 'string', + 'example' => '232', + ], + 'CityName.zh_CN' => [ + 'description' => '城市名称(简体中文)。'."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '贵阳市', + ], + 'Region.zh_CN' => [ + 'description' => '省份(简体中文)。'."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '贵州省', + ], + 'IspName.zh_CN' => [ + 'description' => '运营商名称(简体中文)。'."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '联通', + ], + 'Country.en' => [ + 'description' => '国家(英文)。', + 'type' => 'string', + 'example' => 'China', + ], + 'IPV6ProbeCount' => [ + 'description' => 'IPv6探针数量。', + 'type' => 'string', + 'example' => '3', + ], + 'Region' => [ + 'description' => '省份代码。', + 'type' => 'string', + 'example' => '264', + ], + 'Country' => [ + 'description' => '国家代码。', + 'type' => 'string', + 'example' => '629', + ], + 'IspName.en' => [ + 'description' => '运营商名称(英文)。', + 'type' => 'string', + 'example' => 'China-Unicom', + ], + 'Region.en' => [ + 'description' => '省份(英文)。', + 'type' => 'string', + 'example' => 'Guizhou', + ], + 'Country.zh_CN' => [ + 'description' => '国家(简体中文)。'."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '中国', + ], + 'Area.zh_CN' => [ + 'description' => '区域(简体中文)。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '西南', + ], + 'Area.en' => [ + 'description' => '区域(汉语拼音)。', + 'type' => 'string', + 'example' => 'XiNan', + ], + 'IPPool' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'IPPool' => [ + 'description' => 'IP地址池。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址池。', + 'type' => 'string', + 'example' => '["192.68.XX.XX","192.68.XX.XX"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"B35D7D84-547B-4E61-B909-48A1F8A0C756\\",\\n \\"Success\\": \\"true\\",\\n \\"IspCityList\\": {\\n \\"IspCity\\": [\\n {\\n \\"CityName.en\\": \\"Guiyang\\",\\n \\"IPV4ProbeCount\\": \\"4\\",\\n \\"City\\": \\"4\\",\\n \\"Isp\\": \\"232\\",\\n \\"CityName.zh_CN\\": \\"贵阳市\\",\\n \\"Region.zh_CN\\": \\"贵州省\\",\\n \\"IspName.zh_CN\\": \\"联通\\",\\n \\"Country.en\\": \\"China\\",\\n \\"IPV6ProbeCount\\": \\"3\\",\\n \\"Region\\": \\"264\\",\\n \\"Country\\": \\"629\\",\\n \\"IspName.en\\": \\"China-Unicom\\",\\n \\"Region.en\\": \\"Guizhou\\",\\n \\"Country.zh_CN\\": \\"中国\\",\\n \\"Area.zh_CN\\": \\"西南\\",\\n \\"Area.en\\": \\"XiNan\\",\\n \\"IPPool\\": {\\n \\"IPPool\\": [\\n \\"[\\\\\\"192.68.XX.XX\\\\\\",\\\\\\"192.68.XX.XX\\\\\\"]\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorISPCityListResponse>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<RequestId>B35D7D84-547B-4E61-B909-48A1F8A0C756</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<IspCityList>\\r\\n\\t\\t<IspCity>\\r\\n\\t\\t\\t<Country.zh_CN>中国</Country.zh_CN>\\r\\n\\t\\t\\t<Area.zh_CN>西南</Area.zh_CN>\\r\\n\\t\\t\\t<CityName.en>Guiyang</CityName.en>\\r\\n\\t\\t\\t<IPV4ProbeCount>4</IPV4ProbeCount>\\r\\n\\t\\t\\t<Isp>232</Isp>\\r\\n\\t\\t\\t<City>4</City>\\r\\n\\t\\t\\t<IspName.en>China-Unicom</IspName.en>\\r\\n\\t\\t\\t<Country.en>China</Country.en>\\r\\n\\t\\t\\t<IPV6ProbeCount>0</IPV6ProbeCount>\\r\\n\\t\\t\\t<CityName.zh_CN>贵阳市</CityName.zh_CN>\\r\\n\\t\\t\\t<Area.en>XiNan</Area.en>\\r\\n\\t\\t\\t<Region.zh_CN>贵州省</Region.zh_CN>\\r\\n\\t\\t\\t<APIProbeCount>0</APIProbeCount>\\r\\n\\t\\t\\t<Region>264</Region>\\r\\n\\t\\t\\t<Country>629</Country>\\r\\n\\t\\t\\t<IspName.zh_CN>联通</IspName.zh_CN>\\r\\n\\t\\t\\t<Region.en>Guizhou</Region.en>\\r\\n\\t\\t\\t<IPPool>\\r\\n\\t\\t\\t\\t<IPPool>192.168.XX.XX</IPPool>\\r\\n\\t\\t\\t\\t<IPPool>192.168.XX.XX</IPPool>\\r\\n\\t\\t\\t</IPPool>\\r\\n\\t\\t</IspCity>\\r\\n\\t</IspCityList>\\r\\n</DescribeSiteMonitorISPCityListResponse>","errorExample":""}]', + 'title' => '查询所有运营商探测点详情', + 'description' => '本文将提供一个示例,查询运营商“联通”在“贵阳市”的探测点详情。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorData' => [ + 'summary' => '调用DescribeSiteMonitorData接口查询任务的细粒度监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '49f7b317-7645-4cc9-94fd-ea42e522****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '监控的数据类型。取值:'."\n" + .'- metric:时序类指标监控'."\n" + .'- event:事件类监控', + 'type' => 'string', + 'required' => false, + 'example' => 'metric', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的名称。取值:'."\n" + .'- Availability:可用率'."\n" + .'- ResponseTime:响应时间', + 'type' => 'string', + 'required' => true, + 'example' => 'Availability', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + ."\n" + .'- Format格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1551579637000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + ."\n" + .'- Format格式:YYYY-MM-DDThh:mm:ssZ。', + 'type' => 'string', + 'required' => false, + 'example' => '1551581437000', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '统计周期。单位:秒,取值为60或60的整数倍。'."\n" + .'>默认根据探测频率最小周期返回数据。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标。', + 'type' => 'string', + 'required' => false, + 'example' => '49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '返回的数据点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '分页游标。', + 'type' => 'string', + 'example' => 'ea42e5220930ea42e522****', + ], + 'Data' => [ + 'description' => '监控数据。', + 'type' => 'string', + 'example' => '[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3febb181-0d98-4af9-8b04-7faf36b048b9', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\"Maximum\\\\\\":247,\\\\\\"Mimimum\\\\\\":61,\\\\\\"Average\\\\\\":154,\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\",\\\\\\"taskId\\\\\\":\\\\\\"49f7b317-7645-4cc9-94fd-ea42e522****\\\\\\",\\\\\\"timestamp\\\\\\":1551581760000}]\\",\\n \\"NextToken\\": \\"ea42e5220930ea42e522****\\",\\n \\"RequestId\\": \\"3febb181-0d98-4af9-8b04-7faf36b048b9\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorData>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<Over5totalTime>0</Over5totalTime>\\r\\n\\t\\t\\t<Error4XXRate>0</Error4XXRate>\\r\\n\\t\\t\\t<UnavailableNumber>0</UnavailableNumber>\\r\\n\\t\\t\\t<Over2totalTime>0</Over2totalTime>\\r\\n\\t\\t\\t<timestamp>1551581040000</timestamp>\\r\\n\\t\\t\\t<Over100FailureRate>0</Over100FailureRate>\\r\\n\\t\\t\\t<Over10FailureRate>0</Over10FailureRate>\\r\\n\\t\\t\\t<Availability>100</Availability>\\r\\n\\t\\t\\t<Over80FailureRate>0</Over80FailureRate>\\r\\n\\t\\t\\t<userId>123****</userId>\\r\\n\\t\\t\\t<AvailableNumber>2</AvailableNumber>\\r\\n\\t\\t\\t<Unavailability>0</Unavailability>\\r\\n\\t\\t\\t<ErrorCodeMaximum>0</ErrorCodeMaximum>\\r\\n\\t\\t\\t<Over10totalTime>0</Over10totalTime>\\r\\n\\t\\t\\t<taskId>49f7b317-7645-4cc9-94fd-1****</taskId>\\r\\n\\t\\t\\t<Over30FailureRate>0</Over30FailureRate>\\r\\n\\t\\t\\t<Error6XXRate>0</Error6XXRate>\\r\\n\\t\\t\\t<Over500NumberRate>0</Over500NumberRate>\\r\\n\\t\\t\\t<Over3totalTime>0</Over3totalTime>\\r\\n\\t\\t\\t<Over400NumberRate>0</Over400NumberRate>\\r\\n\\t\\t\\t<Error5XXRate>0</Error5XXRate>\\r\\n\\t\\t\\t<Error5XXNumber>0</Error5XXNumber>\\r\\n\\t\\t\\t<Over90FailureRate>0</Over90FailureRate>\\r\\n\\t\\t\\t<Error4XXNumber>0</Error4XXNumber>\\r\\n\\t\\t\\t<Over50FailureRate>0</Over50FailureRate>\\r\\n\\t\\t\\t<ErrorCodeMinimum>0</ErrorCodeMinimum>\\r\\n\\t\\t\\t<Error6XXNumber>0</Error6XXNumber>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<Data>\\r\\n\\t\\t\\t<Over5totalTime>0</Over5totalTime>\\r\\n\\t\\t\\t<Error4XXRate>0</Error4XXRate>\\r\\n\\t\\t\\t<UnavailableNumber>0</UnavailableNumber>\\r\\n\\t\\t\\t<Over2totalTime>0</Over2totalTime>\\r\\n\\t\\t\\t<timestamp>1551581100000</timestamp>\\r\\n\\t\\t\\t<Over100FailureRate>0</Over100FailureRate>\\r\\n\\t\\t\\t<Over10FailureRate>0</Over10FailureRate>\\r\\n\\t\\t\\t<Availability>100</Availability>\\r\\n\\t\\t\\t<Over80FailureRate>0</Over80FailureRate>\\r\\n\\t\\t\\t<userId>12345</userId>\\r\\n\\t\\t\\t<AvailableNumber>2</AvailableNumber>\\r\\n\\t\\t\\t<Unavailability>0</Unavailability>\\r\\n\\t\\t\\t<ErrorCodeMaximum>0</ErrorCodeMaximum>\\r\\n\\t\\t\\t<Over10totalTime>0</Over10totalTime>\\r\\n\\t\\t\\t<taskId>49f7b317-7645-4cc9-94fd-1****</taskId>\\r\\n\\t\\t\\t<Over30FailureRate>0</Over30FailureRate>\\r\\n\\t\\t\\t<Error6XXRate>0</Error6XXRate>\\r\\n\\t\\t\\t<Over500NumberRate>0</Over500NumberRate>\\r\\n\\t\\t\\t<Over3totalTime>0</Over3totalTime>\\r\\n\\t\\t\\t<Over400NumberRate>0</Over400NumberRate>\\r\\n\\t\\t\\t<Error5XXRate>0</Error5XXRate>\\r\\n\\t\\t\\t<Error5XXNumber>0</Error5XXNumber>\\r\\n\\t\\t\\t<Over90FailureRate>0</Over90FailureRate>\\r\\n\\t\\t\\t<Error4XXNumber>0</Error4XXNumber>\\r\\n\\t\\t\\t<Over50FailureRate>0</Over50FailureRate>\\r\\n\\t\\t\\t<ErrorCodeMinimum>0</ErrorCodeMinimum>\\r\\n\\t\\t\\t<Error6XXNumber>0</Error6XXNumber>\\r\\n\\t\\t</Data>\\r\\n\\t\\t<RequestId>DBDEAC51-EA3C-4853-8F25-6B48D38A28A9</RequestId>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<Code>200</Code>\\r\\n</DescribeSiteMonitorData>","errorExample":""}]', + 'title' => '查询任务的细粒度监控数据', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' 返回结果是一个JSON字符串,描述信息如下:'."\n" + ."\n" + .'- Error4XXRate:4XX错误占比'."\n" + .'- Error6XXRate:6xx错误占比'."\n" + .'- Error5XXRate:5xx错误占比'."\n" + .'- Error4XXNumber:4xx错误探针的数量'."\n" + .'- Error5XXNumber:5xx错误探针的数量'."\n" + .'- Error6XXNumber:6xx错误探针数量'."\n" + .'- Over5totalTime:响应时间超过5000毫秒的占比'."\n" + .'- Over3totalTime:响应时间超过3000毫秒的占比'."\n" + .'- Over2totalTime:响应时间超过2000毫秒的占比'."\n" + .'- Over10FailureRate:错误大于10%所占的比例'."\n" + .'- Over100FailureRate:错误大于99%所占的比例'."\n" + .'- Over30FailureRate:错误大于30%所占的比例'."\n" + .'- Over50FailureRate:错误大于50%所占的比例'."\n" + .'- Over80FailureRate:错误大于80%所占的比例'."\n" + .'- Over90FailureRate:错误大于90%所占的比例'."\n" + .'- Over400NumberRate:超过4XX错误所占的比例'."\n" + .'- Over500NumberRate:超过5XX错误所占的比例'."\n" + .'- AvailableNumber:可用探针数量'."\n" + .'- UnavailableNumber:不可用探测点数量'."\n" + .'- Availability:可用率'."\n" + .'- Unavailability:不可用率'."\n" + .'- ErrorCodeMaximum:最大错误码,例如:1分钟内5个探测点有4个是200, 1个是404, 那么最大错误码就是404'."\n" + .'- ErrorCodeMinimum:最小错误码, 例如:1分钟内5个探测点有4个是200, 1个是404, 那么最小错误码就是200'."\n" + ."\n" + .'> 建议您使用AvailableNumber、UnavailableNumber、Availability、Unavailability、ErrorCodeMaximum或ErrorCodeMinimum,其他计算方式较繁琐。', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorStatistics' => [ + 'summary' => '调用DescribeSiteMonitorStatistics接口查询指定站点监控任务中指定监控项的平均统计数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控任务ID。'."\n" + ."\n" + .'关于如何获取站点监控任务ID,请参见[DescribeSiteMonitorList](~~115052~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ef4cdc8b-9dc7-43e7-810e-f950e56c****', + ], + ], + [ + 'name' => 'TimeRange', + 'in' => 'query', + 'schema' => [ + 'description' => '统计周期。'."\n" + ."\n\n" + .'单位:分钟。默认值:1440(1天)。最大值:43200(30天)。', + 'type' => 'string', + 'required' => false, + 'example' => '1440', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳。'."\n" + ."\n" + .'单位:毫秒。默认值为当前时间向前推1小时。', + 'type' => 'string', + 'required' => false, + 'example' => '1576142850527', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。取值:'."\n" + ."\n" + .'- Availability:可用率。'."\n" + .'- ErrorRate:错误率。'."\n" + .'- ResponseTime:响应时间。', + 'type' => 'string', + 'required' => true, + 'example' => 'Availability', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Successful', + ], + 'Data' => [ + 'description' => '统计结果。', + 'type' => 'string', + 'example' => '100', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3AD2724D-E317-4BFB-B422-D6691D071BE1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + [ + 'errorCode' => 'InvalidClientTokenId', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"100\\",\\n \\"RequestId\\": \\"3AD2724D-E317-4BFB-B422-D6691D071BE1\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorStatisticsResponse>\\n\\t<Message>successful</Message>\\n\\t<RequestId>3AD2724D-E317-4BFB-B422-D6691D071BE1</RequestId>\\n\\t<Data>100</Data>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeSiteMonitorStatisticsResponse>\\t","errorExample":""}]', + 'title' => '查询指定站点监控任务中指定监控项的平均统计数据', + 'description' => '本文将提供一个示例,查询站点监控任务`ef4cdc8b-9dc7-43e7-810e-f950e56c****`中监控项`Availability`(可用率)的平均统计数据。返回结果显示可用率为`100`。'."\n" + ."\n\n", + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorList' => [ + 'summary' => '调用DescribeSiteMonitorList接口查询站点监控任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a1ecd34a-8157-44d9-b060-14950837****', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '站点监控任务探测类型。云监控支持的探测类型包括:HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP。', + 'type' => 'string', + 'required' => false, + 'example' => 'HTTP', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '查询站点监控任务的关键字。'."\n" + ."\n" + .'> 支持根据任务名称或任务地址模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'site', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TaskState', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态。取值:'."\n" + ."\n" + .'- 1:正常。'."\n" + ."\n" + .'- 2:禁用。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '任务使用的节点类型。取值:'."\n" + ."\n" + .'- PC:PC端探测点。'."\n" + ."\n" + .'- MOBILE:移动端探测点。'."\n" + ."\n" + .'- FC:内网探测点', + 'type' => 'string', + 'required' => false, + 'example' => 'PC', + 'enum' => [ + 'PC', + 'MOBILE', + 'FC', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SiteMonitors' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SiteMonitor' => [ + 'description' => '站点监控任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '站点监控任务探测类型。云监控支持的探测类型包括:HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'UpdateTime' => [ + 'description' => '站点监控任务更新时间。', + 'type' => 'string', + 'example' => '2022-03-08 17:14:31', + ], + 'Interval' => [ + 'description' => '探测频率。单位:分钟。', + 'type' => 'string', + 'example' => '1', + ], + 'TaskState' => [ + 'description' => '任务状态。取值:'."\n" + ."\n" + .'- 1:正常。'."\n" + ."\n" + .'- 2:禁用。', + 'type' => 'string', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => '任务的创建时间。', + 'type' => 'string', + 'example' => '2021-11-01 11:05:18', + ], + 'TaskName' => [ + 'description' => '站点监控任务名称。', + 'type' => 'string', + 'example' => '新的探测任务', + ], + 'Address' => [ + 'description' => '任务的探测URL地址或IP地址。', + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'TaskId' => [ + 'description' => '站点监控任务ID。', + 'type' => 'string', + 'example' => 'f5783760-1b39-4b6b-80e8-453d962a****', + ], + 'OptionsJson' => [ + 'description' => '扩展选项。每一种探测类型有不同的扩展类型,详情请参见[CreateSiteMonitor](~~115048~~)。', + 'type' => 'object', + 'properties' => [ + 'password' => [ + 'description' => 'SMTP、POP3或FTP探测类型的密码。', + 'type' => 'string', + 'example' => '123****', + ], + 'request_format' => [ + 'description' => 'HTTP请求内容格式。取值:'."\n" + .'- hex:十六进制格式。'."\n" + .'- txt:文本格式。', + 'type' => 'string', + 'example' => 'hex', + ], + 'response_content' => [ + 'description' => '匹配响应内容。'."\n" + .'- 十六进制格式:当请求的内容是字节串,且无法用可见字符表达时,可以将字节串转换为十六进制表示的可见字符串形式。具体转换规则为:一个字节转换成二字节的十六进制字符,例如:1字节(1B)转换成十六进制为`01`, 27字节(27B)转换成十六进制为`1B`。二进制数组(Java形式)为`{(byte)1, (byte)27}`,转换成十六进制为`011b`或`011B`。站点监控对十六进制不区分大小写。将字符串`011B`填入请求内容中,同时请求内容格式选择十六进制格式。'."\n" + ."\n" + .'- 文本格式:普通文本指字符串,即由可见字符组成的字符串。', + 'type' => 'string', + 'example' => 'cf0f85', + ], + 'failure_rate' => [ + 'description' => '丢包率。'."\n" + ."\n" + .'> 该参数仅适用于PING探测类型。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'time_out' => [ + 'description' => '超时时间。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'header' => [ + 'description' => 'HTTP请求头。格式为`key1:value1`,通过回车键换行。', + 'type' => 'string', + 'example' => 'testKey:testValue', + ], + 'cookie' => [ + 'description' => '发送HTTP请求的Cookie文本。', + 'type' => 'string', + 'example' => 'lang=en', + ], + 'port' => [ + 'description' => 'TCP、UDP、SMTP或POP3探测类型的端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'ping_num' => [ + 'description' => 'PING探测的次数设置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'authentication' => [ + 'description' => '是否开启安全验证。取值:'."\n" + .'- 0:开启。'."\n" + .'- 1:关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'http_method' => [ + 'description' => 'HTTP的请求方法。取值:'."\n" + .'- get '."\n" + .'- post'."\n" + .'- head', + 'type' => 'string', + 'example' => 'get', + ], + 'match_rule' => [ + 'description' => '是否包含报警规则。取值:'."\n" + .'- 0:包含。'."\n" + .'- 1:不包含。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'dns_match_rule' => [ + 'description' => 'DNS的匹配规则。取值:'."\n" + ."\n" + .'- IN_DNS:期望解析的别名或IP地址均在DNS应答中。'."\n" + .'- DNS_IN:所有的DNS应答都出现在期望解析的别名或IP地址中。'."\n" + .'- EQUAL:DNS应答和期望解析的别名或IP地址完全相同。'."\n" + .'- ANY:DNS应答和期望解析的别名或IP地址有交集。', + 'type' => 'string', + 'example' => 'IN_DNS', + ], + 'request_content' => [ + 'description' => 'HTTP探测请求内容。', + 'type' => 'string', + 'example' => 'cf0f85', + ], + 'username' => [ + 'description' => 'FTP、SMTP或POP3的用户名。', + 'type' => 'string', + 'example' => 'testUser', + ], + 'response_format' => [ + 'description' => 'HTTP响应内容格式。取值:'."\n" + .'- hex:十六进制格式。'."\n" + .'- txt:文本格式。', + 'type' => 'string', + 'example' => 'hex', + ], + 'dns_type' => [ + 'description' => 'DNS解析类型。仅适用于DNS探测类型。取值:'."\n" + .'- A(默认值):指定主机名或域名对应的IP地址。'."\n" + .'- CNAME:将多个域名映射到另外一个域名。'."\n" + .'- NS:指定域名由某个DNS服务器解析。'."\n" + .'- MX:将域名指向一个邮件服务器地址。'."\n" + .'- TXT:主机名或域名的说明。文本长度限制512字节,通常用做SPF(Sender Policy Framework)记录,即反垃圾邮件。'."\n" + .'- AAAA:将域名解析到IPv6地址的DNS记录。', + 'type' => 'string', + 'example' => 'A', + ], + 'dns_server' => [ + 'description' => '指定DNS解析服务器的域名或IP地址。'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'enable_operator_dns' => [ + 'description' => '是否使用运营商的DNS。'."\n" + .'- true(默认值):使用运营商的DNS。'."\n" + .'- false:不使用运营商的DNS。使用默认DNS或指定服务器的DNS。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'attempts' => [ + 'description' => 'DNS失败后重试次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'protocol' => [ + 'description' => 'DNS探测协议类型。取值:'."\n" + .'- udp(默认值)'."\n" + .'- tcp'."\n" + .'- tcp-tls', + 'type' => 'string', + 'example' => 'udp', + ], + 'proxy_protocol' => [ + 'description' => '是否开启ProxyProtocol。取值:'."\n" + .'- false(默认值):不开启ProxyProtocol。'."\n" + .'- true:开启ProxyProtocol。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'acceptable_response_code' => [ + 'description' => '可接受的状态码。 '."\n" + ."\n" + .'> 建议您使用断言配置。', + 'type' => 'string', + 'example' => '400', + ], + 'isBase64Encode' => [ + 'description' => '是否对密码进行base64解码存储。取值:'."\n" + .'- true:对密码进行base64解码存储。'."\n" + .'- false(默认值):不对密码进行base64解码存储。', + 'type' => 'string', + 'example' => 'false', + ], + 'cert_verify' => [ + 'description' => '是否验证证书。取值:'."\n" + .'- false(默认值):忽略证书验证。'."\n" + .'- true:证书验证。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'unfollow_redirect' => [ + 'description' => '如果出现301或302状态码,是否跟随再次做重定向探测。取值:'."\n" + .'- true:不跟随跳转。'."\n" + .'- false(默认值):跟随跳转。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'diagnosis_mtr' => [ + 'description' => '是否开启任务失败后的自动MTR网络诊断。取值:'."\n" + .'- false(默认值):不开启自动MTR网络诊断。'."\n" + .'- true 开启自动MTR网络诊断。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'diagnosis_ping' => [ + 'description' => '是否开启探测任务失败后自动Ping网络延时探测。取值:'."\n" + .'- false(默认值):不开启。'."\n" + .'- true:开启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'retry_delay' => [ + 'description' => '探测失败后重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'assertions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'assertions' => [ + 'description' => '断言配置组。', + 'type' => 'array', + 'items' => [ + 'description' => '断言配置组。', + 'type' => 'object', + 'properties' => [ + 'property' => [ + 'description' => '断言内容解析路径。'."\n" + ."\n" + .'- 如果断言类型为`body_json`,则路径为`json path`。'."\n" + ."\n" + .'- 如果断言类型是`body_xml`,则路径为`xml path`。'."\n", + 'type' => 'string', + 'example' => 'json path', + ], + 'type' => [ + 'description' => '断言类型。取值:'."\n" + .'- response_time:判定响应时间是否符合预期。'."\n" + .'- status_code:判断HTTP响应状态码是否符合预期。'."\n" + .'- header:判定响应Header中的字段是否符合预期。'."\n" + .'- body_text:通过文本字符匹配判断返回Body中的内容是否符合预期。'."\n" + .'- body_json:通过JSON解析(JSON Path)判断返回Body中的内容是否符合预期。'."\n" + .'- body_xml:通过XML解析(XPath)判断返回Body中的内容是否符合预期。', + 'type' => 'string', + 'example' => 'response_time', + ], + 'operator' => [ + 'description' => '断言比较操作符。取值:'."\n" + .'- contains:包含。'."\n" + .'- doesNotContain:不包含。'."\n" + .'- matches:正则匹配。'."\n" + .'- doesNotMatch:正则不匹配。'."\n" + .'- is:数值等于或字符匹配相等。'."\n" + .'- isNot:不等于。'."\n" + .'- lessThan:小于。'."\n" + .'- moreThan:大于。', + 'type' => 'string', + 'example' => 'lessThan', + ], + 'target' => [ + 'description' => '断言匹配比较的目标数值或字符。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + ], + ], + 'AgentGroup' => [ + 'description' => '探针类型。取值:'."\n" + ."\n" + .'- PC:PC端。'."\n" + .'- MOBILE:移动端。', + 'type' => 'string', + 'example' => 'PC', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"SiteMonitors\\": {\\n \\"SiteMonitor\\": [\\n {\\n \\"TaskType\\": \\"TCP\\",\\n \\"UpdateTime\\": \\"2022-03-08 17:14:31\\",\\n \\"Interval\\": \\"1\\",\\n \\"TaskState\\": \\"1\\",\\n \\"CreateTime\\": \\"2021-11-01 11:05:18\\",\\n \\"TaskName\\": \\"新的探测任务\\",\\n \\"Address\\": \\"https://aliyun.com\\",\\n \\"TaskId\\": \\"f5783760-1b39-4b6b-80e8-453d962a****\\",\\n \\"OptionsJson\\": {\\n \\"password\\": \\"123****\\",\\n \\"request_format\\": \\"hex\\",\\n \\"response_content\\": \\"cf0f85\\",\\n \\"failure_rate\\": 0.5,\\n \\"time_out\\": 3000,\\n \\"header\\": \\"testKey:testValue\\",\\n \\"cookie\\": \\"lang=en\\",\\n \\"port\\": 80,\\n \\"ping_num\\": 20,\\n \\"authentication\\": 1,\\n \\"http_method\\": \\"get\\",\\n \\"match_rule\\": 0,\\n \\"dns_match_rule\\": \\"IN_DNS\\",\\n \\"request_content\\": \\"cf0f85\\",\\n \\"username\\": \\"testUser\\",\\n \\"response_format\\": \\"hex\\",\\n \\"dns_type\\": \\"A\\",\\n \\"dns_server\\": \\"192.168.XX.XX\\",\\n \\"enable_operator_dns\\": true,\\n \\"attempts\\": 3,\\n \\"protocol\\": \\"udp\\",\\n \\"proxy_protocol\\": false,\\n \\"acceptable_response_code\\": \\"400\\",\\n \\"isBase64Encode\\": \\"false\\",\\n \\"cert_verify\\": false,\\n \\"unfollow_redirect\\": false,\\n \\"diagnosis_mtr\\": false,\\n \\"diagnosis_ping\\": false,\\n \\"retry_delay\\": 1,\\n \\"assertions\\": {\\n \\"assertions\\": [\\n {\\n \\"property\\": \\"json path\\",\\n \\"type\\": \\"response_time\\",\\n \\"operator\\": \\"lessThan\\",\\n \\"target\\": \\"1000\\"\\n }\\n ]\\n }\\n },\\n \\"AgentGroup\\": \\"PC\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSiteMonitorListResponse>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<RequestId>A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B</RequestId>\\r\\n\\t<Message>successful</Message>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<SiteMonitors>\\r\\n\\t\\t<SiteMonitor>\\r\\n\\t\\t\\t<TaskId>f5783760-1b39-4b6b-80e8-453d962a****</TaskId>\\r\\n\\t\\t\\t<Address>https://aliyun.com</Address>\\r\\n\\t\\t\\t<EndTime></EndTime>\\r\\n\\t\\t\\t<TaskName>test123</TaskName>\\r\\n\\t\\t\\t<OptionsJson>\\r\\n\\t\\t\\t\\t<response_content></response_content>\\r\\n\\t\\t\\t\\t<request_format>hex</request_format>\\r\\n\\t\\t\\t\\t<response_format>hex</response_format>\\r\\n\\t\\t\\t\\t<request_content>cf0f85</request_content>\\r\\n\\t\\t\\t\\t<port>80</port>\\r\\n\\t\\t\\t</OptionsJson>\\r\\n\\t\\t\\t<TaskType>TCP</TaskType>\\r\\n\\t\\t\\t<CreateTime>2021-11-01 11:05:18</CreateTime>\\r\\n\\t\\t\\t<UpdateTime>2022-03-08 17:14:31</UpdateTime>\\r\\n\\t\\t\\t<TaskState>1</TaskState>\\r\\n\\t\\t\\t<Interval>1</Interval>\\r\\n\\t\\t</SiteMonitor>\\r\\n\\t</SiteMonitors>\\r\\n</DescribeSiteMonitorListResponse>\\t","errorExample":""}]', + 'title' => '查询站点监控任务列表', + 'description' => '本文将提供一个示例,查询当前账号的站点监控任务列表。返回结果显示,当前账号存在一条站点监控记录`HanZhou_ECS2`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeSiteMonitorLog' => [ + 'summary' => '调用DescribeSiteMonitorLog接口查询一次性探测任务的探测日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'schema' => [ + 'description' => '探测任务ID。多个探测任务ID之间用半角逗号(,)分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'afa5c3ce-f944-4363-9edb-ce919a29****', + ], + ], + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商标识码。', + 'type' => 'string', + 'required' => false, + 'example' => '465', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => '城市标识码。', + 'type' => 'string', + 'required' => false, + 'example' => '546', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项。'."\n" + ."\n" + .'目前仅支持监控项`ProbeLog`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ProbeLog', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。支持的格式:'."\n" + ."\n" + .'- UNIX时间戳:从1970年01月01日开始所经过的毫秒数。'."\n" + .'- UTC格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> - 开始时间和结束时间遵循左开右闭模式,StartTime不能等于或大于EndTime。 '."\n" + .' - 建议您使用UNIX时间戳,避免时区问题。', + 'type' => 'string', + 'required' => false, + 'example' => '1638422474389', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。支持的格式:'."\n" + ."\n" + .'- UNIX时间戳:从1970年01月01日开始所经过的毫秒数。'."\n" + .'- UTC格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> 建议您使用UNIX时间戳,避免时区问题。', + 'type' => 'string', + 'required' => false, + 'example' => '1638422475687', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '当请求的返回结果被截断时,您可以使用`NextToken`再次发起请求,获取从当前截断位置之后的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'IWBjqMYSy0is7zSMGu16****', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数,用于分页查询。取值范围:1~1440。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤探测值。'."\n" + ."\n" + .'支持简单的表达式,例如:`TotalTime>100`,表示过滤出总响应时间超过100毫秒的探测数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'TotalTime>100', + ], + ], + [ + 'name' => 'BrowserInfo', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'Browser', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '浏览器类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + ' Chrome' => ' Chrome', + 'Safari' => 'Safari', + 'Edge' => 'Edge', + 'Firefox' => 'Firefox', + ], + 'example' => 'Chrome', + ], + ], + [ + 'name' => 'Device', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '设备类型(模拟屏幕大小类型)。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'tablet' => 'tablet', + 'mobile' => 'mobile', + 'laptop' => 'laptop', + ], + 'example' => 'laptop', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '查询下一页使用的Token。', + 'type' => 'string', + 'example' => 'IWBjqMYSy0is7zSMGu16****', + ], + 'Data' => [ + 'description' => '一次性探测任务的探测日志。', + 'type' => 'string', + 'example' => '[{\\"redirectCount\\":0.0,\\"SSLConnectTime\\":0.0,\\"pingDetail\\":\\"\\",\\"HTTPConnectTime\\":0.0,\\"isp\\":\\"465\\",\\"errorCode\\":611,\\"ispCN\\":\\"阿里巴巴\\",\\"resolution\\":\\"\\",\\"areaEN\\":\\"HuaBei\\",\\"taskEndTimestamp\\":1638422475687,\\"targetIspEN\\":\\"\\",\\"TotalTime\\":1.0,\\"taskStartTimestamp\\":1638422474389,\\"countryCN\\":\\"中国\\",\\"provinceEN\\":\\"Beijing\\",\\"countryEN\\":\\"China\\",\\"targetCityEN\\":\\"\\",\\"curlConnectTime\\":0.0,\\"ips\\":\\"\\",\\"route\\":\\"\\",\\"tcpConnectTime\\":0.0,\\"cityEN\\":\\"Beijing\\",\\"HTTPDownloadSpeed\\":0.0,\\"HTTPDownloadTime\\":0.0,\\"HTTPResponseCode\\":0.0,\\"areaCN\\":\\"华北\\",\\"city\\":\\"546\\",\\"expection\\":\\"\\",\\"suorceIp\\":\\"192.168.XX.XX \\",\\"ispEN\\":\\"Alibaba\\",\\"HTTPDNSTime\\":1.0,\\"targetIsp\\":\\"\\",\\"curlStarttransferTime\\":0.0,\\"provinceCN\\":\\"北京市\\",\\"timestamp\\":1638422474000,\\"redirectTime\\":0.0,\\"targetCity\\":\\"\\", \\"expect\\":\\"\\",\\"HTTPDownloadSize\\":0.0,\\"localDns\\":\\"192.168.XX.XX\\",\\"cityCN\\":\\"北京市\\",\\"taskId\\":\\"afa5c3ce-f944-4363-9edb-ce919a29****\\"}]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '67F646FA-ED8A-58C2-B461-451DB52C8B14', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"IWBjqMYSy0is7zSMGu16****\\",\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"redirectCount\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"SSLConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"pingDetail\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"isp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"465\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":611,\\\\\\\\\\\\\\"ispCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"阿里巴巴\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"resolution\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"areaEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HuaBei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskEndTimestamp\\\\\\\\\\\\\\":1638422475687,\\\\\\\\\\\\\\"targetIspEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"TotalTime\\\\\\\\\\\\\\":1.0,\\\\\\\\\\\\\\"taskStartTimestamp\\\\\\\\\\\\\\":1638422474389,\\\\\\\\\\\\\\"countryCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"中国\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"provinceEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"countryEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"China\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetCityEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"curlConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"ips\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"route\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tcpConnectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"cityEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Beijing\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDownloadSpeed\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"HTTPDownloadTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"HTTPResponseCode\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"areaCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"华北\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"city\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"546\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"expection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"suorceIp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.XX.XX \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ispEN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Alibaba\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDNSTime\\\\\\\\\\\\\\":1.0,\\\\\\\\\\\\\\"targetIsp\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"curlStarttransferTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"provinceCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1638422474000,\\\\\\\\\\\\\\"redirectTime\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"targetCity\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"expect\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"HTTPDownloadSize\\\\\\\\\\\\\\":0.0,\\\\\\\\\\\\\\"localDns\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.XX.XX\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cityCN\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"北京市\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"afa5c3ce-f944-4363-9edb-ce919a29****\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"67F646FA-ED8A-58C2-B461-451DB52C8B14\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + 'title' => '查询一次性探测任务的探测日志', + 'description' => '仅开通网络分析与监控的阿里云账号,才能创建一次性探测任务。'."\n" + ."\n" + .'本文将提供一个示例,查询一次性探测任务`afa5c3ce-f944-4363-9edb-ce919a29****`的探测日志。', + ], + 'DescribeMetricLast' => [ + 'summary' => '调用DescribeMetricLast接口查询指定监控项的最新监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于监控项名称,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'取值:15、60、900和3600。'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'> - 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。'."\n" + .' - 每个云产品的监控项(`MetricName`)的统计周期不同。更多信息,请参见[云产品监控项](~~163515~~)中目标云产品**指标列表**页面中的`Min Periods`列。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控项的结束时间。'."\n" + ."\n" + .'- 对于秒级数据,查询数据的起始时间是EndTime往前倒推20分钟后与startTime对比的最大值。'."\n" + ."\n" + .'- 对于分钟级数据,查询数据的起始时间是EndTime往前倒推2小时后与startTime对比的最大值。'."\n" + ."\n" + .'- 对于小时级数据,查询数据的起始时间是EndTime往前倒推2天后与startTime对比的最大值。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-31 10:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。'."\n" + ."\n\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标的标识。'."\n" + ."\n" + .'- 如果匹配查询条件的返回结果超过了分页大小,则会返回这个分页游标。'."\n" + .'- 如果需要获取下一页数据,将返回的游标值作为请求参数即可,直到无游标值返回,表示已经获取了全部数据。', + 'type' => 'string', + 'required' => false, + 'example' => '15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '返回监控数据的每页大小,用于分页查询。'."\n" + ."\n" + .'默认值:1000,即每页1000条监控数据。'."\n" + ."\n" + .'> 单次请求Length的最大值为1440。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对现有查询结果进行实时计算的表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"groupby":["userId","instanceId"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '分页游标标识。', + 'type' => 'string', + 'example' => 'xxxxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '021472A6-25E3-4094-8D00-BA4B6A5486C3', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{"timestamp":1548777660000,"userId":"123456789876****","instanceId":"i-abcdefgh12****","Minimum":93.1,"Average":99.52,"Maximum":100}]', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'Period' => [ + 'description' => '时间间隔。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"xxxxxx\\",\\n \\"RequestId\\": \\"021472A6-25E3-4094-8D00-BA4B6A5486C3\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"123456789876****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abcdefgh12****\\\\\\",\\\\\\"Minimum\\\\\\":93.1,\\\\\\"Average\\\\\\":99.52,\\\\\\"Maximum\\\\\\":100}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMetricListResponse>\\r\\n\\t<Period>60</Period>\\r\\n\\t<Datapoints>\\r\\n\\t\\t<timestamp>1548777660000</timestamp>\\r\\n\\t\\t<Maximum>100</Maximum>\\r\\n\\t\\t<userId>123456789876****</userId>\\r\\n\\t\\t<Minimum>93.1</Minimum>\\r\\n\\t\\t<instanceId>i-abcdefgh12****</instanceId>\\r\\n\\t\\t<Average>99.52</Average>\\r\\n\\t</Datapoints>\\r\\n\\t<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</QueryMetricListResponse>","errorExample":""}]', + 'title' => '查询指定监控项的最新监控数据', + 'description' => '### 使用限制'."\n" + .'- 调用DescribeMetricLast、DescribeMetricList、DescribeMetricData和DescribeMetricTop的接口,有100万次/月免费额度(总计),当免费额度用完且您没有开通基础云监控按量计费时,将无法正常使用该API。如果您已开通基础云监控的按量计费,当免费调用额度用完时,该API仍然可以正常使用,超出免费额度部分将自动按使用量计费。开通方法详见[开通按量计费](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG&commodityCode=cms_basic_public_cn&from_biz_channel=help_bill)。'."\n" + .'- 单个API的调用次数限制为50次/秒,即一个阿里云账号及该账号下的RAM用户共用50次/秒。'."\n" + ."\n" + .'> 当您调用API时,如果返回信息`Throttling.User`或`Request was denied due to user flow control`,则说明该API被限流。处理方法,请参见[如何处理查询API限流问题](~~2615031~~)。'."\n" + .'### 注意事项'."\n" + .'各云产品监控数据的存储时长与`Period`(统计周期)有关,`Period`越大,查询的监控数据越稀疏,监控数据的存储时间越长,具体关系如下:'."\n" + .'- `Period`小于60秒,存储时长为7天。'."\n" + .'- `Period`等于60秒,存储时长为31天。'."\n" + .'- `Period`大于等于300秒,存储时长为91天。'."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,查询云产品`acs_ecs_dashboard`监控项`CPUUtilization`的最新监控数据。返回结果显示,当前账号`123456789876****`下实例`i-abcdefgh12****`间隔60秒的最大值为100、最小值为93.1、平均值为99.52。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。 ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetricList' => [ + 'summary' => '调用 DescribeMetricList 接口查询指定云产品的指定监控项的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于监控项名称,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'取值:15、60、900和3600。'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'> - 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。'."\n" + .'- 每个云产品的监控项(`MetricName`)的统计周期不同。更多信息,请参见[云产品监控项](~~163515~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + .'- Format格式:YYYY-MM-DD hh:mm:ss。 '."\n" + ."\n" + .'> - 开始和结束时间执行的是左开右闭的模式,StartTime不能等于或大于EndTime。'."\n" + .'- StartTime和EndTime之间的间隔小于等于31天。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + .'- Format格式:YYYY-MM-DD hh:mm:ss。 '."\n" + ."\n" + .'> StartTime和EndTime之间的间隔小于等于31天。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-30 00:10:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标标识。'."\n" + ."\n\n" + .'>如果不设置该参数,则表示获取第一页的数据。当该参数有返回值时,说明还有下一页,您可以将返回的NextToken作为参数再次请求获得下一页的数据,直到返回为Null为止,表示获取到了所有的数据。', + 'type' => 'string', + 'required' => false, + 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数,用于分页查询。'."\n" + ."\n" + .'> 单次请求Length的最大值为1440。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '查询出的现有结果进行实时计算的表达式。'."\n" + ."\n" + .'> 目前仅支持groupby,类似数据库的groupby语句。', + 'type' => 'string', + 'required' => false, + 'example' => '{"groupby":["userId","instanceId"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '分页游标标识。', + 'type' => 'string', + 'example' => '15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'Period' => [ + 'description' => '时间间隔。单位:秒。取值:60、300、900。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\\\\\\"timestamp\\\\\\":1548777660000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-abc\\\\\\",\\\\\\"Minimum\\\\\\":9.92,\\\\\\"Average\\\\\\":9.92,\\\\\\"Maximum\\\\\\":9.92}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricListResponse>\\r\\n\\t<Period>60</Period>\\r\\n\\t<Datapoints>\\r\\n\\t\\t<timestamp>1490152860000</timestamp>\\r\\n\\t\\t<Maximum>100</Maximum>\\r\\n\\t\\t<userId>120886317861****</userId>\\r\\n\\t\\t<Minimum>93.1</Minimum>\\r\\n\\t\\t<instanceId>i-abcdefgh12****</instanceId>\\r\\n\\t\\t<Average>99.52</Average>\\r\\n\\t</Datapoints>\\r\\n\\t<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMetricListResponse>","errorExample":""}]', + 'title' => '查询指定云产品的指定监控项的监控数据', + 'description' => '### 使用限制'."\n" + .'- 调用DescribeMetricLast、DescribeMetricList、DescribeMetricData和DescribeMetricTop的接口,有100万次/月免费额度(总计),当免费额度用完且您没有开通基础云监控按量计费时,将无法正常使用该API。如果您已开通基础云监控的按量计费,当免费调用额度用完时,该API仍然可以正常使用,超出免费额度部分将自动按使用量计费。开通方法详见[开通按量计费](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG&commodityCode=cms_basic_public_cn&from_biz_channel=help_bill)。'."\n" + .'- 单个API的调用次数限制为50次/秒。一个阿里云账号及该账号下的RAM用户共用50次/秒。'."\n" + .'> 当您调用API时,如果返回信息`Throttling.User`或`Request was denied due to user flow control`,则说明该API被限流。处理方法,请参见[如何处理查询API限流问题](~~2615031~~)。'."\n" + .'### 注意事项'."\n" + .'各云产品监控数据的存储时长与`Period`(统计周期)有关,`Period`越大,查询的监控数据越稀疏,监控数据的存储时间越长,具体关系如下:'."\n" + .'- `Period`小于60秒,存储时长为7天。'."\n" + .'- `Period`等于60秒,存储时长为31天。'."\n" + .'- `Period`大于等于300秒,存储时长为91天。'."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,查询云产品`acs_ecs_dashboard`的监控项`cpu_idle`的监控数据。返回结果显示,当前账号`120886317861****`下实例`i-abcdefgh12****`间隔60秒的最大值为100、最小值为93.1、平均值为99.52。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetricData' => [ + 'summary' => '调用DescribeMetricData接口查询指定云产品的某个监控项的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于云产品的监控项名称,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的统计周期。'."\n" + ."\n" + .'取值:15、60、900和3600。'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'> - 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。'."\n" + .'- 监控项(`MetricName`)的统计周期,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控数据的开始时间。'."\n" + ."\n" + .'- 当您未设置`StartTime`和`EndTime`时,查询当前时间最近一个统计周期`Period`的监控数据。'."\n" + ."\n" + .'- 当您同时设置`StartTime`和`EndTime`时,查询指定时间段内距离`EndTime`最近一个统计周期`Period`的监控数据。具体如下:'."\n" + ."\n" + .' - 当`Period`设置为15秒时,指定时间段必须小于或等于20分钟。例如:StartTime为2021-05-08 08:10:00,EndTime为2021-05-08 08:30:00,统计距离2021-05-08 08:30:00最近一个15秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为60秒或900秒时,指定时间段必须小于或等于2小时。例如:Period为60秒,StartTime为2021-05-08 08:00:00,EndTime为2021-05-08 10:00:00,统计距离2021-05-08 10:00:00最近一个60秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为3600秒时,指定时间段必须小于或等于2天。例如:StartTime为2021-05-08 08:00:00,EndTime为2021-05-10 08:00:00,统计距离2021-05-10 08:00:00最近一个3600秒的监控数据。'."\n" + ."\n" + .'开始时间支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + ."\n" + .'- Format格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> - `StartTime`如果设置过早,则无效。'."\n" + .'- 建议您使用Unix时间戳,避免时区的问题。', + 'type' => 'string', + 'required' => false, + 'example' => '1618368900000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控数据的结束时间。'."\n" + ."\n" + .'- 当您未设置`StartTime`和`EndTime`时,查询当前时间最近一个统计周期`Period`的监控数据。'."\n" + ."\n" + .'- 当您同时设置`StartTime`和`EndTime`时,查询指定时间段内距离`EndTime`最近一个统计周期`Period`的监控数据。具体如下:'."\n" + ."\n" + .' - 当`Period`设置为15秒时,指定时间段必须小于或等于20分钟。例如:StartTime为2021-05-08 08:10:00,EndTime为2021-05-08 08:30:00,统计距离2021-05-08 08:30:00最近一个15秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为60秒或900秒时,指定时间段必须小于或等于2小时。例如:Period为60秒,StartTime为2021-05-08 08:00:00,EndTime为2021-05-08 10:00:00,统计距离2021-05-08 10:00:00最近一个60秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为3600秒时,指定时间段必须小于或等于2天。例如:StartTime为2021-05-08 08:00:00,EndTime为2021-05-10 08:00:00,统计距离2021-05-10 08:00:00最近一个3600秒的监控数据。'."\n" + ."\n\n" + ."\n" + .'结束时间支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + ."\n" + .'- Format格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> 建议您使用Unix时间戳,避免时区的问题。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => '1618368960000', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。'."\n" + ."\n" + .'格式:key-value键值对形式的集合,常用的key-value集合为`instanceId:i-2ze2d6j5uhg20x47****`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId": "i-abcdefgh12****"}]', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询出的现有结果进行实时计算的表达式。'."\n" + ."\n" + .'> 目前仅支持`groupby`(类似数据库`groupby`语句)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"groupby":["userId","instanceId"]}', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数,用于分页查询。'."\n" + ."\n" + .'默认值:1000。'."\n" + ."\n" + .'> 单次请求Length的最大值为1440。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。包括如下信息:'."\n" + ."\n" + .'- `timestamp`:发生报警的时间戳。'."\n" + ."\n" + .'- `userId`:发生报警的用户ID。'."\n" + ."\n" + .'- `instanceId`:发生报警的实例ID。'."\n" + ."\n" + .'- `Minimum`、`Average`、`Maximum`:报警规则。', + 'type' => 'string', + 'example' => '[{\\"timestamp\\":1618368900000,\\"Average\\":95.8291666666667,\\"Minimum\\":65.48,\\"Maximum\\":100.0},{\\"timestamp\\":1618368960000,\\"Average\\":95.8683333333333,\\"Minimum\\":67.84,\\"Maximum\\":100.0}]', + ], + 'Period' => [ + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'取值:15、60、900和3600。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368900000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8291666666667,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":65.48,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0},{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1618368960000,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":95.8683333333333,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":67.84,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0}]\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricDataResponse>\\r\\n\\t<RequestId>7598FEED-3B79-4B4A-AD01-435F34DA8EDC</RequestId>\\r\\n\\t<Period>60</Period>\\t\\r\\n <Datapoints>[{\\\\\\"timestamp\\\\\\":1618368900000,\\\\\\"Average\\\\\\":95.8291666666667,\\\\\\"Minimum\\\\\\":65.48,\\\\\\"Maximum\\\\\\":100.0},{\\\\\\"timestamp\\\\\\":1618368960000,\\\\\\"Average\\\\\\":95.8683333333333,\\\\\\"Minimum\\\\\\":67.84,\\\\\\"Maximum\\\\\\":100.0}]</Datapoints>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMetricDataResponse>\\t","errorExample":""}]', + 'title' => '查询指定云产品的某个监控项的监控数据', + 'description' => '### 使用限制'."\n" + .'- 调用DescribeMetricLast、DescribeMetricList、DescribeMetricData和DescribeMetricTop的接口,有100万次/月免费额度(总计),当免费额度用完且您没有开通基础云监控按量计费时,将无法正常使用该API。如果您已开通基础云监控的按量计费,当免费调用额度用完时,该API仍然可以正常使用,超出免费额度部分将自动按使用量计费。开通方法详见[开通按量计费](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG&commodityCode=cms_basic_public_cn&from_biz_channel=help_bill)。'."\n" + .'- 单个API的调用次数限制为10次/秒。一个阿里云账号及该账号下的RAM用户共用10次/秒。'."\n" + .'### 使用说明'."\n" + .'> 与[DescribeMetricList](~~51936~~)不同,本接口具有统计功能(即`Dimension={"instanceId": "i-abcdefgh12****"}`),将该账号下的所有监控数据进行聚合统计。'."\n" + ."\n" + .'本文将提供一个示例,查询云产品`acs_ecs_dashboard`监控项`cpu_idle`的监控数据。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DescribeMetricMetaList' => [ + 'summary' => '调用DescribeMetricMetaList接口查询云监控开放的监控项详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的命名空间。'."\n" + ."\n" + .'关于云产品的命名空间,请参见[云产品监控项](~~163515~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'acs_kvstore', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => '根据标签过滤资源。是一个JSON的字符串。'."\n" + ."\n" + .'格式:`[{"name":"标签键","value":"标签值"},{"name":"标签键","value":"标签值"}] `。已有标签说明如下: '."\n" + ."\n" + .'- metricCategory:监控项分类描述。 '."\n" + .'- alertEnable:是否需要报警。 '."\n" + .'- alertUnit:建议的报警单位。 '."\n" + .'- unitFactor:单位转换系数。 '."\n" + .'- minAlertPeriod:最小报警周期。 '."\n" + .'- productCategory:产品类型分类。 ', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"productCategory","value":"kvstore_old"}]', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。详情请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页参数。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大数量。默认值:30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CDE9EAFF-D54E-4024-BBFC-B0AAC883143B', + ], + 'TotalCount' => [ + 'description' => '总记录条数。', + 'type' => 'string', + 'example' => '10', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '资源中监控项的配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资源中监控项的配置信息。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'ads.diskSize', + ], + 'Description' => [ + 'description' => '监控项描述。', + 'type' => 'string', + 'example' => 'The rated disk capacity', + ], + 'Labels' => [ + 'description' => '监控项的标签,是一个或多个JSON字符串。'."\n" + ."\n" + .'格式:`[{"name":"标签键","value":"标签值"}]`,`name`可以重复,已有标签说明如下: '."\n" + ."\n" + .'- metricCategory:监控项分类描述。 '."\n" + .'- alertEnable:是否需要报警。 '."\n" + .'- alertUnit:建议的报警单位。 '."\n" + .'- unitFactor:单位转换系数。 '."\n" + .'- minAlertPeriod:最小报警周期。 '."\n" + .'- productCategory:产品类型分类。 ', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"minAlertPeriod\\",\\"value\\":\\"300\\"},{\\"name\\":\\"alertDefault\\",\\"value\\":\\"\\"},{\\"name\\":\\"unitFactor\\",\\"value\\":\\"1\\"},{\\"name\\":\\"alertUnit\\",\\"value\\":\\"Mbytes\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"ads\\"},{\\"name\\":\\"is_alarm\\",\\"value\\":\\"true\\"},{\\"name\\":\\"metricCategory\\",\\"value\\":\\"workerId\\"}]', + ], + 'Unit' => [ + 'description' => '监控项的单位。', + 'type' => 'string', + 'example' => 'MB', + ], + 'Dimensions' => [ + 'description' => '资源的监控维度。多个监控维度之间用半角逗号(,)分隔。', + 'type' => 'string', + 'example' => 'userId,instanceId,tableSchema,workerId', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'example' => 'acs_ads', + ], + 'Periods' => [ + 'description' => '监控项的所有统计周期。多个统计周期之间用半角逗号(,)分隔。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '300', + ], + 'Statistics' => [ + 'description' => '统计方法。多个统计方法之间用半角逗号(,)分隔。', + 'type' => 'string', + 'example' => 'Average,Minimum,Maximum', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"CDE9EAFF-D54E-4024-BBFC-B0AAC883143B\\",\\n \\"TotalCount\\": \\"10\\",\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"MetricName\\": \\"ads.diskSize\\",\\n \\"Description\\": \\"The rated disk capacity\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"minAlertPeriod\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"300\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertDefault\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"unitFactor\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"alertUnit\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Mbytes\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"productCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ads\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"is_alarm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"metricCategory\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"workerId\\\\\\\\\\\\\\"}]\\",\\n \\"Unit\\": \\"MB\\",\\n \\"Dimensions\\": \\"userId,instanceId,tableSchema,workerId\\",\\n \\"Namespace\\": \\"acs_ads\\",\\n \\"Periods\\": \\"300\\",\\n \\"Statistics\\": \\"Average,Minimum,Maximum\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricMetaListResponse>\\r\\n\\t\\t<TotalCount>1853</TotalCount>\\r\\n\\t\\t<RequestId>CDE9EAFF-D54E-4024-BBFC-B0AAC883143B</RequestId>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Resources>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>磁盘额定容量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>ads.diskSize</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Mbytes\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ads\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t\\t<Unit>MB</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>磁盘已用容量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>ads.diskUsed</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"Mbytes\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t\\t<Unit>MB</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>磁盘使用率</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>ads.diskUsedPercent</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"%\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"300\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"workerId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId,tableSchema,workerId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t\\t<Periods>300</Periods>\\r\\n\\t\\t\\t\\t<Unit>%</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>queue的未消费的消息数目</Description>\\r\\n\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>QueueMessageAccumulation</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName,queueName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>queue每分钟消息生产量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>QueueMessageInput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"n ame\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName,queueName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>queue的未消费的消息数目</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>QueueMessageOutput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"queue\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName,queueName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>实例每分钟产生的消息数量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>VhostMessageInput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"vhost\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>实例每分钟消费的消息数量</Description>\\r\\n\\t\\t\\t\\t<Statistics>Value</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>VhostMessageOutput</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertDefault\\\\\\",\\\\\\"value\\\\\\":\\\\\\"\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"unitFactor\\\\\\",\\\\\\"value\\\\\\":\\\\\\"1\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"count/min\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"productCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"amqp\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"vhost\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,regionId,vhostName</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_amqp</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>count/min</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>Latency</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"ms\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"instanceId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,region,apiUid</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_apigateway_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300,900</Periods>\\r\\n\\t\\t\\t\\t<Unit>ms</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>时间粒度内http返回码4XX占全部返回码的百分比</Description>\\r\\n\\t\\t\\t\\t<Statistics>Average,Minimum,Maximum</Statistics>\\r\\n\\t\\t\\t\\t<MetricName>code4xx</MetricName>\\r\\n\\t\\t\\t\\t<Labels>[{\\\\\\"name\\\\\\":\\\\\\"alertUnit\\\\\\",\\\\\\"value\\\\\\":\\\\\\"%\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"minAlertPeriod\\\\\\",\\\\\\"value\\\\\\":\\\\\\"60\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"metricCategory\\\\\\",\\\\\\"value\\\\\\":\\\\\\"instanceId\\\\\\"},{\\\\\\"name\\\\\\":\\\\\\"is_alarm\\\\\\",\\\\\\"value\\\\\\":\\\\\\"true\\\\\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Dimensions>userId,instanceId</Dimensions>\\r\\n\\t\\t\\t\\t<Namespace>acs_cdn</Namespace>\\r\\n\\t\\t\\t\\t<Periods>60,300</Periods>\\r\\n\\t\\t\\t\\t<Unit>%</Unit>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t</Resources>\\r\\n</DescribeMetricMetaListResponse>","errorExample":""}]', + 'title' => '查询云监控开放的监控项详情', + 'description' => '通常配合查询监控数据接口DescribeMetricList和DescribeMetricLast一起使用,详情请参见[DescribeMetricList](~~51936~~)和[DescribeMetricLast](~~51939~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProjectMeta' => [ + 'summary' => '调用DescribeProjectMeta接口查询云监控支持的时序类监控项产品列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => '标签。根据标签过滤,标签为每个报警增加特殊标记。'."\n" + ."\n" + .'目前仅支持按照产品过滤,即`name`为`product`的过滤方式,例如:{"name":"product","value":"ECS"}。'."\n" + .'>对于阿里云中云监控控制台的特殊标签,不建议您使用。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"product","value":"ECS"}]', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'取值范围:1~100。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + ."\n" + .'取值范围:1~10000。'."\n" + ."\n" + .'默认值:30。'."\n" + ."\n" + .'>目前阿里云未限制该参数,如果您需要获取所有结果,则将分页大小设置为较大的值即可。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C2061B2-3B1B-43BF-A4A4-C53426F479C0', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'string', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'string', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'string', + 'example' => '12', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '云产品信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => '命名空间,用于区分产品。格式:`acs_产品缩写`,详情请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'acs_cdn', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'CDN', + ], + 'Labels' => [ + 'description' => '标签。根据标签过滤,标签为每个报警增加特殊标记。'."\n" + ."\n" + .'例如:报警所属产品的规格,是否能设置告警,格式:`[{"name":"标签名","value":"标签值"}、{"name":"标签名","value":"标签值"}]`。常用的标签如下:'."\n" + ."\n" + .'- alertUnit:报警的单位。'."\n" + .' 为了避免原始上报数据的单位过小,而导致告警规则输入的值过大而增加的`alertUnit`标签,目前主要应用于云监控控制台。'."\n" + ."\n" + .'- minAlertPeriod:最小上报周期。上报监控数据的时间间隔,通常为1分钟。'."\n" + ."\n" + .'- metricCategory:产品的规格。例如: kvstore_sharding。'."\n" + .' 部分阿里云产品分不同规格,定义在同一个namespace中,用该参数进行区分。'."\n" + ."\n" + .'- is_alarm:能否设置告警规则。'."\n" + .' 对于阿里云中云监控控制台的特殊标签,不建议您使用。'."\n" + ."\n", + 'type' => 'string', + 'example' => '[{"metricCategory":ecs}]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C2061B2-3B1B-43BF-A4A4-C53426F479C0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"PageSize\\": \\"5\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Total\\": \\"12\\",\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"Namespace\\": \\"acs_cdn\\",\\n \\"Description\\": \\"CDN\\",\\n \\"Labels\\": \\"[{\\\\\\"metricCategory\\\\\\":ecs}]\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProjectMeta>\\r\\n\\t\\t<PageNumber>1</PageNumber>\\r\\n\\t\\t<PageSize>5</PageSize>\\r\\n\\t\\t<RequestId>4C2061B2-3B1B-43BF-A4A4-C53426F479C0</RequestId>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Total>12</Total>\\r\\n\\t\\t<Resources>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>分析型数据库</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"ADS\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"ads\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_ads</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>智能推荐</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"AIRec\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"airec\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_airec</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>API网关</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"APIGateway\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"apigateway\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_apigateway_dashboard</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>CDN</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"CDN\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"cdn\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_cdn</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t<Description>云企业网</Description>\\r\\n\\t\\t\\t\\t<Labels>[{\\"name\\":\\"product\\",\\"value\\":\\"CEN\\"},{\\"name\\":\\"productCategory\\",\\"value\\":\\"cen,cen_flow,cen_vbr\\"},{\\"name\\":\\"groupFlag\\",\\"value\\":\\"true\\"}]</Labels>\\r\\n\\t\\t\\t\\t<Namespace>acs_cen</Namespace>\\r\\n\\t\\t\\t</Resource>\\r\\n\\t\\t</Resources>\\r\\n</DescribeProjectMeta>\\r\\n","errorExample":""}]', + 'title' => '查询云监控支持的时序类监控项产品列表', + 'description' => '获取接入的云产品信息,包括产品的描述信息、Namespace和标签。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteExporterOutput' => [ + 'summary' => '调用DeleteExporterOutput接口删除监控数据导出配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DestName', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的目标名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 状态码为200表示成功,其余取值表示失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2DECF751-7AFA-43BB-8C63-2B6B07E51AE1', + ], + 'Success' => [ + 'description' => '是否成功,取值: '."\n" + .'- `true`:成功'."\n" + .'- `false`:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"2DECF751-7AFA-43BB-8C63-2B6B07E51AE1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>success</Message>\\n<RequestId>296AE90D-153C-4612-AF24-75D0F5921976</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '删除监控数据导出配置', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteExporterRule' => [ + 'summary' => '调用DeleteExporterRule接口删除数据导出规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '导出规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'myRuleName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 状态码为200表示成功,其余取值表示失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D023', + ], + 'Success' => [ + 'description' => '是否成功,取值: '."\n" + .'- `true`:成功'."\n" + .'- `false`:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D023\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>success</Message>\\n<RequestId>8B524AE2-FBB1-4202-AA17-B3DEAAC8D861</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '删除数据导出规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExporterOutputList' => [ + 'summary' => '调用DescribeExporterOutputList接口查询监控数据导出列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页码,默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数,默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + 'default' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 状态码为200表示成功,其余取值表示失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'description' => '输出的配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ConfigJson' => [ + 'description' => '监控输出配置。', + 'type' => 'object', + 'properties' => [ + 'ak' => [ + 'description' => 'AccessKeyId。', + 'type' => 'string', + 'example' => 'LTAIpY33********', + ], + 'endpoint' => [ + 'description' => 'SLS的数据对应的域名。', + 'type' => 'string', + 'example' => 'http://cn-qingdao-share.log.aliyuncs.com', + ], + 'logstore' => [ + 'description' => '日志库。', + 'type' => 'string', + 'example' => 'monitorlogstore', + ], + 'project' => [ + 'description' => 'SLS项目。', + 'type' => 'string', + 'example' => 'exporter', + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建的uninx时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1584016495498', + ], + 'DestName' => [ + 'description' => '配置的名称。', + 'type' => 'string', + 'example' => 'exporterOut', + ], + 'DestType' => [ + 'description' => '数据导出的类型。'."\n" + ."\n" + .'> 目前仅支持SLS,后续将支持导出更多的产品。', + 'type' => 'string', + 'example' => 'SLS', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'sucess', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0E657631-CD6C-4C24-9637-98D000B9272C', + ], + 'Success' => [ + 'description' => '是否成功,取值: '."\n" + .'- `true`:成功'."\n" + .'- `false`:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0E657631-CD6C-4C24-9637-98D000B9272C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"sucess\\",\\n \\"PageNumber\\": 1,\\n \\"Total\\": 25,\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"DestType\\": \\"SLS\\",\\n \\"CreateTime\\": 1584016495498,\\n \\"DestName\\": \\"exporterOut\\",\\n \\"ConfigJson\\": {\\n \\"ak\\": \\"LTAIpY33********\\",\\n \\"endpoint\\": \\"http://cn-qingdao-share.log.aliyuncs.com\\",\\n \\"project\\": \\"exporter\\",\\n \\"logstore\\": \\"monitorlogstore\\",\\n \\"as\\": \\"TxHwuJ8yAb3AULcnny******\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BB30C6D9-8D0D-442E-9484-C15BADE76A21</RequestId>\\n<PageNumber>1</PageNumber>\\n<Total>1</Total>\\n<Datapoints>\\n <Datapoint>\\n <DestType>SLS</DestType>\\n <DestName>desctName1</DestName>\\n <CreateTime>1584016495498</CreateTime>\\n <ConfigJson>\\n <endpoint>http://cn-qingdao-share.log.aliyuncs.com</endpoint>\\n <as>TxHwuJ8yAb3AULcnny******</as>\\n <project>exporter</project>\\n <ak>LTAIpY33********</ak>\\n <logstore>exporter</logstore>\\n </ConfigJson>\\n </Datapoint>\\n</Datapoints>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询监控数据导出列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeExporterRuleList' => [ + 'summary' => '调用DescribeExporterRuleList接口查询数据导出规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + 'default' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 状态码为200表示成功,其余取值表示失败。', + 'type' => 'string', + 'example' => '200', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Datapoint' => [ + 'description' => '数据点。', + 'type' => 'array', + 'items' => [ + 'description' => '数据点。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667526533000', + ], + 'Describe' => [ + 'description' => '导出规则描述。', + 'type' => 'string', + 'example' => 'export test', + ], + 'Dimension' => [ + 'description' => '维度', + 'type' => 'string', + 'example' => 'hotsName', + ], + 'DstName' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DstName' => [ + 'description' => '目标名称。', + 'type' => 'array', + 'items' => [ + 'description' => '目标名称。', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + 'Enabled' => [ + 'description' => '是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MetricName' => [ + 'description' => '指标名称。', + 'type' => 'string', + 'example' => 'CPUUtilization', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'RuleName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'L121-寿险-全能保建议书系统_DefaultEventRule_10842827', + ], + 'TargetWindows' => [ + 'description' => '导出数据的时间窗口。单位:秒。'."\n" + ."\n" + .'> - 如果需要导出多个窗口,则使用英文逗号(,)分隔。'."\n" + .'- 不支持导出小于60秒的数据。', + 'type' => 'string', + 'example' => 'rule_test', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'PageNumber' => [ + 'description' => '分页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6BA047CA-8BC6-40BC-BC8F-FBECF35F1993', + ], + 'Success' => [ + 'description' => '是否成功,取值: '."\n" + .'- `true`:成功'."\n" + .'- `false`:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Datapoints\\": {\\n \\"Datapoint\\": [\\n {\\n \\"CreateTime\\": 1667526533000,\\n \\"Describe\\": \\"export test\\",\\n \\"Dimension\\": \\"hotsName\\",\\n \\"DstName\\": {\\n \\"DstName\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"Enabled\\": true,\\n \\"MetricName\\": \\"CPUUtilization\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"L121-寿险-全能保建议书系统_DefaultEventRule_10842827\\",\\n \\"TargetWindows\\": \\"rule_test\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"6BA047CA-8BC6-40BC-BC8F-FBECF35F1993\\",\\n \\"Success\\": true,\\n \\"Total\\": 1000\\n}","type":"json"}]', + 'title' => '查询数据导出规则列表', + ], + 'DescribeMetricTop' => [ + 'summary' => '调用DescribeMetricTop接口先查询指定云产品的指定监控项的最新监控数据,再查询该监控项排序后的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'取值:15、60、900和3600。'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'> - 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。'."\n" + .'- 每个云产品的监控项(`MetricName`)的统计周期不同。更多信息,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于监控项名称,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控数据的开始时间。'."\n" + ."\n" + .'- 当您未设置`StartTime`和`EndTime`时,查询当前时间最近一个统计周期`Period`的监控数据。'."\n" + ."\n" + .'- 当您同时设置`StartTime`和`EndTime`时,查询指定时间段内距离`EndTime`最近一个统计周期`Period`的监控数据。具体如下:'."\n" + ."\n" + .' - 当`Period`设置为15秒时,指定时间段必须小于或等于20分钟。例如:StartTime为2021-05-08 08:10:00,EndTime为2021-05-08 08:30:00,统计距离2021-05-08 08:30:00最近一个15秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为60秒或900秒时,指定时间段必须小于或等于2小时。例如:Period为60秒,StartTime为2021-05-08 08:00:00,EndTime为2021-05-08 10:00:00,统计距离2021-05-08 10:00:00最近一个60秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为3600秒时,指定时间段必须小于或等于2天。例如:StartTime为2021-05-08 08:00:00,EndTime为2021-05-10 08:00:00,统计距离2021-05-10 08:00:00最近一个3600秒的监控数据。'."\n" + ."\n" + .'开始时间支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + ."\n" + .'- Format格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> - `StartTime`如果设置过早,则无效。'."\n" + .'- 建议您使用Unix时间戳,避免时区的问题。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-05-08 08:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询监控数据的结束时间。'."\n" + ."\n" + .'- 当您未设置`StartTime`和`EndTime`时,查询当前时间最近一个统计周期`Period`的监控数据。'."\n" + ."\n" + .'- 当您同时设置`StartTime`和`EndTime`时,查询指定时间段内距离`EndTime`最近一个统计周期`Period`的监控数据。具体如下:'."\n" + ."\n" + .' - 当`Period`设置为15秒时,指定时间段必须小于或等于20分钟。例如:StartTime为2021-05-08 08:10:00,EndTime为2021-05-08 08:30:00,统计距离2021-05-08 08:30:00最近一个15秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为60秒或900秒时,指定时间段必须小于或等于2小时。例如:Period为60秒,StartTime为2021-05-08 08:00:00,EndTime为2021-05-08 10:00:00,统计距离2021-05-08 10:00:00最近一个60秒的监控数据。'."\n" + ."\n" + .' - 当`Period`设置为3600秒时,指定时间段必须小于或等于2天。例如:StartTime为2021-05-08 08:00:00,EndTime为2021-05-10 08:00:00,统计距离2021-05-10 08:00:00最近一个3600秒的监控数据。'."\n" + ."\n\n" + ."\n" + .'结束时间支持的格式:'."\n" + ."\n" + .'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n" + ."\n" + .'- Format格式:YYYY-MM-DDThh:mm:ssZ。'."\n" + ."\n" + .'> 建议您使用Unix时间戳,避免时区的问题。'."\n" + ."\n" + .' ', + 'type' => 'string', + 'required' => false, + 'example' => '2021-05-08 10:00:00', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。'."\n" + ."\n" + .'> 单次请求最多支持批量查询50个实例。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId": "i-2ze2d6j5uhg20x47****"}]', + ], + ], + [ + 'name' => 'Orderby', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段,即按该字段进行排序。取值:'."\n" + ."\n" + .'- Average:平均值。'."\n" + ."\n" + .'- Minimum:最小值。'."\n" + ."\n" + .'- Maximum:最大值。', + 'type' => 'string', + 'required' => true, + 'example' => 'Average', + ], + ], + [ + 'name' => 'OrderDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值:'."\n" + .'- true:由小到大排序。'."\n" + .'- false(默认值):由大到小排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数。'."\n" + ."\n" + .'用于分页查询,默认值:10。'."\n" + ."\n" + .'> 单次请求Length的最大值为1440。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Express', + 'in' => 'query', + 'schema' => [ + 'description' => '对查询出的现有结果进行实时计算的表达式。'."\n" + ."\n" + .'> 目前仅支持`groupby`(类似数据库的groupby语句)。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"groupby":["userId","instanceId"]}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42', + ], + 'Datapoints' => [ + 'description' => '监控数据列表。', + 'type' => 'string', + 'example' => '[{\\"order\\":1,\\"timestamp\\":1620287520000,\\"userId\\":\\"120886317861****\\",\\"instanceId\\":\\"i-j6ccf7d5fn335qpo****\\",\\"Average\\":99.92,\\"Minimum\\":99.5,\\"Maximum\\":100.0,\\"_count\\":1.0},{\\"order\\":2,\\"timestamp\\":1620287520000,\\"userId\\":\\"120886317861****\\",\\"instanceId\\":\\"i-0xii2bvf42iqvxbp****\\",\\"Average\\":99.91,\\"Minimum\\":99.0,\\"Maximum\\":100.0,\\"_count\\":1.0}]', + ], + 'Period' => [ + 'description' => '监控数据的统计周期。单位:秒。取值:15、60、900和3600。', + 'type' => 'string', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42\\",\\n \\"Datapoints\\": \\"[{\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1620287520000,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-j6ccf7d5fn335qpo****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":99.92,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":99.5,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0,\\\\\\\\\\\\\\"_count\\\\\\\\\\\\\\":1.0},{\\\\\\\\\\\\\\"order\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1620287520000,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-0xii2bvf42iqvxbp****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":99.91,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":99.0,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":100.0,\\\\\\\\\\\\\\"_count\\\\\\\\\\\\\\":1.0}]\\",\\n \\"Period\\": \\"60\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricTopResponse>\\r\\n\\t<RequestId>18DC44ED-B058-49B0-9D49-1D6608328E4D</RequestId>\\r\\n\\t<Period>60</Period>\\r\\n\\t<Datapoints>[{\\\\\\"order\\\\\\":1,\\\\\\"timestamp\\\\\\":1620287520000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-j6ccf7d5fn335qpo****\\\\\\",\\\\\\"Average\\\\\\":99.92,\\\\\\"Minimum\\\\\\":99.5,\\\\\\"Maximum\\\\\\":100.0,\\\\\\"_count\\\\\\":1.0},{\\\\\\"order\\\\\\":2,\\\\\\"timestamp\\\\\\":1620287520000,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"instanceId\\\\\\":\\\\\\"i-0xii2bvf42iqvxbp****\\\\\\",\\\\\\"Average\\\\\\":99.91,\\\\\\"Minimum\\\\\\":99.0,\\\\\\"Maximum\\\\\\":100.0,\\\\\\"_count\\\\\\":1.0}]</Datapoints>\\r\\n\\t<Code>200</Code>\\r\\n</DescribeMetricTopResponse>\\t","errorExample":""}]', + 'title' => '查询排序后的最新监控数据', + 'description' => '### 使用限制'."\n" + .'- 调用DescribeMetricLast、DescribeMetricList、DescribeMetricData和DescribeMetricTop的接口,有100万次/月免费额度(总计),当免费额度用完且您没有开通基础云监控按量计费时,将无法正常使用该API。如果您已开通基础云监控的按量计费,当免费调用额度用完时,该API仍然可以正常使用,超出免费额度部分将自动按使用量计费。开通方法详见[开通按量计费](https://common-buy.aliyun.com/?spm=a2c4g.11186623.0.0.6c8f3481IbSHgG&commodityCode=cms_basic_public_cn&from_biz_channel=help_bill)。'."\n" + .'- 单个API的调用次数限制为10次/秒。一个阿里云账号及该账号下的RAM用户共用10次/秒。'."\n" + .'### 注意事项'."\n" + .'各云产品监控数据的存储时长与`Period`(统计周期)有关,`Period`越大,查询的监控数据越稀疏,监控数据的存储时间越长,具体关系如下:'."\n" + .'- `Period`小于60秒,存储时长为7天。'."\n" + .'- `Period`等于60秒,存储时长为31天。'."\n" + .'- `Period`大于等于300秒,存储时长为91天。'."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,查询云服务`acs_ecs_dashboard`监控项`cpu_idle`在最近60秒的监控数据,并对监控数据的`Average`从大到小排序。', + 'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutExporterOutput' => [ + 'summary' => '调用PutExporterOutput接口创建或者修改一个监控数据导出配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'DestName', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的名称。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'exporterConfig', + ], + ], + [ + 'name' => 'ConfigJson', + 'in' => 'query', + 'schema' => [ + 'description' => '数据导出的配置。是一个JSONObject字符串。必须要包含如下字段:'."\n" + ."\n" + .'- endpoint:日志服务(SLS)数据对应的域名。'."\n" + .'- project:项目。'."\n" + .'- logstore:日志库。'."\n" + .'- ak:AccessKey ID。'."\n" + .'- as:AccessKey Secret。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{ "endpoint": "http://cn-qingdao-share.log.aliyuncs.com", "project": "exporter", "logstore": "exporter","ak": "LTAIp*******", "userId": "17754********", "as": "TxHwuJ8yAb3AU******"}', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => '配置的描述信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'CPU指标导出', + ], + ], + [ + 'name' => 'DestType', + 'in' => 'query', + 'schema' => [ + 'description' => '导出的产品。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'sls', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A5F022D-AC7C-460E-94AE-B9E75083D027', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"6A5F022D-AC7C-460E-94AE-B9E75083D027\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutExporterOutput>\\n\\t\\t<RequestId>E5DC60DD-2FDE-488F-942C-424FA3E18BF8</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</PutExporterOutput>","errorExample":""}]', + 'title' => '创建或者修改一个监控数据导出配置', + 'description' => '> 目前仅支持日志服务(SLS),后续将支持导出更多的产品。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutExporterRule' => [ + 'summary' => '调用PutExporterRule接口创建或修改数据导出规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。'."\n" + ."\n" + .'> 如果该规则名称与现有的名称重复,则表示修改,否则表示创建。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rule1_****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的数据命名空间。更多信息,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。>详细信息请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'CPUUtilization', + ], + ], + [ + 'name' => 'TargetWindows', + 'in' => 'query', + 'schema' => [ + 'description' => '导出数据的时间窗口。单位:秒。'."\n" + ."\n" + .'> - 如果需要导出多个窗口,则使用英文逗号(,)分隔。'."\n" + .'- 不支持导出小于60秒的数据。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '60,300', + ], + ], + [ + 'name' => 'Describe', + 'in' => 'query', + 'schema' => [ + 'description' => '导出规则描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'desc_******', + ], + ], + [ + 'name' => 'DstNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '数据导出的目的地。', + 'type' => 'array', + 'items' => [ + 'description' => '数据导出的目的地。', + 'type' => 'string', + 'required' => false, + 'example' => 'dst_******', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建或修改数据导出规则', + ], + 'DescribeAlertHistoryList' => [ + 'summary' => '调用DescribeAlertHistoryList接口查询报警历史详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'关于如何查询报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'关于如何查询报警规则名称,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Rule', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于如何查询云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于如何查询云产品的监控项名称,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '7671****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默状态。取值:'."\n" + .'- 2(默认值):通道沉默。'."\n" + .'- 0:报警或恢复。'."\n" + .'- 1:失效期。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '报警状态。取值:'."\n" + .'- ALARM(默认值):报警状态。'."\n" + .'- OK:正常状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALARM', + ], + ], + [ + 'name' => 'Ascending', + 'in' => 'query', + 'schema' => [ + 'description' => '时间排序。取值:'."\n" + .'- true(默认值):表示时间倒序。'."\n" + .'- false:表示时间正序。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1640237400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1640608200000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C3C69FBE-2262-541F-A409-C52F380BAE63', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'string', + 'example' => '2', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlarmHistoryList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlarmHistory' => [ + 'description' => '报警历史详情。', + 'type' => 'array', + 'items' => [ + 'description' => '报警历史详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '通道沉默状态。取值:'."\n" + .'- 2(默认值):通道沉默。'."\n" + .'- 0:报警或恢复。'."\n" + .'- 1:失效期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'EvaluationCount' => [ + 'description' => '报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'State' => [ + 'description' => '报警状态。取值:'."\n" + ."\n" + .'- ALARM:报警状态。'."\n" + ."\n" + .'- OK:正常状态。', + 'type' => 'string', + 'example' => 'ALARM', + ], + 'Namespace' => [ + 'description' => '云服务的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Webhooks' => [ + 'description' => 'URL回调地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'ECS_Rule', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****', + ], + 'LastTime' => [ + 'description' => '报警持续的时间。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '360133', + ], + 'Value' => [ + 'description' => '出现报警或报警恢复时的监控值。', + 'type' => 'string', + 'example' => '10.58', + ], + 'Expression' => [ + 'description' => '报警触发的表达式。', + 'type' => 'string', + 'example' => '$Average>=10', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '7671****', + ], + 'AlertTime' => [ + 'description' => '报警推送的时间戳。单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640586600000', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'i-bp1cqhiw1za2****', + ], + 'Dimensions' => [ + 'description' => '报警的资源。', + 'type' => 'string', + 'example' => '{\\"instanceId\\":\\"i-bp1cqhiw1za2****\\"}', + ], + 'Level' => [ + 'description' => '报警的级别和通知方式。取值:'."\n" + ."\n" + .'<props="china">- P2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>'."\n", + 'type' => 'string', + 'example' => 'P4', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '报警联系人。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人。', + 'type' => 'string', + 'example' => 'Alice', + ], + ], + ], + ], + 'ContactALIIMs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactALIIM' => [ + 'description' => '报警联系人的旺旺号。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的旺旺号。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'ContactMails' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactMail' => [ + 'description' => '报警联系人的邮箱地址。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的邮箱地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + 'ContactSmses' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactSms' => [ + 'description' => '报警联系人的手机号码。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的手机号码。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '13900009999', + ], + ], + ], + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError ', + 'errorMessage' => 'The request processing has failed due to some unknown error. ', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Cms::2019-01-01::DescribeAlertLogList', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"C3C69FBE-2262-541F-A409-C52F380BAE63\\",\\n \\"Total\\": \\"2\\",\\n \\"Success\\": true,\\n \\"AlarmHistoryList\\": {\\n \\"AlarmHistory\\": [\\n {\\n \\"Status\\": 2,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": 3,\\n \\"State\\": \\"ALARM\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Webhooks\\": \\"https://www.aliyun.com\\",\\n \\"RuleName\\": \\"ECS_Rule\\",\\n \\"RuleId\\": \\"applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****\\",\\n \\"LastTime\\": 360133,\\n \\"Value\\": \\"10.58\\",\\n \\"Expression\\": \\"$Average>=10\\",\\n \\"GroupId\\": \\"7671****\\",\\n \\"AlertTime\\": 1640586600000,\\n \\"InstanceName\\": \\"i-bp1cqhiw1za2****\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp1cqhiw1za2****\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": \\"P4\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"Alice\\"\\n ]\\n },\\n \\"ContactALIIMs\\": {\\n \\"ContactALIIM\\": [\\n \\"[email protected]\\"\\n ]\\n },\\n \\"ContactMails\\": {\\n \\"ContactMail\\": [\\n \\"[email protected]\\"\\n ]\\n },\\n \\"ContactSmses\\": {\\n \\"ContactSms\\": [\\n \\"13900009999\\"\\n ]\\n },\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"ECS_Group\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertHistoryListResponse>\\r\\n\\t<AlarmHistoryList>\\r\\n\\t\\t<AlarmHistory>\\r\\n\\t\\t\\t<Status>2</Status>\\r\\n\\t\\t\\t<ContactGroups>\\r\\n\\t\\t\\t\\t<ContactGroup>ECS_Group</ContactGroup>\\r\\n\\t\\t\\t</ContactGroups>\\r\\n\\t\\t\\t<RuleId>applyTemplate61dc81b5-d357-4cf6-a9b7-9f83c1d5****</RuleId>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"instanceId\\\\\\":\\\\\\"i-bp1cqhiw1za2****\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<EvaluationCount>3</EvaluationCount>\\r\\n\\t\\t\\t<ContactMails></ContactMails>\\r\\n\\t\\t\\t<ContactSmses></ContactSmses>\\r\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t<AlertTime>1640586600000</AlertTime>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<InstanceName>i-bp1cqhiw1za2****</InstanceName>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<Contacts></Contacts>\\r\\n\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t<State>ALARM</State>\\r\\n\\t\\t\\t<Value>10.58</Value>\\r\\n\\t\\t\\t<Level>P4</Level>\\r\\n\\t\\t\\t<PreLevel>P4</PreLevel>\\r\\n\\t\\t\\t<LastTime>360133</LastTime>\\r\\n\\t\\t\\t<RuleName>ECS_Rule</RuleName>\\r\\n\\t\\t\\t<ContactALIIMs></ContactALIIMs>\\r\\n\\t\\t</AlarmHistory>\\r\\n\\t\\t<AlarmHistory>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<ContactGroups>\\r\\n\\t\\t\\t\\t<ContactGroup>ECS_Group</ContactGroup>\\r\\n\\t\\t\\t</ContactGroups>\\r\\n\\t\\t\\t<RuleId>applyTemplate61dc81b5-d357-4cf6-a9b7-9f83****</RuleId>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"instanceId\\\\\\":\\\\\\"i-bp1cqhiw1za2807s****\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<EvaluationCount>3</EvaluationCount>\\r\\n\\t\\t\\t<ContactMails></ContactMails>\\r\\n\\t\\t\\t<ContactSmses></ContactSmses>\\r\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t<AlertTime>1640586540000</AlertTime>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<InstanceName>i-bp1cqhiw1za2807s****</InstanceName>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<Contacts></Contacts>\\r\\n\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t<State>ALARM</State>\\r\\n\\t\\t\\t<Value>10.13</Value>\\r\\n\\t\\t\\t<Level>P4</Level>\\r\\n\\t\\t\\t<LastTime>300085</LastTime>\\r\\n\\t\\t\\t<RuleName>ECS_Rule</RuleName>\\r\\n\\t\\t\\t<ContactALIIMs>\\r\\n\\t\\t\\t\\t<ContactALIIM>\\\\\\"[email protected]\\\\\\"</ContactALIIM>\\r\\n\\t\\t\\t</ContactALIIMs>\\r\\n\\t\\t</AlarmHistory>\\r\\n\\t</AlarmHistoryList>\\r\\n\\t<RequestId>C3C69FBE-2262-541F-A409-C52F380BAE63</RequestId>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertHistoryListResponse>\\t","errorExample":""}]', + 'title' => '查询报警历史详情', + 'description' => '本API不再维护,推荐您使用[DescribeAlertLogList](~~201087~~)。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAlertLogCount' => [ + 'summary' => '调用DescribeAlertLogCount接口统计报警历史。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'您只能查询最近一年的报警历史,如果查询时间大于一年,则参数`AlertLogCount`的返回值为空。'."\n" + ."\n" + .'> 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于15天,并且需要同时填写或同时不填写。如果不填,则默认查询最近15分钟的报警历史。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1609988009694', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'您只能查询最近一年的报警历史,如果查询时间大于一年,则参数`AlertLogCount`的返回值为空。'."\n" + ."\n" + .'> 开始时间(StartTime)和结束时间(EndTime)之间必须小于等于15天,并且需要同时填写或同时不填写。如果不填,则默认查询最近15分钟的报警历史。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1610074409694', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '统计报警历史的搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的命名空间。'."\n" + ."\n" + .'>关于云服务的命名空间,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7301****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务名称缩写。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '报警的级别和通知方式。取值:'."\n" + ."\n" + .'<props="china">- P2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'P4', + ], + ], + [ + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '报警状态。取值:'."\n" + .'- 0:发生报警或报警恢复正常。'."\n" + .'- 1:非生效期。'."\n" + .'- 2:通道沉默周期。'."\n" + .'- 3:主机重启中。'."\n" + .'- 4:不发送报警。'."\n" + ."\n" + .'<props="china">当报警状态为0时,如果Level的取值为P2、P3或P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="intl">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="partner">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'>关于云服务的监控项,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志的周期。单位:分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '360', + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。取值:'."\n" + .'- `product`:按照云服务统计。'."\n" + .'- `level`:按照报警级别统计。'."\n" + .'- `groupId`:按照应用分组统计。'."\n" + .'- `contactGroup`:按照报警联系人组统计。'."\n" + .'- `product,metricName`:按照云服务和监控项统计。 ', + 'type' => 'string', + 'required' => true, + 'example' => 'product', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '告警类型。取值:'."\n" + ."\n" + .'- TRIGGERED:告警触发。'."\n" + ."\n" + .'- RESOLVED:告警恢复。', + 'type' => 'string', + 'required' => false, + 'example' => 'TRIGGERED', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n\n" + .'关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'bfae2ca5b4e07d2c7278772e***********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertLogCount' => [ + 'description' => '报警历史数量统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '报警历史统计的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Logs' => [ + 'description' => '报警历史统计的数量详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警历史统计的字段名称。', + 'type' => 'string', + 'example' => 'product', + ], + 'Value' => [ + 'description' => '报警历史统计的字段值。', + 'type' => 'string', + 'example' => 'ECS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"AlertLogCount\\": [\\n {\\n \\"Count\\": 1,\\n \\"Logs\\": [\\n {\\n \\"Name\\": \\"product\\",\\n \\"Value\\": \\"ECS\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertLogCountResponse>\\r\\n\\t<RequestId>0BA67F6D-B699-4E3F-B205-93A5C38A0A2E</RequestId>\\r\\n\\t<AlertLogCount>\\r\\n\\t\\t<Count>1</Count>\\r\\n\\t\\t<Logs>\\r\\n\\t\\t\\t<Value>ECS</Value>\\r\\n\\t\\t\\t<Name>product</Name>\\r\\n\\t\\t</Logs>\\r\\n\\t</AlertLogCount>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertLogCountResponse>\\t","errorExample":""}]', + 'title' => '统计报警历史', + 'description' => '该接口只能统计到最近一年的报警历史。'."\n" + ."\n" + .'本文将提供一个示例,从云服务`product`维度查询ECS的报警统计历史。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAlertLogList' => [ + 'summary' => '调用DescribeAlertLogList接口查询报警历史。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'您只能查询最近一年的报警历史,如果查询时间大于一年,则参数`AlertLogList`的返回值为空。'."\n" + ."\n" + .'> 开始时间(`StartTime`)和结束时间(`EndTime`)之间必须小于等于15天,并且需要同时填写或同时不填写。如果不填,则默认查询最近15分钟的报警历史。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1609988009694', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'您只能查询最近一年的报警历史,如果查询时间大于一年,则参数`AlertLogList`的返回值为空。'."\n" + ."\n" + .'> 开始时间(`StartTime`)和结束时间(`EndTime`)之间必须小于等于15天,并且需要同时填写或同时不填写。如果不填,则默认查询最近15分钟的报警历史。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1610074409694', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'alert', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7301****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的命名空间。'."\n" + ."\n" + .'> 关于云产品的命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'关于如何获取云产品名称缩写,请参见[DescribeProductsOfActiveMetricRule](~~114930~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '报警的级别和通知方式。取值:'."\n" + ."\n" + .'<props="china">- P2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'P4', + ], + ], + [ + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '报警状态。取值:'."\n" + .'- 0:发生报警或报警恢复正常。'."\n" + .'- 1:非生效期。'."\n" + .'- 2:通道沉默周期。'."\n" + .'- 3:主机重启中。'."\n" + .'- 4:不发送报警。'."\n" + ."\n" + .'<props="china">当报警状态为0时,如果Level的取值为P2、P3或P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="intl">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="partner">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'>关于云产品的监控项,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'IntranetInRate', + ], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志的周期。单位:分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '360', + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。取值:'."\n" + .'- `product`:按照云产品统计。'."\n" + .'- `level`:按照报警级别统计。'."\n" + .'- `groupId`:按照应用分组统计。'."\n" + .'- `contactGroup`:按照报警联系人组统计。'."\n" + .'- `product,metricName`:按照云产品和监控项统计。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'product', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'关于如何查询报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bc369e8_30f87e517ed2fc****', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则类型。取值:METRIC,表示时序指标报警规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'METRIC', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '告警类型。取值:'."\n" + ."\n" + .'- TRIGGERED:告警触发。'."\n" + ."\n" + .'- RESOLVED:告警恢复。', + 'type' => 'string', + 'required' => false, + 'example' => 'TRIGGERED', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AlertLogList' => [ + 'description' => '报警历史列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'EventName' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'IOHang', + ], + 'Product' => [ + 'description' => '云产品标识。取值:'."\n" + ."\n" + .'- 如果是阿里云产品,则为云产品名称缩写,例如:ECS。'."\n" + ."\n" + .'- 如果非阿里云产品,则为`acs_产品关键字`,例如:acs_networkmonitor。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'BlackListUUID' => [ + 'description' => '命中的报警黑名单UUID。', + 'type' => 'string', + 'example' => '8410dbbd-7d30-41c5-94cb-****', + ], + 'Message' => [ + 'description' => '报警相关信息,为一个JSON串。', + 'type' => 'string', + 'example' => '{"alertName":"e47aa0ac-4076-44db-a47d-d1083968****_Availability"}', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'LevelChange' => [ + 'description' => '报警级别的变更。取值:'."\n" + .'- `P4->OK`:由P4级别报警到报警恢复。'."\n" + .'- `P4->P4`:P4级别报警。', + 'type' => 'string', + 'example' => 'P4->OK', + ], + 'InstanceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i-m5e1qg6uo38rztr4****', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'CPU使用率', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'd582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime', + ], + 'BlackListName' => [ + 'description' => '命中的报警黑名单名称。', + 'type' => 'string', + 'example' => 'Black_Test', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'ECS_Instances', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '7301****', + ], + 'AlertTime' => [ + 'description' => '发生报警的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1610043776621', + ], + 'InstanceName' => [ + 'description' => '资源名称。', + 'type' => 'string', + 'example' => 'portalHost', + ], + 'BlackListDetail' => [ + 'description' => '命中的报警黑名单详情。', + 'type' => 'string', + 'example' => '{"id":12****,"metricProject":"acs_ecs_dashboard","userId":173651113438****,"uuid":"8410dbbd-7d30-41c5-94cb-****","name":"alert-****","productCategory":"ecs","instances":[{"instanceId":"i-m5e1qg6uo38rztr4****"}],"metrics":null,"scopeType":"USER","scopeValue":"","startTime":"0001-01-01T00:00:00Z","endTime":"9999-12-31T23:59:59.999999999+08:00","effectiveTime":null,"isEnable":true,"status":1,"gmtCreate":"2021-11-02T16:35:59+08:00","gmtModified":"2021-11-02T16:35:59+08:00","loadTime":"2021-11-02T16:36:15.213072177+08:00"}', + ], + 'Level' => [ + 'description' => '报警级别和报警通知方式。取值:'."\n" + ."\n" + .'<props="china">- P2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>', + 'type' => 'string', + 'example' => 'P4', + ], + 'SendStatus' => [ + 'description' => '报警状态。取值:'."\n" + .'- 0:发生报警或报警恢复正常。'."\n" + .'- 1:非生效期。'."\n" + .'- 2:通道沉默周期。'."\n" + .'- 3:主机重启中。'."\n" + .'- 4:不发送报警。'."\n" + ."\n" + .'<props="china">当报警状态为0时,如果Level的取值为P2、P3或P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="intl">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="partner">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>', + 'type' => 'string', + 'example' => '0', + ], + 'ExtendedInfo' => [ + 'description' => '报警的扩展信息。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '扩展字段名称。', + 'type' => 'string', + 'example' => 'userId', + ], + 'Value' => [ + 'description' => '扩展字段值。', + 'type' => 'string', + 'example' => '100931896542****', + ], + ], + ], + ], + 'Dimensions' => [ + 'description' => '报警资源的维度。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '报警资源的Key。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'Value' => [ + 'description' => '报警资源的Value。', + 'type' => 'string', + 'example' => 'i-m5e1qg6uo38rztr4****', + ], + ], + ], + ], + 'WebhookList' => [ + 'description' => '报警回调的URL地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => '报警回调的状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'url' => [ + 'description' => '报警回调的URL地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/webhook.html', + ], + 'message' => [ + 'description' => '报警回调的返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + 'DingdingWebhookList' => [ + 'description' => '报警联系人的webhook地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的Webhook地址列表。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****', + ], + ], + 'ContactOnCallList' => [ + 'description' => '报警联系人的电话通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的电话通知列表。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '1368888****', + ], + ], + 'ContactMailList' => [ + 'description' => '报警联系人的邮件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的邮件列表。', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + 'ContactGroups' => [ + 'description' => '报警联系人组的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + ], + 'ContactALIIWWList' => [ + 'description' => '旺旺报警联系人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的旺旺列表。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => 'Alice', + ], + ], + 'ContactSMSList' => [ + 'description' => '报警联系人的短信通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的短信通知列表。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '1368888****', + ], + ], + 'ContactDingList' => [ + 'description' => '报警联系人的钉钉列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的钉钉列表。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + ], + 'SendDetail' => [ + 'description' => '报警推送结果详情。', + 'type' => 'object', + 'properties' => [ + 'ResultCode' => [ + 'description' => '报警信息推送状态。'."\n" + ."\n" + .'- success:推送成功。'."\n" + ."\n" + .'- 错误码:当配置错误时,无推送列表,显示错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'ChannelResultList' => [ + 'description' => '按报警渠道推送的报警结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '按报警渠道推送的报警结果。', + 'type' => 'object', + 'properties' => [ + 'Channel' => [ + 'description' => '报警推送渠道。取值:'."\n" + ."\n" + .'- MAIL:邮件。'."\n" + ."\n" + .'- SMS:短信。'."\n" + ."\n" + .'- WEBHOOK:报警回调。'."\n" + ."\n" + .'- SLS:日志服务。'."\n" + ."\n" + .'- ONCALL:电话。'."\n" + ."\n" + .'- FC:函数计算'."\n" + ."\n" + .'- MNS:消息队列。', + 'type' => 'string', + 'example' => 'MAIL', + ], + 'ResultList' => [ + 'description' => '云监控向报警渠道发送的报警信息结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '云监控向报警渠道发送的报警信息结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'- 当`Channel`为`WEBHOOK`时,状态码为200或500。'."\n" + ."\n" + .'- 当`Channel`为`MAIL`、`SMS`、`SLS`、`ONCALL`、`FC`和`MNS`时,无该参数,或该参数为空。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '调用其他云产品返回的请求ID。', + 'type' => 'string', + 'example' => '0BDAF8A8-04DC-5F0C-90E4-724D42C4****', + ], + 'Success' => [ + 'description' => '调用目标的结果'."\n" + ."\n" + .'- true 成功'."\n" + ."\n" + .'- false 失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Detail' => [ + 'description' => '返回结果详情。', + 'type' => 'string', + 'example' => '{ }', + ], + 'notifyTargetList' => [ + 'description' => '渠道通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '渠道通知列表。', + 'type' => 'string', + 'example' => 'MAIL', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Escalation' => [ + 'description' => '触发报警的规则。', + 'type' => 'object', + 'properties' => [ + 'Expression' => [ + 'description' => '触发报警的规则描述。'."\n" + ."\n" + .'> 报警规则的主体,当监控数据满足报警条件时,触发报警规则。', + 'type' => 'string', + 'example' => '$Average<90', + ], + 'Times' => [ + 'description' => '报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Level' => [ + 'description' => '报警级别和报警通知方式。取值:'."\n" + ."\n" + .'<props="china">- P2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>', + 'type' => 'string', + 'example' => 'P4', + ], + ], + ], + 'SendResultList' => [ + 'description' => '报警的发送结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警的发送结果列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '发送报警渠道。取值:'."\n" + .'- MAIL:邮件。'."\n" + .'- ALIIM:旺旺。'."\n" + .'- SMS:短信。'."\n" + .'- CALL:电话。'."\n" + .'- DING:钉钉机器人。'."\n" + .'- Merged:报警合并。', + 'type' => 'string', + 'example' => 'MAIL', + ], + 'Value' => [ + 'description' => '报警渠道对应的通知对象。', + 'type' => 'array', + 'items' => [ + 'description' => '报警渠道对应的通知对象。', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + ], + ], + 'LogId' => [ + 'description' => '日志ID。', + 'type' => 'string', + 'example' => '7510****::e8a472a0-46ae-4ac0-84b1-e46be368****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Parameter invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"AlertLogList\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EventName\\": \\"IOHang\\",\\n \\"Product\\": \\"ECS\\",\\n \\"BlackListUUID\\": \\"8410dbbd-7d30-41c5-94cb-****\\",\\n \\"Message\\": \\"{\\\\\\"alertName\\\\\\":\\\\\\"e47aa0ac-4076-44db-a47d-d1083968****_Availability\\\\\\"}\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"LevelChange\\": \\"P4->OK\\",\\n \\"InstanceId\\": \\"i-m5e1qg6uo38rztr4****\\",\\n \\"RuleName\\": \\"CPU使用率\\",\\n \\"RuleId\\": \\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\\",\\n \\"BlackListName\\": \\"Black_Test\\",\\n \\"GroupName\\": \\"ECS_Instances\\",\\n \\"GroupId\\": \\"7301****\\",\\n \\"AlertTime\\": \\"1610043776621\\",\\n \\"InstanceName\\": \\"portalHost\\",\\n \\"BlackListDetail\\": \\"{\\\\\\"id\\\\\\":12****,\\\\\\"metricProject\\\\\\":\\\\\\"acs_ecs_dashboard\\\\\\",\\\\\\"userId\\\\\\":173651113438****,\\\\\\"uuid\\\\\\":\\\\\\"8410dbbd-7d30-41c5-94cb-****\\\\\\",\\\\\\"name\\\\\\":\\\\\\"alert-****\\\\\\",\\\\\\"productCategory\\\\\\":\\\\\\"ecs\\\\\\",\\\\\\"instances\\\\\\":[{\\\\\\"instanceId\\\\\\":\\\\\\"i-m5e1qg6uo38rztr4****\\\\\\"}],\\\\\\"metrics\\\\\\":null,\\\\\\"scopeType\\\\\\":\\\\\\"USER\\\\\\",\\\\\\"scopeValue\\\\\\":\\\\\\"\\\\\\",\\\\\\"startTime\\\\\\":\\\\\\"0001-01-01T00:00:00Z\\\\\\",\\\\\\"endTime\\\\\\":\\\\\\"9999-12-31T23:59:59.999999999+08:00\\\\\\",\\\\\\"effectiveTime\\\\\\":null,\\\\\\"isEnable\\\\\\":true,\\\\\\"status\\\\\\":1,\\\\\\"gmtCreate\\\\\\":\\\\\\"2021-11-02T16:35:59+08:00\\\\\\",\\\\\\"gmtModified\\\\\\":\\\\\\"2021-11-02T16:35:59+08:00\\\\\\",\\\\\\"loadTime\\\\\\":\\\\\\"2021-11-02T16:36:15.213072177+08:00\\\\\\"}\\",\\n \\"Level\\": \\"P4\\",\\n \\"SendStatus\\": \\"0\\",\\n \\"ExtendedInfo\\": [\\n {\\n \\"Name\\": \\"userId\\",\\n \\"Value\\": \\"100931896542****\\"\\n }\\n ],\\n \\"Dimensions\\": [\\n {\\n \\"Key\\": \\"instanceId\\",\\n \\"Value\\": \\"i-m5e1qg6uo38rztr4****\\"\\n }\\n ],\\n \\"WebhookList\\": [\\n {\\n \\"code\\": \\"200\\",\\n \\"url\\": \\"https://www.aliyun.com/webhook.html\\",\\n \\"message\\": \\"success\\"\\n }\\n ],\\n \\"DingdingWebhookList\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=b7ff24032da1a5f86659ecda46797e13cc1d4e4da6903d7b014ea1d1488b****\\"\\n ],\\n \\"ContactOnCallList\\": [\\n \\"1368888****\\"\\n ],\\n \\"ContactMailList\\": [\\n \\"[email protected]\\"\\n ],\\n \\"ContactGroups\\": [\\n \\"ECS_Group\\"\\n ],\\n \\"ContactALIIWWList\\": [\\n \\"Alice\\"\\n ],\\n \\"ContactSMSList\\": [\\n \\"1368888****\\"\\n ],\\n \\"ContactDingList\\": [\\n \\"CloudMonitor\\"\\n ],\\n \\"SendDetail\\": {\\n \\"ResultCode\\": \\"success\\",\\n \\"ChannelResultList\\": [\\n {\\n \\"Channel\\": \\"MAIL\\",\\n \\"ResultList\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0BDAF8A8-04DC-5F0C-90E4-724D42C4****\\",\\n \\"Success\\": true,\\n \\"Detail\\": \\"{ }\\",\\n \\"notifyTargetList\\": [\\n \\"MAIL\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Escalation\\": {\\n \\"Expression\\": \\"$Average<90\\",\\n \\"Times\\": 1,\\n \\"Level\\": \\"P4\\"\\n },\\n \\"SendResultList\\": [\\n {\\n \\"Key\\": \\"MAIL\\",\\n \\"Value\\": [\\n \\"[email protected]\\"\\n ]\\n }\\n ],\\n \\"LogId\\": \\"7510****::e8a472a0-46ae-4ac0-84b1-e46be368****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertLogListResponse>\\r\\n\\t<AlertLogList>\\r\\n\\t\\t<GroupName></GroupName>\\r\\n\\t\\t<Message>{\\\\\\"alertName\\\\\\":\\\\\\"d582b9e9-b1c1-4f17-9279-0fe7333a****_ResponseTime\\\\\\",\\\\\\"curLevel\\\\\\":\\\\\\"OK\\\\\\",\\\\\\"dimensions\\\\\\":{\\\\\\"taskId\\\\\\":\\\\\\"d582b9e9-b1c1-4f17-9279-0fe7333a****\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"127067667954****\\\\\\"},\\\\\\"escalation\\\\\\":{\\\\\\"expression\\\\\\":\\\\\\"$Average>=800\\\\\\",\\\\\\"level\\\\\\":P4,\\\\\\"tag\\\\\\":\\\\\\"P4\\\\\\",\\\\\\"times\\\\\\":1}</Message>\\r\\n\\t\\t<RuleId>d582b9e9-b1c1-4f17-9279-0fe7****_ResponseTime</RuleId>\\r\\n\\t\\t<Escalation>\\r\\n\\t\\t\\t<Expression>$Average>=800</Expression>\\r\\n\\t\\t\\t<Times>1</Times>\\r\\n\\t\\t\\t<Level>P4</Level>\\r\\n\\t\\t</Escalation>\\r\\n\\t\\t<SendStatus>0</SendStatus>\\r\\n\\t\\t<Product>acs_ecs_dashboard</Product>\\r\\n\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t<RuleName>CPU使用率</RuleName>\\r\\n\\t\\t<ContactGroups>ECS_Group</ContactGroups>\\r\\n\\t\\t<InstanceId></InstanceId>\\r\\n\\t\\t<LevelChange>P4->OK</LevelChange>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<Value>100931896542****</Value>\\r\\n\\t\\t\\t<Key>userId</Key>\\r\\n\\t\\t</Dimensions>\\r\\n\\t\\t<Dimensions>\\r\\n\\t\\t\\t<Value>i-abcdefgh12****</Value>\\r\\n\\t\\t\\t<Key>instanceId</Key>\\r\\n\\t\\t</Dimensions>\\r\\n\\t\\t<EventName>AlertOk</EventName>\\r\\n\\t\\t<ExtendedInfo>\\r\\n\\t\\t\\t<Value>i-hp34y1eiszazu49y****</Value>\\r\\n\\t\\t\\t<Name>instanceId</Name>\\r\\n\\t\\t</ExtendedInfo>\\r\\n\\t\\t<ExtendedInfo>\\r\\n\\t\\t\\t<Value>12706****</Value>\\r\\n\\t\\t\\t<Name>userId</Name>\\r\\n\\t\\t</ExtendedInfo>\\r\\n\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t<AlertTime>1610085521564</AlertTime>\\r\\n\\t\\t<GroupId>7301****</GroupId>\\r\\n\\t\\t<InstanceName>portalHost</InstanceName>\\r\\n\\t\\t<Level>OK</Level>\\r\\n\\t</AlertLogList>\\r\\n\\t<RequestId>6FCB1AB7-57F7-4DDA-B14E-6468FAFE79D9</RequestId>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertLogListResponse>\\t","errorExample":""}]', + 'title' => '查询报警历史', + 'description' => '该接口只能查询到最近一年的报警历史。'."\n" + ."\n" + .'本文将提供一个示例,从云产品`product`维度查询云服务器ECS的报警历史。', + 'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAlertLogHistogram' => [ + 'summary' => '调用DescribeAlertLogHistogram接口查询报警历史的直方图列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'> - 您只能查询最近一年的报警历史。'."\n" + .'> - 开始时间(`StartTime`)和结束时间(`EndTime`)之间必须小于等于15天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1609988009694', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'> - 您只能查询最近一年的报警历史。'."\n" + .'> - 开始时间(`StartTime`)和结束时间(`EndTime`)之间必须小于等于15天。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1609989009694', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史的搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'alert', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7301****', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务名称缩写。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的命名空间。'."\n" + ."\n" + .'>关于云服务的命名空间,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '报警的级别和通知方式。取值:'."\n" + ."\n" + .'<props="china">- P2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- P4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'P4', + ], + ], + [ + 'name' => 'SendStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '报警状态。取值:'."\n" + .'- 0:发生报警或报警恢复正常。'."\n" + .'- 1:非生效期。'."\n" + .'- 2:通道沉默周期。'."\n" + .'- 3:主机重启中。'."\n" + .'- 4:不发送报警。'."\n" + ."\n" + .'<props="china">当报警状态为0时,如果Level的取值为P2、P3或P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="intl">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>'."\n" + .'<props="partner">当报警状态为0时,如果Level的取值为P4,则发生告警;如果Level的取值为OK,则报警恢复正常。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ContactGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test123', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'>关于云服务的监控项,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'LastMin', + 'in' => 'query', + 'schema' => [ + 'description' => '获取日志的周期。单位:分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '360', + ], + ], + [ + 'name' => 'GroupBy', + 'in' => 'query', + 'schema' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。取值:'."\n" + .'- `product`:按照云服务统计。'."\n" + .'- `level`:按照报警级别统计。'."\n" + .'- `groupId`:按照应用分组统计。'."\n" + .'- `contactGroup`:按照报警联系人组统计。'."\n" + .'- `product,metricName`:按照云服务和监控项统计。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'product', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '告警类型。取值:'."\n" + ."\n" + .'- TRIGGERED:告警触发。'."\n" + .'- RESOLVED:告警恢复。', + 'type' => 'string', + 'required' => false, + 'example' => 'RESOLVED', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n\n" + .'关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ae06917_75a8c43178ab66****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1C4A3709-BF52-42EE-87B5-7435F0929585', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertLogHistogramList' => [ + 'description' => '查询报警历史的直方图列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'From' => [ + 'description' => '查询报警历史的开始时间戳。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1610074791', + ], + 'To' => [ + 'description' => '查询报警历史的结束时间戳。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1610074800', + ], + 'Count' => [ + 'description' => '报警历史的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"1C4A3709-BF52-42EE-87B5-7435F0929585\\",\\n \\"Success\\": true,\\n \\"AlertLogHistogramList\\": [\\n {\\n \\"From\\": 1610074791,\\n \\"To\\": 1610074800,\\n \\"Count\\": 20\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertLogHistogramResponse>\\n <Code>200</Code>\\n <Message>The specified resource is not found.</Message>\\n <RequestId>1C4A3709-BF52-42EE-87B5-7435F0929585</RequestId>\\n <Success>true</Success>\\n <AlertLogHistogramList>\\n <From>1610074791</From>\\n <To>1610074800</To>\\n <Count>20</Count>\\n </AlertLogHistogramList>\\n</DescribeAlertLogHistogramResponse>","errorExample":""}]', + 'title' => '查询报警历史的直方图列表', + 'description' => '本文将提供一个示例,从云服务`product`维度查询ECS报警历史的直方图列表。', + 'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeProductsOfActiveMetricRule' => [ + 'summary' => '调用DescribeProductsOfActiveMetricRule接口查询开通一键报警规则的云服务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', + ], + 'Datapoints' => [ + 'description' => '开通一键报警的云服务列表。云服务之间用英文逗号(,)分隔。取值:'."\n" + .' '."\n" + .'- ecs:云服务器ECS。'."\n" + .'- rds:云数据库RDS版。'."\n" + .'- slb:负载均衡。'."\n" + .'- redis_standard:Redis 开源版标准架构。'."\n" + .'- redis_sharding:Redis 开源版集群架构。'."\n" + .'- redis_splitrw:Redis 开源版读写分离架构。'."\n" + .'- mongodb:云数据库MongoDB版(副本集)。'."\n" + .'- mongodb_sharding:云数据库MongoDB版(分片集群)。'."\n" + .'- hbase:云数据库HBase版。'."\n" + .'- elasticsearch:Elasticsearch。'."\n" + .'- opensearch:OpenSearch。', + 'type' => 'string', + 'example' => 'ecs,rds', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllProductInitMetricRuleList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AllProductInitMetricRule' => [ + 'description' => '开通一键报警的云服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '开通一键报警的云服务列表。', + 'type' => 'object', + 'properties' => [ + 'Product' => [ + 'description' => '阿里云服务缩写。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'AlertInitConfigList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertInitConfig' => [ + 'description' => '初始化开通一键报警云服务的规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '初始化开通一键报警云服务的规则列表。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控项名称。详情请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'EvaluationCount' => [ + 'description' => '报警重试次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Namespace' => [ + 'description' => '指标所属空间。用于区分每个云服务配置。详情请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'acs_rds_dashboard', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => '报警统计方法。详情请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'Average', + ], + 'Period' => [ + 'description' => '监控数据的聚合周期。单位:分钟。详情请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => '1m', + ], + 'Level' => [ + 'description' => '报警级别。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INFO' => '信息', + 'WARN' => '警告', + 'CRITICAL' => '紧急', + ], + 'example' => 'CRITICAL', + ], + 'ComparisonOperator' => [ + 'description' => '警告级别阈值比较符。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LessThanThreshold' => '小于', + 'GreaterThanLastWeek' => '同比上周同一时间上涨', + 'LessThanOrEqualToThreshold' => '小于等于', + 'NotEqualToThreshold' => '不等于', + 'GreaterThanLastPeriod' => '环比上周期上涨', + 'GreaterThanYesterday' => '同比昨天时间上涨', + 'LessThanYesterday' => '同比昨天时间下降', + 'LessThanLastWeek' => '同比上周同一时间下降', + 'GreaterThanOrEqualToThreshold' => '大于等于', + 'GreaterThanThreshold' => '大于', + 'LessThanLastPeriod' => '环比上周期下降', + ], + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Datapoints\\": \\"ecs,rds\\",\\n \\"Success\\": true,\\n \\"AllProductInitMetricRuleList\\": {\\n \\"AllProductInitMetricRule\\": [\\n {\\n \\"Product\\": \\"ecs\\",\\n \\"AlertInitConfigList\\": {\\n \\"AlertInitConfig\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Namespace\\": \\"acs_rds_dashboard\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Period\\": \\"1m\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeProductsOfActiveMetricRuleResponse>\\r\\n\\t\\t<RequestId>A4FFAEFF-4225-4EF6-8F63-FAAA8F58289D</RequestId>\\r\\n\\t\\t<AllProductInitMetricRuleList>\\r\\n\\t\\t\\t<AllProductInitMetricRule>\\r\\n\\t\\t\\t\\t<AlertInitConfigList>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>CPUUtilization</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>vm.DiskUtilization</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>vm.MemoryUtilization</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>InternetOutRate_Percent</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>1m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>95</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t</AlertInitConfigList>\\r\\n\\t\\t\\t\\t<Product>ecs</Product>\\r\\n\\t\\t\\t</AllProductInitMetricRule>\\r\\n\\t\\t\\t<AllProductInitMetricRule>\\r\\n\\t\\t\\t\\t<AlertInitConfigList>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>CpuUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>DiskUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>IOPSUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>ConnectionUsage</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>DataDelay</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>5m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>5</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t</AlertInitConfigList>\\r\\n\\t\\t\\t\\t<Product>rds</Product>\\r\\n\\t\\t\\t</AllProductInitMetricRule>\\r\\n\\t\\t\\t<AllProductInitMetricRule>\\r\\n\\t\\t\\t\\t<AlertInitConfigList>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>DocSizeRatiobyApp</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>10m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>85</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>lossqpsbyapp</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>10m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>0</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>ComputeResourceRatiobyApp</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>10m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>85</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t<AlertInitConfig>\\r\\n\\t\\t\\t\\t\\t\\t<MetricName>app_realtime_write_latency</MetricName>\\r\\n\\t\\t\\t\\t\\t\\t<EvaluationCount>1</EvaluationCount>\\r\\n\\t\\t\\t\\t\\t\\t<Period>20m</Period>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Maximum</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Namespace>acs_opensearch</Namespace>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>1800000</Threshold>\\r\\n\\t\\t\\t\\t\\t</AlertInitConfig>\\r\\n\\t\\t\\t\\t</AlertInitConfigList>\\r\\n\\t\\t\\t\\t<Product>opensearch</Product>\\r\\n\\t\\t\\t</AllProductInitMetricRule>\\r\\n\\t\\t</AllProductInitMetricRuleList>\\r\\n\\t\\t<Datapoints>rds,redis_standard</Datapoints>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeProductsOfActiveMetricRuleResponse>","errorExample":""}]', + 'title' => '查询开通一键报警规则的云服务列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeActiveMetricRuleList' => [ + 'summary' => '调用DescribeActiveMetricRuleList接口查询一键报警规则的列表详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '支持一键报警规则的云产品名称缩写。'."\n" + ."\n" + .'关于如何获取云产品名称,请参见[DescribeProductsOfActiveMetricRule](~~114930~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通道沉默时间。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'MetricName' => [ + 'description' => '监控指标名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'EvaluationCount' => [ + 'description' => '报警重试次数。', + 'type' => 'string', + 'example' => '3', + ], + 'Webhook' => [ + 'description' => 'URL回调地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'State' => [ + 'description' => '报警规则的启用状态。', + 'type' => 'string', + 'example' => 'Enable', + ], + 'ContactGroups' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'SystemDefault_acs_rds_dashboard_CpuUsage', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', + ], + 'Period' => [ + 'description' => '监控数据的聚合周期。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + 'ComparisonOperator' => [ + 'description' => '报警规则比较符。取值:'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `=`', + 'type' => 'string', + 'example' => '>', + ], + 'EndTime' => [ + 'description' => '报警规则失效时间。'."\n" + ."\n" + .'单位:小时。例如:23表示`23:59:59`。', + 'type' => 'string', + 'example' => '24', + ], + 'StartTime' => [ + 'description' => '报警规则生效起始时间。'."\n" + ."\n" + .'单位:小时。例如:00表示`00:00:00`。', + 'type' => 'string', + 'example' => '00', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => '统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + 'Enable' => [ + 'description' => '报警规则的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'AlertList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alert' => [ + 'description' => '报警规则列表。该列表的结构和获取报警规则列表保持统一。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通道沉默时间。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '86400', + ], + 'MetricName' => [ + 'description' => '监控项的名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'Webhook' => [ + 'description' => 'URL回调地址。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + ], + 'ContactGroups' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + 'Namespace' => [ + 'description' => '云服务的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间段。', + 'type' => 'string', + 'example' => '00:00-23:59', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警不生效的时间段。', + 'type' => 'string', + 'example' => '00:00-06:00', + ], + 'MailSubject' => [ + 'description' => '发送邮件的主题。', + 'type' => 'string', + 'example' => 'ECS_Bucket', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'myAlert', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'ruleIdxxxx', + ], + 'Period' => [ + 'description' => '监控数据的聚合周期。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '60', + ], + 'AlertState' => [ + 'description' => '报警规则状态。取值:'."\n" + ."\n" + .'- OK:正常。'."\n" + ."\n" + .'- ALARM:报警。'."\n" + ."\n" + .'- INSUFFICIENT_DATA:无数据。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Dimensions' => [ + 'description' => '指定资源的监控数据。', + 'type' => 'string', + 'example' => '""', + ], + 'EnableState' => [ + 'description' => '报警规则的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resources' => [ + 'description' => '报警规则关联的资源。 ', + 'type' => 'string', + 'example' => '[{"resource":"_ALL"}]', + ], + 'Escalations' => [ + 'description' => '报警分级别触发条件。', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'Info级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanThreshold', + ], + 'Times' => [ + 'description' => 'Info级别连续出现次数。'."\n" + ."\n" + .'Info级别连续出现达到该值且超过阈值才会触发报警。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Info级别阈值。', + 'type' => 'string', + 'example' => '95', + ], + 'Statistics' => [ + 'description' => 'Info级别报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Warn' => [ + 'description' => 'Warn级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Warn级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanThreshold', + ], + 'Times' => [ + 'description' => 'Warn级别连续出现次数。'."\n" + ."\n" + .'Warn级别连续出现达到该值且超过阈值才会触发报警。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Warn级别阈值。', + 'type' => 'string', + 'example' => '80', + ], + 'Statistics' => [ + 'description' => 'Warn级别报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Critical' => [ + 'description' => 'Critical级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanThreshold', + ], + 'Times' => [ + 'description' => 'Critical级别连续出现次数。Critical级别连续出现达到该值且超过阈值才会触发报警。', + 'type' => 'string', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Critical级别阈值。', + 'type' => 'string', + 'example' => '99', + ], + 'Statistics' => [ + 'description' => 'Critical级别报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": \\"86400\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"EvaluationCount\\": \\"3\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"State\\": \\"Enable\\",\\n \\"ContactGroups\\": \\"ECS_Group\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"RuleName\\": \\"SystemDefault_acs_rds_dashboard_CpuUsage\\",\\n \\"RuleId\\": \\"a151cd6023eacee2f0978e03863cc1697c89508****\\",\\n \\"Period\\": \\"60\\",\\n \\"ComparisonOperator\\": \\">\\",\\n \\"EndTime\\": \\"24\\",\\n \\"StartTime\\": \\"00\\",\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": \\"true\\"\\n }\\n ]\\n },\\n \\"AlertList\\": {\\n \\"Alert\\": [\\n {\\n \\"SilenceTime\\": \\"86400\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Webhook\\": \\"http://www.aliyun.com\\",\\n \\"ContactGroups\\": \\"ECS_Group\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"EffectiveInterval\\": \\"00:00-23:59\\",\\n \\"NoEffectiveInterval\\": \\"00:00-06:00\\",\\n \\"MailSubject\\": \\"ECS_Bucket\\",\\n \\"RuleName\\": \\"myAlert\\",\\n \\"RuleId\\": \\"ruleIdxxxx\\",\\n \\"Period\\": \\"60\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Dimensions\\": \\"\\\\\\"\\\\\\"\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"95\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"80\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanThreshold\\",\\n \\"Times\\": \\"3\\",\\n \\"Threshold\\": \\"99\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeActiveMetricRuleListResponse>\\r\\n\\t\\t<AlertList>\\r\\n\\t\\t\\t<Alert>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>ECS_Group</ContactGroups>\\r\\n\\t\\t\\t\\t<NoEffectiveInterval></NoEffectiveInterval>\\r\\n\\t\\t\\t\\t<MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<Dimensions></Dimensions>\\r\\n\\t\\t\\t\\t<EffectiveInterval></EffectiveInterval>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<AlertState>INSUFFICIENT_DATA</AlertState>\\r\\n\\t\\t\\t\\t<MetricName>IOPSUsage</MetricName>\\r\\n\\t\\t\\t\\t<EnableState>true</EnableState>\\r\\n\\t\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t\\t<Critical />\\r\\n\\t\\t\\t\\t\\t<Info>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>5</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</Info>\\r\\n\\t\\t\\t\\t\\t<Warn />\\r\\n\\t\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<Resources>[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]</Resources>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>\\r\\n\\t\\t\\t</Alert>\\r\\n\\t\\t\\t<Alert>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>ECS_Group</ContactGroups>\\r\\n\\t\\t\\t\\t<NoEffectiveInterval></NoEffectiveInterval>\\r\\n\\t\\t\\t\\t<MailSubject>${serviceType}-${metricName}-${levelDescription}</MailSubject>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<Dimensions></Dimensions>\\r\\n\\t\\t\\t\\t<EffectiveInterval></EffectiveInterval>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<AlertState>INSUFFICIENT_DATA</AlertState>\\r\\n\\t\\t\\t\\t<MetricName>CpuUsage</MetricName>\\r\\n\\t\\t\\t\\t<EnableState>true</EnableState>\\r\\n\\t\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t\\t<Critical />\\r\\n\\t\\t\\t\\t\\t<Info>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>5</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t\\t\\t</Info>\\r\\n\\t\\t\\t\\t\\t<Warn />\\r\\n\\t\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<Resources>[{\\\\\\"resource\\\\\\":\\\\\\"_ALL\\\\\\"}]</Resources>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>\\r\\n\\t\\t\\t</Alert>\\r\\n\\t\\t</AlertList>\\r\\n\\t\\t<Datapoints>\\r\\n\\t\\t\\t<Alarm>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>[\\\\\\"Alice\\\\\\"]</ContactGroups>\\r\\n\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t<EndTime></EndTime>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleId>\\r\\n\\t\\t\\t\\t<StartTime></StartTime>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<MetricName>IOPSUsage</MetricName>\\r\\n\\t\\t\\t\\t<State>INSUFFICIENT_DATA</State>\\r\\n\\t\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_IOPSUsage</RuleName>\\r\\n\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t</Alarm>\\r\\n\\t\\t\\t<Alarm>\\r\\n\\t\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t\\t<ContactGroups>[\\\\\\"Jim\\\\\\"]</ContactGroups>\\r\\n\\t\\t\\t\\t<ComparisonOperator>GreaterThanThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t<EndTime></EndTime>\\r\\n\\t\\t\\t\\t<RuleId>SystemDefault_acs_rds_dashboard_CpuUsage</RuleId>\\r\\n\\t\\t\\t\\t<StartTime></StartTime>\\r\\n\\t\\t\\t\\t<Period>300</Period>\\r\\n\\t\\t\\t\\t<EvaluationCount>5</EvaluationCount>\\r\\n\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t<Namespace>acs_rds_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<MetricName>CpuUsage</MetricName>\\r\\n\\t\\t\\t\\t<State>INSUFFICIENT_DATA</State>\\r\\n\\t\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<RuleName>SystemDefault_acs_rds_dashboard_CpuUsage</RuleName>\\r\\n\\t\\t\\t\\t<Threshold>80</Threshold>\\r\\n\\t\\t\\t</Alarm>\\r\\n\\t\\t</Datapoints>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeActiveMetricRuleListResponse>","errorExample":""}]', + 'title' => '查询一键报警规则的列表详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableActiveMetricRule' => [ + 'summary' => '调用EnableActiveMetricRule接口启用一键报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '支持一键报警规则的云服务名称。取值:'."\n" + ."\n" + .'* ecs:云服务器ECS。'."\n" + .'* rds:云数据库RDS版。'."\n" + .'* slb:负载均衡。'."\n" + .'* redis_standard:Redis 开源版标准架构。'."\n" + .'* redis_sharding:Redis 开源版集群架构。'."\n" + .'* redis_splitrw:Redis 开源版读写分离架构。'."\n" + .'* mongodb:云数据库MongoDB版(副本集)。'."\n" + .'* mongodb_sharding:云数据库MongoDB版(分片集群)。'."\n" + .'* hbase:云数据库HBase版。'."\n" + .'* elasticsearch:Elasticsearch。'."\n" + .'* opensearch:OpenSearch。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableActiveMetricRuleResponse>\\n <Code>200</Code>\\n <Success>true</Success>\\n <RequestId>55850888-9CCE-4FD5-B949-5F8947D63929</RequestId>\\n</EnableActiveMetricRuleResponse>","errorExample":""}]', + 'title' => '启用一键报警规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableActiveMetricRule' => [ + 'summary' => '调用DisableActiveMetricRule接口禁用一键报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '支持一键报警规则的云服务名称。取值:'."\n" + ."\n" + .'* ecs:云服务器ECS。'."\n" + .'* rds:云数据库RDS版。'."\n" + .'* slb:负载均衡。'."\n" + .'* redis_standard:Redis 开源版标准架构。'."\n" + .'* redis_sharding:Redis 开源版集群架构。'."\n" + .'* redis_splitrw:Redis 开源版读写分离架构。'."\n" + .'* mongodb:云数据库MongoDB版(副本集)。'."\n" + .'* mongodb_sharding:云数据库MongoDB版(分片集群)。'."\n" + .'* hbase:云数据库HBase版。'."\n" + .'* elasticsearch:Elasticsearch。'."\n" + .'* opensearch:OpenSearch。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F82E6667-7811-4BA0-842F-5B2DC42BBAAD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"F82E6667-7811-4BA0-842F-5B2DC42BBAAD\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '禁用一键报警规则', + ], + 'CreateMetricRuleTemplate' => [ + 'summary' => '调用CreateMetricRuleTemplate接口创建报警模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Template1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Template1', + ], + ], + [ + 'name' => 'AlertTemplates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警模板。', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => [ + 'description' => '普通级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + 'MetricName' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取监控项,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_total', + ], + 'Webhook' => [ + 'description' => '报警发生回调时的URL地址。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://ww.aliyun.com', + ], + 'Escalations.Warn.Threshold' => [ + 'description' => '警告级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'Namespace' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取云产品的数据命名空间,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + 'Period' => [ + 'description' => '监控数据的聚合周期。单位:秒。'."\n" + ."\n" + .'默认为监控项对应的最小周期,通常不需要指定。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'RuleName' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Rule1', + ], + 'Escalations.Critical.Times' => [ + 'description' => '发送紧急报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Selector' => [ + 'description' => 'Dimension扩展字段的选项。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'例如:报警模板被应用到了一个应用分组中,当该参数设置为`{"disk":"/"}`,监控项(MetricName)设置为`DiskUtilization`时,表示关联报警模板的应用分组中所有实例的磁盘根分区(`"/"`) 被关联到了对应报警规则中。'."\n" + ."\n" + .'>关于扩展字段选项的取值,请参见[DescribeMetricRuleTemplateAttribute](~~114979~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"disk":"/"}', + ], + 'Escalations.Info.Statistics' => [ + 'description' => '普通级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Warn.Times' => [ + 'description' => '发送警告报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Escalations.Info.ComparisonOperator' => [ + 'description' => '普通级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Category' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + 'Escalations.Critical.Threshold' => [ + 'description' => '触发紧急级别报警通知的阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'Escalations.Critical.Statistics' => [ + 'description' => '紧急级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Critical.ComparisonOperator' => [ + 'description' => '紧急级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Warn.ComparisonOperator' => [ + 'description' => '警告级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Info.Times' => [ + 'description' => '发送普通报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Escalations.Warn.Statistics' => [ + 'description' => '警告级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9763ED1A-4D09-41BF-851E-310421750204', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '报警模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'InvalidClientTokenId', + 'errorMessage' => 'not allow this operation.', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 412 => [ + [ + 'errorCode' => 'ResourcesOverLimit', + 'errorMessage' => 'Resources over limit.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalFailure', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9763ED1A-4D09-41BF-851E-310421750204\\",\\n \\"Success\\": true,\\n \\"Id\\": 12345\\n}","errorExample":""},{"type":"xml","example":"<CreateMetricRuleTemplateResponse>\\n\\t\\t<RequestId>9763ED1A-4D09-41BF-851E-310421750204</RequestId>\\n\\t\\t<Id>12345</Id>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</CreateMetricRuleTemplateResponse>","errorExample":""}]', + 'title' => '创建报警模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMetricRuleTemplate' => [ + 'summary' => '调用DeleteMetricRuleTemplate接口删除报警规则模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123****', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B63F8CF-D48D-4608-A402-04FB5B2B4B6A', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resource' => [ + 'description' => '模板信息。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'example' => '123****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"7B63F8CF-D48D-4608-A402-04FB5B2B4B6A\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"TemplateId\\": \\"123****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleTemplateResponse>\\r\\n <Resource>\\r\\n <TemplateId>123****</TemplateId>\\r\\n </Resource>\\r\\n <RequestId>7B63F8CF-D48D-4608-A402-04FB5B2B4B6A</RequestId>\\r\\n <Success>true</Success>\\r\\n <Code>200</Code>\\r\\n</DeleteMetricRuleTemplateResponse>","errorExample":""}]', + 'title' => '删除报警规则模板', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyMetricRuleTemplate' => [ + 'summary' => '调用ModifyMetricRuleTemplate接口修改报警模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板ID。'."\n" + ."\n" + .'关于如何获取报警模板ID,请参见[DescribeMetricRuleTemplateList](~~114982~~)。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板名称。'."\n" + ."\n" + .'关于如何获取报警模板名称,请参见[DescribeMetricRuleTemplateList](~~114982~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Template_123', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_template1', + ], + ], + [ + 'name' => 'RestVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板的版本。该参数随报警模板的修改次数自动更新。'."\n" + ."\n" + .'关于如何获取报警模板的版本,请参见[DescribeMetricRuleTemplateList](~~114982~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'AlertTemplates', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警模板列表。', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => [ + 'description' => '普通级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + 'MetricName' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取监控项,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + 'Webhook' => [ + 'description' => '报警发生回调时的URL地址。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + 'Escalations.Warn.Threshold' => [ + 'description' => '警告级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'Namespace' => [ + 'description' => '云产品的命名空间。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取云产品的命名空间,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + 'Period' => [ + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 设置为300秒,表示每300秒统计一次监控值。如果监控数据每分钟上报一次,则会统计5分钟的值(平均值、最大值、最小值)。因为该统计周期可能会造成非您期望的报警,所以目前不建议您单独设置该参数。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'RuleName' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => 'Rule_123', + ], + 'Escalations.Critical.Times' => [ + 'description' => '发送紧急报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Selector' => [ + 'description' => 'Dimension扩展字段的选项。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'例如:报警模板被应用到了一个应用分组中,当该参数设置为`{"disk":"/"}`,监控项(MetricName)设置为`DiskUtilization`时,表示关联报警模板的应用分组中所有实例的磁盘根分区(`"/"`) 被关联到了对应报警规则中。'."\n" + ."\n" + .'>关于扩展字段选项的取值,请参见[DescribeMetricRuleTemplateAttribute](~~114979~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"disk":"/"}', + ], + 'Escalations.Info.Statistics' => [ + 'description' => '普通级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Warn.Times' => [ + 'description' => '发送警告报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Escalations.Info.ComparisonOperator' => [ + 'description' => '普通级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Category' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + 'Escalations.Critical.Threshold' => [ + 'description' => '触发紧急级别报警通知的阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'Escalations.Critical.Statistics' => [ + 'description' => '紧急级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Critical.ComparisonOperator' => [ + 'description' => '紧急级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Warn.ComparisonOperator' => [ + 'description' => '警告级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Info.Times' => [ + 'description' => '发送普通报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Escalations.Warn.Statistics' => [ + 'description' => '警告级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E07117F-F6AE-4F1C-81E8-36FBB4892235', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidQueryParameter', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'InvalidClientTokenId', + 'errorMessage' => 'The X.509 certificate or cms access key ID provided does not exist in our records.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalFailure', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"9E07117F-F6AE-4F1C-81E8-36FBB4892235\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ModifyMetricRuleTemplateResponse>\\n\\t\\t<RequestId>97EAC0E2-CD54-4183-95AC-F0C113024E18</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</ModifyMetricRuleTemplateResponse>","errorExample":""}]', + 'title' => '修改报警模板', + 'description' => '本文将提供一个示例,修改版本`1`的报警模板`123456`,将报警级别修改为`Critical`,报警统计方法修改为`Average`,报警阈值比较符修改为`GreaterThanOrEqualToThreshold`,报警阈值修改为`90`,报警重试次数修改为`3`。返回结果显示,修改报警模板成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetricRuleTemplateAttribute' => [ + 'summary' => '调用DescribeMetricRuleTemplateAttribute接口查询报警模板详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板名称。`Name`和`TemplateId`必须设置一个。'."\n" + ."\n" + .'关于如何获取报警模板名称,请参见[DescribeMetricRuleTemplateList](~~114982~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Template1', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板ID。`Name`和`TemplateId`必须设置一个。'."\n" + ."\n" + .'关于如何获取报警模板ID,请参见[DescribeMetricRuleTemplateList](~~114982~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '70****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8F3A82AD-DA92-52B0-8EC6-C059D1C3839F', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resource' => [ + 'description' => '报警模板详情。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '报警模板描述信息。', + 'type' => 'string', + 'example' => 'ECS模板', + ], + 'Name' => [ + 'description' => '报警模板名称。', + 'type' => 'string', + 'example' => 'ECS_Template1', + ], + 'RestVersion' => [ + 'description' => '报警模板版本。', + 'type' => 'string', + 'example' => '1', + ], + 'TemplateId' => [ + 'description' => '报警模板ID。', + 'type' => 'string', + 'example' => '70****', + ], + 'AlertTemplates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertTemplate' => [ + 'description' => '报警模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警模板。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'Selector' => [ + 'description' => '报警维度扩展选项。', + 'type' => 'string', + 'example' => '{"disk":"/"}', + ], + 'Webhook' => [ + 'description' => '触发报警回调的URL地址。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'Namespace' => [ + 'description' => '云服务的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Category' => [ + 'description' => '云服务名称缩写。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'ECS_Rule', + ], + 'NoDataPolicy' => [ + 'description' => '无监控数据时报警的处理方式。取值:'."\n" + .'- KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'- OK:正常。', + 'type' => 'string', + 'example' => 'KEEP_LAST_STATE', + ], + 'Escalations' => [ + 'description' => '阈值及报警级别。', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'Info级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Info级别的阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Times' => [ + 'description' => 'Info级别的重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Info级别的阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => 'Info级别的统计方法。'."\n" + ."\n" + .'每个云服务的`Statistics`取值不同。更多信息,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Warn' => [ + 'description' => 'Warn级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Warn级别阈值的比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Times' => [ + 'description' => 'Warn级别的重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Warn级别的阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => 'Warn级别的统计方法。'."\n" + ."\n" + .'每个云服务的`Statistics`取值不同。更多信息,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Critical' => [ + 'description' => 'Critical级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Critical级别的阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Times' => [ + 'description' => 'Critical级别的重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Threshold' => [ + 'description' => 'Critical级别的阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => 'Critical级别的统计方法。'."\n" + ."\n" + .'每个云服务的`Statistics`取值不同。更多信息,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + ], + ], + 'Labels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Labels' => [ + 'description' => '报警模板标签。', + 'type' => 'array', + 'items' => [ + 'description' => '报警模板的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '报警模板的标签键。', + 'type' => 'string', + 'example' => 'label1', + ], + 'Value' => [ + 'description' => '报警模板的标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + 'SilenceTime' => [ + 'description' => '通道沉默时间。单位:秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"8F3A82AD-DA92-52B0-8EC6-C059D1C3839F\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"Description\\": \\"ECS模板\\",\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"RestVersion\\": \\"1\\",\\n \\"TemplateId\\": \\"70****\\",\\n \\"AlertTemplates\\": {\\n \\"AlertTemplate\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Selector\\": \\"{\\\\\\"disk\\\\\\":\\\\\\"/\\\\\\"}\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Category\\": \\"ecs\\",\\n \\"RuleName\\": \\"ECS_Rule\\",\\n \\"NoDataPolicy\\": \\"KEEP_LAST_STATE\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Times\\": 5,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n },\\n \\"Labels\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"label1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"SilenceTime\\": 3600\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleTemplateAttributeResponse>\\r\\n\\t<RequestId>8F3A82AD-DA92-52B0-8EC6-C059D1C3839F</RequestId>\\r\\n\\t<Resource>\\r\\n\\t\\t<AlertTemplates>\\r\\n\\t\\t\\t<AlertTemplate>\\r\\n\\t\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t\\t<Category>ecs</Category>\\r\\n\\t\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t\\t<Critical>\\r\\n\\t\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t\\t<Times>5</Times>\\r\\n\\t\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t\\t</Critical>\\r\\n\\t\\t\\t\\t\\t<Info />\\r\\n\\t\\t\\t\\t\\t<Warn />\\r\\n\\t\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t\\t<CompositeExpression />\\r\\n\\t\\t\\t\\t<Webhook></Webhook>\\r\\n\\t\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t\\t<RuleName>ECS_Rule</RuleName>\\r\\n\\t\\t\\t\\t<Selector />\\r\\n\\t\\t\\t</AlertTemplate>\\r\\n\\t\\t</AlertTemplates>\\r\\n\\t\\t<Description></Description>\\r\\n\\t\\t<RestVersion>1</RestVersion>\\r\\n\\t\\t<TemplateId>70****</TemplateId>\\r\\n\\t\\t<Name>ECS_Template1</Name>\\r\\n\\t</Resource>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMetricRuleTemplateAttributeResponse>\\t","errorExample":""}]', + 'title' => '查询报警模板详情', + 'description' => '本文将提供一个示例,查询报警模板`70****`的详情。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetricRuleTemplateList' => [ + 'summary' => '调用DescribeMetricRuleTemplateList接口查询报警模板列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Template1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板名称关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '70****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示模板的记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'History', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示报警模板应用到应用分组的历史记录。取值:'."\n" + ."\n" + .'- true:显示。'."\n" + ."\n" + .'- false(默认值):不显示。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式。取值:'."\n" + ."\n" + .'- true(默认值):升序。 '."\n" + ."\n" + .'- false:降序。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序依据。取值:'."\n" + ."\n" + .'- gmtMotified:修改日期。 '."\n" + ."\n" + .'- gmtCreate(默认值):创建日期。', + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCreate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '659401C0-6214-5C02-972A-CFA929D717B7', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Templates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Template' => [ + 'description' => '报警模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '报警模板描述信息。', + 'type' => 'string', + 'example' => 'ECS的CPU使用率', + ], + 'GmtCreate' => [ + 'description' => '创建报警模板的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646018798000', + ], + 'Name' => [ + 'description' => '报警模板名称。', + 'type' => 'string', + 'example' => 'ECS_Template1', + ], + 'RestVersion' => [ + 'description' => '报警模板版本。'."\n" + ."\n" + .'默认值:0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'GmtModified' => [ + 'description' => '修改报警模板的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646054798000', + ], + 'TemplateId' => [ + 'description' => '报警模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70****', + ], + 'ApplyHistories' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApplyHistory' => [ + 'description' => '报警模板应用到应用分组的历史记录。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3607****', + ], + 'GroupName' => [ + 'description' => '应用分组名称。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + 'ApplyTime' => [ + 'description' => '报警模板应用到应用分组的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646055898000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"659401C0-6214-5C02-972A-CFA929D717B7\\",\\n \\"Total\\": 2,\\n \\"Success\\": true,\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"Description\\": \\"ECS的CPU使用率\\",\\n \\"GmtCreate\\": 1646018798000,\\n \\"Name\\": \\"ECS_Template1\\",\\n \\"RestVersion\\": 0,\\n \\"GmtModified\\": 1646054798000,\\n \\"TemplateId\\": 0,\\n \\"ApplyHistories\\": {\\n \\"ApplyHistory\\": [\\n {\\n \\"GroupId\\": 0,\\n \\"GroupName\\": \\"ECS_Group\\",\\n \\"ApplyTime\\": 1646055898000\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleTemplateListResponse>\\r\\n\\t<RequestId>659401C0-6214-5C02-972A-CFA929D717B7</RequestId>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Templates>\\r\\n\\t\\t<Template>\\r\\n\\t\\t\\t<GmtCreate>1606291110000</GmtCreate>\\r\\n\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t<GmtModified>1646018798000</GmtModified>\\r\\n\\t\\t\\t<RestVersion>0</RestVersion>\\r\\n\\t\\t\\t<TemplateId>70****</TemplateId>\\r\\n\\t\\t\\t<Name>ECS_Template1</Name>\\r\\n\\t\\t</Template>\\r\\n\\t\\t<Template>\\r\\n\\t\\t\\t<GmtCreate>1607420429000</GmtCreate>\\r\\n\\t\\t\\t<Description></Description>\\r\\n\\t\\t\\t<GmtModified>1646017352000</GmtModified>\\r\\n\\t\\t\\t<RestVersion>1</RestVersion>\\r\\n\\t\\t\\t<TemplateId>71****</TemplateId>\\r\\n\\t\\t\\t<Name>ECS_Template2</Name>\\r\\n\\t\\t</Template>\\r\\n\\t</Templates>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMetricRuleTemplateListResponse>\\t","errorExample":""}]', + 'title' => '查询报警模板列表', + 'description' => '本文将提供一个示例,查询报警模板列表。返回结果显示,报警模板列表中共有2个报警模板,分别是`ECS_Template1`和`ECS_Template2`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。'."\n" + ."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ApplyMetricRuleTemplate' => [ + 'summary' => '调用ApplyMetricRuleTemplate接口将报警模板应用到应用分组并生成报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默周期。单位:秒。默认值:86400。'."\n" + ."\n" + .'> 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'TemplateIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板ID。'."\n" + ."\n" + .'关于如何获取报警模板ID,请参见[DescribeMetricRuleTemplateList](~~114982~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '700****', + ], + ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效的开始时间。取值范围:00~23,表示00:00到23:00。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '00', + ], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警生效的结束时间。取值范围:00~23,表示00:59到23:59。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23', + ], + ], + [ + 'name' => 'NotifyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '报警通知方式。取值:'."\n" + ."\n" + .'<props="china">- 2:电话+短信+邮箱+旺旺+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 3:短信+邮箱+旺旺+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 4:旺旺+钉钉机器人。</props>'."\n" + ."\n\n" + .'<props="intl">4:旺旺+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">4:旺旺+钉钉机器人。</props>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'ApplyMode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板应用方式。取值:'."\n" + ."\n" + .'- GROUP_INSTANCE_FIRST:应用分组实例优先。应用报警模板时,以应用分组实例优先,如果应用分组中不存在该实例,则忽略模板中的规则。'."\n" + ."\n" + .'- ALARM_TEMPLATE_FIRST:报警模板实例优先。应用报警模板时,不管应用分组中是否存在该实例,都创建报警规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'GROUP_INSTANCE_FIRST', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '报警发生时会回调指定的URL地址并发送POST请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'AppendMode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板应用策略。取值:'."\n" + ."\n" + .'- all:删除已选择分组上所有通过报警模板创建的规则,然后按模板创建新的报警规则(默认值)。'."\n" + ."\n" + .'- append:删除已选择分组上通过该报警模板创建的规则,然后按当前模板创建新的报警规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F897F3C-020A-4993-95B4-63ABB84F83E6', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resource' => [ + 'description' => '报警规则影响的资源。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'AlertResults' => [ + 'description' => '生成报警规则的详细结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'alert rule is creating, please wait a few minutes.', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'test123', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3F897F3C-020A-4993-95B4-63ABB84F83E6\\",\\n \\"Success\\": true,\\n \\"Resource\\": {\\n \\"GroupId\\": 123456,\\n \\"AlertResults\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"alert rule is creating, please wait a few minutes.\\",\\n \\"Success\\": true,\\n \\"RuleName\\": \\"test123\\",\\n \\"RuleId\\": \\"applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ApplyMetricRuleTemplateResponse>\\r\\n\\t<RequestId>37D4037E-827E-4E66-87DF-F56A22F2884D</RequestId>\\r\\n\\t<Resource>\\r\\n\\t\\t<GroupId>123456</GroupId>\\r\\n\\t\\t<AlertResults>\\r\\n\\t\\t\\t<Message>alert rule is creating, please wait a few minutes.</Message>\\r\\n\\t\\t\\t<RuleId>applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****</RuleId>\\r\\n\\t\\t\\t<Code>202</Code>\\r\\n\\t\\t\\t<RuleName>test123</RuleName>\\r\\n\\t\\t\\t<Success>true</Success>\\r\\n\\t\\t</AlertResults>\\r\\n\\t</Resource>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ApplyMetricRuleTemplateResponse>","errorExample":""}]', + 'title' => '应用报警模板至应用分组', + 'description' => '本文将提供一个示例,将报警模板`700****`应用到应用分组`123456`,生成报警规则的ID为`applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`,名称为`test123`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetricRuleList' => [ + 'summary' => '查询报警规则列表中的所有规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'关于如何获取监控项名称,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'补充说明:针对组合指标,只能够根据第一个指标项进行检索。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'EnableState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的启用状态。取值:'."\n" + .'- true:启用。'."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的命名空间。'."\n" + ."\n" + .'关于如何获取云产品的命名空间,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AlertState', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则状态。取值:'."\n" + .'- OK:正常。'."\n" + .'- ALARM:报警。'."\n" + .'- INSUFFICIENT_DATA:无数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '{"instanceId":"i-2ze2d6j5uhg20x47****"}', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'该参数支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'Rule_01', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '7301****', + ], + ], + [ + 'name' => 'RuleIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。多个报警规则ID之间用半角逗号(,)分隔,一次最多可查询20条。', + 'type' => 'string', + 'required' => false, + 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '386C6712-335F-5054-930A-CC92B851ECBA', + ], + 'Total' => [ + 'description' => '总记录数。', + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Alarms' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Alarm' => [ + 'description' => '报警规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SilenceTime' => [ + 'description' => '通道沉默周期。单位:秒。默认值:86400,最小值:3600。'."\n" + ."\n" + .'监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '86400', + ], + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'Webhook' => [ + 'description' => '报警发生回调时的 URL 地址。云监控会将报警信息通过 POST 请求推送到该地址,目前仅支持 HTTP 协议。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com', + ], + 'ContactGroups' => [ + 'description' => '报警联系组。', + 'type' => 'string', + 'example' => 'ECS_Alarm', + ], + 'SourceType' => [ + 'description' => '报警规则类型。取值:METRIC,表示时序指标报警规则。', + 'type' => 'string', + 'example' => 'METRIC', + ], + 'Namespace' => [ + 'description' => '云服务的命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'MailSubject' => [ + 'description' => '报警邮件主题。', + 'type' => 'string', + 'example' => '"${serviceType}-${metricName}-${levelDescription}通知(${dimensions})"', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警规则的失效时间范围。', + 'type' => 'string', + 'example' => '00:00-05:30', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间范围。', + 'type' => 'string', + 'example' => '05:31-23:59', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'Rule_01', + ], + 'AlertState' => [ + 'description' => '报警规则状态。取值:'."\n" + ."\n" + .'- OK:正常。'."\n" + ."\n" + .'- ALARM:报警。'."\n" + ."\n" + .'- INSUFFICIENT_DATA:无数据。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Period' => [ + 'description' => '统计周期。', + 'type' => 'string', + 'example' => '60', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****', + ], + 'GroupName' => [ + 'description' => '应用分组名称。'."\n" + .'> 如果报警规则关联到应用分组,此处显示该参数。', + 'type' => 'string', + 'example' => 'ECS_Group', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '7301****', + ], + 'Dimensions' => [ + 'description' => '报警规则维度。', + 'type' => 'string', + 'example' => '[{"instanceId":"i-2ze2d6j5uhg20x47****"}]', + ], + 'EnableState' => [ + 'description' => '启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resources' => [ + 'description' => '报警规则关联的资源。', + 'type' => 'string', + 'example' => '[{\\"instanceId\\":\\"i-2ze2d6j5uhg20x47****\\"}]', + ], + 'Escalations' => [ + 'description' => '报警分级别触发条件。', + 'type' => 'object', + 'properties' => [ + 'Info' => [ + 'description' => 'Info 级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'PreCondition' => [ + 'description' => 'Info 级别报警的前置条件。当参数 ComparisonOperator 设置为同比或环比时,与该参数共同起作用。'."\n" + ."\n" + .'例如:该参数设置为$Average>80,ComparisonOperator 设置为 GreaterThanYesterday,Threshold 设置为 10,表示当平均值大于 80 且环比昨天上涨 10%时,触发报警。'."\n" + ."\n" + .'>$Average>0 中的$Average 为一个占位符,格式为$监控结果字段值,云监控会将其替换为对应的统计值或原始的监控值。', + 'type' => 'string', + 'example' => '$Average>80', + ], + 'Times' => [ + 'description' => 'Info级别报警连续出现次数。报警连续出现这个次数,且超过阈值才会触发报警。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Info级别报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => 'Info级别报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Warn' => [ + 'description' => 'Warn级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Warn级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'PreCondition' => [ + 'description' => 'Warn级别报警的前置条件。当参数ComparisonOperator设置为同比或环比时,与该参数共同起作用。'."\n" + ."\n" + .'例如:该参数设置为$Average>80,ComparisonOperator设置为GreaterThanYesterday,Threshold设置为10,表示当平均值大于80且环比昨天上涨10%时,触发报警。'."\n" + .'> $Average>0 中的$Average 为一个占位符,格式为$监控结果字段值,云监控会将其替换为对应的统计值或原始的监控值。', + 'type' => 'string', + 'example' => '$Average>80', + ], + 'Times' => [ + 'description' => 'Warn级别报警连续出现次数。报警连续出现这个次数,且超过阈值才会触发报警。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Warn级别报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => 'Warn级别报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + 'Critical' => [ + 'description' => 'Critical级别报警触发条件。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'PreCondition' => [ + 'description' => 'Critical 级别报警的前置条件。当参数 ComparisonOperator 设置为同比或环比时,与该参数共同起作用。'."\n" + ."\n" + .'例如:该参数设置为$Average>80,ComparisonOperator 设置为 GreaterThanYesterday,Threshold 设置为 10,表示当平均值大于 80 且环比昨天上涨 10%时,触发报警。'."\n" + .'>$Average>0中的$Average为一个占位符,格式为`$监控结果字段值`,云监控会将其替换为对应的统计值或原始的监控值。', + 'type' => 'string', + 'example' => '$Average>80', + ], + 'Times' => [ + 'description' => 'Critical级别报警连续出现次数。报警连续出现这个次数,且超过阈值才会触发报警。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => 'Critical级别报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + 'Statistics' => [ + 'description' => 'Critical级别报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + ], + ], + ], + ], + 'NoDataPolicy' => [ + 'description' => '无监控数据时报警的处理方式。取值:'."\n" + .'- KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'- OK:正常。', + 'type' => 'string', + 'example' => 'KEEP_LAST_STATE', + ], + 'CompositeExpression' => [ + 'description' => '多指标的报警条件。'."\n" + .'> 单指标和多指标互斥,不能同时设置。', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + 'ExpressionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExpressionList' => [ + 'description' => '标准创建的报警条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '云产品的监控项名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'Period' => [ + 'description' => '监控项的聚合周期。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Statistics' => [ + 'description' => '监控项的统计方法。取值:'."\n" + .'- $Maximum:最大值。'."\n" + .'- $Minimum:最小值。'."\n" + .'- $Average:平均值。'."\n" + .'- $Availability:可用率(通常用于站点监控)。'."\n" + ."\n" + .'> `$`为监控项的统一前缀符号。支持的云产品,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'example' => '$Maximum', + ], + 'ComparisonOperator' => [ + 'description' => '阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '90', + ], + ], + ], + ], + ], + ], + 'ExpressionListJoin' => [ + 'description' => '多指标报警条件之间的关系。取值: '."\n" + ."\n" + .'- `&&`:当所有指标都符合报警条件时,才触发报警。当ExpressionList下各表达式均为`true`时,才触发报警。'."\n" + ."\n" + .'- `||`:其中一个指标符合报警条件,即触发报警。', + 'type' => 'string', + 'example' => '||', + ], + 'ExpressionRaw' => [ + 'description' => '表达式创建的报警条件。包括但不限于以下情况:'."\n" + ."\n" + .'- 为部分资源设置报警黑名单,例如:`$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`,表示当报警规则中的实例`i-io8kfvcpp7x5****`的`Average`大于50时,也不会产生报警。'."\n" + .'- 对规则中的指定实例设置特殊报警阈值,例如:`$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`,表示当报警规则中的实例`i-io8kfvcpp7x5****`的`Average`大于80时,才报警,其他实例的`Average`大于50,即可报警。'."\n" + .'- 对规则中超过阈值的实例数量进行限制,例如:`count($Average > 20) > 3`,表示当报警规则中的`Average`大于20的实例数大于3个时,才进行报警。'."\n", + 'type' => 'string', + 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'Labels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Labels' => [ + 'description' => '报警规则标签。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '报警规则的标签键。', + 'type' => 'string', + 'example' => 'cmsRuleKey', + ], + 'Value' => [ + 'description' => '报警规则的标签值。', + 'type' => 'string', + 'example' => 'cmsRuleValue', + ], + ], + ], + ], + ], + ], + 'Prometheus' => [ + 'description' => 'Prometheus报警。'."\n" + ."\n" + .'> 仅当您为企业云监控创建Prometheus报警规则,需要设置该参数。', + 'type' => 'object', + 'properties' => [ + 'PromQL' => [ + 'description' => 'PromQL查询语句。'."\n" + ."\n" + .'> 通过PromQL查询语句获取的数据即为报警数据,请您在该语句中携带报警阈值。', + 'type' => 'string', + 'example' => 'CpuUsage{instanceId="xxxx"}[1m]>90', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Annotations' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Annotations' => [ + 'description' => 'Prometheus报警时,将注释的键和值进行渲染,易于您对监控项或报警规则的理解。'."\n" + .'> 该功能等同于Prometheus的Annotation。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '注释的键。', + 'type' => 'string', + 'example' => 'summary', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', + ], + ], + ], + ], + ], + ], + ], + ], + 'ProductCategory' => [ + 'description' => '云产品类型。', + 'type' => 'string', + 'example' => 'slb', + ], + 'GmtCreate' => [ + 'description' => '规则创建时间,Unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1760432061000', + ], + 'GmtUpdate' => [ + 'description' => '规则更新时间,Unix时间戳。', + 'type' => 'string', + 'example' => '1760432061000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'The Request is not authorization.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"386C6712-335F-5054-930A-CC92B851ECBA\\",\\n \\"Total\\": \\"1\\",\\n \\"Success\\": true,\\n \\"Alarms\\": {\\n \\"Alarm\\": [\\n {\\n \\"SilenceTime\\": 86400,\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Webhook\\": \\"https://www.aliyun.com\\",\\n \\"ContactGroups\\": \\"ECS_Alarm\\",\\n \\"SourceType\\": \\"METRIC\\",\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MailSubject\\": \\"\\\\\\"${serviceType}-${metricName}-${levelDescription}通知(${dimensions})\\\\\\"\\",\\n \\"NoEffectiveInterval\\": \\"00:00-05:30\\",\\n \\"EffectiveInterval\\": \\"05:31-23:59\\",\\n \\"RuleName\\": \\"Rule_01\\",\\n \\"AlertState\\": \\"OK\\",\\n \\"Period\\": \\"60\\",\\n \\"RuleId\\": \\"applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****\\",\\n \\"GroupName\\": \\"ECS_Group\\",\\n \\"GroupId\\": \\"7301****\\",\\n \\"Dimensions\\": \\"[{\\\\\\"instanceId\\\\\\":\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\"}]\\",\\n \\"EnableState\\": true,\\n \\"Resources\\": \\"[{\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\\\\\\\\\"}]\\",\\n \\"Escalations\\": {\\n \\"Info\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Warn\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n },\\n \\"Critical\\": {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\"$Average>80\\",\\n \\"Times\\": 3,\\n \\"Threshold\\": \\"90\\",\\n \\"Statistics\\": \\"Average\\"\\n }\\n },\\n \\"NoDataPolicy\\": \\"KEEP_LAST_STATE\\",\\n \\"CompositeExpression\\": {\\n \\"Level\\": \\"CRITICAL\\",\\n \\"ExpressionList\\": {\\n \\"ExpressionList\\": [\\n {\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Period\\": 60,\\n \\"Statistics\\": \\"$Maximum\\",\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"Threshold\\": \\"90\\"\\n }\\n ]\\n },\\n \\"ExpressionListJoin\\": \\"||\\",\\n \\"ExpressionRaw\\": \\"$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)\\",\\n \\"Times\\": 3\\n },\\n \\"Labels\\": {\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"cmsRuleKey\\",\\n \\"Value\\": \\"cmsRuleValue\\"\\n }\\n ]\\n },\\n \\"Prometheus\\": {\\n \\"PromQL\\": \\"CpuUsage{instanceId=\\\\\\"xxxx\\\\\\"}[1m]>90\\",\\n \\"Level\\": \\"CRITICAL\\",\\n \\"Times\\": 3,\\n \\"Annotations\\": {\\n \\"Annotations\\": [\\n {\\n \\"Key\\": \\"summary\\",\\n \\"Value\\": \\"{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }\\"\\n }\\n ]\\n }\\n },\\n \\"ProductCategory\\": \\"slb\\",\\n \\"GmtCreate\\": 1760432061000,\\n \\"GmtUpdate\\": \\"1760432061000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleListResponse>\\r\\n\\t<RequestId>386C6712-335F-5054-930A-CC92B851ECBA</RequestId>\\r\\n\\t<Total>1</Total>\\r\\n\\t<Alarms>\\r\\n\\t\\t<Alarm>\\r\\n\\t\\t\\t<GroupName>ECS_Group</GroupName>\\r\\n\\t\\t\\t<SilenceTime>86400</SilenceTime>\\r\\n\\t\\t\\t<ContactGroups>ECS_Alarm</ContactGroups>\\r\\n\\t\\t\\t<NoEffectiveInterval>00:00-05:30</NoEffectiveInterval>\\r\\n\\t\\t\\t<GroupBy>group</GroupBy>\\r\\n\\t\\t\\t<MailSubject>${serviceType}-${metricName}-${levelDescription}通知(${dimensions})</MailSubject>\\r\\n\\t\\t\\t<SourceType>METRIC</SourceType>\\r\\n\\t\\t\\t<RuleId>applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****</RuleId>\\r\\n\\t\\t\\t<Period>60</Period>\\r\\n\\t\\t\\t<Dimensions>\\r\\n\\t\\t\\t\\t<instanceId>i-2ze2d6j5uhg20x47****</instanceId>\\r\\n\\t\\t\\t</Dimensions>\\r\\n\\t\\t\\t<EffectiveInterval>05:31-23:59</EffectiveInterval>\\r\\n\\t\\t\\t<Namespace>acs_ecs_dashboard</Namespace>\\r\\n\\t\\t\\t<AlertState>OK</AlertState>\\r\\n\\t\\t\\t<GroupId>7301****</GroupId>\\r\\n\\t\\t\\t<MetricName>cpu_total</MetricName>\\r\\n\\t\\t\\t<EnableState>true</EnableState>\\r\\n\\t\\t\\t<Escalations>\\r\\n\\t\\t\\t\\t<Critical>\\r\\n\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t</Critical>\\r\\n\\t\\t\\t\\t<Info>\\r\\n\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t</Info>\\r\\n\\t\\t\\t\\t<Warn>\\r\\n\\t\\t\\t\\t\\t<ComparisonOperator>GreaterThanOrEqualToThreshold</ComparisonOperator>\\r\\n\\t\\t\\t\\t\\t<Times>3</Times>\\r\\n\\t\\t\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t\\t\\t<Threshold>90</Threshold>\\r\\n\\t\\t\\t\\t</Warn>\\r\\n\\t\\t\\t</Escalations>\\r\\n\\t\\t\\t<Webhook>https://www.aliyun.com</Webhook>\\r\\n\\t\\t\\t<Resources>[{\\\\\\"instanceId\\\\\\":\\\\\\"i-2ze2d6j5uhg20x47****\\\\\\"}]</Resources>\\r\\n\\t\\t\\t<RuleName>Rule_01</RuleName>\\r\\n\\t\\t</Alarm>\\r\\n\\t</Alarms>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeMetricRuleListResponse>\\t","errorExample":""}]', + 'title' => '查询报警规则列表中的所有规则', + 'description' => '本文将提供一个示例,查询当前阿里云账号下的报警规则列表中的所有报警规则。返回结果显示,报警规则列表中只有一条报警规则,该报警规则的名称为`Rule_01`、ID为`applyTemplate344cfd42-0f32-4fd6-805a-88d7908a****`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'CreateGroupMetricRules' => [ + 'summary' => '调用CreateGroupMetricRules接口批量为指定应用分组创建报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3607****', + ], + ], + [ + 'name' => 'GroupMetricRules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用分组的监控项规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组的监控项规则。', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => [ + 'description' => '普通级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'MetricName' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取监控项名称,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_total', + ], + 'Escalations.Warn.Threshold' => [ + 'description' => '警告级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间范围。N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => '05:31-23:59', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警规则的失效时间范围。N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-05:30', + ], + 'RuleId' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '456789', + ], + 'Escalations.Critical.Times' => [ + 'description' => '发送紧急报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Dimensions' => [ + 'description' => '指定资源的监控维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-2ze2d6j5uhg20x47****"}`。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', + ], + 'Escalations.Critical.Threshold' => [ + 'description' => '触发紧急级别报警通知的阈值。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + 'Escalations.Critical.Statistics' => [ + 'description' => '紧急级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Warn.ComparisonOperator' => [ + 'description' => '警告级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Info.Times' => [ + 'description' => '发送普通报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SilenceTime' => [ + 'description' => '报警通知的沉默周期。N的取值范围:1~200。'."\n" + ."\n" + .'单位:秒。默认值:86400。最小值:3600。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + ], + 'Webhook' => [ + 'description' => '报警发生回调时的URL地址。N的取值范围:1~200。'."\n" + ."\n" + .'填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + 'Namespace' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取云产品的数据命名空间,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + 'EmailSubject' => [ + 'description' => '报警邮件主题。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS实例', + ], + 'Period' => [ + 'description' => '监控数据的上报周期。'."\n" + ."\n" + .'N的取值范围:1~200。 '."\n" + ."\n" + .'`Period`的取值为60或60的整数倍。单位:秒。默认值:300。'."\n" + ."\n\n" + ."\n\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + 'RuleName' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Rule1', + ], + 'Escalations.Info.Statistics' => [ + 'description' => '普通级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Warn.Times' => [ + 'description' => '发送警告报警通知需要监控指标达到报警阈值的次数。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Escalations.Info.ComparisonOperator' => [ + 'description' => '普通级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Interval' => [ + 'description' => '报警规则的探测周期。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'单位:秒。秒默认为监控项的最小频率。'."\n" + ."\n" + .'> 建议报警规则的探测周期和数据上报周期保持一致。如果报警规则的探测周期小于数据上报周期,会因为数据不足而不能触发报警。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + 'Category' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS', + ], + 'Escalations.Critical.ComparisonOperator' => [ + 'description' => '紧急级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。 '."\n" + .'- GreaterThanThreshold:大于。 '."\n" + .'- LessThanOrEqualToThreshold:小于等于。 '."\n" + .'- LessThanThreshold:小于。 '."\n" + .'- NotEqualToThreshold:不等于。 '."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。 '."\n" + .'- LessThanYesterday:同比昨天时间下降。 '."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。 '."\n" + .'- LessThanLastWeek:同比上周同一时间下降。 '."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。 '."\n" + .'- LessThanLastPeriod:环比上周期下降。 '."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Warn.Statistics' => [ + 'description' => '警告级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'NoDataPolicy' => [ + 'description' => '无监控数据时报警的处理方式。取值:'."\n" + .'- KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'- OK:正常。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => 'KEEP_LAST_STATE', + ], + 'ContactGroups' => [ + 'description' => '报警联系人组。'."\n" + ."\n" + .'N的取值范围:1~200。'."\n" + ."\n" + .'关于如何获取报警联系人组,请参见[DescribeContactGroupList](~~114922~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Group', + ], + 'Labels' => [ + 'description' => '报警规则的标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则的标签键。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '报警规则的标签键。报警通知中会包含标签。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '报警规则的标签值。报警通知中会包含标签。'."\n" + ."\n" + .'N的取值范围:1~200。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + 'Options' => [ + 'description' => '高级设置。'."\n" + ."\n" + .'格式:{"key1":"value1","key2":"value2"},例如:{"NotSendOK":true},表示是否发送报警恢复通知,key为NotSendOK,value为true(不发送)或false(默认发送)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "NotSendOK": true'."\n" + .'}', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '报错信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AlertResult' => [ + 'description' => '报警规则列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '新创建报警规则的状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '新创建报警规则的错误信息。', + 'type' => 'string', + 'example' => 'Metric not found.', + ], + 'Success' => [ + 'description' => '新创建报警规则是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RuleName' => [ + 'description' => '新创建报警规则的名称。', + 'type' => 'string', + 'example' => 'ECS_Rule1', + ], + 'RuleId' => [ + 'description' => '新创建报警规则的ID。', + 'type' => 'string', + 'example' => '456789', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => '500', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"AlertResult\\": [\\n {\\n \\"Code\\": 200,\\n \\"Message\\": \\"Metric not found.\\",\\n \\"Success\\": true,\\n \\"RuleName\\": \\"ECS_Rule1\\",\\n \\"RuleId\\": \\"456789\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateGroupMetricRulesResponse>\\r\\n\\t<RequestId>CED22B00-CFD8-5BDF-A645-CAF7B81FAE45</RequestId>\\r\\n\\t<Resources>\\r\\n\\t\\t<AlertResult>\\r\\n\\t\\t\\t<RuleId>456789</RuleId>\\r\\n\\t\\t\\t<Code>200</Code>\\r\\n\\t\\t\\t<Success>true</Success>\\r\\n\\t\\t\\t<RuleName>ECS_Rule1</RuleName>\\r\\n\\t\\t</AlertResult>\\r\\n\\t</Resources>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</CreateGroupMetricRulesResponse>\\t","errorExample":""}]', + 'title' => '批量为指定应用分组创建报警规则', + 'description' => '本文将提供一个示例,为应用分组`123456`中的云服务器ECS的监控项`cpu_total`创建一条报警规则,其中报警规则ID为`456789`,报警规则名称为`ECS_Rule1`,报警级别为`Critical`,报警统计方法为`Average`,报警阈值比较符为`GreaterThanOrEqualToThreshold`,报警阈值为`90`,报警重试次数为`3`。返回结果显示,报警规则`ECS_Rule1`创建成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMetricRuleResources' => [ + 'summary' => '调用CreateMetricRuleResources接口创建一个报警规则关联的资源。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则 ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'i-2ze3w55tr2rcpejpcfap_59c96b85-0339-4f35-ba66-ae4e34d3****', + ], + ], + [ + 'name' => 'Overwrite', + 'in' => 'query', + 'schema' => [ + 'description' => '是否覆盖。取值:'."\n" + ."\n" + .'- true:覆盖。表示本次提交的资源将覆盖之前的关联资源,即全量修改。'."\n" + ."\n" + .'- false:不覆盖。表示本次提交的资源将不覆盖之前的关联资源(关联的结果资源为历史的关联资源加本次提交的资源),即增量修改。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的资源。格式为一个 JSON 数组。'."\n" + .'> 每次最多添加 100 个资源实例,一个报警规则最多关联 3000 个实例。'."\n" + .'>', + 'type' => 'string', + 'required' => true, + 'example' => '[{"instanceId":"i-a2d5q7pm3f9yr29e****"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'> 200 表示成功。'."\n" + .'>', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '0671A721-0D7A-4F11-BB77-2416325D65AB', + ], + 'Success' => [ + 'description' => '操作是否成功。true 表示成功,false 表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0671A721-0D7A-4F11-BB77-2416325D65AB\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建一个报警规则关联的资源', + ], + 'DeleteMetricRuleTargets' => [ + 'summary' => '调用DeleteMetricRuleTargets接口删除一个报警规则的推送渠道。', + 'methods' => [ + 'post', + 'get', + 'delete', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ruleId-xxxxxx', + ], + ], + [ + 'name' => 'TargetIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '目标ID。', + 'type' => 'array', + 'items' => [ + 'description' => '目标ID。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'required' => true, + 'example' => '12345', + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailIds' => [ + 'description' => '删除失败的目标ID列表。', + 'type' => 'object', + 'properties' => [ + 'TargetIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TargetId' => [ + 'description' => '删除失败的目标ID。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败的目标ID。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed because of an unknown error, exception or failure.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": true,\\n \\"FailIds\\": {\\n \\"TargetIds\\": {\\n \\"TargetId\\": [\\n \\"1\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleTargetsResponse>\\r\\n\\t\\t<RequestId>786E92D2-AC66-4250-B76F-F1E2FCDDBA1C</RequestId>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n\\t\\t<FailIds>\\r\\n\\t\\t\\t<TargetIds>1</TargetIds>\\r\\n\\t\\t</FailIds>\\r\\n</DeleteMetricRuleTargetsResponse>","errorExample":""}]', + 'title' => '删除报警规则的推送渠道', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteMetricRules' => [ + 'summary' => '调用DeleteMetricRules接口删除一个或多个报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要删除的报警规则ID的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要删除的报警规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c3b2804a297444d0aa7bfd4fb0e4a01b', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', + 'type' => 'string', + 'example' => '09B3A484-1A2B-5743-BB6B-D796416F2677', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternetServerError', + 'errorMessage' => 'InternetServerError', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"09B3A484-1A2B-5743-BB6B-D796416F2677\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除一个或多个报警规则', + ], + 'DeleteMetricRuleResources' => [ + 'summary' => '调用DeleteMetricRuleResources接口删除报警规则关联的资源。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rr-bp18017n6iolv****', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则关联的资源。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"instanceId":"i-uf6hm9lnlzsarrc7****"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The alert does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D8A35882-90C6-4F03-BBEB-153C180398EA', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"D8A35882-90C6-4F03-BBEB-153C180398EA\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleResourcesResponse>\\n\\t\\t<RequestId>0671A721-0D7A-4F11-BB77-2416325D65AB</RequestId>\\n\\t\\t<Success>true</Success>\\n\\t\\t<Code>200</Code>\\n</DeleteMetricRuleResourcesResponse>","errorExample":""}]', + 'title' => '删除报警规则关联的资源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EnableMetricRules' => [ + 'summary' => '调用EnableMetricRules接口启用一个或多个报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'GroupProcess_67800278_2FE7D515-4BBD-447B-BC1A-3F17ED49****', + ], + 'required' => true, + 'example' => 'ab05733c97b7ce239fb1b53393dc1697c123****', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 402 => [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<EnableMetricRulesResponse>\\n <Code>200</Code>\\n <Message>success</Message>\\n <RequestId>FF38D33A-67C1-40EB-AB65-FAEE51EDB644</RequestId>\\n <Success>true</Success>\\n</EnableMetricRulesResponse>","errorExample":""}]', + 'title' => '启用一个或多个报警规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DisableMetricRules' => [ + 'summary' => '调用DisableMetricRules接口禁用报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警规则ID。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uuid_a141b055483428c22bab05443287196afa42cb6146', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:-true:成功。-false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '禁用报警规则', + ], + 'DescribeMetricRuleTargets' => [ + 'summary' => '调用DescribeMetricRuleTargets接口查询指定报警规则的推送渠道。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n\n" + .'关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ae06917_75a8c43178ab66****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '786E92D2-AC66-4250-B76F-F1E2FCDDBA1C', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Targets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => '报警触发目标。', + 'type' => 'array', + 'items' => [ + 'description' => '报警触发目标。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。', + 'type' => 'string', + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。格式为`acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。目前支持轻量消息队列(原 MNS),弹性伸缩ESS,日志服务SLS,函数计算FC。例如:`acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`。轻量消息队列(原 MNS)的ARN参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:mns'."\n" + ."\n" + .'- {userId}:阿里云账号ID。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + ."\n" + .'- {资源类型}`:接收报警的资源类型。取值:'."\n" + ."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'example' => 'INFO', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"786E92D2-AC66-4250-B76F-F1E2FCDDBA1C\\",\\n \\"Success\\": true,\\n \\"Targets\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:120886317861****:/queues/test/message\\",\\n \\"Level\\": \\"INFO\\",\\n \\"JsonParams\\": \\"{\\\\\\"customField1\\\\\\":\\\\\\"value1\\\\\\",\\\\\\"customField2\\\\\\":\\\\\\"$.name\\\\\\"}\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleTargetsResponse>\\n\\t<RequestId>786E92D2-AC66-4250-B76F-F1E2FCDDBA1C</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeMetricRuleTargetsResponse>\\t","errorExample":""}]', + 'title' => '查询指定报警规则的推送渠道', + 'description' => '## 使用说明'."\n" + .'本文将提供一个示例,查询报警规则`ae06917_75a8c43178ab66****`关联的目标资源。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMetricRuleCount' => [ + 'summary' => '调用DescribeMetricRuleCount接口获取各种状态报警规则的数量。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的命名空间。详情请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。详情请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FF38D33A-67C1-40EB-AB65-FAEE51EDB644', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MetricRuleCount' => [ + 'description' => '各类状态报警规则的数量。', + 'type' => 'object', + 'properties' => [ + 'Ok' => [ + 'description' => '正常状态报警规则的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Nodata' => [ + 'description' => '无数据状态报警规则的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Disable' => [ + 'description' => '禁用状态报警规则的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => '报警规则总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'Alarm' => [ + 'description' => '报警状态报警规则的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 402 => [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttli∂ngException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"FF38D33A-67C1-40EB-AB65-FAEE51EDB644\\",\\n \\"Success\\": true,\\n \\"MetricRuleCount\\": {\\n \\"Ok\\": 40,\\n \\"Nodata\\": 0,\\n \\"Disable\\": 0,\\n \\"Total\\": 45,\\n \\"Alarm\\": 5\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleCountResponse>\\n <Success>true</Success>\\n <Code>200</Code>\\n <RequestId>FF38D33A-67C1-40EB-AB65-FAEE51EDB644</RequestId>\\n <MetricRuleCount>\\n <Ok>40</Ok>\\n <Disable>0</Disable>\\n <Total>45</Total>\\n <Nodata>0</Nodata>\\n <Alarm>5</Alarm>\\n </MetricRuleCount>\\n</DescribeMetricRuleCountResponse>","errorExample":""}]', + 'title' => '获取各种状态报警规则的数量', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAlertingMetricRuleResources' => [ + 'summary' => '调用DescribeAlertingMetricRuleResources接口查询指定报警规则中正在发生报警的资源列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。关于如何查询报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。关于如何查询应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '7671****', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。 '."\n" + ."\n" + .'默认值:1 。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于如何获取云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_mns_new', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', + ], + ], + [ + 'name' => 'AlertBeforeTime', + 'in' => 'query', + 'schema' => [ + 'description' => '用于查询在这个时刻之前发生的报警。支持毫秒时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '1698827400000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request processing has failed due to some unknown error.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0724011B-D9E0-4B2F-8C51-F17A894CC42C', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Resources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '报警规则的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'ActiveMessages', + ], + 'RetryTimes' => [ + 'description' => '报警重试次数。', + 'type' => 'string', + 'example' => '3', + ], + 'MetricValues' => [ + 'description' => '触发报警时监控项的值。格式为一个JSON字符串。', + 'type' => 'string', + 'example' => '{\\"timestamp\\":1623727500000,\\"Sum\\":926,\\"value\\":463,\\"Maximum\\":463,\\"Minimum\\":463,\\"Average\\":463,\\"SampleCount\\":2,\\"userId\\":\\"120886317861****\\",\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\"}', + ], + 'Namespace' => [ + 'description' => '云产品的数据命名空间。', + 'type' => 'string', + 'example' => 'acs_mns_new', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'test123456789', + ], + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****', + ], + 'ProductCategory' => [ + 'description' => '云产品类型。', + 'type' => 'string', + 'example' => 'mns', + ], + 'StartTime' => [ + 'description' => '资源被关联到报警规则的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1622427900000', + ], + 'Resource' => [ + 'description' => '报警的资源。', + 'type' => 'string', + 'example' => 'userId=120886317861****,region=cn-huhehaote,queue=test-0128', + ], + 'LastModifyTime' => [ + 'description' => '最后一次修改报警规则的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1622827900000', + ], + 'GroupId' => [ + 'description' => '应用分组ID。'."\n" + .'>如果报警规则与指定应用分组关联,则显示该应用分组ID。', + 'type' => 'string', + 'example' => '7671****', + ], + 'Dimensions' => [ + 'description' => '维度Map,用于查询指定资源的监控数据。', + 'type' => 'string', + 'example' => '{\\"region\\":\\"cn-huhehaote\\",\\"queue\\":\\"test-0128\\",\\"userId\\":\\"120886317861****\\"}', + ], + 'LastAlertTime' => [ + 'description' => '最后一次触发报警的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1622427900000', + ], + 'Level' => [ + 'description' => '报警的级别和通知方式。取值:'."\n" + ."\n" + .'<props="china">- 2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- 4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- 4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '10', + ], + 'Statistics' => [ + 'description' => '报警统计方法。', + 'type' => 'string', + 'example' => 'Average', + ], + 'Enable' => [ + 'description' => '是否启用报警规则。取值:'."\n" + ."\n" + .'- true:启用报警规则。'."\n" + ."\n" + .'- false:不启用报警规则。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Escalation' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Resource' => [ + 'description' => '触发报警的规则。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => '阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + ."\n" + .'- GreaterThanThreshold:大于。'."\n" + ."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + ."\n" + .'- LessThanThreshold:小于。'."\n" + ."\n" + .'- NotEqualToThreshold:不等于。'."\n" + ."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + ."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + ."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + ."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + ."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + ."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'PreCondition' => [ + 'description' => '阈值比较符号。取值:'."\n" + ."\n" + .'- `>=`'."\n" + ."\n" + .'- `=`'."\n" + ."\n" + .'- `<=`'."\n" + ."\n" + .'- `>`'."\n" + ."\n" + .'- `<`'."\n" + ."\n" + .'- `!=`', + 'type' => 'string', + 'example' => '>=', + ], + 'Expression' => [ + 'description' => '触发报警的规则描述。'."\n" + ."\n" + .'> 报警规则的主体,当监控数据满足报警条件时,触发报警规则。', + 'type' => 'string', + 'example' => '$Average>=10', + ], + 'Times' => [ + 'description' => '报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tag' => [ + 'description' => '该参数已废弃,无需关注。', + 'type' => 'string', + 'example' => '无', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'example' => '10', + ], + 'Level' => [ + 'description' => '报警的级别和通知方式。取值:'."\n" + ."\n" + .'<props="china">- 2:电话+短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 3:短信+邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- 4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="china">- OK:无报警。</props>'."\n" + ."\n" + .'<props="intl">- 4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="intl">- OK:无报警。</props>'."\n" + ."\n" + .'<props="partner">- 4:邮件+钉钉机器人。</props>'."\n" + ."\n" + .'<props="partner">- OK:无报警。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExpressionListJoin' => [ + 'description' => '多个监控项之间的关系。取值:'."\n" + ."\n" + .'- &&:当所有监控项都满足报警条件时,发送报警通知。'."\n" + .'- ||:当其中一个监控项满足报警条件时,发送报警通知。', + 'type' => 'string', + 'example' => '&&', + ], + 'ExpressionList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ExpressionList' => [ + 'description' => '多指标报警规则描述。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'ComparisonOperator' => [ + 'description' => '报警级别的阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'MetricName' => [ + 'description' => '监控项名称。', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'Period' => [ + 'description' => '监控项的统计周期。单位:秒。默认为监控项的原始上报周期。', + 'type' => 'string', + 'example' => '60', + ], + 'Statistics' => [ + 'description' => '报警级别的统计方法。取值:'."\n" + ."\n" + .'- Maximum:最大值。'."\n" + .'- Minimum:最小值。'."\n" + .'- Average:平均值。', + 'type' => 'string', + 'example' => 'Average', + ], + 'Threshold' => [ + 'description' => '报警阈值。'."\n" + .' ', + 'type' => 'string', + 'example' => '90', + ], + ], + ], + ], + ], + ], + 'ExpressionRaw' => [ + 'description' => '表达式创建的报警条件。包括但不限于以下情况:'."\n" + ."\n" + .'- 为部分资源设置报警黑名单,例如:`$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`,表示当报警规则中的实例`i-io8kfvcpp7x5****`的`Average`大于50时,也不会产生报警。'."\n" + .'- 对规则中的指定实例设置特殊报警阈值,例如:`$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`,表示当报警规则中的实例`i-io8kfvcpp7x5****`的`Average`大于80时,才报警,其他实例的`Average`大于50,即可报警。'."\n" + .'- 对规则中超过阈值的实例数量进行限制,例如:`count($Average > 20) > 3`,表示当报警规则中的`Average`大于20的实例数大于3个时,才进行报警。'."\n", + 'type' => 'string', + 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"0724011B-D9E0-4B2F-8C51-F17A894CC42C\\",\\n \\"Total\\": 2,\\n \\"Success\\": true,\\n \\"Resources\\": {\\n \\"Resource\\": [\\n {\\n \\"MetricName\\": \\"ActiveMessages\\",\\n \\"RetryTimes\\": \\"3\\",\\n \\"MetricValues\\": \\"{\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1623727500000,\\\\\\\\\\\\\\"Sum\\\\\\\\\\\\\\":926,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Maximum\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Minimum\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"Average\\\\\\\\\\\\\\":463,\\\\\\\\\\\\\\"SampleCount\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-huhehaote\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0128\\\\\\\\\\\\\\"}\\",\\n \\"Namespace\\": \\"acs_mns_new\\",\\n \\"RuleName\\": \\"test123456789\\",\\n \\"RuleId\\": \\"putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****\\",\\n \\"ProductCategory\\": \\"mns\\",\\n \\"StartTime\\": \\"1622427900000\\",\\n \\"Resource\\": \\"userId=120886317861****,region=cn-huhehaote,queue=test-0128\\",\\n \\"LastModifyTime\\": \\"1622827900000\\",\\n \\"GroupId\\": \\"7671****\\",\\n \\"Dimensions\\": \\"{\\\\\\\\\\\\\\"region\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-huhehaote\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test-0128\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120886317861****\\\\\\\\\\\\\\"}\\",\\n \\"LastAlertTime\\": \\"1622427900000\\",\\n \\"Level\\": 3,\\n \\"Threshold\\": \\"10\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Enable\\": \\"true\\",\\n \\"Escalation\\": {\\n \\"Resource\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"PreCondition\\": \\">=\\",\\n \\"Expression\\": \\"$Average>=10\\",\\n \\"Times\\": 1,\\n \\"Tag\\": \\"无\\",\\n \\"Threshold\\": \\"10\\",\\n \\"Level\\": 3,\\n \\"ExpressionListJoin\\": \\"&&\\",\\n \\"ExpressionList\\": {\\n \\"ExpressionList\\": [\\n {\\n \\"ComparisonOperator\\": \\"GreaterThanOrEqualToThreshold\\",\\n \\"MetricName\\": \\"cpu_total\\",\\n \\"Period\\": \\"60\\",\\n \\"Statistics\\": \\"Average\\",\\n \\"Threshold\\": \\"90\\"\\n }\\n ]\\n },\\n \\"ExpressionRaw\\": \\"$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAlertingMetricRuleResourcesResponse>\\r\\n\\t<RequestId>0724011B-D9E0-4B2F-8C51-F17A894CC42C</RequestId>\\r\\n\\t<Message></Message>\\r\\n\\t<Total>2</Total>\\r\\n\\t<Resources>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<RuleId>putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****</RuleId>\\r\\n\\t\\t\\t<Escalation>\\r\\n\\t\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t\\t\\t<Times>1</Times>\\r\\n\\t\\t\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t\\t\\t<Tag>mns</Tag>\\r\\n\\t\\t\\t\\t</Resource>\\r\\n\\t\\t\\t</Escalation>\\r\\n\\t\\t\\t<Resource>userId=120886317861****,region=cn-huhehaote,queue=test-0128</Resource>\\r\\n\\t\\t\\t<StartTime>1622427900000</StartTime>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-0128\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<MetricValues>{\\\\\\"timestamp\\\\\\":1623727500000,\\\\\\"Sum\\\\\\":926,\\\\\\"value\\\\\\":463,\\\\\\"Maximum\\\\\\":463,\\\\\\"Minimum\\\\\\":463,\\\\\\"Average\\\\\\":463,\\\\\\"SampleCount\\\\\\":2,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-0128\\\\\\"}</MetricValues>\\r\\n\\t\\t\\t<LastModifyTime>1623727904000</LastModifyTime>\\r\\n\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t<Namespace>acs_mns_new</Namespace>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<MetricName>ActiveMessages</MetricName>\\r\\n\\t\\t\\t<LastAlertTime>1622427900000</LastAlertTime>\\r\\n\\t\\t\\t<ProductCategory>mns</ProductCategory>\\r\\n\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t<RuleName>test123456789</RuleName>\\r\\n\\t\\t\\t<RetryTimes>1</RetryTimes>\\r\\n\\t\\t\\t<Threshold>10</Threshold>\\r\\n\\t\\t</Resource>\\r\\n\\t\\t<Resource>\\r\\n\\t\\t\\t<RuleId>putNewAlarm_user_7e78d765-0e3e-4671-ba6d-7ce39108****</RuleId>\\r\\n\\t\\t\\t<Escalation>\\r\\n\\t\\t\\t\\t<Resource>\\r\\n\\t\\t\\t\\t\\t<Expression>$Average>=10</Expression>\\r\\n\\t\\t\\t\\t\\t<Times>1</Times>\\r\\n\\t\\t\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t\\t\\t<Tag>mns</Tag>\\r\\n\\t\\t\\t\\t</Resource>\\r\\n\\t\\t\\t</Escalation>\\r\\n\\t\\t\\t<Resource>userId=120886317861****,region=cn-huhehaote,queue=test-022401-1</Resource>\\r\\n\\t\\t\\t<StartTime>1622427900000</StartTime>\\r\\n\\t\\t\\t<Dimensions>{\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"queue\\\\\\":\\\\\\"test-022401-1\\\\\\"}</Dimensions>\\r\\n\\t\\t\\t<MetricValues>{\\\\\\"timestamp\\\\\\":1623727500000,\\\\\\"queue\\\\\\":\\\\\\"test-022401-1\\\\\\",\\\\\\"Maximum\\\\\\":349,\\\\\\"Minimum\\\\\\":349,\\\\\\"Sum\\\\\\":698,\\\\\\"value\\\\\\":349,\\\\\\"userId\\\\\\":\\\\\\"120886317861****\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-huhehaote\\\\\\",\\\\\\"Average\\\\\\":349,\\\\\\"SampleCount\\\\\\":2}</MetricValues>\\r\\n\\t\\t\\t<LastModifyTime>1623727904000</LastModifyTime>\\r\\n\\t\\t\\t<Statistics>Average</Statistics>\\r\\n\\t\\t\\t<Namespace>acs_mns_new</Namespace>\\r\\n\\t\\t\\t<GroupId>7671****</GroupId>\\r\\n\\t\\t\\t<MetricName>ActiveMessages</MetricName>\\r\\n\\t\\t\\t<LastAlertTime>1622427900000</LastAlertTime>\\r\\n\\t\\t\\t<ProductCategory>mns</ProductCategory>\\r\\n\\t\\t\\t<Enable>true</Enable>\\r\\n\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t<RuleName>test123456789</RuleName>\\r\\n\\t\\t\\t<RetryTimes>1</RetryTimes>\\r\\n\\t\\t\\t<Threshold>10</Threshold>\\r\\n\\t\\t</Resource>\\r\\n\\t</Resources>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeAlertingMetricRuleResourcesResponse>\\t","errorExample":""}]', + 'title' => '查询指定报警规则中正在发生报警的资源列表', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutMetricRuleTargets' => [ + 'summary' => '调用PutMetricRuleTargets接口为指定报警规则添加或修改推送渠道。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ae06917_75a8c43178ab66****', + ], + ], + [ + 'name' => 'Targets', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。'."\n" + ."\n" + .'关于如何获取报警触发目标ID,请参见[DescribeMetricRuleTargets](~~121592~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。目前支持轻量消息队列(原 MNS),弹性伸缩ESS,日志服务SLS,函数计算FC。'."\n" + ."\n" + .'轻量消息队列(原 MNS)的ARN参数说明如下:'."\n" + ."\n" + .'`acs:mns:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + .'- {userId}:资源所属的阿里云账号。'."\n" + .'- {资源类型}`:接收报警的资源类型。取值:'."\n" + ."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。'."\n" + ."\n" + .'弹性伸缩的ARN:'."\n" + ."\n" + .'acs:ess:{regionId}:{userId}:scalingGroupId/{伸缩组id}:scalingRuleId/{伸缩规则id}'."\n" + ."\n" + .'日志服务的ARN:'."\n" + ."\n" + .'acs:log:{regionId}:{userId}:project/{project名称}/logstore/{日志库名称}'."\n" + ."\n" + .'函数计算的ARN:'."\n" + ."\n" + .'acs:fc:{regionId}:{userId}:services/{服务名称}/functions/{函数名称}', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:mns:cn-hangzhou:120886317861****:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'required' => false, + 'example' => '["INFO", "WARN", "CRITICAL"]', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request processing has failed due to some unknown error.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A569B0D-9055-58AF-9E82-BAEAF95C0FD5', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailData' => [ + 'description' => '失败列表。', + 'type' => 'object', + 'properties' => [ + 'Targets' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => '报警触发目标。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警触发目标ID。', + 'type' => 'string', + 'example' => '1', + ], + 'Arn' => [ + 'description' => '资源ARN。格式为`acs:{云产品缩写}:{regionId}:{userId}:/{资源类型}/{资源名称}/message`。目前支持轻量消息队列(原 MNS),弹性伸缩ESS,日志服务SLS,函数计算FC。例如:`acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`。轻量消息队列(原 MNS)的ARN参数说明如下:'."\n" + ."\n" + .'- {云产品缩写}:mns'."\n" + ."\n" + .'- {userId}:阿里云账号ID。'."\n" + ."\n" + .'- {regionId}:轻量消息队列(原 MNS)或主题所在地域。'."\n" + ."\n" + .'- {资源类型}`:接收报警的资源类型。取值:'."\n" + ."\n" + .' - **queues**:队列。'."\n" + .' - **topics**:主题。'."\n" + ."\n" + .'- {资源名称}:资源名称。'."\n" + ."\n" + .' - 如果资源类型为**queues**,则资源名称为队列名称。'."\n" + .' - 如果资源类型为**topics**,则资源名称为主题名称。', + 'type' => 'string', + 'example' => 'acs:mns:cn-hangzhou:111:/queues/test/message', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + ."\n" + .'- INFO:信息。'."\n" + .'- WARN:警告。'."\n" + .'- CRITICAL:紧急。', + 'type' => 'string', + 'example' => '["INFO", "WARN", "CRITICAL"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"6A569B0D-9055-58AF-9E82-BAEAF95C0FD5\\",\\n \\"Success\\": true,\\n \\"FailData\\": {\\n \\"Targets\\": {\\n \\"Target\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Arn\\": \\"acs:mns:cn-hangzhou:111:/queues/test/message\\",\\n \\"Level\\": \\"[\\\\\\"INFO\\\\\\", \\\\\\"WARN\\\\\\", \\\\\\"CRITICAL\\\\\\"]\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<PutMetricRuleTargetsResponse>\\r\\n\\t<RequestId>6A569B0D-9055-58AF-9E82-BAEAF95C0FD5</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</PutMetricRuleTargetsResponse>\\t","errorExample":""}]', + 'title' => '为指定报警规则添加或修改推送渠道', + 'description' => '## 使用说明'."\n" + .'本文将提供一个示例,为报警规则`ae06917_75a8c43178ab66****`关联资源`acs:mns:cn-hangzhou:120886317861****:/queues/test/message`,报警触发目标ID为`1`。返回结果显示,添加关联资源成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutResourceMetricRule' => [ + 'summary' => '设置报警规则', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'您可以输入新的报警规则ID,也可以使用云监控已存在的报警规则ID。关于如何查询报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。'."\n" + ."\n" + .'> 输入新的报警规则ID,表示创建一条阈值报警规则。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'您可以输入新的报警规则名称,也可以使用云监控已存在的报警规则名称。关于如何查询报警规则名称,请参见[DescribeMetricRuleList](~~114941~~)。'."\n" + ."\n" + .'> 输入新的报警规则名称,表示创建一条阈值报警规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'test123', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。关于如何查询云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 当您为企业云监控创建Prometheus报警规则时,该参数必须为`acs_prometheus`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。关于如何查询监控项名称,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 当您为企业云监控创建Prometheus报警规则时,该参数为指标仓库名称。关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'schema' => [ + 'description' => '资源信息,例如:`[{"instanceId":"i-uf6j91r34rnwawoo****"}]`、`[{"userId":"100931896542****"}]`。'."\n" + ."\n" + .'关于资源信息支持的维度Dimensions,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组。报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'> 报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~114923~~)和[PutContactGroup](~~114929~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '报警发生回调时指定的URL地址,向URL发送POST请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alert.aliyun.com.com:8080/callback', + ], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的生效时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-23:59', + ], + ], + [ + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的失效时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-06:00', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默周期。单位:秒,默认值:86400。'."\n" + ."\n" + .'> 通道沉默周期是指报警发生后未恢复正常,间隔多久重新发送一次报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + 'default' => '86400', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的统计周期。单位:秒。默认为监控项的原始上报周期。'."\n" + ."\n" + .'>关于如何查询监控项的统计周期,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的触发周期。单位:秒。'."\n" + ."\n" + .'>关于如何查询监控项的统计周期,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => [ + 'description' => '报警邮件主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS实例报警', + ], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别报警统计方法。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别报警阈值。'."\n" + ."\n\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别报警重试次数。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Escalations.Warn.Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别报警统计方法。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别报警阈值。'."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别报警重试次数。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别报警统计方法。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别报警阈值。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别报警重试次数。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'NoDataPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '无监控数据时报警的处理方式。取值:'."\n" + ."\n" + .'- KEEP\\_LAST\\_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT\\_DATA:报警内容为无数据。'."\n" + .'- OK:正常。', + 'type' => 'string', + 'required' => false, + 'example' => 'KEEP_LAST_STATE', + ], + ], + [ + 'name' => 'CompositeExpression', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '多指标的报警条件。'."\n" + ."\n" + .'> 单指标和多指标互斥,不能同时设置。', + 'type' => 'object', + 'properties' => [ + 'ExpressionList' => [ + 'description' => '标准创建的报警条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '云产品的监控项名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + 'Period' => [ + 'description' => '监控项的聚合周期。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + 'Statistics' => [ + 'description' => '监控项的统计方法。取值:'."\n" + .'- $Maximum:最大值。'."\n" + .'- $Minimum:最小值。'."\n" + .'- $Average:平均值。'."\n" + .'- $Availability:可用率(通常用于站点监控)。'."\n" + ."\n" + .'> `$`为监控项的统一前缀符号。支持的云产品,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '$Maximum', + ], + 'ComparisonOperator' => [ + 'description' => '阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Threshold' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ExpressionListJoin' => [ + 'description' => '多指标报警条件之间的关系。取值: '."\n" + ."\n" + .'- `&&`:当所有指标都符合报警条件时,才触发报警。当ExpressionList下各表达式均为`true`时,才触发报警。'."\n" + ."\n" + .'- `||`:其中一个指标符合报警条件,即触发报警。', + 'type' => 'string', + 'required' => false, + 'example' => '||', + ], + 'ExpressionRaw' => [ + 'description' => '表达式创建的报警条件。包括但不限于以下情况:'."\n" + ."\n" + .'- 为部分资源设置报警黑名单,例如:`$instanceId != \'i-io8kfvcpp7x5****\' ``&&`` $Average > 50`,表示当报警规则中的实例`i-io8kfvcpp7x5****`的`Average`大于50时,也不会产生报警。'."\n" + .'- 对规则中的指定实例设置特殊报警阈值,例如:`$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)`,表示当报警规则中的实例`i-io8kfvcpp7x5****`的`Average`大于80时,才报警,其他实例的`Average`大于50,即可报警。'."\n" + .'- 对规则中超过阈值的实例数量进行限制,例如:`count($Average > 20) > 3`,表示当报警规则中的`Average`大于20的实例数大于3个时,才进行报警。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '$Average > ($instanceId == \'i-io8kfvcpp7x5****\'? 80: 50)', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '当监控项达到报警条件并进行报警时,标签同时写入监控项,在报警通知中进行展示。'."\n" + ."\n" + .'> 该功能与Prometheus报警中的Label相同。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagKey1', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'> 标签值支持模板参数,将模板参数替换为实际标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Prometheus', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Prometheus报警。'."\n" + ."\n" + .'> 仅当您为企业云监控创建Prometheus报警规则,需要设置该参数。', + 'type' => 'object', + 'properties' => [ + 'PromQL' => [ + 'description' => 'PromQL查询语句。'."\n" + ."\n" + .'> 通过PromQL查询语句获取的数据即为报警数据,请您在该语句中携带报警阈值。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpuUsage{instanceId="xxxx"}[1m]>90', + ], + 'Level' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + 'Times' => [ + 'description' => '发出报警通知需要达到报警条件的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Annotations' => [ + 'description' => 'Prometheus报警时,将注释的键和值进行渲染,易于您对监控项或报警规则的理解。'."\n" + ."\n" + .'> 该功能等同于Prometheus的Annotation。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '注释的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'summary', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'required' => false, + 'example' => '{{ $labels.instance }} CPU usage above 10% {current value: {{ humanizePercentage $value }} }', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request processing has failed due to some unknown error.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '65D50468-ECEF-48F1-A6E1-D952E89D9436', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 429 => [ + [ + 'errorCode' => 'ResourceOverLimit', + 'errorMessage' => 'The resource has exceeded the limit. %s', + ], + ], + 499 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"65D50468-ECEF-48F1-A6E1-D952E89D9436\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutResourceMetricRuleResponse>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Message></Message>\\r\\n\\t<RequestId>65D50468-ECEF-48F1-A6E1-D952E89D9436</RequestId>\\r\\n\\t<Success>true</Success>\\r\\n</PutResourceMetricRuleResponse>","errorExample":""}]', + 'title' => '为指定资源的指定监控项设置一条阈值报警规则', + 'description' => '本文将提供一个示例,为云服务器ECS `acs_ecs_dashboard`的实例`i-uf6j91r34rnwawoo****`中的监控项`cpu_total`设置阈值报警规则。该报警规则的报警联系组为`ECS_Group`、报警规则名称为`test123`、报警规则ID为`a151cd6023eacee2f0978e03863cc1697c89508****`、Critical级别的统计方法为`Average`、Critical级别的比较符为`GreaterThanOrEqualToThreshold`、Critical级别的阈值为`90`和Critical级别的报警重试次数为`3`。'."\n" + .'> 2024-08-15 增加Statistics校验,统计值只能填对应指标的Statistics。关于如何获取该参数的取值,请参见[云产品监控项](https://help.aliyun.com/zh/cms/support/appendix-1-metrics)。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutResourceMetricRules' => [ + 'summary' => '调用PutResourceMetricRules接口为指定资源的指定监控项设置多条阈值报警规则。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Rules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '阈值报警规则列表。'."\n" + ."\n" + .'N的取值范围:1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Escalations.Info.Threshold' => [ + 'description' => 'Info级别报警阈值。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + 'MetricName' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'关于如何查询监控项名称,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'cpu_total', + ], + 'Escalations.Warn.Threshold' => [ + 'description' => 'Warn级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + 'EffectiveInterval' => [ + 'description' => '报警规则的生效时间范围。'."\n" + ."\n" + .'N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-23:59', + ], + 'NoEffectiveInterval' => [ + 'description' => '报警规则的失效时间范围。'."\n" + ."\n" + .'N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-06:00', + ], + 'RuleId' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'您可以输入新的报警规则ID,也可以使用云监控已存在的报警规则ID。关于如何查询报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。'."\n" + ."\n" + .'> 输入新的报警规则ID,表示创建一条阈值报警规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', + ], + 'Escalations.Critical.Times' => [ + 'description' => 'Critical级别报警重试次数。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Escalations.Critical.Threshold' => [ + 'description' => 'Critical级别报警阈值。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + 'Escalations.Critical.Statistics' => [ + 'description' => 'Critical级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Warn.ComparisonOperator' => [ + 'description' => 'Warn级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Info.Times' => [ + 'description' => 'Info级别报警重试次数。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Resources' => [ + 'description' => '资源信息,例如:`[{"instanceId":"i-uf6j91r34rnwawoo****"}]`、`[{"userId":"100931896542****"}]`。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'关于资源信息支持的维度Dimensions,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '[{"instanceId":"i-uf6j91r34rnwawoo****"}]', + ], + 'SilenceTime' => [ + 'description' => '通道沉默周期。'."\n" + ."\n" + .'单位:秒,默认值:86400。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 通道沉默周期是指报警发生后未恢复正常,间隔多久重新发送一次报警通知。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + ], + 'Webhook' => [ + 'description' => '报警发生回调时指定的URL地址,向URL发送POST请求。'."\n" + ."\n" + .'N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alert.aliyun.com.com:8080/callback', + ], + 'ContactGroups' => [ + 'description' => '报警联系组。报警通知会发送给该报警联系组中的报警联系人。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警联系组是一组报警联系人,可以包含一个或多个报警联系人。关于如何创建报警联系人和报警联系组,请参见[PutContact](~~114923~~)和[PutContactGroup](~~114929~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Group', + ], + 'Namespace' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'关于如何查询云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + 'EmailSubject' => [ + 'description' => '报警邮件主题。'."\n" + ."\n" + .'N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS实例报警', + ], + 'Period' => [ + 'description' => '监控项的统计周期。'."\n" + ."\n" + .'单位:秒。默认为监控项的原始上报周期。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'>关于如何查询监控项的统计周期,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + 'RuleName' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'您可以输入新的报警规则名称,也可以使用云监控已存在的报警规则名称。关于如何查询报警规则名称,请参见[DescribeMetricRuleList](~~114941~~)。'."\n" + ."\n" + .'> 输入新的报警规则名称,表示创建一条阈值报警规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'test123', + ], + 'Escalations.Info.Statistics' => [ + 'description' => 'Info级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'Escalations.Warn.Times' => [ + 'description' => 'Warn级别报警重试次数。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Escalations.Info.ComparisonOperator' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Interval' => [ + 'description' => '报警规则的触发周期。'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'>关于如何查询监控项的统计周期,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + 'Escalations.Critical.ComparisonOperator' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'Escalations.Warn.Statistics' => [ + 'description' => 'Warn级别报警统计方法。'."\n" + ."\n" + .'N的取值范围:1~50。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 报警级别Critical(严重)、Warn(警告)或Info(信息)至少设置一个,且该报警级别中的参数Statistics、ComparisonOperator、Threshold和Times必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + 'NoDataPolicy' => [ + 'description' => '无监控数据时报警的处理方式。取值:'."\n" + ."\n" + .'- KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'- OK:正常。'."\n" + ."\n" + .'N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => 'KEEP_LAST_STATE', + ], + 'Labels' => [ + 'description' => '当监控项达到报警条件并进行报警时,标签同时写入监控项,在报警通知中进行展示。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagKey1', + ], + 'Value' => [ + 'description' => '标签值。'."\n" + ."\n" + .'> 标签值支持模板参数,将模板参数替换为实际标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 500, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request processing has failed due to some unknown error.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '15D1440E-BF24-5A41-93E4-36864635179E', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailedListResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Target' => [ + 'description' => '为资源设置报警规则的失败结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => 'a151cd6023eacee2f0978e03863cc1697c89508****', + ], + 'Result' => [ + 'description' => '失败结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '404', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request processing has failed due to some unknown error.', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 422 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 499 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"RequestId\\": \\"15D1440E-BF24-5A41-93E4-36864635179E\\",\\n \\"Success\\": true,\\n \\"FailedListResult\\": {\\n \\"Target\\": [\\n {\\n \\"RuleId\\": \\"a151cd6023eacee2f0978e03863cc1697c89508****\\",\\n \\"Result\\": {\\n \\"Code\\": \\"404\\",\\n \\"Message\\": \\"The request processing has failed due to some unknown error.\\",\\n \\"Success\\": false\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PutResourceMetricRulesResponse>\\r\\n\\t<Message></Message>\\r\\n\\t<RequestId>15D1440E-BF24-5A41-93E4-36864635179E</RequestId>\\r\\n\\t<FailedListResult></FailedListResult>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</PutResourceMetricRulesResponse>\\t","errorExample":""}]', + 'title' => '为指定资源的指定监控项设置多条阈值报警规则', + 'description' => '本文将提供一个示例,为云服务器ECS `acs_ecs_dashboard`的实例`i-uf6j91r34rnwawoo****`中的监控项`cpu_total`设置阈值报警规则。该报警规则的报警联系组为`ECS_Group`、报警规则名称为`test123`、报警规则ID为`a151cd6023eacee2f0978e03863cc1697c89508****`、Critical级别的统计方法为`Average`、Critical级别的比较符为`GreaterThanOrEqualToThreshold`、Critical级别的阈值为`90`和Critical级别的报警重试次数为`3`。'."\n" + .'> 2024-08-15 增加Statistics校验,统计值只能填对应指标的Statistics。关于如何获取该参数的取值,请参见[云产品监控项](https://help.aliyun.com/zh/cms/support/appendix-1-metrics)。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutGroupMetricRule' => [ + 'summary' => '调用PutGroupMetricRule接口创建或修改指定应用分组中的报警规则。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '17285****', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'- 当您为该应用分组创建报警规则时,直接输入报警规则ID。'."\n" + ."\n" + .'- 当您修改该应用分组中的指定报警规则时,需要获取报警规则ID。关于如何获取报警规则ID,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品名称缩写。'."\n" + ."\n" + .'关于如何获取云产品名称缩写,请参见[DescribeProjectMeta](~~114916~~)接口的返回参数`Labels`中的`metricCategory`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。'."\n" + ."\n" + .'- 当您为该应用分组创建报警规则时,直接输入报警规则名称。'."\n" + ."\n" + .'- 当您修改该应用分组中的指定报警规则时,需要获取报警规则名称。关于如何获取报警规则名称,请参见[DescribeMetricRuleList](~~114941~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Rule_01', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的命名空间。'."\n" + ."\n" + .'关于如何获取云产品的命名空间,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。'."\n" + ."\n" + .'关于如何获取监控项名称,请参见[DescribeMetricMetaList](~~98846~~)或[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_total', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组中报警规则的第一级维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`{"userId":"120886317861****"}`和`{"instanceId":"i-m5e1qg6uo38rztr4****"}`。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"instanceId":"i-m5e1qg6uo38rztr4****"}]', + ], + ], + [ + 'name' => 'ExtraDimensionJson', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组中报警规则的第二级或第三级维度。'."\n" + ."\n" + .'格式:`key:value`键值对形式的集合,例如:`port:80`、`/dev/xvda:d-m5e6yphgzn3aprwu****`。'."\n" + ."\n" + .'当报警规则的第一级维度为`{"instanceId":"i-m5e1qg6uo38rztr4****"}`时,其第二级维度为该实例中的云盘`{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}`。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}', + ], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的生效时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '05:31-23:59', + ], + ], + [ + 'name' => 'NoEffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的失效时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-05:30', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默周期。'."\n" + ."\n" + .'单位:秒。默认值:86400。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的上报周期。'."\n" + ."\n" + .'`Period`的取值为60或60的整数倍。单位:秒。默认值:300。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的探测周期。单位:秒。'."\n" + ."\n" + .'> 建议报警规则的探测周期和数据上报周期保持一致。如果报警规则的探测周期小于数据上报周期,会因为数据不足而不能触发报警。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '报警发生回调时的URL地址。'."\n" + ."\n" + .'填写公网可访问的URL地址,云监控会将报警信息通过POST请求推送到该地址,目前仅支持HTTP协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => [ + 'description' => '报警邮件主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS实例', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'Escalations.Critical.Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Escalations.Critical.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + [ + 'name' => 'Escalations.Critical.Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别报警阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Escalations.Critical.Times', + 'in' => 'query', + 'schema' => [ + 'description' => 'Critical级别报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Escalations.Warn.Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Escalations.Warn.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + [ + 'name' => 'Escalations.Warn.Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别报警阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Escalations.Warn.Times', + 'in' => 'query', + 'schema' => [ + 'description' => 'Warn级别报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'Escalations.Info.Statistics', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别报警统计方法。多个统计方法之间用半角逗号(,)分隔。'."\n" + ."\n" + .'该参数的取值由指定云产品的`MetricName`对应的`Statistics`列决定,例如:Maximum、Minimum和Average。关于如何获取该参数的取值,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Average', + ], + ], + [ + 'name' => 'Escalations.Info.ComparisonOperator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别阈值比较符。取值:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'required' => false, + 'example' => 'GreaterThanOrEqualToThreshold', + ], + ], + [ + 'name' => 'Escalations.Info.Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别报警阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'Escalations.Info.Times', + 'in' => 'query', + 'schema' => [ + 'description' => 'Info级别报警重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'NoDataPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => '无监控数据时报警的处理方式。取值:'."\n" + .'- KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'- OK:正常。', + 'type' => 'string', + 'required' => false, + 'example' => 'KEEP_LAST_STATE', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警规则标签。'."\n" + ."\n" + .'报警通知中会包含标签。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '报警规则的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '报警规则的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + [ + 'name' => 'Options', + 'in' => 'query', + 'schema' => [ + 'description' => '高级设置。'."\n" + ."\n" + .'格式:{"key1":"value1","key2":"value2"},例如:{"NotSendOK":true},表示是否发送报警恢复通知,key为NotSendOK,value为true(不发送)或false(默认发送)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"NotSendOK":true}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '报错信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '创建或修改报警规则的结果。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 499 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RuleId\\": \\"123456\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<PutGroupMetricRuleResponse>\\r\\n\\t<Message></Message>\\r\\n\\t<RequestId>461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Result>\\r\\n\\t\\t<RuleId>123456</RuleId>\\r\\n\\t</Result>\\r\\n</PutGroupMetricRuleResponse>","errorExample":""}]', + 'title' => '创建或修改指定应用分组中的报警规则', + 'description' => '本文将提供一个示例,为应用分组`17285****`中的云服务器ECS的监控项`cpu_total`创建一条报警规则,其中报警规则的ID为`123456`,报警规则名称为`Rule_test`,报警级别为`Critical`,报警统计方法为`Average`,报警阈值比较符为`GreaterThanOrEqualToThreshold`,报警阈值为`90`,报警重试次数为`3`。返回结果显示,创建报警规则成功,报警规则ID为`123456`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteEventRuleTargets' => [ + 'summary' => '调用DeleteEventRuleTargets接口删除事件报警的推送渠道。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则名称。'."\n" + ."\n" + .'关于如何获取事件报警规则名称,请参见[DescribeEventRuleList](~~114996~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testRule', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '事件报警规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRuleId', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successfull', + ], + 'RequestId' => [ + 'description' => '请求ID,用于定位日志,排查问题。', + 'type' => 'string', + 'example' => '142989D9-CC52-54D0-928D-2C9B1D9F051C', + ], + 'Success' => [ + 'description' => '是否成功,取值: '."\n" + .'- `true`:成功'."\n" + .'- `false`:失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successfull\\",\\n \\"RequestId\\": \\"142989D9-CC52-54D0-928D-2C9B1D9F051C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除事件报警的推送渠道', + ], + 'DeleteEventRules' => [ + 'summary' => '调用DeleteEventRules接口删除事件报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要删除的规则的名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要删除的规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'lq-test', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求的uuid,便于查询日志。', + 'type' => 'string', + 'example' => '45231A42-5A09-5AFF-953C-A5B3D4ED8925', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"45231A42-5A09-5AFF-953C-A5B3D4ED8925\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除事件报警规则', + ], + 'EnableEventRules' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RuleNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要启用的事件规则名称列表', + 'type' => 'array', + 'items' => [ + 'description' => '要启用的事件规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ruleName1', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', + 'type' => 'string', + 'example' => '20F2896A-6684-4A04-8255-4155B1593C70', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"20F2896A-6684-4A04-8255-4155B1593C70\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '启用一个或者多个事件监控报警规则', + 'summary' => '调用EnableEventRules接口启用一个或者多个事件监控报警规则。', + ], + 'DisableEventRules' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RuleNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'array', + 'items' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ruleName1', + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3FD0E8B5-F132-4F4E-A081-2878AF378B12', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"3FD0E8B5-F132-4F4E-A081-2878AF378B12\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '调用DisableEventRule接口禁用一个或多个事件报警规则', + 'summary' => '调用DisableEventRule接口禁用一个或多个事件报警规则。', + ], + 'DescribeEventRuleAttribute' => [ + 'summary' => '调用DescribeEventRuleAttribute接口查询指定事件报警规则的详情。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则名称。'."\n" + ."\n" + .'关于如何获取事件报警规则名称,请参见[DescribeEventRuleList](~~114996~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testRule', + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默周期。'."\n" + ."\n" + .'单位:秒,默认值:86400(1天)。'."\n" + ."\n" + .'> 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。', + 'type' => 'string', + 'required' => false, + 'example' => '86400', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The alert does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9AA3F210-C03D-4C86-8DB6-21C84FF692A1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '事件报警规则详情。', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '事件类型。取值:'."\n" + ."\n" + .'- SYSTEM:系统事件。'."\n" + ."\n" + .'- CUSTOM:自定义事件。', + 'type' => 'string', + 'example' => 'SYSTEM', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '3607****', + ], + 'Name' => [ + 'description' => '事件报警规则的名称。', + 'type' => 'string', + 'example' => 'test_DefaultEventRule_7378****', + ], + 'Description' => [ + 'description' => '事件报警规则的描述信息。', + 'type' => 'string', + 'example' => 'Default group event rule.', + ], + 'State' => [ + 'description' => '事件报警规则的状态。取值:'."\n" + ."\n" + .'- ENABLED:启用。'."\n" + ."\n" + .'- DISABLED:禁用。', + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'EventPattern' => [ + 'description' => '事件模式。用于描述事件的触发条件。', + 'type' => 'object', + 'properties' => [ + 'Product' => [ + 'description' => '云产品名称。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => '事件报警规则的级别的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的级别。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + ."\n" + .'- WARN:警告。'."\n" + ."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => '["CRITICAL","WARN"] ', + ], + ], + ], + ], + 'StatusList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'StatusList' => [ + 'description' => '事件报警规则的状态的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => '事件报警规则的名称的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件名称。', + 'type' => 'string', + 'example' => 'Agent_Status_Running', + ], + ], + ], + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => '事件报警规则的类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的类型。'."\n" + ."\n" + .'`*`表示不限制报警规则类型。', + 'type' => 'string', + 'example' => '*', + ], + ], + ], + ], + 'SQLFilter' => [ + 'description' => '按照SQL过滤日志。如果符合条件,则触发报警。', + 'type' => 'string', + 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', + ], + 'KeywordFilterObj' => [ + 'description' => '过滤关键词。', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'keyword' => [ + 'description' => '事件匹配的关键字列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关键字。', + 'type' => 'string', + 'example' => 'VMException', + ], + ], + ], + ], + 'Relation' => [ + 'description' => '多个关键字的条件。取值:'."\n" + ."\n" + .'- OR: 多个关键字之间或的关系。'."\n" + .'- NOT:不包含关键字。表示匹配非关键字列表中的所有事件。', + 'type' => 'string', + 'example' => 'OR', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The alert does not exist.\\",\\n \\"RequestId\\": \\"9AA3F210-C03D-4C86-8DB6-21C84FF692A1\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"EventType\\": \\"SYSTEM\\",\\n \\"GroupId\\": \\"3607****\\",\\n \\"Name\\": \\"test_DefaultEventRule_7378****\\",\\n \\"Description\\": \\"Default group event rule.\\",\\n \\"State\\": \\"ENABLED\\",\\n \\"EventPattern\\": {\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"[\\\\\\"CRITICAL\\\\\\",\\\\\\"WARN\\\\\\"] \\"\\n ]\\n },\\n \\"StatusList\\": {\\n \\"StatusList\\": [\\n \\"Running\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"Agent_Status_Running\\"\\n ]\\n },\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"*\\"\\n ]\\n },\\n \\"SQLFilter\\": \\"ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222\\",\\n \\"KeywordFilterObj\\": {\\n \\"Keywords\\": {\\n \\"keyword\\": [\\n \\"VMException\\"\\n ]\\n },\\n \\"Relation\\": \\"OR\\"\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventRuleAttributeResponse>\\r\\n\\t<RequestId>9AA3F210-C03D-4C86-8DB6-21C84FF692A1</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n\\t<Result>\\r\\n\\t\\t<EventPattern>\\r\\n\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t<NameList>Agent_Status_Running</NameList>\\r\\n\\t\\t\\t</NameList>\\r\\n\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t<Product>CloudMonitor</Product>\\r\\n\\t\\t</EventPattern>\\r\\n\\t\\t<Description>Default group event rule</Description>\\r\\n\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t<State>ENABLED</State>\\r\\n\\t\\t<Name>test_DefaultEventRule_7378****</Name>\\r\\n\\t\\t<GroupId>3607****</GroupId>\\r\\n\\t</Result>\\r\\n</DescribeEventRuleAttributeResponse>\\t","errorExample":""}]', + 'title' => '查询指定事件报警规则的详情', + 'description' => '本文将提供一个示例,查询事件报警规则`testRule`的详情。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEventRuleList' => [ + 'summary' => '调用DescribeEventRuleList接口查询事件报警规则列表。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'NamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7378****', + ], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '启用或禁用事件报警规则。取值:'."\n" + ."\n" + .'true(默认值):启用。'."\n" + ."\n" + .'false:禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '事件报警规则列表。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D0E6D82B-16B5-422A-8136-EE5BDC01E415', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EventRules' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventRule' => [ + 'description' => '事件报警规则。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则。', + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '事件报警类型。取值:'."\n" + ."\n" + .'- SYSTEM:系统事件。'."\n" + ."\n" + .'- CUSTOM:自定义事件。', + 'type' => 'string', + 'example' => 'SYSTEM', + ], + 'Description' => [ + 'description' => '事件报警规则的描述信息。', + 'type' => 'string', + 'example' => 'Default group event rule.', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '7378****', + ], + 'Name' => [ + 'description' => '事件报警规则名称。', + 'type' => 'string', + 'example' => 'test_DefaultEventRule_7378****', + ], + 'State' => [ + 'description' => '事件报警规则状态。取值:'."\n" + ."\n" + .'- ENABLED:启用。'."\n" + ."\n" + .'- DISABLED:禁用。', + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'EventPattern' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventPattern' => [ + 'description' => '事件报警规则的模式。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的模式。', + 'type' => 'object', + 'properties' => [ + 'Product' => [ + 'description' => '云服务名称的缩写。', + 'type' => 'string', + 'example' => 'CloudMonitor', + ], + 'LevelList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LevelList' => [ + 'description' => '事件的等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件的等级。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + ."\n" + .'- WARN:警告。'."\n" + ."\n" + .'- INFO:信息。', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + ], + ], + ], + 'EventTypeList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'EventTypeList' => [ + 'description' => '事件报警规则的类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的类型。'."\n" + ."\n" + .'`*`表示不限制报警规则类型。', + 'type' => 'string', + 'example' => '*', + ], + ], + ], + ], + 'NameList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NameList' => [ + 'description' => '事件名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件名称列表。', + 'type' => 'string', + 'example' => '["Agent_Status_Stopped"]', + ], + ], + ], + ], + 'CustomFilters' => [ + 'description' => '自定义过滤条件。', + 'type' => 'string', + 'example' => 'ECS123', + ], + 'KeywordFilter' => [ + 'description' => '过滤关键词。', + 'type' => 'object', + 'properties' => [ + 'Keywords' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Keywords' => [ + 'description' => '事件匹配的关键字列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关键字。', + 'type' => 'string', + 'example' => 'VMException', + ], + ], + ], + ], + 'Relation' => [ + 'description' => '多个关键字的条件。取值:'."\n" + ."\n" + .'- OR: 多个关键字之前是或的关系。'."\n" + .'- NOT:不包含关键字。表示匹配非关键字列表中的所有事件。', + 'type' => 'string', + 'example' => 'OR', + ], + ], + ], + 'SQLFilter' => [ + 'description' => '按照SQL过滤日志。如果符合条件,则触发报警。', + 'type' => 'string', + 'example' => 'ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222', + ], + ], + ], + ], + ], + ], + 'SilenceTime' => [ + 'description' => '通道沉默周期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86400', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"D0E6D82B-16B5-422A-8136-EE5BDC01E415\\",\\n \\"Total\\": 21,\\n \\"Success\\": true,\\n \\"EventRules\\": {\\n \\"EventRule\\": [\\n {\\n \\"EventType\\": \\"SYSTEM\\",\\n \\"Description\\": \\"Default group event rule.\\",\\n \\"GroupId\\": \\"7378****\\",\\n \\"Name\\": \\"test_DefaultEventRule_7378****\\",\\n \\"State\\": \\"ENABLED\\",\\n \\"EventPattern\\": {\\n \\"EventPattern\\": [\\n {\\n \\"Product\\": \\"CloudMonitor\\",\\n \\"LevelList\\": {\\n \\"LevelList\\": [\\n \\"CRITICAL\\"\\n ]\\n },\\n \\"EventTypeList\\": {\\n \\"EventTypeList\\": [\\n \\"*\\"\\n ]\\n },\\n \\"NameList\\": {\\n \\"NameList\\": [\\n \\"[\\\\\\"Agent_Status_Stopped\\\\\\"]\\"\\n ]\\n },\\n \\"CustomFilters\\": \\"ECS123\\",\\n \\"KeywordFilter\\": {\\n \\"Keywords\\": {\\n \\"Keywords\\": [\\n \\"VMException\\"\\n ]\\n },\\n \\"Relation\\": \\"OR\\"\\n },\\n \\"SQLFilter\\": \\"ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222\\"\\n }\\n ]\\n },\\n \\"SilenceTime\\": 86400\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventRuleListResponse>\\r\\n\\t<RequestId>C8308712-6E7A-4FA0-82AC-80D018DAD168</RequestId>\\r\\n\\t<Total>3</Total>\\r\\n\\t<EventRules>\\r\\n\\t\\t<EventRule>\\r\\n\\t\\t\\t<EventPattern>\\r\\n\\t\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t\\t<NameList>*</NameList>\\r\\n\\t\\t\\t\\t</NameList>\\r\\n\\t\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t\\t<EventTypeList>\\r\\n\\t\\t\\t\\t\\t<EventTypeList>*</EventTypeList>\\r\\n\\t\\t\\t\\t</EventTypeList>\\r\\n\\t\\t\\t\\t<Product>CloudMonitor</Product>\\r\\n\\t\\t\\t</EventPattern>\\r\\n\\t\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t\\t<State>ENABLED</State>\\r\\n\\t\\t\\t<Name>test123</Name>\\r\\n\\t\\t</EventRule>\\r\\n\\t\\t<EventRule>\\r\\n\\t\\t\\t<EventPattern>\\r\\n\\t\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t\\t<NameList>*</NameList>\\r\\n\\t\\t\\t\\t</NameList>\\r\\n\\t\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>WARN</LevelList>\\r\\n\\t\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t\\t<Product>*</Product>\\r\\n\\t\\t\\t</EventPattern>\\r\\n\\t\\t\\t<Description>Default group event rule.</Description>\\r\\n\\t\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t\\t<State>ENABLED</State>\\r\\n\\t\\t\\t<Name>test_DefaultEventRule_7378****</Name>\\r\\n\\t\\t\\t<GroupId>7378****</GroupId>\\r\\n\\t\\t</EventRule>\\r\\n\\t\\t<EventRule>\\r\\n\\t\\t\\t<EventPattern>\\r\\n\\t\\t\\t\\t<NameList>\\r\\n\\t\\t\\t\\t\\t<NameList>*</NameList>\\r\\n\\t\\t\\t\\t</NameList>\\r\\n\\t\\t\\t\\t<LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>CRITICAL</LevelList>\\r\\n\\t\\t\\t\\t\\t<LevelList>WARN</LevelList>\\r\\n\\t\\t\\t\\t</LevelList>\\r\\n\\t\\t\\t\\t<Product>*</Product>\\r\\n\\t\\t\\t</EventPattern>\\r\\n\\t\\t\\t<Description>Default group event rule.</Description>\\r\\n\\t\\t\\t<EventType>SYSTEM</EventType>\\r\\n\\t\\t\\t<State>ENABLED</State>\\r\\n\\t\\t\\t<Name>test123_DefaultEventRule_7301****</Name>\\r\\n\\t\\t\\t<GroupId>7301****</GroupId>\\r\\n\\t\\t</EventRule>\\r\\n\\t</EventRules>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeEventRuleListResponse>\\t","errorExample":""}]', + 'title' => '查询事件报警规则列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEventRuleTargetList' => [ + 'summary' => '查询事件规则列表', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testRule', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', + ], + 'ContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => '报警联系组通知方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => [ + 'description' => '报警联系人组的名称。', + 'type' => 'string', + 'example' => '默认告警通知组', + ], + 'Level' => [ + 'description' => '通知级别。取值:'."\n" + ."\n" + .'<props="china">- 2:电话、短信、钉钉、Email。</props>'."\n" + ."\n" + .'<props="china">- 3:短信、钉钉、Email。</props>'."\n" + ."\n" + .'<props="china">- 4:钉钉、Email。</props>'."\n" + ."\n" + .'<props="intl">4:钉钉、Email。</props>'."\n" + ."\n" + .'<props="partner">4:钉钉、Email。</props>'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'Id' => [ + 'description' => '报警联系人组通知方式唯一标识。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'FcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FCParameter' => [ + 'description' => '函数计算通知方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '函数计算服务名称。', + 'type' => 'string', + 'example' => 'service1', + ], + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'fcTest1', + ], + 'Arn' => [ + 'description' => 'ARN资源描述。'."\n" + ."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + ."\n" + .'- Service:云产品code。'."\n" + ."\n" + .'- Region:地域ID。'."\n" + ."\n" + .'- Account:阿里云账号ID。'."\n" + ."\n" + .'- ResourceType:资源类型。'."\n" + ."\n" + .'- ResourceId:资源ID。', + 'type' => 'string', + 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', + ], + 'Id' => [ + 'description' => '函数服务通知方式唯一标识。', + 'type' => 'string', + 'example' => '3', + ], + 'Region' => [ + 'description' => '函数计算服务对应的地域。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + ], + ], + ], + ], + ], + 'MnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => '轻量消息队列(原 MNS)通知。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Queue' => [ + 'description' => '轻量消息队列(原 MNS)的名称。', + 'type' => 'string', + 'example' => 'testQueue', + ], + 'Arn' => [ + 'description' => 'ARN资源描述。'."\n" + ."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + ."\n" + .'- Service:云服务Code。'."\n" + ."\n" + .'- Region:地域ID。'."\n" + ."\n" + .'- Account:阿里云账号ID。'."\n" + ."\n" + .'- ResourceType:资源类型。'."\n" + ."\n" + .'- ResourceId:资源ID。', + 'type' => 'string', + 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', + ], + 'Region' => [ + 'description' => '轻量消息队列(原 MNS)对应的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Id' => [ + 'description' => '轻量消息队列(原 MNS)通知方式唯一标识。', + 'type' => 'string', + 'example' => '2', + ], + 'Topic' => [ + 'description' => '轻量消息队列(原 MNS)的主题。', + 'type' => 'string', + 'example' => 'topic_sample', + ], + ], + ], + ], + ], + ], + 'WebhookParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'WebhookParameter' => [ + 'description' => 'URL回调通知方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '回调的URL地址。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + ], + 'Method' => [ + 'description' => 'HTTP回调的请求方法。目前支持GET和POST方法。', + 'type' => 'string', + 'example' => 'GET', + ], + 'Protocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'example' => 'HTTP', + ], + 'Id' => [ + 'description' => 'URL回调通知方式唯一标识。', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + ], + ], + 'SlsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SlsParameter' => [ + 'description' => '日志服务(SLS)通知方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => 'Project名称。', + 'type' => 'string', + 'example' => 'project_test', + ], + 'LogStore' => [ + 'description' => 'LogStore名称。', + 'type' => 'string', + 'example' => 'logstore_test', + ], + 'Arn' => [ + 'description' => 'ARN资源描述。'."\n" + ."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + ."\n" + .'- Service:云服务Code。'."\n" + ."\n" + .'- Region:地域ID。'."\n" + ."\n" + .'- Account:阿里云账号ID。'."\n" + ."\n" + .'- ResourceType:资源类型。'."\n" + ."\n" + .'- ResourceId:资源ID。', + 'type' => 'string', + 'example' => 'acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***', + ], + 'Region' => [ + 'description' => 'Project对应的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Id' => [ + 'description' => '日志服务通知方式唯一标识。', + 'type' => 'string', + 'example' => '4', + ], + ], + ], + ], + ], + ], + 'OpenApiParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OpenApiParameters' => [ + 'description' => '回调API的参数含义。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => 'API名称。', + 'type' => 'string', + 'example' => 'PutLogs', + ], + 'Arn' => [ + 'description' => 'ARN资源描述。'."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + .' - Service:阿里云产品。'."\n" + .' - Region:地域ID。'."\n" + .' - Account:阿里云账号ID。'."\n" + .' - ResourceType:资源类型。'."\n" + .' - ResourceId:资源ID。ARN资源描述。'."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + .' - Service:阿里云产品。'."\n" + .' - Region:地域ID。'."\n" + .' - Account:阿里云账号ID。'."\n" + .' - ResourceType:资源类型。'."\n" + .' - ResourceId:资源ID。', + 'type' => 'string', + 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', + ], + 'Id' => [ + 'description' => 'API回调通知方式的唯一标识。', + 'type' => 'string', + 'example' => '3', + ], + 'Product' => [ + 'description' => 'API对应的云产品ID。', + 'type' => 'string', + 'example' => 'log', + ], + 'Region' => [ + 'description' => '资源对应的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Role' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'example' => 'MyRole', + ], + 'Version' => [ + 'description' => 'API的版本。', + 'type' => 'string', + 'example' => '2019-01-01', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"87170bc7-e28a-4c93-b9bf-90a1dbe84736\\",\\n \\"ContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"默认告警通知组\\",\\n \\"Level\\": \\"3\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n },\\n \\"FcParameters\\": {\\n \\"FCParameter\\": [\\n {\\n \\"ServiceName\\": \\"service1\\",\\n \\"FunctionName\\": \\"fcTest1\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Id\\": \\"3\\",\\n \\"Region\\": \\"cn-qingdao\\"\\n }\\n ]\\n },\\n \\"MnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"testQueue\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"2\\",\\n \\"Topic\\": \\"topic_sample\\"\\n }\\n ]\\n },\\n \\"WebhookParameters\\": {\\n \\"WebhookParameter\\": [\\n {\\n \\"Url\\": \\"http://www.aliyun.com\\",\\n \\"Method\\": \\"GET\\",\\n \\"Protocol\\": \\"HTTP\\",\\n \\"Id\\": \\"5\\"\\n }\\n ]\\n },\\n \\"SlsParameters\\": {\\n \\"SlsParameter\\": [\\n {\\n \\"Project\\": \\"project_test\\",\\n \\"LogStore\\": \\"logstore_test\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mo****/logstore/c***\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Id\\": \\"4\\"\\n }\\n ]\\n },\\n \\"OpenApiParameters\\": {\\n \\"OpenApiParameters\\": [\\n {\\n \\"Action\\": \\"PutLogs\\",\\n \\"Arn\\": \\"acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***\\",\\n \\"Id\\": \\"3\\",\\n \\"Product\\": \\"log\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Role\\": \\"MyRole\\",\\n \\"Version\\": \\"2019-01-01\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventRuleTargetList>\\r\\n\\t\\t<RequestId>87170bc7-e28a-4c93-b9bf-90a1dbe84736</RequestId>\\r\\n\\t\\t<ContactParameters>\\r\\n\\t\\t\\t<ContactParameter>\\r\\n\\t\\t\\t\\t<ContactGroupName>默认告警通知组</ContactGroupName>\\r\\n\\t\\t\\t\\t<Level>3</Level>\\r\\n\\t\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t</ContactParameter>\\r\\n\\t\\t</ContactParameters>\\r\\n\\t\\t<SlsParameters>\\r\\n\\t\\t\\t<SlsParameter>\\r\\n\\t\\t\\t\\t<Project>project_test</Project>\\r\\n\\t\\t\\t\\t<LogStore>logstore_test</LogStore>\\r\\n\\t\\t\\t\\t<Region>cn-hangzhou</Region>\\r\\n\\t\\t\\t\\t<Arn>acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***</Arn>\\r\\n\\t\\t\\t\\t<Id>2</Id>\\r\\n\\t\\t\\t</SlsParameter>\\r\\n\\t\\t</SlsParameters>\\r\\n\\t\\t<Code>200</Code>\\r\\n</DescribeEventRuleTargetList>","errorExample":""}]', + 'title' => '查询指定事件报警规则的推送渠道', + 'description' => '本文将提供一个示例,查询事件报警规则`testRule`的详情。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutEventRuleTargets' => [ + 'summary' => '调用PutEventRuleTargets接口添加或修改规则的推送渠道。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testEventRule', + ], + ], + [ + 'name' => 'FcParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '函数计算通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'FunctionName' => [ + 'description' => '函数名称。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'fc-test', + ], + 'Region' => [ + 'description' => '函数服务对应的地域。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'ServiceName' => [ + 'description' => '函数服务的服务名称。N的取值范围为1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'fc-test', + ], + 'Id' => [ + 'description' => '规则发送目标的唯一标识。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ContactParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警联系组通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => [ + 'description' => '报警联系人组的名称。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '默认报警联系组', + ], + 'Id' => [ + 'description' => '规则发送目标的唯一标识。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + 'Level' => [ + 'description' => '报警通知级别。N的取值范围:1~5。取值:'."\n" + ."\n" + .'<props="china">- 2:电话、短信、钉钉、邮箱</props>'."\n" + ."\n" + .'<props="china">- 3:短信、钉钉、邮箱</props>'."\n" + ."\n" + .'<props="china">- 4:钉钉、邮箱</props>'."\n" + ."\n" + .'<props="intl">4:钉钉、邮箱</props>'."\n" + ."\n" + .'<props="partner">4:钉钉、邮箱</props>', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'MnsParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '轻量消息队列(原 MNS)通知。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'description' => '轻量消息队列(原 MNS)对应的地域。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Queue' => [ + 'description' => '队列名称。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'queue1', + ], + 'Id' => [ + 'description' => '规则发送目标的唯一标识。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + 'Topic' => [ + 'description' => '轻量消息队列(原 MNS)的主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'topic_sample', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'WebhookParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'URL回调通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '协议名称。N的取值范围:1~5。取值:'."\n" + ."\n" + .'- http'."\n" + .'- telnet'."\n" + .'- ping'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http', + ], + 'Url' => [ + 'description' => '回调的URL。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + 'Method' => [ + 'description' => 'HTTP回调的请求方法。N的取值范围:1~5。'."\n" + ."\n" + .'目前仅支持GET和POST。', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + 'Id' => [ + 'description' => '规则发送目标的唯一标识。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'SlsParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '日志服务(SLS)通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'LogStore' => [ + 'description' => '日志服务对应的日志库。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'testlogstore', + ], + 'Region' => [ + 'description' => '日志服务对应的地域。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Project' => [ + 'description' => '日志服务对应的项目。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => 'testproject', + ], + 'Id' => [ + 'description' => '规则发送目标的唯一标识。N的取值范围:1~5。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'OpenApiParameters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'API回调通知参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => 'API名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'PutLogs', + ], + 'Arn' => [ + 'description' => '资源的ARN。N的取值范围:1~5。'."\n" + .'格式:`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各字段含义如下:'."\n" + .' - Service:云产品。'."\n" + .' - Region:地域ID。'."\n" + .' - Account:阿里云账号ID。'."\n" + .' - ResourceType:资源类型。'."\n" + .' - ResourceId:资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs:log:cn-hangzhou::project/cms-log-mon***/logstore/cxxxx***', + ], + 'Id' => [ + 'description' => 'API回调通知方式的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + 'Product' => [ + 'description' => 'API对应的云产品ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'log', + ], + 'Region' => [ + 'description' => '资源对应的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'Role' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MyRole', + ], + 'Version' => [ + 'description' => 'API的版本。', + 'type' => 'string', + 'required' => false, + 'example' => '2019-01-01', + ], + 'JsonParams' => [ + 'description' => '报警回调的JSON格式参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{"customField1":"value1","customField2":"$.name"}', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '409C64DA-CF14-45DF-B463-471C790DD15A', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailedParameterCount' => [ + 'description' => '错误参数数量统计。', + 'type' => 'string', + 'example' => '2', + ], + 'FailedContactParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactParameter' => [ + 'description' => '如果规则发送目标中包含创建错误的报警联系人组,则返回此参数。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'ContactGroupName' => [ + 'description' => '报警联系人组的名称。', + 'type' => 'string', + 'example' => '默认报警联系人组', + ], + 'Id' => [ + 'description' => '规则发送目标的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Level' => [ + 'description' => "\n" + .'报警通知级别。取值:'."\n" + ."\n" + .'<props="china">- 2:电话、短信、钉钉、邮箱</props>'."\n" + ."\n" + .'<props="china">- 3:短信、钉钉、邮箱</props>'."\n" + ."\n" + .'<props="china">- 4:钉钉、邮箱</props>'."\n" + ."\n" + .'<props="intl">4:钉钉、邮箱</props>'."\n" + ."\n" + .'<props="partner">4:钉钉、邮箱</props>'."\n" + ."\n", + 'type' => 'string', + 'example' => '4', + ], + ], + ], + ], + ], + ], + 'FailedMnsParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MnsParameter' => [ + 'description' => '如果规则发送目标中包含创建错误的轻量消息队列(原 MNS),则返回此参数。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Queue' => [ + 'description' => '队列的名称。', + 'type' => 'string', + 'example' => 'testQueue', + ], + 'Id' => [ + 'description' => '规则发送目标的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + 'FailedFcParameters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FcParameter' => [ + 'description' => '如果规则发送目标中包含创建错误的函数服务,则返回此参数。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '函数服务的名称。', + 'type' => 'string', + 'example' => 'serviceTest1', + ], + 'FunctionName' => [ + 'description' => '函数名称。', + 'type' => 'string', + 'example' => 'functionTest1', + ], + 'Id' => [ + 'description' => '规则发送目标的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Region' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"409C64DA-CF14-45DF-B463-471C790DD15A\\",\\n \\"Success\\": true,\\n \\"FailedParameterCount\\": \\"2\\",\\n \\"FailedContactParameters\\": {\\n \\"ContactParameter\\": [\\n {\\n \\"ContactGroupName\\": \\"默认报警联系人组\\",\\n \\"Id\\": 2,\\n \\"Level\\": \\"4\\"\\n }\\n ]\\n },\\n \\"FailedMnsParameters\\": {\\n \\"MnsParameter\\": [\\n {\\n \\"Queue\\": \\"testQueue\\",\\n \\"Id\\": 2,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n },\\n \\"FailedFcParameters\\": {\\n \\"FcParameter\\": [\\n {\\n \\"ServiceName\\": \\"serviceTest1\\",\\n \\"FunctionName\\": \\"functionTest1\\",\\n \\"Id\\": 1,\\n \\"Region\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteCustomMetric>\\n\\t\\t<RequestId>681CC49A-DD28-4D11-B86F-19D3F71E0EAE</RequestId>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</DeleteCustomMetric>","errorExample":""}]', + 'title' => '添加或修改规则的推送渠道', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutEventRule' => [ + 'summary' => '调用PutEventRule接口创建或修改事件的报警规则。', + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'myRuleName', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则所属的应用分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '7378****', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则的类型。取值:'."\n" + ."\n" + .'- SYSTEM:系统事件。'."\n" + .'- CUSTOM:自定义事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM', + 'default' => 'SYSTEM', + 'enum' => [ + 'SYSTEM', + 'CUSTOM', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则的描述。', + 'type' => 'string', + 'required' => false, + 'example' => '事件报警测试', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '事件报警规则的状态。取值:'."\n" + ."\n" + .'- ENABLED:启用。'."\n" + .'- DISABLED:禁用。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENABLED', + 'default' => 'ENABLED', + 'enum' => [ + 'ENABLED', + 'DISABLED', + ], + ], + ], + [ + 'name' => 'EventPattern', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '事件报警规则的模式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'EventTypeList' => [ + 'description' => '事件报警规则的类型。N的取值范围:1~50。取值:'."\n" + ."\n" + .'- StatusNotification:故障通知。'."\n" + ."\n" + .'- Exception:异常。'."\n" + ."\n" + .'- Maintenance:运维。'."\n" + ."\n" + .'- *:无限制。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的类型。N的取值范围:1~50。取值:'."\n" + ."\n" + .'- StatusNotification:故障通知。'."\n" + ."\n" + .'- Exception:异常。'."\n" + ."\n" + .'- Maintenance:运维。'."\n" + ."\n" + .'- *:无限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'Exception', + ], + 'required' => false, + 'example' => 'Exception', + 'maxItems' => 5, + ], + 'StatusList' => [ + 'description' => '事件报警规则的状态。N的取值范围:1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的状态。N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => 'Failed', + ], + 'required' => false, + 'example' => 'Failed', + 'maxItems' => 5, + ], + 'Product' => [ + 'description' => '云服务类型。N的取值范围:1~50。'."\n" + ."\n" + .'>关于事件报警规则支持的云服务,请参见[DescribeSystemEventMetaList](~~114972~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + 'LevelList' => [ + 'description' => '事件报警规则的等级。N的取值范围:1~50。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + ."\n" + .'- WARN:警告。'."\n" + ."\n" + .'- INFO:信息。'."\n" + ."\n" + .'- *:所有等级。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的等级。N的取值范围:1~50。取值:'."\n" + ."\n" + .'- CRITICAL:严重。'."\n" + ."\n" + .'- WARN:警告。'."\n" + ."\n" + .'- INFO:信息。'."\n" + ."\n" + .'- *:所有等级。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CRITICAL', + ], + 'required' => false, + 'example' => 'CRITICAL', + 'maxItems' => 5, + ], + 'NameList' => [ + 'description' => '事件报警规则的名称。N的取值范围:1~50。', + 'type' => 'array', + 'items' => [ + 'description' => '事件报警规则的名称。N的取值范围:1~50。', + 'type' => 'string', + 'required' => false, + 'example' => 'Agent_Status_Stopped', + ], + 'required' => false, + 'example' => 'Agent_Status_Stopped', + 'maxItems' => 20, + ], + 'CustomFilters' => [ + 'description' => '事件过滤关键字。当事件内容包含该关键字时,自动触发报警。', + 'type' => 'string', + 'required' => false, + 'example' => 'Stopping', + ], + 'SQLFilter' => [ + 'description' => 'SQL事件过滤。当事件内容满足SQL条件时,自动触发报警。'."\n" + .'> SQL事件过滤的语法与日志服务SLS的查询语法保持一致。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX and Executed', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'SilenceTime', + 'in' => 'query', + 'schema' => [ + 'description' => '通道沉默时间。单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '86400', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'Data' => [ + 'description' => '创建或修改事件报警规则时,返回影响的行数。', + 'type' => 'string', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0B47C47B-E68A-4429-BB23-370E91889C7D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"Data\\": \\"1\\",\\n \\"RequestId\\": \\"0B47C47B-E68A-4429-BB23-370E91889C7D\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutEventRuleResponse>\\n\\t\\t<RequestId>0B47C47B-E68A-4429-BB23-370E91889C7D</RequestId>\\n\\t\\t<Data>1</Data>\\n\\t\\t<Code>200</Code>\\n\\t\\t<Success>true</Success>\\n</PutEventRuleResponse>","errorExample":""}]', + 'title' => '创建或修改事件的报警规则', + 'description' => '如果报警规则名称不存在,则创建新的报警规则;如果报警规则名称存在,则修改已有报警规则。'."\n" + ."\n" + .'本文将提供一个示例,为云服务`ecs`创建一条事件报警规则`myRuleName`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutCustomEventRule' => [ + 'methods' => [ + 'post', + 'get', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。获取方法请参见[DescribeCustomEventAttribute](~~115262~~)。'."\n" + ."\n" + .'> 0表示上报的自定义事件不属于任何一个应用分组。', + 'type' => 'string', + 'required' => true, + 'example' => '7378****', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。'."\n" + ."\n" + .'> 如果报警规则ID已存在,则表示修改报警规则;如果报警规则ID不存在,则表示创建报警规则。', + 'type' => 'string', + 'required' => true, + 'example' => 'CustomRuleId1', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'CustomeRule', + ], + ], + [ + 'name' => 'EventName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义事件名称。获取方法请参见[DescribeCustomEventAttribute](~~115262~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'HostDown', + ], + ], + [ + 'name' => 'ContactGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人组。多个联系人组之间用英文逗号(,)分隔。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Group', + ], + ], + [ + 'name' => 'Webhook', + 'in' => 'query', + 'schema' => [ + 'description' => '报警发生回调时指定的URL地址,向URL发送POST请求。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.aliyun.com', + ], + ], + [ + 'name' => 'EffectiveInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则生效的时间范围。取值范围:00:00-23:59。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00-23:59', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义事件监控数据的聚合周期。单位:秒。取值为60或60的整数倍。默认值:300。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + 'default' => '300', + ], + ], + [ + 'name' => 'EmailSubject', + 'in' => 'query', + 'schema' => [ + 'description' => '报警邮件主题。', + 'type' => 'string', + 'required' => false, + 'example' => 'ECS实例', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '报警阈值。', + 'type' => 'string', + 'required' => true, + 'example' => '99', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '报警级别。取值:'."\n" + .'- CRITICAL:严重。'."\n" + .'- WARN:警告。'."\n" + .'- INFO:信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'CRITICAL', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AD5DCD82-BD1C-405F-BAED-32302DE9F498', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 204 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 206 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 499 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"AD5DCD82-BD1C-405F-BAED-32302DE9F498\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutCustomEventRuleResponse>\\n\\t<RequestId>AD5DCD82-BD1C-405F-BAED-32302DE9F498</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</PutCustomEventRuleResponse>","errorExample":""}]', + 'title' => '创建自定义事件报警规则', + 'summary' => '调用PutCustomEventRule接口创建自定义事件报警规则。', + 'description' => '调用本接口前,请先调用PutCustomEvent接口上报自定义事件的监控数据,详情请参见[PutCustomEvent](~~115012~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateMetricRuleBlackList' => [ + 'summary' => '调用CreateMetricRuleBlackList接口创建报警黑名单策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Blacklist-01', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的数据命名空间。'."\n" + ."\n" + .'关于云服务的命名空间,请参见[云服务监控项](~~163515~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的类型分类。例如:Redis有`kvstore_standard`(标准版)、`kvstore_sharding`(集群版)和`kvstore_splitrw`(读写分离版)等。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的生效范围。取值:'."\n" + ."\n" + .'- USER(默认值):报警黑名单策略仅在当前阿里云账号中生效。'."\n" + ."\n" + .'- GROUP:报警黑名单策略在指定应用分组中生效,您需要选择指定应用分组。'."\n" + .' 关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + [ + 'name' => 'ScopeValue', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID列表。格式为JSON Array。'."\n" + ."\n" + .'> 仅当`ScopeType`为`GROUP`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '["67****","78****"]', + ], + ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略生效的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1640237400000', + ], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略生效的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1640608200000', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的生效时间范围。'."\n" + ."\n" + .'- 如果您未设置该参数,则报警黑名单策略永久有效。'."\n" + ."\n" + .'- 如果您已设置该参数,则黑名单策略仅在指定的时间范围内有效。该参数有以下两种格式示例:'."\n" + .' - `03:00-04:59`:本地时间凌晨3点到凌5点(不包含05:00)报警黑名单策略有效。'."\n" + .' - `03:00-04:59 UTC+0700`:东7区时间凌晨3点到凌晨5点(不包含05:00)报警黑名单策略有效。', + 'type' => 'string', + 'required' => false, + 'example' => '03:00-04:59', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警黑名单策略中指定云服务的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警黑名单策略中指定云服务的实例列表。'."\n" + ."\n" + .'N的取值范围:1~100。', + 'type' => 'string', + 'required' => false, + 'example' => '{"instanceId":"i-bp1ew0zfkjblsuwx****"}', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例中的监控指标。'."\n" + ."\n" + .'- 如果您未设置该参数,则报警黑名单策略应用于指定云服务下的所有监控指标。'."\n" + ."\n" + .'- 如果您已设置该参数,则黑名单策略仅应用于当前监控指标。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控指标名称。'."\n" + ."\n" + .'N的取值范围:1~10。', + 'type' => 'string', + 'required' => true, + 'example' => 'disk_utilization', + ], + 'Resource' => [ + 'description' => '实例的扩展维度信息。例如:`{"device":"C:"}`,表示对云服务器ECS实例下的所有C盘应用黑名单策略。'."\n" + ."\n" + .'N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '{"device":"C:"}', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5C637FA3-3959-3352-8BE6-78CE2ED2D33D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '报警黑名单策略的ID。', + 'type' => 'string', + 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"5C637FA3-3959-3352-8BE6-78CE2ED2D33D\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"93514c96-ceb8-47d8-8ee3-93b6d98b****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMetricRuleBlackListResponse>\\n <RequestId>5C637FA3-3959-3352-8BE6-78CE2ED2D33D</RequestId>\\n <Id>93514c96-ceb8-47d8-8ee3-93b6d98b****</Id>\\n <Success>true</Success>\\n</CreateMetricRuleBlackListResponse>","errorExample":""}]', + 'title' => '创建报警黑名单策略', + 'description' => '### 背景信息'."\n" + ."\n" + .'- 报警黑名单是指云监控根据报警黑名单策略对报警通知进行屏蔽。当阈值报警规则中某个云服务的某个实例中的某个指标无需发送报警通知时,您可以为其设置报警黑名单策略,对报警通知进行屏蔽。'."\n" + ."\n" + .'- 目前云监控仅支持为阈值指标设置报警黑名单策略,不支持系统事件。关于云监控支持的云服务和阈值指标,请参见[云服务监控项](~~163515~~)。'."\n" + ."\n\n" + ."\n", + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'ModifyMetricRuleBlackList' => [ + 'summary' => '调用ModifyMetricRuleBlackList接口修改报警黑名单策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的ID。'."\n" + ."\n" + .'关于如何获取报警黑名单策略的ID,请参见[DescribeMetricRuleBlackList](~~457257~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Blacklist-02', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于云产品的命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品分类。例如:Redis有`kvstore_standard`(标准版)、`kvstore_sharding`(集群版)和`kvstore_splitrw`(读写分离版)等。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的生效范围。取值:'."\n" + ."\n" + .'- USER:报警黑名单策略仅在当前阿里云账号中生效。'."\n" + ."\n" + .'- GROUP(默认值):报警黑名单策略在指定应用分组中生效,您需要选择指定应用分组。'."\n" + .' 关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + [ + 'name' => 'ScopeValue', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID列表。'."\n" + ."\n" + .'> 仅当`ScopeType`为`GROUP`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '["67****","78****"]', + ], + ], + [ + 'name' => 'EnableStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略生效的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1640237400000', + ], + ], + [ + 'name' => 'EnableEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略生效的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'required' => false, + 'example' => '1640608200000', + ], + ], + [ + 'name' => 'EffectiveTime', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的生效时间范围。是否设置该参数的含义如下:'."\n" + ."\n" + .'- 如果您未设置该参数,则报警黑名单策略永久有效。'."\n" + ."\n" + .'- 如果您已设置该参数,则黑名单策略仅在指定的时间范围内有效。该参数有以下两种格式示例:'."\n" + .' - `03:00-04:59`:本地时间凌晨3点到凌晨5点(不包含05:00)报警黑名单策略有效。'."\n" + .' - `03:00-04:59 UTC+0700`:东7区时间凌晨3点到凌晨5点(不包含05:00)报警黑名单策略有效。', + 'type' => 'string', + 'required' => false, + 'example' => '03:00-04:59', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警黑名单策略中指定云服务的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警黑名单策略中指定云服务的实例列表。'."\n" + ."\n" + .'N的取值范围:1~100。', + 'type' => 'string', + 'required' => false, + 'example' => '{"instancceId":"i-bp1ew0zfkjblsuwx****"}', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Metrics', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '实例中的监控指标。'."\n" + ."\n" + .'- 如果您未设置该参数,则报警黑名单策略应用于指定云服务下的所有监控指标。'."\n" + ."\n" + .'- 如果您已设置该参数,则黑名单策略仅应用于当前监控指标。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控指标名称。'."\n" + ."\n" + .'N的取值范围:1~10。', + 'type' => 'string', + 'required' => true, + 'example' => 'disk_utilization', + ], + 'Resource' => [ + 'description' => '实例的扩展维度信息。例如:`{"device":"C:"}`,表示对云服务器ECS实例下的所有C盘应用黑名单策略。'."\n" + ."\n" + .'N的取值范围:1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '{"device":"C:"}', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '008773AE-1D86-3231-90F9-1AF7F808F9CE', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Count' => [ + 'description' => '成功修改报警黑名单策略的数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"008773AE-1D86-3231-90F9-1AF7F808F9CE\\",\\n \\"Success\\": true,\\n \\"Count\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyMetricRuleBlackListResponse>\\n <RequestId>008773AE-1D86-3231-90F9-1AF7F808F9CE</RequestId>\\n <Success>true</Success>\\n <Count>1</Count>\\n</ModifyMetricRuleBlackListResponse>","errorExample":""}]', + 'title' => '修改报警黑名单策略', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DeleteMetricRuleBlackList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的ID。多个ID之间以半角逗号(,)分隔,且不能超过50个。'."\n" + ."\n" + .'关于如何获取报警黑名单策略的ID,请参见[DescribeMetricRuleBlackList](~~457257~~)。'."\n" + ."\n" + .'> 该参数也支持JSON Array格式,例如:`["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`。', + 'type' => 'string', + 'required' => true, + 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B88D233C-A004-3AB8-AD9C-30CBDD4440C5', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Count' => [ + 'description' => '成功删除的报警黑名单策略的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"B88D233C-A004-3AB8-AD9C-30CBDD4440C5\\",\\n \\"Success\\": true,\\n \\"Count\\": 1\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetricRuleBlackListResponse>\\n <RequestId>B88D233C-A004-3AB8-AD9C-30CBDD4440C5</RequestId>\\n <Success>true</Success>\\n <Count>1</Count>\\n</DeleteMetricRuleBlackListResponse>","errorExample":""}]', + 'title' => '删除报警黑名单策略', + 'summary' => '调用DeleteMetricRuleBlackList接口删除报警黑名单策略。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DescribeMetricRuleBlackList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务的数据命名空间。'."\n" + ."\n" + .'关于云服务的命名空间,请参见[云服务监控项](~~163515~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数。'."\n" + ."\n" + .'默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果按时间的排序方式。取值:'."\n" + ."\n" + .'- DESC(默认值):降序。'."\n" + ."\n" + .'- ASC:升序。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务分类。例如:Redis有`kvstore_standard`(标准版)、`kvstore_sharding`(集群版)和`kvstore_splitrw`(读写分离版)等。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警黑名单策略的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警黑名单策略的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略名称。'."\n" + ."\n" + .'该参数支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'Blacklist-01', + ], + ], + [ + 'name' => 'ScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的生效范围。取值:'."\n" + ."\n" + .'- USER:报警黑名单策略仅在当前阿里云账号中生效。'."\n" + ."\n" + .'- GROUP:报警黑名单策略在指定应用分组中生效。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER', + ], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的启用状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + .'- false:禁用。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'flat', + 'schema' => [ + 'description' => '报警黑名单策略中的实例ID列表。'."\n" + ."\n" + .'N的取值范围:0~10。', + 'type' => 'array', + 'items' => [ + 'description' => '报警黑名单策略中的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze2d6j5uhg20x47****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D63E76CB-29AA-5B9F-88CE-400A6F28D428', + ], + 'Total' => [ + 'description' => '报警黑名单策略的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DescribeMetricRuleBlackList' => [ + 'description' => '报警黑名单策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警黑名单策略列表。', + 'type' => 'object', + 'properties' => [ + 'EffectiveTime' => [ + 'description' => '报警黑名单策略的生效时间范围。', + 'type' => 'string', + 'example' => '00:00-23:59', + ], + 'UpdateTime' => [ + 'description' => '修改报警黑名单策略的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1665718373000', + ], + 'CreateTime' => [ + 'description' => '创建报警黑名单策略的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1665714561000', + ], + 'ScopeType' => [ + 'description' => '报警黑名单策略的生效范围。取值:'."\n" + ."\n" + .'- USER:报警黑名单策略仅在当前阿里云账号中生效。'."\n" + ."\n" + .'- GROUP:报警黑名单策略在指定应用分组中生效。', + 'type' => 'string', + 'example' => 'USER', + ], + 'IsEnable' => [ + 'description' => '报警黑名单策略的状态。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false:禁用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Namespace' => [ + 'description' => '云服务的数据命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'Category' => [ + 'description' => '云服务分类。例如:Redis有`kvstore_standard`(标准版)、`kvstore_sharding`(集群版)和`kvstore_splitrw`(读写分离版)等。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'EnableEndTime' => [ + 'description' => '报警黑名单策略的开始时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640608200000', + ], + 'Name' => [ + 'description' => '报警黑名单策略的名称。', + 'type' => 'string', + 'example' => 'Blacklist-01', + ], + 'EnableStartTime' => [ + 'description' => '报警黑名单策略的结束时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640237400000', + ], + 'Id' => [ + 'description' => '报警黑名单策略的ID。', + 'type' => 'string', + 'example' => '93514c96-ceb8-47d8-8ee3-93b6d98b****', + ], + 'Metrics' => [ + 'description' => '实例中的监控指标。', + 'type' => 'array', + 'items' => [ + 'description' => '实例中的监控指标。', + 'type' => 'object', + 'properties' => [ + 'Resource' => [ + 'description' => '实例的扩展维度信息。例如:`{"device":"C:"}`,表示对云服务器ECS实例下的所有C盘应用黑名单策略。', + 'type' => 'string', + 'example' => '[{"device":"C:"}]', + ], + 'MetricName' => [ + 'description' => '监控指标名称。'."\n", + 'type' => 'string', + 'example' => 'disk_utilization', + ], + ], + ], + ], + 'Instances' => [ + 'description' => '报警黑名单策略中指定云服务的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警黑名单策略中指定云服务的实例列表。', + 'type' => 'string', + 'example' => 'i-rj99xc6cptkk64ml****', + ], + ], + 'ScopeValue' => [ + 'description' => '应用分组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用分组ID列表。格式为JSON Array。'."\n" + ."\n" + .'> 仅当`ScopeType`为`GROUP`时,显示该参数。', + 'type' => 'string', + 'example' => '["67****","78****"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"D63E76CB-29AA-5B9F-88CE-400A6F28D428\\",\\n \\"Total\\": 1,\\n \\"Success\\": true,\\n \\"DescribeMetricRuleBlackList\\": [\\n {\\n \\"EffectiveTime\\": \\"00:00-23:59\\",\\n \\"UpdateTime\\": \\"1665718373000\\",\\n \\"CreateTime\\": \\"1665714561000\\",\\n \\"ScopeType\\": \\"USER\\",\\n \\"IsEnable\\": true,\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"Category\\": \\"ecs\\",\\n \\"EnableEndTime\\": 1640608200000,\\n \\"Name\\": \\"Blacklist-01\\",\\n \\"EnableStartTime\\": 1640237400000,\\n \\"Id\\": \\"93514c96-ceb8-47d8-8ee3-93b6d98b****\\",\\n \\"Metrics\\": [\\n {\\n \\"Resource\\": \\"[{\\\\\\"device\\\\\\":\\\\\\"C:\\\\\\"}]\\",\\n \\"MetricName\\": \\"disk_utilization\\"\\n }\\n ],\\n \\"Instances\\": [\\n \\"i-rj99xc6cptkk64ml****\\"\\n ],\\n \\"ScopeValue\\": [\\n \\"[\\\\\\"67****\\\\\\",\\\\\\"78****\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMetricRuleBlackListResponse>\\n <RequestId>D63E76CB-29AA-5B9F-88CE-400A6F28D428</RequestId>\\n <Total>1</Total>\\n <DescribeMetricRuleBlackList>\\n <ScopeType>USER</ScopeType>\\n <Instances>\\n <instancceId>i-rj99xc6cptkk64ml****</instancceId>\\n </Instances>\\n <IsEnable>true</IsEnable>\\n <Metrics>\\n <MetricName>disk_utilization</MetricName>\\n <Resource/>\\n </Metrics>\\n <Category>ecs</Category>\\n <CreateTime>1635714561000</CreateTime>\\n <UpdateTime>1635718373000</UpdateTime>\\n <Id>93514c96-ceb8-47d8-8ee3-93b6d98b****</Id>\\n <Namespace>acs_ecs_dashboard</Namespace>\\n <Name>Blacklist-01</Name>\\n </DescribeMetricRuleBlackList>\\n <Success>true</Success>\\n</DescribeMetricRuleBlackListResponse>","errorExample":""}]', + 'title' => '查询报警黑名单策略列表', + 'summary' => '调用DescribeMetricRuleBlackList接口查询报警黑名单策略列表。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'EnableMetricRuleBlackList' => [ + 'summary' => '调用EnableMetricRuleBlackList接口启用或禁用报警黑名单策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '报警黑名单策略的ID。多个ID之间以半角逗号(,)分隔,且不能超过50个。'."\n" + ."\n" + .'关于如何获取报警黑名单策略的ID,请参见[DescribeMetricRuleBlackList](~~457257~~)。'."\n" + ."\n" + .'> 该参数也支持JSON Array格式,例如:`["a9ad2ac2-3ed9-11ed-b878-0242ac12****","5cb8a9a4-198f-4651-a353-f8b28788****"]`。', + 'type' => 'string', + 'required' => true, + 'example' => 'a9ad2ac2-3ed9-11ed-b878-0242ac12****', + ], + ], + [ + 'name' => 'IsEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '启用或禁用报警黑名单策略。取值:'."\n" + ."\n" + .'- true:启用。'."\n" + ."\n" + .'- false(默认值):禁用。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'>200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '94869866-1621-3652-BBC9-72A47B2AC2F5', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Count' => [ + 'description' => '成功启用或禁用的报警黑名单策略的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'AccessForbidden', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => 'ResourceConflict', + 'errorMessage' => 'Concurrent modification of resources.', + ], + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"94869866-1621-3652-BBC9-72A47B2AC2F5\\",\\n \\"Success\\": true,\\n \\"Count\\": 1\\n}","errorExample":""},{"type":"xml","example":"<EnableMetricRuleBlackListResponse>\\n <RequestId>94869866-1621-3652-BBC9-72A47B2AC2F5</RequestId>\\n <Success>true</Success>\\n <Count>1</Count>\\n</EnableMetricRuleBlackListResponse>","errorExample":""}]', + 'title' => '启用或禁用报警黑名单策略', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DeleteContactGroup' => [ + 'summary' => '调用DeleteContactGroup接口删除报警联系人组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组名称。', + 'type' => 'string', + 'required' => true, + 'example' => '我的报警组', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F722BE59-2400-4A64-9C1A-AD886AED9A69', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + [ + [ + 'errorCode' => 'ContactNotExists', + 'errorMessage' => 'ContactGroupName Not Exists', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F722BE59-2400-4A64-9C1A-AD886AED9A69\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactGroupResponse>\\n <RequestId>F722BE59-2400-4A64-9C1A-AD886AED9A69</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteContactGroupResponse>","errorExample":""}]', + 'title' => '删除报警联系人组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteContact' => [ + 'summary' => '调用DeleteContact接口删除报警联系人。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人姓名。', + 'type' => 'string', + 'required' => true, + 'example' => '张三', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '50D4CFE1-01E5-4543-939C-18BC01E3EC1C', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功,false表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + [ + [ + 'errorCode' => 'ContactNotExists', + 'errorMessage' => 'ContactName does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"50D4CFE1-01E5-4543-939C-18BC01E3EC1C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactResponse>\\n <RequestId>50D4CFE1-01E5-4543-939C-18BC01E3EC1C</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</DeleteContactResponse>","errorExample":""}]', + 'title' => '删除报警联系人', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeContactListByContactGroup' => [ + 'summary' => '调用DescribeContactListByContactGroup接口查询报警联系组中的报警联系人列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CloudMonitor', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The group is not exists.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '报警联系人。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '更新报警联系人的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552323252000', + ], + 'Name' => [ + 'description' => '报警联系人的姓名。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'CreateTime' => [ + 'description' => '创建报警联系人的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552314252000', + ], + 'Desc' => [ + 'description' => '报警联系组的描述。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'Channels' => [ + 'description' => '报警通道。', + 'type' => 'object', + 'properties' => [ + 'Mail' => [ + 'description' => '报警联系人的Email地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AliIM' => [ + 'description' => '报警联系人的旺旺名称。'."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'DingWebHook' => [ + 'description' => '报警联系人的钉钉机器人地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', + ], + 'SMS' => [ + 'description' => '报警联系人的手机号码。'."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => '1333333****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The group is not exists.\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Success\\": true,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"UpdateTime\\": 1552323252000,\\n \\"Name\\": \\"Alice\\",\\n \\"CreateTime\\": 1552314252000,\\n \\"Desc\\": \\"ECS\\",\\n \\"Channels\\": {\\n \\"Mail\\": \\"[email protected]\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactListByContactGroupResponse>\\r\\n\\t<RequestId>96B41DE5-6DC9-4FAF-A790-3D4AA17C1F09</RequestId>\\r\\n\\t<Contacts>\\r\\n\\t\\t<Contact>\\r\\n\\t\\t\\t<Desc></Desc>\\r\\n\\t\\t\\t<CreateTime>1604024233000</CreateTime>\\r\\n\\t\\t\\t<UpdateTime>1604024233000</UpdateTime>\\r\\n\\t\\t\\t<Channels>\\r\\n\\t\\t\\t\\t<SMS></SMS>\\r\\n\\t\\t\\t</Channels>\\r\\n\\t\\t\\t<Name>Alice</Name>\\r\\n\\t\\t</Contact>\\r\\n\\t</Contacts>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeContactListByContactGroupResponse>","errorExample":""}]', + 'title' => '查询报警联系组中的报警联系人列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeContactGroupList' => [ + 'summary' => '调用DescribeContactGroupList接口查询报警联系组列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', + 'type' => 'string', + 'example' => '916EE694-03C2-47B6-85EE-5054E3C168D3', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'string', + 'example' => '云账号报警联系人', + ], + ], + ], + ], + 'ContactGroupList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '报警联系人组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组。', + 'type' => 'object', + 'properties' => [ + 'Describe' => [ + 'description' => '报警联系组的描述信息。', + 'type' => 'string', + 'example' => 'Devops-运维组', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2025-03-04T02:12:06Z', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2023-06-07T03:52:30Z', + ], + 'EnabledWeeklyReport' => [ + 'description' => '是否启用了周报功能。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'EnableSubscribed' => [ + 'description' => '是否开启周报订阅功能。取值:'."\n" + ."\n" + .'- true:是。'."\n" + ."\n" + .'- false:否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '联系人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人。', + 'type' => 'string', + 'example' => '135xxxx8066', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'User not authorized to operate on the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"916EE694-03C2-47B6-85EE-5054E3C168D3\\",\\n \\"Total\\": 22,\\n \\"Success\\": true,\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"云账号报警联系人\\"\\n ]\\n },\\n \\"ContactGroupList\\": {\\n \\"ContactGroup\\": [\\n {\\n \\"Describe\\": \\"Devops-运维组\\",\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"EnabledWeeklyReport\\": false,\\n \\"Name\\": \\"name\\",\\n \\"EnableSubscribed\\": false,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n \\"135xxxx8066\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询报警联系组列表', + ], + 'DescribeContactList' => [ + 'summary' => '调用DescribeContactList接口查询报警联系人列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的记录条数。'."\n" + ."\n" + .'默认值:100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人姓名。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alice', + ], + ], + [ + 'name' => 'ChanelType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警类型。取值:'."\n" + ."\n" + .'<props="china">- SMS:短信。</props>'."\n" + ."\n" + .'<props="china">- AliIM:阿里旺旺。</props>'."\n" + ."\n" + .'- Mail:邮件。'."\n" + ."\n" + .'- DingWebHook:钉钉机器人。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Mail', + ], + ], + [ + 'name' => 'ChanelValue', + 'in' => 'query', + 'schema' => [ + 'description' => '报警类型的值。'."\n" + ."\n" + .'> 仅当`ChanelType`设置为`Mail`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Contacts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Contact' => [ + 'description' => '报警联系方式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '报警更新时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552356159000', + ], + 'Name' => [ + 'description' => '报警联系人姓名。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'CreateTime' => [ + 'description' => '报警创建时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1552356159000', + ], + 'Lang' => [ + 'description' => '报警的语言类型。取值:'."\n" + .'- zh-cn:简体中文。'."\n" + .'- en:英文。', + 'type' => 'string', + 'example' => 'zh-cn', + ], + 'Desc' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'ECS联系人', + ], + 'ContactGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ContactGroup' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人组列表。', + 'type' => 'string', + 'example' => '{ "ContactGroup": [ "ECS_Group", "Jim" ] }', + ], + ], + ], + ], + 'Channels' => [ + 'description' => '报警通知方式。', + 'type' => 'object', + 'properties' => [ + 'Mail' => [ + 'description' => '邮件地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AliIM' => [ + 'description' => '旺旺名称。', + 'type' => 'string', + 'example' => 'Alice', + ], + 'DingWebHook' => [ + 'description' => '钉钉机器人地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****', + ], + 'SMS' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '1333333****', + ], + ], + ], + 'ChannelsState' => [ + 'description' => '报警通道的状态。'."\n" + ."\n" + .'<props="china">因为短信、电话号码和Email需要激活以后才能使用,所以当添加或修改报警通道时,如果处于未激活状态,则为PENDING;如果处于激活状态,则为OK。</props>'."\n" + ."\n" + .'<props="intl">因为Email需要激活以后才能使用,所以当添加或修改报警通道时,如果处于未激活状态,则为PENDING;如果处于激活状态,则为OK。</props>'."\n" + ."\n" + .'<props="partner">因为Email需要激活以后才能使用,所以当添加或修改报警通道时,如果处于未激活状态,则为PENDING;如果处于激活状态,则为OK。</props>'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Mail' => [ + 'description' => 'Email的状态。取值:'."\n" + .'- PENDING:对应报警通道未激活,激活后才能使用。'."\n" + .'- OK:对应报警通道正常,可正常报警。', + 'type' => 'string', + 'example' => 'PENDING', + ], + 'AliIM' => [ + 'description' => '旺旺名称的状态正常。'."\n" + ."\n" + .'目前取值只支持:OK。OK表示旺旺名状态正常,对应的报警通道正常,可正常报警。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => 'OK', + ], + 'DingWebHook' => [ + 'description' => '钉钉机器人的状态正常。'."\n" + ."\n" + .'目前取值只支持:OK。OK表示钉钉机器人状态正常,对应的报警通道正常,可正常报警。', + 'type' => 'string', + 'example' => 'OK', + ], + 'SMS' => [ + 'description' => '短信的状态。取值:'."\n" + .'- PENDING:对应报警通道未激活,激活后才能使用。'."\n" + .'- OK:对应报警通道正常,可正常报警。'."\n" + ."\n" + .'> 该参数仅适用于中国站。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83\\",\\n \\"Total\\": 15,\\n \\"Success\\": true,\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"UpdateTime\\": 1552356159000,\\n \\"Name\\": \\"Alice\\",\\n \\"CreateTime\\": 1552356159000,\\n \\"Lang\\": \\"zh-cn\\",\\n \\"Desc\\": \\"ECS联系人\\",\\n \\"ContactGroups\\": {\\n \\"ContactGroup\\": [\\n \\"{ \\\\\\"ContactGroup\\\\\\": [ \\\\t\\\\\\"ECS_Group\\\\\\", \\\\\\"Jim\\\\\\" ] }\\"\\n ]\\n },\\n \\"Channels\\": {\\n \\"Mail\\": \\"[email protected]\\",\\n \\"AliIM\\": \\"Alice\\",\\n \\"DingWebHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****\\",\\n \\"SMS\\": \\"1333333****\\"\\n },\\n \\"ChannelsState\\": {\\n \\"Mail\\": \\"PENDING\\",\\n \\"AliIM\\": \\"OK\\",\\n \\"DingWebHook\\": \\"OK\\",\\n \\"SMS\\": \\"OK\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactListResponse>\\r\\n\\t\\t<RequestId>A1267F27-942F-40EE-9254-57FE16E3C9AB</RequestId>\\r\\n\\t\\t<Contacts>\\r\\n\\t\\t\\t<Contact>\\r\\n\\t\\t\\t\\t<Desc>Contact Desc</Desc>\\r\\n\\t\\t\\t\\t<ContactGroups>\\r\\n\\t\\t\\t\\t\\t<ContactGroup>ECS_Group</ContactGroup>\\r\\n\\t\\t\\t\\t\\t<ContactGroup>Jim</ContactGroup>\\r\\n\\t\\t\\t\\t</ContactGroups>\\r\\n\\t\\t\\t\\t<ChannelsState>\\r\\n\\t\\t\\t\\t\\t<SMS>PENDING</SMS>\\r\\n\\t\\t\\t\\t\\t<Mail>OK</Mail>\\r\\n\\t\\t\\t\\t</ChannelsState>\\r\\n\\t\\t\\t\\t<CreateTime>1583307692000</CreateTime>\\r\\n\\t\\t\\t\\t<UpdateTime>1589441072000</UpdateTime>\\r\\n\\t\\t\\t\\t<Channels>\\r\\n\\t\\t\\t\\t\\t<Mail>[email protected]</Mail>\\r\\n\\t\\t\\t\\t\\t<SMS>155*******</SMS>\\r\\n\\t\\t\\t\\t</Channels>\\r\\n\\t\\t\\t\\t<Name>Alice</Name>\\r\\n\\t\\t\\t\\t<Lang>zh-cn</Lang>\\r\\n\\t\\t\\t</Contact>\\r\\n\\t\\t</Contacts>\\r\\n\\t\\t<Total>25</Total>\\r\\n\\t\\t<Code>200</Code>\\r\\n\\t\\t<Success>true</Success>\\r\\n</DescribeContactListResponse>","errorExample":""}]', + 'title' => '查询报警联系人列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutContact' => [ + 'summary' => '调用PutContact接口创建或修改报警联系人信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人姓名。', + 'type' => 'string', + 'required' => true, + 'example' => 'Alice', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Describe', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人描述详情。', + 'type' => 'string', + 'required' => true, + 'example' => 'ECS_Instance', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Channels.SMS', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。手机号码会收到一个激活链接, 激活之后您才会被加入到联系人中。'."\n" + ."\n" + .'<props="china">手机号码、邮箱、钉钉机器人和旺旺最少添加一种联系方式。</props>'."\n" + .'<props="intl">邮箱和钉钉机器人最少添加一种联系方式。</props>'."\n" + .'<props="partner">邮箱和钉钉机器人最少添加一种联系方式。</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1333333****', + ], + ], + [ + 'name' => 'Channels.Mail', + 'in' => 'query', + 'schema' => [ + 'description' => 'Email地址。Email会收到一个激活链接, 激活之后您才会被加入到联系人中。'."\n" + ."\n" + .'<props="china">手机号码、邮箱、钉钉机器人和旺旺最少添加一种联系方式。</props>'."\n" + .'<props="intl">邮箱和钉钉机器人最少添加一种联系方式。</props>'."\n" + .'<props="partner">邮箱和钉钉机器人最少添加一种联系方式。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Channels.AliIM', + 'in' => 'query', + 'schema' => [ + 'description' => '旺旺联系人。'."\n" + ."\n" + .'<props="china">手机号码、邮箱、钉钉机器人和旺旺最少添加一种联系方式。</props>'."\n" + .'<props="intl">邮箱和钉钉机器人最少添加一种联系方式。</props>'."\n" + .'<props="partner">邮箱和钉钉机器人最少添加一种联系方式。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'Jim', + ], + ], + [ + 'name' => 'Channels.DingWebHook', + 'in' => 'query', + 'schema' => [ + 'description' => '钉钉机器人。'."\n" + ."\n" + .'<props="china">手机号码、邮箱、钉钉机器人和旺旺最少添加一种联系方式。</props>'."\n" + .'<props="intl">邮箱和钉钉机器人最少添加一种联系方式。</props>'."\n" + .'<props="partner">邮箱和钉钉机器人最少添加一种联系方式。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=7d49515e8ebf21106a80a9cc4bb3d247771305d52fb15d6201234565****', + ], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => '报警的语言类型。取值:'."\n" + .'- zh-cn:简体中文。'."\n" + .'- en:英文。'."\n" + ."\n" + .'> 如果不设置该参数,则自动按照账号归属地域自动识别。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-cn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The Request is not authorization.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '181C406E-9DE4-484C-9C61-37AE9A1A12EE', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"The Request is not authorization.\\",\\n \\"RequestId\\": \\"181C406E-9DE4-484C-9C61-37AE9A1A12EE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PutContactResponse>\\n <Code>200</Code>\\n <RequestId>181C406E-9DE4-484C-9C61-37AE9A1A12EE</RequestId>\\n <Success>true</Success>\\n</PutContactResponse>","errorExample":""}]', + 'title' => '创建或修改报警联系人信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PutContactGroup' => [ + 'summary' => '调用PutContactGroup接口创建或修改报警联系组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组名称。', + 'type' => 'string', + 'required' => true, + 'example' => '考勤系统组', + ], + ], + [ + 'name' => 'Describe', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系组描述信息', + 'type' => 'string', + 'required' => false, + 'example' => '告警测试', + ], + ], + [ + 'name' => 'EnableSubscribed', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启订阅功能。取值:'."\n" + ."\n" + .'- true:是。'."\n" + ."\n" + .'- false:否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ContactNames', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '报警联系人的名称。', + 'type' => 'array', + 'items' => [ + 'description' => '报警联系人的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'lucy', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'Illegal parameters.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B4E30DB6-F069-5D0B-A589-2A89F7D62A57', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied', + ], + ], + [ + [ + 'errorCode' => 'ContactGroup.NotExists', + 'errorMessage' => 'ContactGroup not exists', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Illegal parameters.\\",\\n \\"RequestId\\": \\"B4E30DB6-F069-5D0B-A589-2A89F7D62A57\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建或修改报警联系组', + ], + 'CreateHybridMonitorNamespace' => [ + 'summary' => '调用CreateHybridMonitorNamespace接口创建指标仓库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'格式:由小写字母、数字和短划线(-)组成。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '阿里云产品指标仓库。', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'description' => '数据存储时长。取值:'."\n" + ."\n" + .'- cms.s1.large:数据存储时长15天。'."\n" + .'- cms.s1.xlarge:数据存储时长32天。'."\n" + .'- cms.s1.2xlarge:数据存储时长63天。'."\n" + .'- cms.s1.3xlarge(默认值):数据存储时长93天。'."\n" + .'- cms.s1.6xlarge:数据存储时长185天。'."\n" + .'- cms.s1.12xlarge:数据存储时长376天。'."\n" + ."\n" + .'不同存储时长规格的价格,请参见[监控大盘](~~223532~~)中的**价格表**。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'cms.s1.large' => 'cms.s1.large', + 'cms.s1.2xlarge' => 'cms.s1.2xlarge', + 'cms.s1.xlarge' => 'cms.s1.xlarge', + 'cms.s1.6xlarge' => 'cms.s1.6xlarge', + 'cms.s1.3xlarge' => 'cms.s1.3xlarge', + ], + 'example' => 'cms.s1.3xlarge', + 'enum' => [], + ], + ], + [ + 'name' => 'NamespaceType', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的存储方案。取值:'."\n" + ."\n" + .'- aliyun_prometheus:监控数据存储在 Prometheus 服务中。'."\n" + ."\n" + .'> 关于监控数据的存储方案的更多信息,请参见[企业云监控的监控数据存储方案说明](~~2594921~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_prometheus', + ], + ], + [ + 'name' => 'NamespaceRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据存储的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Namespace.Existed', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.Existed\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridMonitorNamespace>\\r\\n\\t<RequestId>3843D23A-FB9E-5DC8-BCCC-458768B79296</RequestId>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</CreateHybridMonitorNamespace>\\t","errorExample":""}]', + 'title' => '创建指标仓库', + 'description' => '## 前提条件'."\n" + .'请确保您已开通企业云监控。具体操作,请参见[开通企业云监控](~~250773~~)。'."\n" + ."\n" + .'## 使用说明'."\n" + .'本文将提供一个示例,创建指标仓库`aliyun`,其数据存储时长为`cms.s1.3xlarge`。返回结果显示创建指标仓库成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'ModifyHybridMonitorNamespace' => [ + 'summary' => '调用ModifyHybridMonitorNamespace接口修改指标仓库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'格式:由大写字母、小写字母、数字和短划线(-)组成。'."\n" + ."\n" + .'关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '阿里云产品指标仓库。', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'query', + 'schema' => [ + 'description' => '数据存储时长。取值:'."\n" + ."\n" + .'- cms.s1.large:数据存储时长15天。'."\n" + .'- cms.s1.xlarge:数据存储时长32天。'."\n" + .'- cms.s1.2xlarge:数据存储时长63天。'."\n" + .'- cms.s1.3xlarge:数据存储时长93天。'."\n" + .'- cms.s1.6xlarge:数据存储时长185天。'."\n" + .'- cms.s1.12xlarge:数据存储时长376天。'."\n" + ."\n" + .'不同存储时长规格的价格,请参见[监控大盘](~~223532~~)中的**价格表**。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'cms.s1.12xlarge' => 'cms.s1.12xlarge', + 'cms.s1.large' => 'cms.s1.large', + 'cms.s1.2xlarge' => 'cms.s1.2xlarge', + 'cms.s1.6xlarge' => 'cms.s1.6xlarge', + 'cms.s1.3xlarge' => 'cms.s1.3xlarge', + ], + 'example' => 'cms.s1.2xlarge', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '%s', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"%s\\",\\n \\"RequestId\\": \\"E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyHybridMonitorNamespace>\\r\\n\\t<RequestId>E190AB2E-7BF9-59B7-9DDC-7CB1782C5ECD</RequestId>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ModifyHybridMonitorNamespace>\\t","errorExample":""}]', + 'title' => '修改指标仓库', + 'description' => '本文将提供一个示例,将指标仓库`aliyun`中的数据存储时长修改为`cms.s1.2xlarge`。返回结果显示修改指标仓库成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DeleteHybridMonitorNamespace' => [ + 'summary' => '调用DeleteHybridMonitorNamespace接口删除指标仓库。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Namespace.NotFound', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3843D23A-FB9E-5DC8-BCCC-458768B79296', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Namespace.NotFound\\",\\n \\"RequestId\\": \\"3843D23A-FB9E-5DC8-BCCC-458768B79296\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteHybridMonitorNamespace>\\r\\n\\t<RequestId>3843D23A-FB9E-5DC8-BCCC-458768B79296</RequestId>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DeleteHybridMonitorNamespace>\\t","errorExample":""}]', + 'title' => '删除指标仓库', + 'description' => '> 如果指标仓库中存在数据接入任务,则不允许删除。'."\n" + ."\n" + .'本文将提供一个示例,删除指标仓库`aliyun`。返回结果显示删除指标仓库成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DescribeHybridMonitorNamespaceList' => [ + 'summary' => '查询指标仓库列表,及其接入数据详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'格式:由大写字母、小写字母、数字和短划线(-)组成。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aliyun-test', + ], + ], + [ + 'name' => 'ShowTaskStatistic', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示阿里云产品的数据接入任务的配置详情和非阿里云产品的数据接入任务数量。取值:'."\n" + ."\n" + .'- true:显示。'."\n" + .'- false(默认值):不显示。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1EC450A4-3221-5148-B77E-2827576CFE48', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '调用结果。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Specified parameter PageSize is not valid.', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DescribeHybridMonitorNamespace' => [ + 'description' => '指标仓库详情。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '指标仓库描述。', + 'type' => 'string', + 'example' => 'aliyun-test', + ], + 'CreateTime' => [ + 'description' => '创建指标仓库的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1652682744000', + ], + 'Namespace' => [ + 'description' => '指标仓库名称。', + 'type' => 'string', + 'example' => 'aliyun-test', + ], + 'IsDelete' => [ + 'description' => '指标仓库是否已删除。取值:'."\n" + ."\n" + .'- 0:未删除。'."\n" + .'- 1:已删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Id' => [ + 'description' => '指标仓库ID。', + 'type' => 'string', + 'example' => '3****', + ], + 'ModifyTime' => [ + 'description' => '最后一次修改指标仓库的时间戳。', + 'type' => 'string', + 'example' => '1652682744000', + ], + 'Detail' => [ + 'description' => '数据存储时长的详情。', + 'type' => 'object', + 'properties' => [ + 'Spec' => [ + 'description' => '数据存储时长。取值:'."\n" + ."\n" + .'- cms.s1.large:数据存储时长15天。'."\n" + .'- cms.s1.xlarge:数据存储时长32天。'."\n" + .'- cms.s1.2xlarge:数据存储时长63天。'."\n" + .'- cms.s1.3xlarge:数据存储时长93天。'."\n" + .'- cms.s1.6xlarge:数据存储时长185天。'."\n" + .'- cms.s1.12xlarge:数据存储时长376天。', + 'type' => 'string', + 'example' => 'cms.s1.3xlarge', + ], + 'NamespaceRegion' => [ + 'description' => '监控数据存储的地域。'."\n" + ."\n" + .'> 当您创建指标仓库时,如果`NamespaceType`选择`m_prom_user`,则显示该参数。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SLSProject' => [ + 'description' => '监控数据所在的日志项目。'."\n" + ."\n" + .'> 当您创建指标仓库时,如果`NamespaceType`选择`m_prom_user`,则显示该参数。', + 'type' => 'string', + 'example' => 'cms-hybrid-120886317861****-cn-hangzhou-a83d', + ], + 'PrometheusInstanceId' => [ + 'description' => '监控数据所在的 Prometheus 实例。'."\n" + ."\n" + .'> 当您创建指标仓库时,如果`NamespaceType`选择`aliyun_prometheus`,则显示该参数。', + 'type' => 'string', + 'example' => 'rw-57******************7f', + ], + ], + ], + 'NotAliyunTaskNumber' => [ + 'description' => '非阿里云产品的数据接入任务数量。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'AliyunProductMetricList' => [ + 'description' => '阿里云产品的数据接入任务的配置详情。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '创建指标仓库的账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120886317861****', + ], + 'NamespaceList' => [ + 'description' => '指标仓库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'description' => '阿里云产品数据命名空间。', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'MetricList' => [ + 'description' => '阿里云产品的监控项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Period' => [ + 'description' => '监控项的采集周期。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'List' => [ + 'description' => '监控项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控项。', + 'type' => 'string', + 'example' => '["cpu_total"]', + ], + ], + ], + ], + ], + ], + ], + ], + 'YAMLConfig' => [ + 'description' => '接入企业云监控的阿里云产品的配置文件。'."\n" + ."\n" + .'- namespace:阿里云产品的命名空间。'."\n" + .'- metric_list:阿里云服务的监控项。'."\n" + .'- dimension:企业云监控支持查询的阿里云服务的资源。dimension为空,表示监控所有资源。', + 'type' => 'string', + 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'', + ], + ], + ], + ], + 'NamespaceType' => [ + 'description' => '监控数据的存储方案。取值:'."\n" + ."\n" + .'- m_prom_user:监控数据存储在日志服务中。'."\n" + ."\n" + .'- m_prom_pool:监控数据存储在云监控提供的存储空间中。'."\n" + ."\n" + .'- aliyun_prometheus:监控数据存储在 Prometheus 服务中。', + 'type' => 'string', + 'example' => 'aliyun_prometheus', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1EC450A4-3221-5148-B77E-2827576CFE48\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Specified parameter PageSize is not valid.\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"DescribeHybridMonitorNamespace\\": [\\n {\\n \\"Description\\": \\"aliyun-test\\",\\n \\"CreateTime\\": \\"1652682744000\\",\\n \\"Namespace\\": \\"aliyun-test\\",\\n \\"IsDelete\\": 0,\\n \\"Id\\": \\"3****\\",\\n \\"ModifyTime\\": \\"1652682744000\\",\\n \\"Detail\\": {\\n \\"Spec\\": \\"cms.s1.3xlarge\\",\\n \\"NamespaceRegion\\": \\"cn-hangzhou\\",\\n \\"SLSProject\\": \\"cms-hybrid-120886317861****-cn-hangzhou-a83d\\",\\n \\"PrometheusInstanceId\\": \\"rw-57******************7f\\"\\n },\\n \\"NotAliyunTaskNumber\\": 0,\\n \\"AliyunProductMetricList\\": [\\n {\\n \\"UserId\\": 0,\\n \\"NamespaceList\\": [\\n {\\n \\"Namespace\\": \\"acs_ecs_dashboard\\",\\n \\"MetricList\\": [\\n {\\n \\"Period\\": 60,\\n \\"List\\": [\\n \\"[\\\\\\"cpu_total\\\\\\"]\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"YAMLConfig\\": \\"products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total dimension: \'\'\\"\\n }\\n ],\\n \\"NamespaceType\\": \\"aliyun_prometheus\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorNamespaceListResponse>\\r\\n\\t<RequestId>1EC450A4-3221-5148-B77E-2827576CFE48</RequestId>\\r\\n\\t<PageSize>10</PageSize>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Total>1</Total>\\r\\n\\t<DescribeHybridMonitorNamespace>\\r\\n\\t\\t<ModifyTime>1652682744000</ModifyTime>\\r\\n\\t\\t<Description></Description>\\r\\n\\t\\t<CreateTime>1652682744000</CreateTime>\\r\\n\\t\\t<IsDelete>0</IsDelete>\\r\\n\\t\\t<Id>3****</Id>\\r\\n\\t\\t<Namespace>aliyun-test</Namespace>\\r\\n\\t\\t<Detail>\\r\\n\\t\\t\\t<Spec>cms.s1.3xlarge</Spec>\\r\\n\\t\\t</Detail>\\r\\n\\t</DescribeHybridMonitorNamespace>\\r\\n\\t<Code>Success</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DescribeHybridMonitorNamespaceListResponse>\\t","errorExample":""}]', + 'title' => '查询指标仓库列表', + 'description' => '本文将提供一个示例,查询当前账号下的所有指标仓库。返回结果显示,当前账号下只有一个指标仓库`aliyun-test`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'CreateHybridMonitorTask' => [ + 'summary' => '调用CreateHybridMonitorTask接口创建阿里云产品的数据接入任务或SLS日志的监控项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '阿里云产品数据接入任务。', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务名称。'."\n" + ."\n" + .'- 当`TaskType`为`aliyun_fc`时,输入阿里云产品的数据接入任务名称。'."\n" + .'- 当`TaskType`为`aliyun_sls`时,输入SLS日志的监控项名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aliyun_task', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务类型。取值:'."\n" + ."\n" + .'- aliyun_fc:阿里云产品的数据接入任务。'."\n" + .'- aliyun_sls:SLS日志的监控项。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'aliyun_fc' => 'aliyun_fc', + 'aliyun_sls' => 'aliyun_sls', + ], + 'example' => 'aliyun_fc', + ], + ], + [ + 'name' => 'CollectTargetType', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的采集目标类型。'."\n" + .'- 当`TaskType`为`aliyun_fc`时,输入`aliyun_fc`。'."\n" + .'- 当`TaskType`为`aliyun_sls`时,输入SLS日志的Logstore组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun_fc', + ], + ], + [ + 'name' => 'CollectInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的采集周期。取值:'."\n" + ."\n" + .'- 15'."\n" + .'- 60(默认值)'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'> 仅当`TaskType`为`aliyun_sls`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 15 => '15', + 60 => '60', + ], + 'example' => '60', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。'."\n" + ."\n" + .'> 仅当`TaskType`为`aliyun_sls`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '3607****', + ], + ], + [ + 'name' => 'YARMConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '接入企业云监控的阿里云产品的配置文件。'."\n" + ."\n" + .'- namespace:阿里云产品的命名空间。关于如何查询阿里云产品的命名空间,请参见[DescribeMetricMetaList](~~98846~~)。'."\n" + .'- metric_list:阿里云服务的监控项。关于如何查询阿里云产品的监控项,请参见[DescribeMetricMetaList](~~98846~~)。'."\n" + ."\n" + .'配置文件示例如下:'."\n" + ."\n" + .'```'."\n" + .'products:'."\n" + .'- namespace: acs_ecs_dashboard'."\n" + .' metric_info:'."\n" + .' - metric_list:'."\n" + .' - cpu_total'."\n" + .' - cpu_idle'."\n" + .' - diskusage_utilization'."\n" + .' - CPUUtilization'."\n" + .' - DiskReadBPS'."\n" + .' - InternetOut'."\n" + .' - IntranetOut'."\n" + .' - cpu_system'."\n" + .'- namespace: acs_rds_dashboard'."\n" + .' metric_info:'."\n" + .' - metric_list:'."\n" + .' - MySQL_QPS'."\n" + .' - MySQL_TPS'."\n" + .'```'."\n" + .'> 当`TaskType`为`aliyun_fc`时,必须设置该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', + ], + ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'当您通过管理账号调用API时,可以选择将资源目录中的任意成员的阿里云产品接入企业云监控。通过资源目录实现企业跨账号统一监控目标阿里云产品。'."\n" + ."\n" + .'> 仅当`TaskType`为`aliyun_fc`时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '120886317861****', + ], + ], + [ + 'name' => 'AttachLabels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监控项的标签。'."\n" + ."\n" + .'> 仅当`TaskType`为`aliyun_sls`时,需要设置该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '监控项的标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + 'Name' => [ + 'description' => '监控项的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'app_service', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'TargetUserIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。多个成员ID之间用半角逗号(,)分隔。'."\n" + ."\n" + .'> 仅当您通过管理账号调用本接口时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '120886317861****', + ], + ], + [ + 'name' => 'SLSProcessConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'SLS日志配置。'."\n" + ."\n" + .'> 仅当`TaskType`为`aliyun_sls`时,需要设置该参数。', + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => 'SLS日志中参数的过滤条件。', + 'type' => 'object', + 'properties' => [ + 'Relation' => [ + 'description' => '多个参数过滤条件之间的关系。取值:'."\n" + ."\n" + .'- and(默认值):满足所有过滤条件,才处理日志。'."\n" + .'- or:满足任意过滤条件,即可处理日志。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'or' => 'or', + 'and' => 'and', + ], + 'example' => 'and', + ], + 'Filters' => [ + 'description' => 'SLS日志中参数的过滤条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志中过滤的参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + 'Operator' => [ + 'description' => 'SLS日志中参数值的过滤方式。取值:'."\n" + .'- `contain`:包含。'."\n" + .'- `notContain`:不包含。'."\n" + .'- `>`:大于。'."\n" + .'- `<`:小于。'."\n" + .'- `=`:等于。'."\n" + .'- `!=`:不等于。'."\n" + .'- `>=`:大于等于。'."\n" + .'- `<=`:小于等于。', + 'type' => 'string', + 'required' => false, + 'example' => '=', + 'enum' => [ + '>', + '>=', + '=', + '<=', + '<', + '!=', + 'contain', + 'notContain', + ], + ], + 'Value' => [ + 'description' => 'SLS日志中参数的过滤值。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Statistics' => [ + 'description' => 'SLS日志的统计方式。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志统计的参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'Function' => [ + 'description' => '在计算周期内根据选定的统计方法对日志数据进行聚合处理。取值:'."\n" + .'- count:计数。'."\n" + .'- sum:求和。'."\n" + .'- avg:平均值。'."\n" + .'- max:最大值。'."\n" + .'- min:最小值。'."\n" + .'- value:周期内采样。'."\n" + .'- countps:计算统计周期内指定字段求count后的每秒平均值。'."\n" + .'- sumps:计算统计周期内指定字段求sum后的每秒平均值。'."\n" + .'- distinct:去重后计算统计周期内指定字段出现的次数。'."\n" + .'- distribution:计算字段值在一个区间内的出现次数。'."\n" + .'- percentile:计算字段值的分布值,例如:P50。', + 'type' => 'string', + 'required' => false, + 'example' => 'count', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'level_count', + 'minLength' => 0, + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + ], + 'Parameter1' => [ + 'description' => 'SLS日志的统计值。'."\n" + ."\n" + .'- 当`Function`为`distribution`时,表示统计区间的下限,例如:统计HttpCode的2XX数量,填写200。'."\n" + ."\n" + .'- 当`Function`为`percentile`时,表示统计分布的百分位,例如:0.5表示P50。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + 'Parameter2' => [ + 'description' => 'SLS日志的统计值。'."\n" + ."\n" + .'> 仅当`Function`为`distribution`时,需要设置该参数。表示统计区间的上限,例如:统计HttpCode的2XX数量,填写299。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '299', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'GroupBy' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志统计的参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'ApiResult', + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Express' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Express' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'success_count', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'SuccRate', + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CloudAccessId', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '其他云厂商接入云监控的主账号ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '其他云厂商接入云监控的主账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'n5n9ik1b****', + ], + 'required' => false, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'yamlConfigFail', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '28CEA2E0-3E90-51B2-A7E8-B1ED75534E49', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => '监控任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"yamlConfigFail\\",\\n \\"RequestId\\": \\"28CEA2E0-3E90-51B2-A7E8-B1ED75534E49\\",\\n \\"Success\\": \\"true\\",\\n \\"TaskId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridMonitorTaskResponse>\\n\\t<TaskId>36****</TaskId>\\n\\t<RequestId>28CEA2E0-3E90-51B2-A7E8-B1ED75534E49</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</CreateHybridMonitorTaskResponse>\\t","errorExample":""}]', + 'title' => '创建监控任务', + 'description' => '## 前提条件'."\n" + ."\n" + .'- 请确保您已开通企业云监控。具体操作,请参见[开通企业云监控](~~250773~~)。'."\n" + ."\n" + .'- 如果您需要创建SLS日志的监控项,请确保您已开通SLS日志服务,且已创建日志项目(Project)和日志库(Logstore)。具体操作,请参见[快速入门](~~54604~~)。'."\n" + ."\n" + .'## 使用说明'."\n" + .'本文将提供一个示例,创建阿里云产品的数据接入任务`aliyun_task`,将云服务器ECS的监控项`cpu_total`接入指标仓库`aliyun`。返回结果显示,创建数据接入任务成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'ModifyHybridMonitorTask' => [ + 'summary' => '调用ModifyHybridMonitorTask接口修改SLS日志的监控项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务ID。'."\n" + ."\n" + .'关于如何获取监控任务ID,请参见[DescribeHybridMonitorTaskList](~~428624~~)。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '36****', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务名称。'."\n" + ."\n" + .'关于如何获取监控任务ID,请参见[DescribeHybridMonitorTaskList](~~428624~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'SLS_task', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'SLS日志监控数据。', + ], + ], + [ + 'name' => 'CollectInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项的采集周期。取值:'."\n" + ."\n" + .'- 15'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'required' => false, + 'example' => '15', + ], + ], + [ + 'name' => 'AttachLabels', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '监控项的标签。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '监控项的标签值。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + 'Name' => [ + 'description' => '监控项的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'app_service', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SLSProcessConfig', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'SLS日志配置。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => 'SLS日志中参数的过滤条件。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Relation' => [ + 'description' => '多个参数过滤条件之间的关系。取值:'."\n" + ."\n" + .'- and(默认值):满足所有过滤条件,才处理日志。'."\n" + .'- or:满足任意过滤条件,即可处理日志。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'and', + ], + 'Filters' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志中过滤的参数名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + 'Operator' => [ + 'description' => 'SLS日志中参数值的过滤方式。取值:'."\n" + .'- `contain`:包含。'."\n" + .'- `notContain`:不包含。'."\n" + .'- `>`:大于。'."\n" + .'- `<`:小于。'."\n" + .'- `=`:等于。'."\n" + .'- `!=`:不等于。'."\n" + .'- `>=`:大于等于。'."\n" + .'- `<=`:小于等于。', + 'type' => 'string', + 'required' => false, + 'example' => '=', + 'enum' => [ + '>', + '>=', + '=', + '<=', + '<', + '!=', + 'contain', + 'notContain', + ], + ], + 'Value' => [ + 'description' => 'SLS日志中参数的过滤值。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Statistics' => [ + 'description' => '无。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志统计的参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'Function' => [ + 'description' => '在计算周期内根据选定的统计方法对日志数据进行聚合处理。取值:'."\n" + .'- count:计数。'."\n" + .'- sum:求和。'."\n" + .'- avg:平均值。'."\n" + .'- max:最大值。'."\n" + .'- min:最小值。'."\n" + .'- value:周期内采样。'."\n" + .'- countps:计算统计周期内指定字段求count后的每秒平均值。'."\n" + .'- sumps:计算统计周期内指定字段求sum后的每秒平均值。'."\n" + .'- distinct:去重后计算统计周期内指定字段出现的次数。'."\n" + .'- distribution:计算字段值在一个区间内的出现次数。'."\n" + .'- percentile:计算字段值的分布值,例如:P50。', + 'type' => 'string', + 'required' => false, + 'example' => 'count', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'level_count', + 'minLength' => 0, + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + ], + 'Parameter1' => [ + 'description' => 'SLS日志的统计值。'."\n" + ."\n" + .'- 当`Function`为`distribution`时,表示统计区间的下限,例如:统计HttpCode的2XX数量,填写200。'."\n" + ."\n" + .'- 当`Function`为`percentile`时,表示统计分布的百分位,例如:0.5表示P50。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + 'Parameter2' => [ + 'description' => 'SLS日志的统计值。'."\n" + ."\n" + .'> 仅当`Function`为`distribution`时,需要设置该参数。表示统计区间的上限,例如:统计HttpCode的2XX数量,填写299。', + 'type' => 'string', + 'required' => false, + 'example' => '299', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'GroupBy' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志统计的参数名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'ApiResult', + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Express' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Express' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'success_count', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果的别名。', + 'type' => 'string', + 'required' => false, + 'example' => 'SuccRate', + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]{1,39}$', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.SLSConfig', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Invalid.SLSConfig\\",\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyHybridMonitorTaskResponse>\\n <RequestId>11145B76-566A-5D80-A8A3-FAD98D310079</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyHybridMonitorTaskResponse>","errorExample":""}]', + 'title' => '修改监控任务', + 'description' => '本文将提供一个示例,将SLS日志的监控任务`36****`的采集周期修改为`15`秒。返回结果显示,修改监控项成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DeleteHybridMonitorTask' => [ + 'summary' => '调用DeleteHybridMonitorTask接口删除阿里云产品的数据接入任务或SLS日志的监控项。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务ID。'."\n" + ."\n" + .'关于如何获取监控任务ID,请参见[DescribeHybridMonitorTaskList](~~428624~~)。'."\n" + ."\n" + .'> 当您删除SLS日志的监控项(即`TaskType`为`aliyun_sls`)时,必须设置该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '36****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'格式:由大写字母、小写字母、数字和短划线(-)组成。'."\n" + ."\n" + .'> 当您删除阿里云产品的数据接入任务(即`TaskType`为`aliyun_fc`)时,必须设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'> 仅当您通过管理账号调用本接口删除成员的阿里云数据接入任务(即`TaskType`为`aliyun_fc`)时,需要设置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '120886317861****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6B8103F-7BAD-5FEB-945F-71D991AB8834', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"null\\",\\n \\"RequestId\\": \\"D6B8103F-7BAD-5FEB-945F-71D991AB8834\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteHybridMonitorTaskResponse>\\n <RequestId>D6B8103F-7BAD-5FEB-945F-71D991AB8834</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteHybridMonitorTaskResponse>","errorExample":""}]', + 'title' => '删除监控任务', + 'description' => '本文将提供一个示例,删除监控任务`36****`。返回结果显示,删除监控任务成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DescribeHybridMonitorTaskList' => [ + 'summary' => '调用DescribeHybridMonitorTaskList接口查询数据接入任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'task', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '36****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组ID。'."\n" + ."\n" + .'关于如何获取应用分组ID,请参见[DescribeMonitorGroups](~~115032~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '3607****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'IncludeAliyunTask', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果是否包含阿里云产品的数据接入任务。取值:'."\n" + ."\n" + .'- true(默认值):包含。'."\n" + .'- false:不包含。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '监控任务类型。取值:'."\n" + ."\n" + .'- aliyun_fc:阿里云产品的数据接入任务。'."\n" + .'- aliyun_sls:SLS日志的监控项。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'aliyun_sls' => 'aliyun_sls', + ], + 'example' => 'aliyun_fc', + ], + ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'> 仅当您通过管理账号调用本接口删除成员的阿里云数据接入任务(即`TaskType`为`aliyun_fc`)时,需要设置该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120886317861****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '11145B76-566A-5D80-A8A3-FAD98D310079', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。'."\n" + ."\n" + .'- 当操作成功时,返回`success`。'."\n" + .'- 当操作失败时,返回错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskList' => [ + 'description' => '监控任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'YARMConfig' => [ + 'description' => '接入企业云监控的阿里云产品的配置文件。'."\n" + ."\n" + .'- namespace:阿里云产品的命名空间。'."\n" + .'- metric_list:阿里云服务的监控项。', + 'type' => 'string', + 'example' => 'products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total', + ], + 'CreateTime' => [ + 'description' => '创建监控任务的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1639382496000', + ], + 'TaskName' => [ + 'description' => '监控任务名称。', + 'type' => 'string', + 'example' => 'aliyun_task', + ], + 'Namespace' => [ + 'description' => '主机归属的指标仓库。', + 'type' => 'string', + 'example' => 'aliyun', + ], + 'UploadRegion' => [ + 'description' => '主机归属的地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'NetworkType' => [ + 'description' => '主机的网络类型。取值:'."\n" + ."\n" + .'- `vpc`:专有网络。'."\n" + .'- `Internet`:公网。', + 'type' => 'string', + 'example' => 'vpc', + ], + 'CollectTimout' => [ + 'description' => '云监控插件采集主机监控数据的超时时间。取值:'."\n" + ."\n" + .'- 0'."\n" + .'- 15'."\n" + .'- 30'."\n" + .'- 60'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'CollectTargetEndpoint' => [ + 'description' => '云监控插件采集主机监控数据的地址。', + 'type' => 'string', + 'example' => 'http://localhost', + ], + 'TaskType' => [ + 'description' => '监控任务类型。取值:'."\n" + ."\n" + .'- aliyun_fc:阿里云产品的数据接入任务。'."\n" + .'- aliyun_sls:SLS日志的监控项。', + 'type' => 'string', + 'example' => 'aliyun_sls', + ], + 'MatchExpressRelation' => [ + 'description' => '监控任务的实例过滤条件。取值:'."\n" + ."\n" + .'- or:或。'."\n" + .'- and:和。', + 'type' => 'string', + 'example' => 'or', + ], + 'Description' => [ + 'description' => '监控任务描述。', + 'type' => 'string', + 'example' => 'aliyun', + ], + 'GroupId' => [ + 'description' => '应用分组ID。', + 'type' => 'string', + 'example' => '3607****', + ], + 'CollectInterval' => [ + 'description' => '云监控插件采集主机监控数据的间隔时间。取值:'."\n" + ."\n" + .'- 15'."\n" + .'- 30'."\n" + .'- 60'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'TargetUserId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'> 仅当您通过管理账号调用本接口时,显示该参数。', + 'type' => 'string', + 'example' => '120886317861****', + ], + 'CollectTargetPath' => [ + 'description' => '云监控Agent采集的时候,采集的相对路径。', + 'type' => 'string', + 'example' => '/metrics', + ], + 'CollectTargetType' => [ + 'description' => '采集目标类型。包括:Spring、Tomcat、Nginx、Tengine、JVM、Redis和MySQL等。', + 'type' => 'string', + 'example' => 'nginx', + ], + 'TaskId' => [ + 'description' => '监控任务ID。', + 'type' => 'string', + 'example' => '36****', + ], + 'AttachLabels' => [ + 'description' => '监控任务的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'MatchExpress' => [ + 'description' => '应用分组中实例的匹配条件。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '实例名称的值。', + 'type' => 'string', + 'example' => 'ECS_instance1', + ], + 'Name' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'Function' => [ + 'description' => '实例名称的匹配方法。取值:'."\n" + ."\n" + .'- startWith:前缀。'."\n" + .'- endWith:后缀。'."\n" + .'- all:全部。'."\n" + .'- equals:等于。'."\n" + .'- contains:包含。'."\n" + .'- notContains:不包含。', + 'type' => 'string', + 'example' => 'all', + ], + ], + ], + ], + 'Instances' => [ + 'description' => '分批采集监控数据的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-hp368focau7dp0hw****', + ], + ], + 'ExtraInfo' => [ + 'description' => '实例的附加信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'LogFilePath' => [ + 'description' => '本地日志数据保存在云监控所在主机的指定路径。'."\n" + ."\n" + .'- Windows:仅支持盘符开头,例如:`C:\\UserData\\log\\\\*.Log`(不支持通配路径)。'."\n" + .'- Linux:仅支持以“/”开头,例如:`/home/appdata/log/**/*.log`(`/**/`用于匹配appdata下的所有文件)。', + 'type' => 'string', + 'example' => 'C:\\UserData\\log\\*.Log', + ], + 'LogSplit' => [ + 'description' => '本地日志数据根据不同匹配模式的切分结果。'."\n" + ."\n" + .'> 本地日志数据的匹配模式包括:完整正则模式、分隔符模式和JSON模式。', + 'type' => 'string', + 'example' => '{"type": "regex","regex": "\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\s+(\\\\d+)\\\\s+\\\\S+\\\\s+\\\\[\\\\d+/\\\\S+/\\\\d+:\\\\d+:\\\\d+:\\\\d+\\\\s+\\\\+\\\\d+\\\\]\\\\s+(\\\\S+)\\\\s+\\\\S+\\\\s+/\\\\S+/\\\\S+/\\\\S+\\\\s+(\\\\d+)","columns": [{"name": "field1"},{"name": "filed2","translate": {"default": "-","mappings": [{"from": "(\\\\w+)","to": "$1x","type": "regex"}]}},{"name": "filed3","translate": {"default": "-","mappings": [{"from": "NumberRange(100,300)","to": "true","type": "function"}]}}]}', + ], + 'LogProcess' => [ + 'description' => '本地日志监控计算方式。', + 'type' => 'string', + 'example' => '[{"metric": "metric1","filters": [{"column": "filed2","type": "include","values": ["222222"]}],"groupBys": [{"column": "filed3","name": "filed3"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]},{"metric": "metric2","filters": [{"column": "field1","type": "include","values": ["11111"]}],"groupBys": [{"column": "filed2","name": "filed2"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]}]', + ], + 'LogSample' => [ + 'description' => '本地日志数据的示例。', + 'type' => 'string', + 'example' => '{"logContent":"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\"-\\" \\"127.0.0.1:7001\\" \\"Go-http-client/1.1\\" \\"-\\" \\"-\\" \\"0a98a21a15656865460656276e\\"","addData":{"field1":["1119","1119"],"filed2":["POSTx","POST"],"filed3":["true","200"]}}', + ], + 'SLSProcess' => [ + 'description' => 'SLS日志数据的配置信息。', + 'type' => 'string', + 'example' => '{"express": [],"filter": {"filters": [{"key": "task_type","operator": "=","value": "1"}]},"groupby": [{"alias": "isp","key": "isp","sqlKey": "t.`isp`","valueKey": "isp"}],"interval": 60,"labels": [{"name": "__cms_app__","type": 0,"value": "sitemonitor"}],"statistics": [{"alias": "http_dns_time_avg","function": "avg","key": "http_dns_time"}]}', + ], + 'SLSProcessConfig' => [ + 'description' => 'SLS日志配置。'."\n" + ."\n" + .'> 仅当`TaskType`为`aliyun_sls`时,显示该参数。', + 'type' => 'object', + 'properties' => [ + 'Filter' => [ + 'description' => 'SLS日志中参数的过滤条件。', + 'type' => 'object', + 'properties' => [ + 'Relation' => [ + 'description' => '多个参数过滤条件之间的关系。取值:'."\n" + ."\n" + .'- and(默认值):满足所有过滤条件,才处理日志。'."\n" + .'- or:满足任意过滤条件,即可处理日志。', + 'type' => 'string', + 'example' => 'and', + ], + 'Filters' => [ + 'description' => 'SLS日志中参数的过滤条件。', + 'type' => 'array', + 'items' => [ + 'description' => 'SLS日志中参数的过滤条件。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志中过滤的参数名称。', + 'type' => 'string', + 'example' => 'host', + ], + 'Operator' => [ + 'description' => 'SLS日志中参数值的过滤方式。取值:'."\n" + .'- `contain`:包含。'."\n" + .'- `notContain`:不包含。'."\n" + .'- `>`:大于。'."\n" + .'- `<`:小于。'."\n" + .'- `=`:等于。'."\n" + .'- `!=`:不等于。'."\n" + .'- `>=`:大于等于。'."\n" + .'- `<=`:小于等于。', + 'type' => 'string', + 'example' => '=', + ], + 'Value' => [ + 'description' => 'SLS日志中参数的过滤值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + 'Statistics' => [ + 'description' => 'SLS日志的统计方式。', + 'type' => 'array', + 'items' => [ + 'description' => 'SLS日志的统计方式。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志统计的参数名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'Function' => [ + 'description' => '在计算周期内根据选定的统计方法对日志数据进行聚合处理。取值:'."\n" + .'- count:计数。'."\n" + .'- sum:求和。'."\n" + .'- avg:平均值。'."\n" + .'- max:最大值。'."\n" + .'- min:最小值。'."\n" + .'- value:周期内采样。'."\n" + .'- countps:计算统计周期内指定字段求count后的每秒平均值。'."\n" + .'- sumps:计算统计周期内指定字段求sum后的每秒平均值。'."\n" + .'- distinct:去重后计算统计周期内指定字段出现的次数。'."\n" + .'- distribution:计算字段值在一个区间内的出现次数。'."\n" + .'- percentile:计算字段值的分布值,例如:P50。', + 'type' => 'string', + 'example' => 'count', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的别名。', + 'type' => 'string', + 'example' => 'level_count', + ], + 'Parameter1' => [ + 'description' => 'SLS日志的统计值。'."\n" + ."\n" + .'- 当`Function`为`distribution`时,表示统计区间的下限,例如:统计HttpCode的2XX数量,填写200。'."\n" + ."\n" + .'- 当`Function`为`percentile`时,表示统计分布的百分位,例如:0.5表示P50。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Parameter2' => [ + 'description' => 'SLS日志的统计值。'."\n" + ."\n" + .'> 仅当`Function`为`distribution`时,需要设置该参数。表示统计区间的上限,例如:统计HttpCode的2XX数量,填写299。', + 'type' => 'string', + 'example' => '299', + ], + ], + ], + ], + 'GroupBy' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。', + 'type' => 'array', + 'items' => [ + 'description' => '对数据进行空间维度聚合,相当于SQL中的Group By。', + 'type' => 'object', + 'properties' => [ + 'SLSKeyName' => [ + 'description' => 'SLS日志统计的参数名称。', + 'type' => 'string', + 'example' => 'code', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的别名。', + 'type' => 'string', + 'example' => 'ApiResult', + ], + ], + ], + ], + 'Express' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'array', + 'items' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'object', + 'properties' => [ + 'Express' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果。', + 'type' => 'string', + 'example' => 'success_count', + ], + 'Alias' => [ + 'description' => 'SLS日志统计结果的扩展字段的四则运算结果的别名。', + 'type' => 'string', + 'example' => 'SuccRate', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"11145B76-566A-5D80-A8A3-FAD98D310079\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 1,\\n \\"TaskList\\": [\\n {\\n \\"YARMConfig\\": \\"products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total\\",\\n \\"CreateTime\\": \\"1639382496000\\",\\n \\"TaskName\\": \\"aliyun_task\\",\\n \\"Namespace\\": \\"aliyun\\",\\n \\"UploadRegion\\": \\"cn-hangzhou\\",\\n \\"NetworkType\\": \\"vpc\\",\\n \\"CollectTimout\\": 15,\\n \\"CollectTargetEndpoint\\": \\"http://localhost\\",\\n \\"TaskType\\": \\"aliyun_sls\\",\\n \\"MatchExpressRelation\\": \\"or\\",\\n \\"Description\\": \\"aliyun\\",\\n \\"GroupId\\": \\"3607****\\",\\n \\"CollectInterval\\": 60,\\n \\"TargetUserId\\": \\"120886317861****\\",\\n \\"CollectTargetPath\\": \\"/metrics\\",\\n \\"CollectTargetType\\": \\"nginx\\",\\n \\"TaskId\\": \\"36****\\",\\n \\"AttachLabels\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"MatchExpress\\": [\\n {\\n \\"Value\\": \\"ECS_instance1\\",\\n \\"Name\\": \\"name\\",\\n \\"Function\\": \\"all\\"\\n }\\n ],\\n \\"Instances\\": [\\n \\"i-hp368focau7dp0hw****\\"\\n ],\\n \\"ExtraInfo\\": \\"test\\",\\n \\"LogFilePath\\": \\"C:\\\\\\\\UserData\\\\\\\\log\\\\\\\\*.Log\\",\\n \\"LogSplit\\": \\"{\\\\\\"type\\\\\\": \\\\\\"regex\\\\\\",\\\\\\"regex\\\\\\": \\\\\\"\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\d+)\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\[\\\\\\\\\\\\\\\\d+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+:\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\+\\\\\\\\\\\\\\\\d+\\\\\\\\\\\\\\\\]\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\S+)\\\\\\\\\\\\\\\\s+\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\S+/\\\\\\\\\\\\\\\\S+\\\\\\\\\\\\\\\\s+(\\\\\\\\\\\\\\\\d+)\\\\\\",\\\\\\"columns\\\\\\": [{\\\\\\"name\\\\\\": \\\\\\"field1\\\\\\"},{\\\\\\"name\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"translate\\\\\\": {\\\\\\"default\\\\\\": \\\\\\"-\\\\\\",\\\\\\"mappings\\\\\\": [{\\\\\\"from\\\\\\": \\\\\\"(\\\\\\\\\\\\\\\\w+)\\\\\\",\\\\\\"to\\\\\\": \\\\\\"$1x\\\\\\",\\\\\\"type\\\\\\": \\\\\\"regex\\\\\\"}]}},{\\\\\\"name\\\\\\": \\\\\\"filed3\\\\\\",\\\\\\"translate\\\\\\": {\\\\\\"default\\\\\\": \\\\\\"-\\\\\\",\\\\\\"mappings\\\\\\": [{\\\\\\"from\\\\\\": \\\\\\"NumberRange(100,300)\\\\\\",\\\\\\"to\\\\\\": \\\\\\"true\\\\\\",\\\\\\"type\\\\\\": \\\\\\"function\\\\\\"}]}}]}\\",\\n \\"LogProcess\\": \\"[{\\\\\\"metric\\\\\\": \\\\\\"metric1\\\\\\",\\\\\\"filters\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"type\\\\\\": \\\\\\"include\\\\\\",\\\\\\"values\\\\\\": [\\\\\\"222222\\\\\\"]}],\\\\\\"groupBys\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed3\\\\\\",\\\\\\"name\\\\\\": \\\\\\"filed3\\\\\\"}],\\\\\\"calculates\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"name\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"type\\\\\\": \\\\\\"avg\\\\\\"}]},{\\\\\\"metric\\\\\\": \\\\\\"metric2\\\\\\",\\\\\\"filters\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"type\\\\\\": \\\\\\"include\\\\\\",\\\\\\"values\\\\\\": [\\\\\\"11111\\\\\\"]}],\\\\\\"groupBys\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"filed2\\\\\\",\\\\\\"name\\\\\\": \\\\\\"filed2\\\\\\"}],\\\\\\"calculates\\\\\\": [{\\\\\\"column\\\\\\": \\\\\\"field1\\\\\\",\\\\\\"name\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"type\\\\\\": \\\\\\"avg\\\\\\"}]}]\\",\\n \\"LogSample\\": \\"{\\\\\\"logContent\\\\\\":\\\\\\"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"127.0.0.1:7001\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"Go-http-client/1.1\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"-\\\\\\\\\\\\\\" \\\\\\\\\\\\\\"0a98a21a15656865460656276e\\\\\\\\\\\\\\"\\\\\\",\\\\\\"addData\\\\\\":{\\\\\\"field1\\\\\\":[\\\\\\"1119\\\\\\",\\\\\\"1119\\\\\\"],\\\\\\"filed2\\\\\\":[\\\\\\"POSTx\\\\\\",\\\\\\"POST\\\\\\"],\\\\\\"filed3\\\\\\":[\\\\\\"true\\\\\\",\\\\\\"200\\\\\\"]}}\\",\\n \\"SLSProcess\\": \\"{\\\\\\"express\\\\\\": [],\\\\\\"filter\\\\\\": {\\\\\\"filters\\\\\\": [{\\\\\\"key\\\\\\": \\\\\\"task_type\\\\\\",\\\\\\"operator\\\\\\": \\\\\\"=\\\\\\",\\\\\\"value\\\\\\": \\\\\\"1\\\\\\"}]},\\\\\\"groupby\\\\\\": [{\\\\\\"alias\\\\\\": \\\\\\"isp\\\\\\",\\\\\\"key\\\\\\": \\\\\\"isp\\\\\\",\\\\\\"sqlKey\\\\\\": \\\\\\"t.`isp`\\\\\\",\\\\\\"valueKey\\\\\\": \\\\\\"isp\\\\\\"}],\\\\\\"interval\\\\\\": 60,\\\\\\"labels\\\\\\": [{\\\\\\"name\\\\\\": \\\\\\"__cms_app__\\\\\\",\\\\\\"type\\\\\\": 0,\\\\\\"value\\\\\\": \\\\\\"sitemonitor\\\\\\"}],\\\\\\"statistics\\\\\\": [{\\\\\\"alias\\\\\\": \\\\\\"http_dns_time_avg\\\\\\",\\\\\\"function\\\\\\": \\\\\\"avg\\\\\\",\\\\\\"key\\\\\\": \\\\\\"http_dns_time\\\\\\"}]}\\",\\n \\"SLSProcessConfig\\": {\\n \\"Filter\\": {\\n \\"Relation\\": \\"and\\",\\n \\"Filters\\": [\\n {\\n \\"SLSKeyName\\": \\"host\\",\\n \\"Operator\\": \\"=\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n },\\n \\"Statistics\\": [\\n {\\n \\"SLSKeyName\\": \\"name\\",\\n \\"Function\\": \\"count\\",\\n \\"Alias\\": \\"level_count\\",\\n \\"Parameter1\\": \\"200\\",\\n \\"Parameter2\\": \\"299\\"\\n }\\n ],\\n \\"GroupBy\\": [\\n {\\n \\"SLSKeyName\\": \\"code\\",\\n \\"Alias\\": \\"ApiResult\\"\\n }\\n ],\\n \\"Express\\": [\\n {\\n \\"Express\\": \\"success_count\\",\\n \\"Alias\\": \\"SuccRate\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorTaskListResponse>\\n\\t<RequestId>11145B76-566A-5D80-A8A3-FAD98D310079</RequestId>\\n\\t<PageSize>10</PageSize>\\n\\t<PageNumber>1</PageNumber>\\n\\t<Total>1</Total>\\n\\t<TaskList>\\n\\t\\t<CollectTimout>15</CollectTimout>\\n\\t\\t<CollectInterval>0</CollectInterval>\\n\\t\\t<Description></Description>\\n\\t\\t<TaskId>36****</TaskId>\\n\\t\\t<CreateTime>1639382496000</CreateTime>\\n\\t\\t<YARMConfig></YARMConfig>\\n\\t\\t<CollectTargetPath></CollectTargetPath>\\n\\t\\t<Namespace>aliyun</Namespace>\\n\\t\\t<GroupId>0</GroupId>\\n\\t\\t<MatchExpressRelation></MatchExpressRelation>\\n\\t\\t<SLSProcess>{\\\\\\"express\\\\\\":[],\\\\\\"filter\\\\\\":{\\\\\\"filters\\\\\\":[]},\\\\\\"groupby\\\\\\":[],\\\\\\"interval\\\\\\":60,\\\\\\"labels\\\\\\":[],\\\\\\"statistics\\\\\\":[{\\\\\\"alias\\\\\\":\\\\\\"referer_count\\\\\\",\\\\\\"function\\\\\\":\\\\\\"count\\\\\\",\\\\\\"key\\\\\\":\\\\\\"referer\\\\\\"}]}</SLSProcess>\\n\\t\\t<CollectTargetEndpoint></CollectTargetEndpoint>\\n\\t\\t<TaskName>aliyun_task</TaskName>\\n\\t\\t<UploadRegion>unknown</UploadRegion>\\n\\t\\t<NetworkType>vpc</NetworkType>\\n\\t\\t<TaskType>aliyun_sls</TaskType>\\n\\t\\t<CollectTargetType></CollectTargetType>\\n\\t\\t<TargetUserId></TargetUserId>\\n\\t</TaskList>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeHybridMonitorTaskListResponse>\\t","errorExample":""}]', + 'title' => '查询数据接入任务列表', + 'description' => '本文将提供一个示例,查询当前账号下的所有数据接入任务。返回结果显示,当前账号下只有一个数据接入任务`aliyun_task`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'PutHybridMonitorMetricData' => [ + 'summary' => '调用PutHybridMonitorMetricData接口将指定监控数据上报至企业云监控的指定指标仓库中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'default-aliyun', + ], + ], + [ + 'name' => 'MetricList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '上报的监控数据', + 'description' => '监控数据列表。'."\n" + ."\n" + .'N的取值范围:1~100。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '指标名,只能是英文字母、数字、下划线', + 'description' => '监控指标名称。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'格式:由大写字母、小写字母、数字和下划线(_)组成。开头必须为大写字母或小写字母。', + 'type' => 'string', + 'required' => true, + 'example' => 'CPU_Usage', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[a-zA-Z_][a-zA-Z0-9_]*$', + ], + 'Labels' => [ + 'title' => '标签,Key只能是英文字母、数字、下划线', + 'description' => '监控指标的标签列表。'."\n" + ."\n" + .'N的取值范围:1~100。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '只能是英文字母、数字、下划线', + 'description' => '监控指标的标签键。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'格式:由大写字母、小写字母、数字和下划线(_)组成。开头必须为大写字母、小写字母或下划线。'."\n" + ."\n" + .'> Key和Value必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'IP', + ], + 'Value' => [ + 'description' => '监控指标的标签值。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'> Key和Value必须同时设置。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'app、ip、hostName等标识信息', + 'maxItems' => 20, + ], + 'Value' => [ + 'title' => '监控值,浮点或整型', + 'description' => '监控指标的取值。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'格式:整数或浮点数。', + 'type' => 'string', + 'required' => true, + 'example' => '90', + 'pattern' => '^[0-9\\.]*$', + ], + 'TS' => [ + 'title' => '时间戳,unix毫秒数,如果不传会使用服务器时间', + 'description' => '监控数据上报的时间戳。'."\n" + ."\n" + .'N的取值范围:1~100。'."\n" + ."\n" + .'单位:毫秒。默认值为当前时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1640776119473', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '返回code', + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'title' => '请求的requestId', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5DB1CBCA-D14A-55FA-814F-B4DBD9735F68', + ], + 'ErrorDetail' => [ + 'title' => '不合法的指标信息', + 'description' => '错误参数的详情。'."\n" + ."\n" + .'如果您设置的请求参数不符合要求,则会显示错误参数的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'title' => '错误数据在上报列表中的序号,从0开始', + 'description' => '错误信息在数组中的位置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ErrorMessage' => [ + 'title' => '错误信息', + 'description' => '错误参数的提示信息。', + 'type' => 'string', + 'example' => 'label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"5DB1CBCA-D14A-55FA-814F-B4DBD9735F68\\",\\n \\"ErrorDetail\\": [\\n {\\n \\"Index\\": 0,\\n \\"ErrorMessage\\": \\"label name :123 not match [a-zA-Z_][a-zA-Z0-9_]*\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<PutHybridMonitorMetricDataResponse>\\r\\n\\t<RequestId>5DB1CBCA-D14A-55FA-814F-B4DBD9735F68</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n</PutHybridMonitorMetricDataResponse>\\t","errorExample":""}]', + 'title' => '上报监控数据至指标仓库', + 'description' => '## 前提条件'."\n" + .'请确保您已开通企业云监控。具体操作,请参见[开通企业云监控](~~250773~~)。'."\n" + ."\n" + .'## 使用限制'."\n" + .'单次上报监控数据小于等于1 MB。'."\n" + ."\n" + .'## 使用说明'."\n" + .'本文将提供一个示例,将监控指标`CPU_Usage`的监控数据上报至企业云监控的指标仓库`default-aliyun`中。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。'."\n" + ."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeHybridMonitorDataList' => [ + 'summary' => '调用DescribeHybridMonitorDataList接口查询指定指标仓库中的监控数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '指标仓库名称。'."\n" + ."\n" + .'关于如何获取指标仓库名称,请参见[DescribeHybridMonitorNamespaceList](~~428880~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'default-aliyun', + ], + ], + [ + 'name' => 'PromSQL', + 'in' => 'query', + 'schema' => [ + 'description' => '监控指标。'."\n" + ."\n" + .'> 支持PromQL查询语句。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'AliyunEcs_cpu_total', + ], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => false, + 'example' => '1653804865', + ], + ], + [ + 'name' => 'End', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间戳。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => false, + 'example' => '1653805225', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'end timestamp must not be before start time.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C240412F-3F5F-50E2-ACEC-DE808EF9C4BE', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'TimeSeries' => [ + 'description' => '监控指标的时间线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'MetricName' => [ + 'description' => '监控指标名称。', + 'type' => 'string', + 'example' => 'AliyunEcs_cpu_total', + ], + 'Labels' => [ + 'description' => '时间维度的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'K' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'V' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'i-rj99xc6cptkk64ml****', + ], + ], + ], + ], + 'Values' => [ + 'description' => '时间点的值。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'V' => [ + 'description' => '监控指标的值。', + 'type' => 'string', + 'example' => '0.13', + ], + 'Ts' => [ + 'description' => '监控指标值对应的时间戳。'."\n" + ."\n" + .'单位:秒。', + 'type' => 'string', + 'example' => '1653804865', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'BadRequest', + 'errorMessage' => 'Bad request.', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => 'Resources already exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"end timestamp must not be before start time.\\",\\n \\"RequestId\\": \\"C240412F-3F5F-50E2-ACEC-DE808EF9C4BE\\",\\n \\"Success\\": \\"true\\",\\n \\"TimeSeries\\": [\\n {\\n \\"MetricName\\": \\"AliyunEcs_cpu_total\\",\\n \\"Labels\\": [\\n {\\n \\"K\\": \\"instanceId\\",\\n \\"V\\": \\"i-rj99xc6cptkk64ml****\\"\\n }\\n ],\\n \\"Values\\": [\\n {\\n \\"V\\": \\"0.13\\",\\n \\"Ts\\": \\"1653804865\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorDataList>\\n\\t<TimeSeries>\\n\\t\\t<MetricName>AliyunEcs_cpu_total</MetricName>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653804865</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653804925</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653804985</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.17</V>\\n\\t\\t\\t<Ts>1653805045</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.23</V>\\n\\t\\t\\t<Ts>1653805105</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.2</V>\\n\\t\\t\\t<Ts>1653805165</Ts>\\n\\t\\t</Values>\\n\\t\\t<Values>\\n\\t\\t\\t<V>0.13</V>\\n\\t\\t\\t<Ts>1653805225</Ts>\\n\\t\\t</Values>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>rg-acfmw3ty5y7****</V>\\n\\t\\t\\t<K>rmgroup_id</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>ESS</V>\\n\\t\\t\\t<K>tag_ess</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>hostname1</V>\\n\\t\\t\\t<K>hostname</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>i-rj99xc6cptkk64ml****</V>\\n\\t\\t\\t<K>instanceId</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>cn-hangzhou</V>\\n\\t\\t\\t<K>regionId</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>192.168.XX.XX</V>\\n\\t\\t\\t<K>ipgroup</K>\\n\\t\\t</Labels>\\n\\t\\t<Labels>\\n\\t\\t\\t<V>120886317861****</V>\\n\\t\\t\\t<K>userId</K>\\n\\t\\t</Labels>\\n\\t</TimeSeries>\\n\\t<RequestId>C240412F-3F5F-50E2-ACEC-DE808EF9C4BE</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DescribeHybridMonitorDataList>\\t","errorExample":""}]', + 'title' => '查询指定指标仓库中的监控数据', + 'description' => '## 前提条件'."\n" + .'请确保您已开通企业云监控。具体操作,请参见[开通企业云监控](~~250773~~)。'."\n" + ."\n" + .'## 使用限制'."\n" + .'单次最多返回监控数据1.5 MB。如果返回数据过大,则查询失败,请您重新设置查询条件。'."\n" + ."\n" + .'## 使用说明'."\n" + .'本文将提供一个示例,查询指标仓库`default-aliyun`中监控指标`AliyunEcs_cpu_total`在指定时间`1653804865`(2022-05-29 14:14:25)至`1653805225`(2022-05-29 14:20:25)内的监控数据。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'CreateHybridMonitorSLSGroup' => [ + 'summary' => '创建企业云监控sls分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SLSGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore组名称。'."\n" + ."\n" + .'长度为2~32个字符,由大写字母、小写字母、数字和下划线(_)组成。开头必须为大写字母或小写字母。', + 'type' => 'string', + 'required' => true, + 'example' => 'Logstore_test', + ], + ], + [ + 'name' => 'SLSGroupDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore组描述。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云产品归属的Logstore组。', + ], + ], + [ + 'name' => 'SLSGroupConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Logstore组的配置信息。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => [ + 'description' => '地域。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'SLSProject' => [ + 'description' => '日志项目。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun-project', + ], + 'SLSLogstore' => [ + 'description' => '日志库。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'string', + 'required' => true, + 'example' => 'Logstore-ECS', + ], + 'SLSUserId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'N的取值范围:1~25。'."\n" + ."\n" + .'当您通过管理账号调用API时,可以选择将资源目录中的任意成员的阿里云产品接入企业云监控。通过资源目录实现企业跨账号统一监控目标阿里云产品。'."\n" + ."\n" + .'> 如果目标成员初次使用云监控,则需要确保该成员已授权云监控服务关联角色(AliyunServiceRoleForCloudMonitor)。更多信息,请参见[云监控服务关联角色](~~170423~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '120886317861****', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 30, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Duplicate.SLSGroup', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterInvalid', + 'errorMessage' => 'The parameter is missing or invalid. %s', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidAuthorization', + 'errorMessage' => 'Permission denied.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Duplicate.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridMonitorSLSGroupResponse>\\n <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateHybridMonitorSLSGroupResponse>","errorExample":""}]', + 'title' => '为SLS日志的监控项创建Logstore组', + 'description' => '### 前提条件'."\n" + .'请确保您已开通SLS日志服务,且已创建日志项目(Project)和日志库(Logstore)。具体操作,请参见[快速入门](~~54604~~)。'."\n" + ."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,创建一个Logstore组`Logstore_test`,其中地域为`cn-hangzhou`、日志项目为`aliyun-project`,日志库为`Logstore-ECS`。返回结果显示,创建Logstore组成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'ModifyHybridMonitorSLSGroup' => [ + 'summary' => '调用ModifyHybridMonitorSLSGroup接口修改Logstore组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SLSGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore组名称。'."\n" + ."\n" + .'关于如何获取Logstore组名称,请参见[DescribeHybridMonitorSLSGroup](~~429526~~)。'."\n" + ."\n\n" + ."\n\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Logstore_test', + ], + ], + [ + 'name' => 'SLSGroupDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore组描述。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云产品归属的Logstore组。', + ], + ], + [ + 'name' => 'SLSGroupConfig', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Logstore组的配置信息。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => [ + 'description' => '地域。'."\n" + ."\n" + .'N的取值范围:1~25。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'SLSProject' => [ + 'description' => '日志项目。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun-project', + ], + 'SLSLogstore' => [ + 'description' => '日志库。'."\n" + ."\n" + .'N的取值范围:1~25。', + 'type' => 'string', + 'required' => true, + 'example' => 'Logstore-aliyun-all', + ], + 'SLSUserId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'N的取值范围:1~25。'."\n" + ."\n" + .'当您通过管理账号调用API时,可以选择将资源目录中的任意成员的阿里云产品接入企业云监控。通过资源目录实现企业跨账号统一监控目标阿里云产品。'."\n" + ."\n" + .'> 如果目标成员初次使用云监控,则需要确保该成员已授权云监控服务关联角色(AliyunServiceRoleForCloudMonitor)。更多信息,请参见[云监控服务关联角色](~~170423~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '120886317861****', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 30, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'NotFound.SLSGroup', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyHybridMonitorSLSGroupResponse>\\n <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ModifyHybridMonitorSLSGroupResponse>","errorExample":""}]', + 'title' => '修改Logstore组', + 'description' => '本文将提供一个示例,将Logstore组`Logstore_test`中地域`cn-hangzhou`下的日志项目`aliyun-project`中的日志库修改为`Logstore-aliyun-all`。返回结果显示,修改Logstore组成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DeleteHybridMonitorSLSGroup' => [ + 'summary' => '调用DeleteHybridMonitorSLSGroup接口删除Logstore组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SLSGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore组名称。'."\n" + ."\n" + .'关于如何获取Logstore组名称,请参见[DescribeHybridMonitorSLSGroup](~~429526~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'Logstore_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'RESOURCE_NOT_FOUND', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '85198BFF-1DE6-556E-B6A4-C77C51C62B8D', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"RESOURCE_NOT_FOUND\\",\\n \\"RequestId\\": \\"85198BFF-1DE6-556E-B6A4-C77C51C62B8D\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteHybridMonitorSLSGroupResponse>\\n <RequestId>85198BFF-1DE6-556E-B6A4-C77C51C62B8D</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteHybridMonitorSLSGroupResponse>","errorExample":""}]', + 'title' => '删除Logstore组', + 'description' => '本文将提供一个示例,删除Logstore组`Logstore_test`。返回结果显示,删除Logstore组成功。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DescribeHybridMonitorSLSGroup' => [ + 'summary' => '调用DescribeHybridMonitorSLSGroup接口查询Logstore组列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'Logstore', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页时每页显示的数据行数。'."\n" + ."\n" + .'起始值:1。默认值:10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'起始值:1。默认值:1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SLSGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Logstore组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Logstore_test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'NotFound.SLSGroup', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '66683237-7126-50F8-BBF8-D67ACC919A17', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + .'- false:失败。', + 'type' => 'string', + 'example' => '无。', + ], + 'List' => [ + 'description' => 'Logstore组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSGroupName' => [ + 'description' => 'Logstore组名称。', + 'type' => 'string', + 'format' => 'int64', + 'example' => 'Logstore_test', + ], + 'SLSGroupDescription' => [ + 'description' => 'Logstore组描述。', + 'type' => 'string', + 'example' => '阿里云产品归属的Logstore组。', + ], + 'SLSGroupConfig' => [ + 'description' => 'Logstore组的配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'SLSRegion' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'SLSProject' => [ + 'description' => '日志项目。', + 'type' => 'string', + 'example' => 'aliyun-project', + ], + 'SLSLogstore' => [ + 'description' => '日志库。', + 'type' => 'string', + 'example' => 'Logstore-aliyun-all', + ], + 'SLSUserId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'> 当您通过管理账号调用API时,显示该参数。'."\n", + 'type' => 'string', + 'example' => '120886317861****', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建Logstore组的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1652845630000', + ], + 'UpdateTime' => [ + 'description' => '修改Logstore组的时间戳。'."\n" + ."\n" + .'单位:毫秒。', + 'type' => 'string', + 'example' => '1652845630000', + ], + ], + ], + ], + 'PageSize' => [ + 'description' => '分页时每页显示的数据行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页面。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 409 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 412 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"NotFound.SLSGroup\\",\\n \\"RequestId\\": \\"66683237-7126-50F8-BBF8-D67ACC919A17\\",\\n \\"Success\\": \\"无。\\",\\n \\"List\\": [\\n {\\n \\"SLSGroupName\\": 0,\\n \\"SLSGroupDescription\\": \\"阿里云产品归属的Logstore组。\\",\\n \\"SLSGroupConfig\\": [\\n {\\n \\"SLSRegion\\": \\"cn-hangzhou\\",\\n \\"SLSProject\\": \\"aliyun-project\\",\\n \\"SLSLogstore\\": \\"Logstore-aliyun-all\\",\\n \\"SLSUserId\\": \\"120886317861****\\"\\n }\\n ],\\n \\"CreateTime\\": \\"1652845630000\\",\\n \\"UpdateTime\\": \\"1652845630000\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 2\\n}","errorExample":""},{"type":"xml","example":"<DescribeHybridMonitorSLSGroupResponse>\\n <RequestId>66683237-7126-50F8-BBF8-D67ACC919A17</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>2</Total>\\n <List>\\n <CreateTime>1652845630000</CreateTime>\\n <SLSGroupName>Logstore_test</SLSGroupName>\\n <UpdateTime>1652845630000</UpdateTime>\\n <SLSGroupDescription/>\\n <SLSGroupConfig>\\n <SLSProject>aliyun-project</SLSProject>\\n <SLSRegion>cn-hangzhou</SLSRegion>\\n <SLSLogstore>Logstore-aliyun-all</SLSLogstore>\\n </SLSGroupConfig>\\n </List>\\n <List>\\n <CreateTime>1649230049000</CreateTime>\\n <SLSGroupName>Logstore_aliyun</SLSGroupName>\\n <UpdateTime>1649230049000</UpdateTime>\\n <SLSGroupDescription/>\\n <SLSGroupConfig>\\n <SLSProject>aliyun-test</SLSProject>\\n <SLSRegion>cn-qingdao</SLSRegion>\\n <SLSLogstore>oss_log</SLSLogstore>\\n </SLSGroupConfig>\\n </List>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeHybridMonitorSLSGroupResponse>","errorExample":""}]', + 'title' => '查询Logstore组列表', + 'description' => '本文将提供一个示例,查询当前账号下的所有Logstore组。返回结果显示,当前账号下有两个Logstore组,分别是`Logstore_test`和`Logstore_aliyun`。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'Cursor' => [ + 'summary' => '调用Cursor接口定义导出监控数据的范围,并返回用于初始调用BatchExport接口的Cursor值。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于如何获取云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于如何获取云产品的监控项名称,请参见[云产品监控项](~~163515~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控项的时间间隔。'."\n" + ."\n" + .'单位:秒。'."\n" + ."\n" + .'> 监控项的时间间隔通常为60秒。特殊取值,请参见[云产品监控项](~~163515~~)中的参数`Period`。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始时间戳。'."\n" + ."\n" + .'支持Format格式(YYYY-MM-DDThh:mm:ssZ),例如:2023-01-01T00:00:00Z,表示GMT时间2023年01月01日零时零分零秒。'."\n" + ."\n" + .'> 云监控不同时间粒度的监控数据TTL不同,请具体参考`Period`输入参数对应的数据TTL,设置合理的时间间隔。', + 'type' => 'string', + 'required' => true, + 'example' => '1641627000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '结束时间戳。'."\n" + ."\n" + .'单位:毫秒。'."\n" + ."\n" + .'> - Unix时间戳:从1970年01月01日开始所经过的毫秒数。支持Format格式(YYYY-MM-DDThh:mm:ssZ),例如:2023-01-01T00:00:00Z,表示GMT时间2023年01月01日零时零分零秒。'."\n" + .'- 不设置结束时间,表示结束时间无限大,使用实时导出的场景,可不设置该参数。'."\n" + .'- 云监控不同时间粒度的监控数据TTL不同,具体请参见`Period`输入参数对应的数据TTL,设置合理的时间间隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1641645000000', + ], + ], + [ + 'name' => 'Matchers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '监控项的维度信息。', + 'type' => 'array', + 'items' => [ + 'description' => '监控项的维度信息。', + 'required' => false, + '$ref' => '#/components/schemas/Matcher', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CursorPopResponse', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Cursor' => [ + 'description' => 'Cursor在[BatchExport](~~2329847~~)接口中作为输入参数进行数据导出。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '915C2D7A-E6A4-17C3-8E13-4DBDD61E7919', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Cursor\\": \\"v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy0***********\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"915C2D7A-E6A4-17C3-8E13-4DBDD61E7919\\"\\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' => '定义导出监控数据的范围', + 'description' => '### 前提条件'."\n" + .'请确保您已开通企业云监控。具体操作,请参见[开通企业云监控](~~250773~~)。'."\n" + ."\n" + .'### 背景信息'."\n" + .'先调用本接口获取初始的Cursor,再调用[BatchExport](~~2329847~~)接口导出监控数据。'."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,定义云产品`acs_ecs_dashboard`的监控项`cpu_idle`在时间段`1641627000000`(2022-01-08 15:30:00)至`1641645000000`(2022-01-08 20:30:00)内每60秒的数据导出范围。返回结果显示`Cursor`信息。', + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'BatchExport' => [ + 'summary' => '调用BatchExport接口导出在Cursor接口中定义的监控数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'formData', + 'schema' => [ + 'description' => '云产品的数据命名空间。'."\n" + ."\n" + .'关于如何获取云产品的数据命名空间,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 本参数必须与Cursor接口中的请求参数`Namespace`相同。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs_ecs_dashboard', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'formData', + 'schema' => [ + 'description' => '云产品的监控项名称。'."\n" + ."\n" + .'关于如何获取云产品的监控项名称,请参见[云产品监控项](~~163515~~)。'."\n" + ."\n" + .'> 本参数必须与Cursor接口中的请求参数`Metric`相同。', + 'type' => 'string', + 'required' => true, + 'example' => 'cpu_idle', + ], + ], + [ + 'name' => 'Cursor', + 'in' => 'formData', + 'schema' => [ + 'description' => '循环调用本接口导出数据时,必须输入`Cursor`的值。`Cursor`值的获取方法如下:'."\n" + ."\n" + .'- 当您初次调用本接口时,必须先调用Cursor接口,获取`Cursor`的值。更多信息,请参见[Cursor](~~2330730~~)。'."\n" + ."\n" + .'- 当您再次调用本接口时,可以从上次调用本接口的返回数据中获取`Cursor`的值。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****', + ], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + 'schema' => [ + 'description' => '每次最多返回的数据条数。'."\n" + ."\n" + .'取值范围:1~10000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'Measurements', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '用于定制返回数据的测量值。默认返回全部测量值。'."\n" + ."\n" + .'例如:云产品`acs_ecs_dashboard`的监控指标`cpu_idle`下有三个测量值的列,分别是`Average`、`Maximum`或`Minimum`,如果只需要返回`Average`和`Maximum`两列,则该参数设置为`["Average", "Maximum"]`数组即可。'."\n" + ."\n" + .'关于如何获取云产品的监控指标的测量值,请参见[云产品监控项](~~163515~~)的`statistics`列。', + 'type' => 'array', + 'items' => [ + 'description' => '测量值列名。', + 'type' => 'string', + 'required' => false, + 'example' => 'Maximum', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '无。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:'."\n" + ."\n" + .'- true:成功。'."\n" + ."\n" + .'- false:失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '251402CD-305C-1617-808E-D8C11FC8138D', + ], + 'Cursor' => [ + 'description' => '用于再次调用本接口。'."\n" + ."\n" + .'> 如果返回结果为`null`,则说明监控数据导出完成。', + 'type' => 'string', + 'example' => 'v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***', + ], + 'Length' => [ + 'description' => '本次调用数据返回的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'Anchor' => [ + 'description' => '后端请求数据的时间戳。时间戳越大,表示导出数据越靠近当前时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1678781819000', + ], + 'HasNext' => [ + 'description' => '数据是否已完成导出。取值:'."\n" + ."\n" + .'- true:部分数据未完成导出。'."\n" + .'- false:数据已完成导出。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DataResults' => [ + 'description' => '当前调用的返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '导出数据。具体如下:'."\n" + .'- Namespace:云产品的数据命名空间,例如:`acs_ecs_dashboard`。'."\n" + .'- Metric:云产品的监控项名称,例如:`cpu_idle`。'."\n" + .'- Timestamp:监控数据的时间戳(单位:毫秒),例如:1641454680000。'."\n" + .'- Period:监控数据的统计周期(单位:秒),例如:60。'."\n" + .'- Dimensions:用于标识监控对象(实例)的Dimension信息,例如:`[{"Label":"userId", "Value":""20654616023382****"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4****"}]`。'."\n" + .'- Associated:监控对象(实例)的附加信息,例如:标签信息之类,key:value键值对形式的集合,例如:`{"group":"test****", "name":"Alice"}`。'."\n" + .'- Measurements:指标的测量值(默认多值模式),例如:`{"Average":60,"Maximum":85}`。'."\n" + .'- LogTime:监控数据的记录时间(单位:毫秒),对于非原始数据(聚合后的数据),`LogTime`为空(NULL)。', + '$ref' => '#/components/schemas/MetricStat', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 403 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + 503 => [ + [ + 'errorCode' => '%s', + 'errorMessage' => '%s', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"RequestId\\": \\"251402CD-305C-1617-808E-D8C11FC8138D\\",\\n \\"Cursor\\": \\"v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***\\",\\n \\"Length\\": 1000,\\n \\"Anchor\\": 1678781819000,\\n \\"HasNext\\": true,\\n \\"DataResults\\": [\\n {\\n \\"Namespace\\": \\"\\",\\n \\"Metric\\": \\"\\",\\n \\"Period\\": 0,\\n \\"Timestamp\\": 0,\\n \\"Dimensions\\": [\\n {\\n \\"Label\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"Associated\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"Measurements\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"LogTime\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<BatchExportResponse>\\n <DataResults>\\n <Associated/>\\n <LogTime/>\\n <Dimensions>\\n <Value>1270676***********</Value>\\n <Label>userId</Label>\\n </Dimensions>\\n <Dimensions>\\n <Value>r-rj9f9s*********</Value>\\n <Label>instanceId</Label>\\n </Dimensions>\\n <Dimensions>\\n <Value>r-rj9f9s19lsu*******</Value>\\n <Label>nodeId</Label>\\n </Dimensions>\\n <Namespace>acs_kvstore</Namespace>\\n <Timestamp>1678781700000</Timestamp>\\n <Metric>SplitrwProxyMaxResponseSize</Metric>\\n <Period>60</Period>\\n <Measurements>\\n <Average>0.583</Average>\\n <Maximum>0.583</Maximum>\\n </Measurements>\\n </DataResults>\\n <RequestId>733A3B5A-F082-1092-B429-1208168FC07F</RequestId>\\n <Code>200</Code>\\n <Length>10</Length>\\n <Message>success</Message>\\n <Cursor>v2.5eyJiYXRjaGVzIjoxLCJidWNrZXRCeXRlcyI6IndBPT0iLCJidWNrZXRzIjo0LCJjdXJyZW50QnVja2V0IjotNjQsImN1cnJlbnRUYXJnZXRUaW1lU2xvdCI6MTY3ODc1MjAwMCwiZW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0RW5kVGltZSI6MTY3ODc4MjQxOTAwMCwiZXhwb3J0U3RhcnRUaW1lIjoxNjc4NzgxODE5MDAwLCJleHByZXNzUmFuZ2UiOmZhbHNlLCJoYXNOZXh0Ijp0cnVlLCJpbmRleCI6MCwibGF0ZXN0TG9nVGltZSI6MCwibWF0Y2hlcnMiOnsiY2hhaW4iOlt7ImxhYmVsIjoidXNlcklkIiwib3BlcmF0b3IiOiJFUVVBTFMiLCJ2YWx1ZSI6IjEyNzA2NzY2Nzk1NDY3MDQifV0sImxvY2tlZCI6dHJ1ZX0sIm1ldHJpYyI6IlNwbGl0cndQcm94eU1heFJlc3BvbnNlU2l6ZSIsIm1ldHJpY1R5cGUiOiJNRVRSSUMiLCJuYW1lc3BhY2UiOiJhY3Nfa3ZzdG9yZV9leCIsIm5leHRQa0FkYXB0ZXIiOnsiZGltIjoiVjowXG5EOmB1c2VySWRgPTEyNzA2NzY2Nzk1NDY3MDQsYGluc3RhbmNlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLGBub2RlSWRgPXItcmo5ZjlzMTlsc3V1MXd1bnVyLXByb3h5LTIsXG4iLCJtZXRhIjoiXG5WOjBcbk06YWNzX2t2c3RvcmVfZXgvU3BsaXRyd1Byb3h5TWF4UmVzcG9uc2VTaXplXG5XOjYwXG5COjRcbkk6LTFcblQ6MFxuQzpgQXZlcmFnZWAsYE1heGltdW1gLGBfX2NvdW50X19gLGBfX3RzX19gXG4iLCJyZCI6InN1YkFMU0RwWXY2K0t6aENQQUFBWkErNUFKMEpjbGErRGd2V0hFNWxDSHMvbGtqR2FXYTFJTkVwdFE9PSIsInRhZyI6IiJ9LCJvZmZzZXQiOjAsIm9mZnNldERpZ2l0Ijo0NTU0NTczNDQyMTc4NDIxMjIsInN0YXJ0VGltZSI6MTY3ODc4MTgxOTAwMCwic3RlcCI6LTEsInRhZ01hdGNoZXJzIjp7ImNoYWluIjpbXSwibG9ja2VkIjp0cnVlfSwidGFyZ2V0VGltZVNsb3RzIjpbMTY3ODY2NTYwMCwxNjc4NzUyMDAwXSwidXVpZCI6ImQwMmFhZmY1LWU3ZGQtNDUyYy04ZGMwLTZlY2QxZGVhZGY***************</Cursor>\\n <Success>true</Success>\\n <HasNext>true</HasNext>\\n <Anchor>1678781819000</Anchor>\\n</BatchExportResponse>","errorExample":""}]', + 'title' => '导出在Cursor中定义的监控数据', + 'description' => '### 前提条件'."\n" + .'请确保您已调用[Cursor](~~2330730~~)接口获取初始的`Cursor`。'."\n" + .'### 使用说明'."\n" + .'本文将提供一个示例,导出云产品`acs_ecs_dashboard`的监控项`cpu_idle`的某个初始`Cursor`的监控数据,且每次最多返回1000条数据。'."\n", + 'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~199331~~)。', + ], + 'DescribeSyntheticProbeList' => [ + 'summary' => '调用DescribeSyntheticProbeList接口查询拨测节点列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Isp', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商探测点的名称或ID。', + 'type' => 'string', + 'required' => false, + 'example' => '联通', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => '运营商探测点所在城市的名称或ID。', + 'type' => 'string', + 'required' => false, + 'example' => '北京市', + ], + ], + [ + 'name' => 'Ipv4', + 'in' => 'query', + 'schema' => [ + 'description' => '只展示ipv4节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Ipv6', + 'in' => 'query', + 'schema' => [ + 'description' => '只展示ipv6节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ViewAll', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回所有探测点。取值:'."\n" + ."\n" + .'- false(默认值):返回用户可使用的探测点。'."\n" + .'- true:返回所有探测点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MbProbe', + 'in' => 'query', + 'schema' => [ + 'description' => '只查询移动端探测点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LmProbe', + 'in' => 'query', + 'schema' => [ + 'description' => '只查询Lastmile网民家宽节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'IdcProbe', + 'in' => 'query', + 'schema' => [ + 'description' => '只查询IDC机房探测点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => 'Id of the request', + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'IspCityList' => [ + 'description' => '探测点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '探测点列表。', + 'type' => 'object', + 'properties' => [ + 'AreaCn' => [ + 'description' => '大区中文。', + 'type' => 'string', + 'example' => '华北', + ], + 'AreaEn' => [ + 'description' => '大区英文。', + 'type' => 'string', + 'example' => 'Huabei', + ], + 'City' => [ + 'description' => '城市ID。', + 'type' => 'string', + 'example' => '738', + ], + 'CityCn' => [ + 'description' => '城市中文。', + 'type' => 'string', + 'example' => '北京', + ], + 'CityEn' => [ + 'description' => '城市英文。', + 'type' => 'string', + 'example' => 'Beijing', + ], + 'Country' => [ + 'description' => '国家代码。', + 'type' => 'string', + 'example' => '629', + ], + 'CountryCn' => [ + 'description' => '国家中文。', + 'type' => 'string', + 'example' => '中国', + ], + 'CountryEn' => [ + 'description' => '国家(或地区)英文', + 'type' => 'string', + 'example' => 'China', + ], + 'IpPool' => [ + 'description' => '节点ip列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ip。', + 'type' => 'string', + 'example' => '1.1.1.1', + ], + ], + 'Isp' => [ + 'description' => '运营商ID。', + 'type' => 'string', + 'example' => '232', + ], + 'IspCn' => [ + 'description' => '运营商中文。', + 'type' => 'string', + 'example' => '联通', + ], + 'IspEn' => [ + 'description' => '运营商英文。', + 'type' => 'string', + 'example' => 'China-Unicom', + ], + 'LmProbeCount' => [ + 'description' => 'lastmile探测点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MbProbeCount' => [ + 'description' => '移动端探测点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Region' => [ + 'description' => '省份代码。', + 'type' => 'string', + 'example' => '264', + ], + 'RegionCn' => [ + 'description' => '省份中文。', + 'type' => 'string', + 'example' => '江西省', + ], + 'RegionEn' => [ + 'description' => '省份英文。', + 'type' => 'string', + 'example' => 'Jiangxi', + ], + 'IdcV4ProbeCount' => [ + 'description' => 'idc ipv4节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IdcV6ProbeCount' => [ + 'description' => 'idc ipv6节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified resource is not found.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '87170bc7-e28a-4c93-b9bf-90a1dbe84736', + ], + 'Success' => [ + 'description' => '操作是否成功。取值:true:成功。false:失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + [ + [ + 'errorCode' => 'AccessDeniedException', + 'errorMessage' => 'You donot have sufficient access to perform this action.', + ], + ], + [ + [ + 'errorCode' => 'LimitExceeded', + 'errorMessage' => 'The quota for this customer had been reached.', + ], + ], + [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + 406 => [ + [ + 'errorCode' => 'ExceedingQuota', + 'errorMessage' => 'Exceeding quota limits.', + ], + ], + 429 => [ + [ + 'errorCode' => 'ThrottlingException', + 'errorMessage' => 'The request was denied due to request throttling.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"IspCityList\\": [\\n {\\n \\"AreaCn\\": \\"华北\\",\\n \\"AreaEn\\": \\"Huabei\\",\\n \\"City\\": \\"738\\",\\n \\"CityCn\\": \\"北京\\",\\n \\"CityEn\\": \\"Beijing\\",\\n \\"Country\\": \\"629\\",\\n \\"CountryCn\\": \\"中国\\",\\n \\"CountryEn\\": \\"China\\",\\n \\"IpPool\\": [\\n \\"1.1.1.1\\"\\n ],\\n \\"Isp\\": \\"232\\",\\n \\"IspCn\\": \\"联通\\",\\n \\"IspEn\\": \\"China-Unicom\\",\\n \\"LmProbeCount\\": 1,\\n \\"MbProbeCount\\": 1,\\n \\"Region\\": \\"264\\",\\n \\"RegionCn\\": \\"江西省\\",\\n \\"RegionEn\\": \\"Jiangxi\\",\\n \\"IdcV4ProbeCount\\": 1,\\n \\"IdcV6ProbeCount\\": 1\\n }\\n ],\\n \\"Message\\": \\"The specified resource is not found.\\",\\n \\"RequestId\\": \\"87170bc7-e28a-4c93-b9bf-90a1dbe84736\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询拨测探测节点列表', + 'description' => '本文将提供一个示例,查询运营商“联通”在“北京市”的探测点详情。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/cms/2024-03-30/api-docs.php b/data/zh_cn/cms/2024-03-30/api-docs.php new file mode 100644 index 0000000..fff67ea --- /dev/null +++ b/data/zh_cn/cms/2024-03-30/api-docs.php @@ -0,0 +1,23327 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'Cms', + 'version' => '2024-03-30', + ], + 'directories' => [ + [ + 'id' => 372127, + 'title' => '工作空间', + 'type' => 'directory', + 'children' => [ + 'PutWorkspace', + 'GetWorkspace', + 'ListWorkspaces', + 'DeleteWorkspace', + 'CreateCloudResource', + 'GetCloudResource', + 'GetCloudResourceData', + 'DeleteCloudResource', + 'CreateEntityStore', + 'GetEntityStore', + 'GetEntityStoreData', + 'DeleteEntityStore', + 'CreateUmodel', + 'GetUmodel', + 'UpdateUmodel', + 'DeleteUmodel', + 'GetUmodelData', + 'UpsertUmodelData', + 'DeleteUmodelData', + 'GetUmodelCommonSchemaRef', + 'DeleteUmodelCommonSchemaRef', + 'UpsertUmodelCommonSchemaRef', + ], + ], + [ + 'id' => 372150, + 'title' => '数字员工', + 'type' => 'directory', + 'children' => [ + 'CreateChat', + 'CreateDigitalEmployee', + 'GetDigitalEmployee', + 'UpdateDigitalEmployee', + 'ListDigitalEmployees', + 'DeleteDigitalEmployee', + 'CreateThread', + 'GetThread', + 'GetThreadData', + 'ListThreads', + 'UpdateThread', + 'DeleteThread', + ], + ], + [ + 'id' => 372163, + 'title' => '数据接入', + 'type' => 'directory', + 'children' => [ + 'UpdateIntegrationPolicy', + 'DeleteIntegrationPolicy', + 'CreateIntegrationPolicy', + 'UpdateAddonRelease', + 'ListIntegrationPolicyStorageRequirements', + 'ListIntegrationPolicyPodMonitors', + 'ListIntegrationPolicyDashboards', + 'ListIntegrationPolicyCustomScrapeJobRules', + 'ListIntegrationPolicies', + 'ListAddonReleases', + 'GetIntegrationPolicy', + 'GetAddonRelease', + 'DeleteAddonRelease', + 'CreateAddonRelease', + ], + ], + [ + 'id' => 372178, + 'title' => '应用监控/用户体验监控', + 'type' => 'directory', + 'children' => [ + 'GetServiceObservability', + 'DeleteService', + 'UpdateService', + 'GetService', + 'CreateService', + 'ListServices', + 'ListServices', + ], + ], + [ + 'id' => 372185, + 'title' => 'Prometheus', + 'type' => 'directory', + 'children' => [ + 'CreatePrometheusVirtualInstance', + 'ListPrometheusVirtualInstances', + 'GetAggTaskGroup', + 'CreateAggTaskGroup', + 'DeleteAggTaskGroup', + 'UpdateAggTaskGroupStatus', + 'UpdateAggTaskGroup', + 'ListAggTaskGroups', + 'DeletePrometheusInstance', + 'DeletePrometheusView', + 'GetPrometheusInstance', + 'GetPrometheusView', + 'ListPrometheusDashboards', + 'UpdatePrometheusView', + 'UpdatePrometheusInstance', + 'ListPrometheusViews', + 'ListPrometheusInstances', + 'CreatePrometheusInstance', + 'CreatePrometheusView', + ], + ], + [ + 'id' => 372210, + 'title' => '告警', + 'type' => 'directory', + 'children' => [ + 'ListAlertActions', + 'UpdateSubscription', + 'CreateAlertWebhook', + 'DeleteAlertWebhooks', + 'ListAlertWebhooks', + 'UpdateAlertWebhook', + 'UpdateNotifyStrategy', + ], + ], + [ + 'id' => 372218, + 'title' => '控制台内嵌', + 'type' => 'directory', + 'children' => [ + 'CreateTicket', + ], + ], + [ + 'id' => 372220, + 'title' => '标签资源组', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 372225, + 'title' => '地域', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + ], + ], + [ + 'id' => 372227, + 'title' => '服务开通', + 'type' => 'directory', + 'children' => [ + 'GetCmsService', + ], + ], + [ + 'id' => 372229, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'CreateBizTrace', + 'CreateServiceObservability', + 'DeleteBizTrace', + 'GetAddon', + 'GetAddonCodeTemplate', + 'GetAddonSchema', + 'GetBizTrace', + 'GetIntegrationVersionForCS', + 'GetPrometheusUserSetting', + 'ListAddons', + 'ListBizTraces', + 'ListIntegrationPolicyAddons', + 'ListIntegrationPolicyCollectors', + 'ListIntegrationPolicyServiceMonitors', + 'UpdateBizTrace', + 'UpdatePrometheusUserSetting', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AddonMeta' => [ + 'description' => '接入组件信息', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '组件名称', + 'type' => 'string', + 'example' => 'cloud-acs-ecs', + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'language' => [ + 'description' => '语言,取值:'."\n" + ."\n" + .'- zh:中文(默认值)'."\n" + .'- en:英文', + 'type' => 'string', + 'example' => 'zh', + ], + 'description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'The out-of-the-box and comprehensive ECS observe dashboards and alarm rules. Based on AliYun CloudMonitor agentless metrics, exporter agent metrics, host audit logs, host events and other data.', + ], + 'scene' => [ + 'description' => '场景', + 'type' => 'string', + 'example' => 'feature', + ], + 'alias' => [ + 'description' => '组件别名,显示名称', + 'type' => 'string', + 'example' => 'ECS 监控', + ], + 'icon' => [ + 'description' => '组件图标。', + 'type' => 'string', + 'example' => 'assets/logos/ecs.svg', + ], + 'keywords' => [ + 'description' => '关键词列表', + 'type' => 'array', + 'items' => [ + 'description' => '关键词', + 'type' => 'string', + 'example' => 'Monitor', + ], + ], + 'once' => [ + 'description' => 'Policy 下是否只能安装一次', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'environments' => [ + 'description' => '支持的环境类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '接入环境类型描述', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '环境类型名称', + 'type' => 'string', + 'example' => 'CS/ECS/Cloud/Client', + ], + 'enable' => [ + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'label' => [ + 'description' => '环境类型显示名称', + 'type' => 'string', + 'example' => '容器环境', + ], + 'description' => [ + 'description' => '环境类型的描述', + 'type' => 'string', + 'example' => '支持容器集群的工作覆盖监控', + ], + 'policies' => [ + 'description' => '组件的控制策略组合信息', + 'type' => 'object', + 'properties' => [ + 'defaultInstall' => [ + 'description' => '是否默认安装', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'targetAddonName' => [ + 'description' => '跳转的目标组件名称', + 'type' => 'string', + 'example' => 'cloud-acs-ecs', + ], + 'alertDefaultStatus' => [ + 'description' => '告警规则默认安装后是否启用', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'protocols' => [ + 'description' => '支持的客户端协议信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '协议信息', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '协议名称', + 'type' => 'string', + 'example' => 'Prometheus', + ], + 'label' => [ + 'description' => '协议显示名称', + 'type' => 'string', + 'example' => 'Prometheus 协议', + ], + 'description' => [ + 'description' => '协议描述', + 'type' => 'string', + 'example' => '使用 Prometheus 协议写入指标数据', + ], + 'icon' => [ + 'description' => '协议显示icon', + 'type' => 'string', + 'example' => 'assets/logos/ecs.svg'."\n", + ], + ], + ], + ], + 'metricCheckRule' => [ + 'description' => '组件接入后的数据检查规则', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => '检测规则 PromQL', + 'type' => 'array', + 'items' => [ + 'description' => '检测规则 PromQL', + 'type' => 'string', + 'example' => 'up{job="acs-ecs"}==1', + ], + ], + ], + ], + 'needRestartAfterIntegration' => [ + 'description' => '是否需要在接入后提示重启工作负载', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'enableServiceAccount' => [ + 'description' => '是否启用内部授权Token分配', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'bindEntity' => [ + 'description' => '绑定的目标实体信息', + 'type' => 'object', + 'properties' => [ + 'entityGroupMode' => [ + 'description' => '是否是组模式', + 'type' => 'boolean', + 'example' => 'true/false', + ], + 'singleEntityMode' => [ + 'description' => '是否是单实体模式', + 'type' => 'boolean', + 'example' => 'true/false'."\n", + ], + 'entityType' => [ + 'description' => '实体类型', + 'type' => 'string', + 'example' => 'acs.ecs.instance', + ], + 'vpcIdFieldKey' => [ + 'description' => '实体中提取VPC ID 信息的字段', + 'type' => 'string', + 'example' => 'vpcId', + ], + ], + ], + 'bindDefaultPolicy' => [ + 'description' => '默认模式,即无需绑定实体的接入模式。', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + ], + 'dependencies' => [ + 'description' => '依赖描述信息', + 'type' => 'object', + 'properties' => [ + 'features' => [ + 'description' => '探针依赖描述,组件名称。新版已由 collectors 字段替换', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '是否依赖', + 'type' => 'boolean', + 'example' => 'true/false', + ], + ], + 'services' => [ + 'description' => '依赖的服务列表', + 'type' => 'array', + 'items' => [ + 'description' => '服务代号名称,由前端完成服务检测', + 'type' => 'string', + 'example' => 'cmee', + ], + ], + 'clusterTypes' => [ + 'description' => '支持的集群类型', + 'type' => 'array', + 'items' => [ + 'description' => '集群类型名称', + 'type' => 'string', + 'example' => 'ManagedKubernetes/Default', + ], + ], + ], + ], + 'policyType' => [ + 'description' => '策略类型', + 'type' => 'string', + 'example' => 'ECS', + ], + 'commonSchemaRefs' => [ + 'description' => '绑定的CommonSchema 列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'description' => 'CommonSchema 的分组名称', + 'type' => 'string', + 'example' => 'acs-ecs', + ], + 'version' => [ + 'description' => 'CommonSchema 的分组版本', + 'type' => 'string', + 'example' => '0.1.0', + ], + ], + ], + ], + ], + ], + ], + 'categories' => [ + 'description' => '组件分类信息', + 'type' => 'array', + 'items' => [ + 'description' => '分类名称', + 'type' => 'string', + 'example' => 'infrastructure', + ], + ], + 'dashboards' => [ + 'description' => '组件示意图列表', + 'type' => 'array', + 'items' => [ + 'description' => '示意图列表', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '示意图名称', + 'type' => 'string', + 'example' => 'ECS 监控概览大盘', + ], + 'url' => [ + 'description' => '示意图 URL', + 'type' => 'string', + 'example' => 'assets/dashboards/ecs.png'."\n", + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => '描述信息', + ], + ], + ], + ], + 'weight' => [ + 'description' => '组件排序权重', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'latestReleaseCreateTime' => [ + 'description' => '该组件上一次接入时间', + 'type' => 'string', + 'example' => '2025-10-25 09:12:12', + ], + ], + ], + 'AlertEventIntegrationPolicyForModify' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体', + 'type' => 'object', + 'properties' => [ + 'transformerSetting' => [ + 'description' => '转换设置', + 'type' => 'array', + 'items' => [ + 'description' => '单个转换配置', + '$ref' => '#/components/schemas/TransformAction', + ], + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'filterSetting' => [ + 'description' => '过滤设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'integrationSetting' => [ + 'title' => '订阅设置', + 'description' => '订阅设置', + 'type' => 'string', + 'example' => '{"region":"cn-hangzhou"}', + ], + 'type' => [ + 'title' => '类型', + 'description' => '类型', + 'type' => 'string', + 'example' => 'ALERT_CUSTOM', + ], + 'alertEventIntegrationPolicyName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test integration', + ], + ], + ], + 'AlertEventIntegrationPolicyForView' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => 'workspace', + 'description' => 'workspace', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'filterSetting' => [ + 'description' => '过滤配置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-12-16T02:00:23Z', + ], + 'type' => [ + 'title' => '类型', + 'description' => '类型', + 'type' => 'string', + 'example' => 'ALERT_CUSTOM', + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '123123', + ], + 'alertEventIntegrationPolicyId' => [ + 'title' => 'UUID', + 'description' => 'UUID', + 'type' => 'string', + 'example' => '123123123', + ], + 'token' => [ + 'description' => '集成的上报入口key', + 'type' => 'string', + 'example' => '10-16818f1445e10a1d012922b285bfb334', + ], + 'transformerSetting' => [ + 'description' => '转换设置', + 'type' => 'array', + 'items' => [ + 'description' => '单个转换配置', + '$ref' => '#/components/schemas/TransformAction', + ], + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'integrationSetting' => [ + 'title' => '订阅设置', + 'description' => '订阅设置', + 'type' => 'string', + 'example' => '{"region":"cn-hangzhou"}', + ], + 'alertEventIntegrationPolicyName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '集成名', + ], + ], + ], + 'AlertRuleAction' => [ + 'description' => '告警规则的行动集成配置', + 'type' => 'object', + 'properties' => [ + 'actions' => [ + 'description' => '行动集成ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成ID', + 'type' => 'string', + 'example' => 'myTestAction', + ], + ], + ], + ], + 'AlertRuleAlertMetricFilterDef' => [ + 'description' => '告警规则告警指标过滤器定义对象', + 'type' => 'object', + 'properties' => [ + 'opt' => [ + 'description' => '过滤条件操作符', + 'type' => 'string', + 'example' => '=', + ], + 'hidden' => [ + 'title' => '是否隐藏。 如果隐藏则在前端交互中不显示,但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件,一般不会通过配置化的方式进行显示,而是前端显为独立的应用搜索列表。', + 'description' => '是否隐藏。 如果隐藏则在前端交互中不显示,但在渲染promQL时可将该过滤条件的值上传上来。 典型的例子是APM场景中的pid这个过滤条件,一般不会通过配置化的方式进行显示,而是前端显为独立的应用搜索列表。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'displayNameCn' => [ + 'description' => '显示名称中文', + 'type' => 'string', + 'example' => '应用状态', + ], + 'dim' => [ + 'description' => 'APM指标中为维度', + 'type' => 'string', + 'example' => 'status', + ], + 'displayNameEn' => [ + 'description' => '显示名称英文', + 'type' => 'string', + 'example' => 'Application Status', + ], + 'labelDisabled' => [ + 'title' => '为true时,过滤项不出现在promQL的label filter中', + 'description' => '为true时,过滤项不出现在promQL的label filter中', + 'type' => 'boolean', + 'example' => 'true', + ], + 'dimDisabled' => [ + 'title' => '为true是,过滤项不出现在promQL的group by中', + 'description' => '为true是,过滤项不出现在promQL的group by中', + 'type' => 'boolean', + 'example' => 'true', + ], + 'supportedOpts' => [ + 'description' => '支持的选项的列表', + 'type' => 'array', + 'items' => [ + 'description' => '支持的选项', + 'type' => 'object', + 'properties' => [ + 'displayNameCn' => [ + 'description' => '显示名称中文', + 'type' => 'string', + 'example' => '在线', + ], + 'displayNameEn' => [ + 'description' => '显示名称英文', + 'type' => 'string', + 'example' => 'Online', + ], + 'value' => [ + 'description' => '匹配值', + 'type' => 'string', + 'example' => 'online', + ], + ], + ], + ], + ], + ], + 'AlertRuleAlertMetricFilterDef_array' => [ + 'description' => '告警规则告警指标过滤器定义对象数组', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则告警指标过滤器定义对象', + '$ref' => '#/components/schemas/AlertRuleAlertMetricFilterDef', + ], + ], + 'AlertRuleAlertMetricInput' => [ + 'description' => '预定义指标输入配置。', + 'type' => 'object', + 'properties' => [ + 'filterValues' => [ + 'title' => '用户输入的过滤条件列表。指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'description' => '用户输入的过滤条件列表。指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤项配置', + '$ref' => '#/components/schemas/AlertRuleAlertMetricInputFilterValue', + ], + ], + 'paramValues' => [ + 'title' => '输入的参数列表。 指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'description' => '输入的参数列表。 指标所支持的参数列表、过滤条件列表可通过ListAlertMetrics进行查询。', + 'type' => 'array', + 'items' => [ + 'description' => '预定义指标参数配置', + '$ref' => '#/components/schemas/AlertRuleAlertMetricInputParamValue', + ], + ], + 'metricId' => [ + 'title' => '用户所选预定义指标的key', + 'description' => '用户所选预定义指标的key', + 'type' => 'string', + 'example' => 'appstat.jvm.GcPsMarkSweepCount', + ], + 'groupId' => [ + 'title' => '用户所选指标组的key', + 'description' => '用户所选指标组的key', + 'type' => 'string', + 'example' => 'apm.jvm'."\n", + ], + ], + ], + 'AlertRuleAlertMetricInputFilterValue' => [ + 'description' => '过滤条件配置对象。', + 'type' => 'object', + 'properties' => [ + 'opt' => [ + 'title' => '过滤条件操作符', + 'description' => '过滤条件操作符。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALL', + ], + 'dim' => [ + 'title' => '过滤条件的维度', + 'description' => '过滤条件的维度。', + 'type' => 'string', + 'required' => true, + 'example' => 'rootIp', + ], + 'value' => [ + 'description' => '过滤条件值。', + 'type' => 'string', + 'example' => '127.0.0.1', + ], + ], + ], + 'AlertRuleAlertMetricInputParamValue' => [ + 'description' => '预定义指标参数配置对象', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '预定义指标参数名', + 'type' => 'string', + 'required' => true, + 'example' => 'paramName', + ], + 'value' => [ + 'description' => '预定义指标参数值', + 'type' => 'string', + 'required' => true, + 'example' => 'paramValue', + ], + ], + ], + 'AlertRuleAlertMetricParamDef' => [ + 'description' => '告警规则告警指标参数定义对象', + 'type' => 'object', + 'properties' => [ + 'placeholderEn' => [ + 'title' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', + 'description' => '仅对INPUT_PARAM有效。用于前端展示的英文展位符', + 'type' => 'string', + 'example' => 'Enter value', + ], + 'placeholderCn' => [ + 'title' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', + 'description' => '仅对INPUT_PARAM有效。用于前端展示的中文展位符', + 'type' => 'string', + 'example' => '请输入值', + ], + 'values' => [ + 'title' => '仅对SELECT_PARAM有效。 下拉列表的可选值列表。', + 'description' => '仅对SELECT_PARAM有效。 下拉列表的可选值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对象值', + 'type' => 'object', + 'properties' => [ + 'labelCn' => [ + 'title' => '选项的中文显示名称', + 'description' => '选项的中文显示名称', + 'type' => 'string', + 'example' => '测试环境', + ], + 'labelEn' => [ + 'title' => '选项的英文显示名称', + 'description' => '选项的英文显示名称', + 'type' => 'string', + 'example' => 'Staging', + ], + 'value' => [ + 'description' => '值', + 'type' => 'string', + 'example' => 'staging', + ], + ], + ], + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'env', + ], + 'minWidth' => [ + 'title' => '输入框的最小宽度,仅对SELECT_PARAM、INPUT_PARAM生效', + 'description' => '输入框的最小宽度,仅对SELECT_PARAM、INPUT_PARAM生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'type' => [ + 'title' => '● TEXT_PARAM: 只读文本参数,由后台定义,前端不显示用户输入控件'."\n" + .'● INPUT_PARAM:输入框参数'."\n" + .'● SELECT_PARAM:选择框参数', + 'description' => '● TEXT_PARAM: 只读文本参数,由后台定义,前端不显示用户输入控件'."\n" + .'● INPUT_PARAM:输入框参数'."\n" + .'● SELECT_PARAM:选择框参数', + 'type' => 'string', + 'example' => 'TEXT_PARAM', + ], + 'value' => [ + 'description' => '值', + 'type' => 'string', + 'example' => 'staging', + ], + 'maxWidth' => [ + 'title' => '输入框的最大宽度,仅对SELECT_PARAM、INPUT_PARAM生效', + 'description' => '输入框的最大宽度,仅对SELECT_PARAM、INPUT_PARAM生效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + 'AlertRuleAlertMetricParamDef_array' => [ + 'description' => '告警规则告警指标参数定义对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则告警指标参数定义对象', + '$ref' => '#/components/schemas/AlertRuleAlertMetricParamDef', + ], + ], + 'AlertRuleCondition' => [ + 'description' => '告警规则条件配置。 该配置对象所包含的字段取决于条件类型(type字段),不同的条件类型适用的字段不同。', + 'type' => 'object', + 'properties' => [ + 'alertCount' => [ + 'title' => '告警触发次数,满足多少次条件后才告警。仅对SLS_CONDITION有效 ', + 'description' => '适用条件类型:SLS_CONDITION'."\n" + ."\n" + .'满足条件几次后告警,默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'pattern' => '', + 'default' => '1', + ], + 'caseList' => [ + 'title' => '告警条件分支列表,仅对SLS_CONDITION生效', + 'description' => '适用条件类型: SLS_CONDITION。'."\n" + ."\n" + .'SLS告警条件列表', + 'type' => 'array', + 'items' => [ + 'description' => 'SLS告警条件对象', + 'type' => 'object', + 'properties' => [ + 'condition' => [ + 'title' => '匹配表达式,示例: logLevel: error', + 'description' => '匹配表达式,示例: logLevel: error', + 'type' => 'string', + 'example' => 'logLevel: error', + ], + 'countCondition' => [ + 'title' => '数量匹配表达式,示例:'."\n" + .'区间组合: __count__ >= 3 && __count__ <= 10'."\n" + .'单区间: __count__ >= 3', + 'description' => '数量匹配表达式,示例:'."\n" + .'区间组合: __count__ >= 3 && __count__ <= 10'."\n" + .'单区间: __count__ >= 3', + 'type' => 'string', + 'example' => 'count >= 3', + ], + 'level' => [ + 'title' => '满足条件后的告警级别', + 'description' => '满足条件后的告警级别', + 'type' => 'string', + 'example' => 'INFO', + ], + 'type' => [ + 'title' => '匹配类型: 有数据/有特定条数据/有数据匹配/有特定条数匹配。'."\n" + .'有数据--HasData: condition和countCondition都是空'."\n" + .'有特定条数据-- HasDataCount: condition为空,countCondition不为空'."\n" + .'有数据匹配--HasDataMatch: condition不为空,countCondition为空'."\n" + .'有特定条数匹配--HasDataMatchCount:condition和countCondition都不为空', + 'description' => '匹配类型: 有数据/有特定条数据/有数据匹配/有特定条数匹配。'."\n" + ."\n" + .'取值范围:'."\n" + .'- HasData: 有数据'."\n" + .'- HasDataCount: 有特定条数据'."\n" + .'- HasDataMatch:有数据匹配'."\n" + .'- HasDataMatchCount:有特定条数匹配', + 'type' => 'string', + 'example' => 'HasData', + 'enum' => [ + 'HasData', + 'HasDataCount', + 'HasDataMatch', + 'HasDataMatchCount', + ], + ], + ], + ], + ], + 'compareList' => [ + 'title' => '仅对APM_CONDITION有效。', + 'description' => '适用条件类型:APM_CONDITION。'."\n" + ."\n" + .'APM告警比较条件列表', + 'type' => 'array', + 'items' => [ + 'description' => 'APM告警条件对象', + 'type' => 'object', + 'properties' => [ + 'aggregate' => [ + 'title' => '时间序列后聚合函数'."\n" + .'● count'."\n" + .'● sum'."\n" + .'● avg'."\n" + .'● min'."\n" + .'● max'."\n" + .'● p90'."\n" + .'● p95'."\n" + .'● p99', + 'description' => '时间序列后聚合函数'."\n" + ."\n" + .'- count'."\n" + .'- sum'."\n" + .'- avg'."\n" + .'- min'."\n" + .'- max'."\n" + .'- p90'."\n" + .'- p95'."\n" + .'- p99', + 'type' => 'string', + 'enumValueTitles' => [ + 'p99' => 'p99', + 'avg' => 'avg', + 'min' => 'min', + 'max' => 'max', + 'p90' => 'p90', + 'count' => 'count', + 'sum' => 'sum', + 'p95' => 'p95', + ], + 'example' => 'count', + ], + 'oper' => [ + 'title' => '比较操作,判断是否是同比、环比'."\n" + .'● 大于 GT'."\n" + .'● 大于等于 GTE'."\n" + .'● 小于 LT'."\n" + .'● 小于等于 LTE'."\n" + .'● 等于 EQ'."\n" + .'● 不等于 NE'."\n" + .'● 同比增加 YOY_UP'."\n" + .'● 同比减少 YOY_DOWN', + 'description' => '比较操作,判断是否是同比、环比'."\n" + ."\n" + .'- 大于 GT'."\n" + .'- 大于等于 GTE'."\n" + .'- 小于 LT'."\n" + .'- 小于等于 LTE'."\n" + .'- 等于 EQ'."\n" + .'- 不等于 NE'."\n" + .'- 同比增加 YOY_UP'."\n" + .'- 同比减少 YOY_DOWN', + 'type' => 'string', + 'enumValueTitles' => [ + 'YOY_DOWN' => 'YOY_DOWN', + 'YOY_UP' => 'YOY_UP', + 'NE' => 'NE', + 'LT' => 'LT', + 'GTE' => 'GTE', + 'LTE' => 'LTE', + 'EQ' => 'EQ', + 'GT' => 'GT', + ], + 'example' => 'GT', + ], + 'value' => [ + 'title' => '对比的阈值', + 'description' => '对比的阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + ], + 'valueLevelList' => [ + 'title' => '不同值的报警级别,在多级level场景使用', + 'description' => '不同值的报警级别的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '不同值的报警级别,在多级level场景使用', + 'type' => 'object', + 'properties' => [ + 'level' => [ + 'title' => '阈值对应的级别', + 'description' => '阈值对应的级别', + 'type' => 'string', + 'example' => 'INFO', + ], + 'value' => [ + 'title' => '对比的阈值', + 'description' => '对比的阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '120', + ], + ], + ], + ], + 'yoyTimeUnit' => [ + 'title' => '同比时间单位(仅对oper=YOY_UP/YOY_DOWN生效)'."\n" + .' minute、hour、day、week、month', + 'description' => '同比时间单位(仅对oper=YOY_UP/YOY_DOWN生效)'."\n" + .' minute、hour、day、week、month', + 'type' => 'string', + 'example' => 'month', + ], + 'yoyTimeValue' => [ + 'title' => '同比时间的值,与yoyTimeUnit配合使用', + 'description' => '同比时间的值,与yoyTimeUnit配合使用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'baseUnit' => [ + 'title' => '数据单位', + 'description' => '数据单位', + 'type' => 'string', + 'example' => '%', + ], + 'displayUnit' => [ + 'title' => '展示单位', + 'description' => '展示单位', + 'type' => 'string', + 'example' => '%', + ], + ], + ], + ], + 'noDataAppendValue' => [ + 'title' => '无数据时补偿的值。 仅对APM_CONDITION有效', + 'description' => '适用条件类型:APM_CONDITION。'."\n" + ."\n" + .'无数据时补偿的值。', + 'type' => 'string', + 'example' => '1', + ], + 'noDataAlertLevel' => [ + 'title' => '无数据告警级别。 ', + 'description' => '适用条件类型:APM_CONDITION。'."\n" + ."\n" + .'无数据时的告警级别,不指定则不对无数据报警', + 'type' => 'string', + 'example' => 'INFO', + 'pattern' => '', + 'default' => '', + ], + 'type' => [ + 'title' => '条件类型。 SLS_CONDITION/APM_CONDITION/CMS_BASIC_CONDITION', + 'description' => '规则条件类型,取值范围:'."\n" + .'- SLS_CONDITION(SLS告警条件)'."\n" + .'- APM_CONDITION(APM告警条件)'."\n" + .'- CMS_BASIC_CONDITION(基础云监控告警条件)', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SLS_CONDITION' => 'SLS告警条件', + 'CMS_BASIC_CONDITION' => '基础云监控告警条件', + 'APM_CONDITION' => 'APM告警条件', + ], + 'example' => 'SLS_CONDITION', + 'pattern' => '', + 'default' => 'SLS_CONDITION', + 'enum' => [ + 'SLS_CONDITION', + 'APM_CONDITION', + 'CMS_BASIC_CONDITION', + 'BASIC_CONDITION', + ], + ], + 'relation' => [ + 'title' => '仅对APM_CONDITION有效,多个条件之间的逻辑关系。'."\n" + .'允许值: and/or', + 'description' => '适用条件类型:APM_CONDITION。'."\n" + ."\n" + .'多个条件之间的逻辑关系。 取值:'."\n" + .'- and'."\n" + .'- or', + 'type' => 'string', + 'enumValueTitles' => [ + 'or' => '或', + 'and' => '且', + ], + 'example' => 'and', + ], + 'escalationType' => [ + 'title' => '仅对CMS_BASIC_CONDITION有效。'."\n" + .'取值范围: '."\n" + .'simple: 简单指标条件'."\n" + .'composite: 组合指标条件'."\n" + .'express: 表达式条件', + 'description' => '适用条件类型:CMS_BASIC_CONDITION'."\n" + ."\n\n" + .'取值范围: '."\n" + ."\n" + .'- simple: 简单指标条件'."\n" + .'- composite: 组合指标条件'."\n" + .'- express: 表达式条件', + 'type' => 'string', + 'example' => 'simple', + ], + 'simpleEscalation' => [ + 'title' => '仅对CMS_BASIC_CONDITION且escalationType=simple时有效,仅针对单一指标设置告警条件', + 'description' => '适用条件类型:CMS_BASIC_CONDITION。'."\n" + ."\n" + .'仅当escalationType=simple时有效,针对单一指标设置的告警条件', + 'type' => 'object', + 'properties' => [ + 'metricName' => [ + 'title' => '告警条件关联的指标', + 'description' => '适用条件类型:CMS_BASIC_CONDITION。'."\n" + ."\n" + .'告警条件关联的指标', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'period' => [ + 'title' => '指标的时间窗口,单位秒', + 'description' => '指标的时间窗口,单位秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'escalations' => [ + 'title' => '条件列表,同一个告警规则对应多个级别的,每一个级别会有一个条件对象。', + 'description' => '条件列表,同一个告警规则对应多个级别的,每一个级别会有一个条件对象。', + 'type' => 'array', + 'items' => [ + 'description' => '告警条件对象', + 'type' => 'object', + 'properties' => [ + 'level' => [ + 'title' => '该告警条件的级别,CRITICAL、WARN、INFO', + 'description' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" + .'- INFO', + 'type' => 'string', + 'enumValueTitles' => [ + 'INFO' => 'INFO', + 'WARNING' => 'WARNING', + 'CRITICAL' => 'CRITICAL', + ], + 'example' => 'INFO', + ], + 'comparisonOperator' => [ + 'title' => ' 阈值比较符,取值范围:'."\n" + .' ■ GreaterThanOrEqualToThreshold:大于等于。'."\n" + .' ■ GreaterThanThreshold:大于。'."\n" + .' ■ LessThanOrEqualToThreshold:小于等于。'."\n" + .' ■ LessThanThreshold:小于。'."\n" + .' ■ NotEqualToThreshold:不等于。'."\n" + .' ■ EqualToThreshold:等于。'."\n" + .' ■ GreaterThanYesterday:同比昨天时间上涨。'."\n" + .' ■ LessThanYesterday:同比昨天时间下降。'."\n" + .' ■ GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .' ■ LessThanLastWeek:同比上周同一时间下降。'."\n" + .' ■ GreaterThanLastPeriod:环比上周期上涨。'."\n" + .' ■ LessThanLastPeriod:环比上周期下降。', + 'description' => '阈值比较符,取值范围:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'statistics' => [ + 'title' => '统计方法,该参数的取值由指定云产品的MetricName对应的Statistics列决定,例如:Maximum、Minimum 和 Average', + 'description' => '统计方法,该参数的取值由指定云产品的MetricName对应的Statistics列决定,例如:Maximum、Minimum 和 Average', + 'type' => 'string', + 'example' => 'Average', + ], + 'times' => [ + 'title' => '触发告警需满足条件的次数', + 'description' => '触发告警需满足条件的次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'threshold' => [ + 'title' => '告警阈值', + 'description' => '告警阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '100', + ], + ], + ], + ], + ], + ], + 'compositeEscalation' => [ + 'title' => '仅对type=CMS_BASIC_CONDITION且escalationType=composite时有效,组合指标告警条件', + 'description' => '适用条件类型:CMS_BASIC_CONDITION'."\n" + ."\n" + .'escalationType=composite时有效,组合指标告警条件', + 'type' => 'object', + 'properties' => [ + 'relation' => [ + 'title' => '多个指标条件之间的关系,取值为and或or', + 'description' => '多个指标条件之间的关系,取值为and或or', + 'type' => 'string', + 'enumValueTitles' => [ + 'or' => 'or', + 'and' => 'and', + ], + 'example' => 'and', + ], + 'level' => [ + 'title' => '满足条件时触发的告警级别(多指标组合告警仅支持一个级别)', + 'description' => '满足条件时触发的告警级别(多指标组合告警仅支持一个级别)', + 'type' => 'string', + 'example' => 'INFO', + ], + 'times' => [ + 'title' => '触发告警需满足条件的次数', + 'description' => '触发告警需满足条件的次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'escalations' => [ + 'title' => '多指标的组合条件列表', + 'description' => '多指标的组合条件列表', + 'type' => 'array', + 'items' => [ + 'description' => '条件对象', + 'type' => 'object', + 'properties' => [ + 'comparisonOperator' => [ + 'title' => '阈值比较符,取值范围:'."\n" + .' ■ GreaterThanOrEqualToThreshold:大于等于。'."\n" + .' ■ GreaterThanThreshold:大于。'."\n" + .' ■ LessThanOrEqualToThreshold:小于等于。'."\n" + .' ■ LessThanThreshold:小于。'."\n" + .' ■ NotEqualToThreshold:不等于。'."\n" + .' ■ EqualToThreshold:等于。'."\n" + .' ■ GreaterThanYesterday:同比昨天时间上涨。'."\n" + .' ■ LessThanYesterday:同比昨天时间下降。'."\n" + .' ■ GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .' ■ LessThanLastWeek:同比上周同一时间下降。'."\n" + .' ■ GreaterThanLastPeriod:环比上周期上涨。'."\n" + .' ■ LessThanLastPeriod:环比上周期下降。', + 'description' => '阈值比较符,取值范围:'."\n" + ."\n" + .'- GreaterThanOrEqualToThreshold:大于等于。'."\n" + .'- GreaterThanThreshold:大于。'."\n" + .'- LessThanOrEqualToThreshold:小于等于。'."\n" + .'- LessThanThreshold:小于。'."\n" + .'- NotEqualToThreshold:不等于。'."\n" + .'- EqualToThreshold:等于。'."\n" + .'- GreaterThanYesterday:同比昨天时间上涨。'."\n" + .'- LessThanYesterday:同比昨天时间下降。'."\n" + .'- GreaterThanLastWeek:同比上周同一时间上涨。'."\n" + .'- LessThanLastWeek:同比上周同一时间下降。'."\n" + .'- GreaterThanLastPeriod:环比上周期上涨。'."\n" + .'- LessThanLastPeriod:环比上周期下降。', + 'type' => 'string', + 'example' => 'GreaterThanOrEqualToThreshold', + ], + 'metricName' => [ + 'title' => '指标名称', + 'description' => '指标名称', + 'type' => 'string', + 'example' => 'cpu_total', + ], + 'period' => [ + 'title' => '指标的时间窗口', + 'description' => '指标的时间窗口', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'statistics' => [ + 'title' => '统计方法,该参数的取值由指定云产品的MetricName对应的Statistics列决定。 监控项的统计方法。取值示例:'."\n" + .' ■ $Maximum:最大值。'."\n" + .' ■ $Minimum:最小值。'."\n" + .' ■ $Average:平均值。'."\n" + .' ■ $Availability:可用率(通常用于站点监控)'."\n" + .'说明 $为监控项的统一前缀符号。', + 'description' => '统计方法,该参数的取值由指定云产品的MetricName对应的Statistics列决定。 监控项的统计方法。取值示例:'."\n" + ."\n" + .'- $Maximum:最大值。'."\n" + .'- $Minimum:最小值。'."\n" + .'- $Average:平均值。'."\n" + .'- $Availability:可用率(通常用于站点监控)'."\n" + ."\n" + .'说明 $为监控项的统一前缀符号。', + 'type' => 'string', + 'example' => '$Maximum', + ], + 'threshold' => [ + 'title' => '告警阈值', + 'description' => '告警阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '50', + ], + ], + ], + ], + ], + ], + 'expressEscalation' => [ + 'title' => '仅type=CMS_BASIC_CONDITION且escalationType=composite时有效', + 'description' => '适用条件类型:CMS_BASIC_CONDITION。'."\n" + ."\n" + .'escalationType=composite时有效,多指标组合告警条件。', + 'type' => 'object', + 'properties' => [ + 'level' => [ + 'title' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)', + 'description' => '满足条件时触发的告警级别(表达式告警仅支持一个级别)'."\n" + ."\n" + .'- CRITICAL'."\n" + .'- WARNING'."\n" + .'- INFO', + 'type' => 'string', + 'example' => 'INFO', + ], + 'times' => [ + 'description' => '触发告警需满足条件的次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'rawExpression' => [ + 'title' => '告警条件表达式', + 'description' => '告警条件表达式', + 'type' => 'string', + 'example' => '@cpu_total[60].$Average > 60', + ], + ], + ], + 'noDataPolicy' => [ + 'title' => '仅对type=CMS_BASIC_CONDITION有效,无监控数据时报警的处理方式。取 值:'."\n" + .'● KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'● INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'● OK:正常。', + 'description' => '适用条件类型:CMS_BASIC_CONDITION。'."\n" + ."\n\n" + .'无监控数据时报警的处理方式。取值:'."\n" + ."\n" + .'- KEEP_LAST_STATE(默认值):不做任何处理。'."\n" + .'- INSUFFICIENT_DATA:报警内容为无数据。'."\n" + .'- OK:正常。', + 'type' => 'string', + 'enumValueTitles' => [ + 'KEEP_LAST_STATE' => '不做任何处理', + 'INSUFFICIENT_DATA' => '报警内容为无数据', + 'OK' => '视为正常', + ], + 'example' => 'KEEP_LAST_STATE', + ], + 'oper' => [ + 'description' => '比较操作,判断是否是同比、环比'."\n" + ."\n" + .'- 大于 GT'."\n" + .'- 大于等于 GTE'."\n" + .'- 小于 LT'."\n" + .'- 小于等于 LTE'."\n" + .'- 等于 EQ'."\n" + .'- 不等于 NE'."\n" + .'- 同比增加 YOY_UP'."\n" + .'- 同比减少 YOY_DOWN', + 'type' => 'string', + 'example' => 'LT', + ], + 'value' => [ + 'description' => '告警触发的阈值', + 'type' => 'number', + 'format' => 'double', + 'example' => '60', + ], + ], + ], + 'AlertRuleDataSource' => [ + 'description' => '告警规则数据源配置。 该配置对象所包含的字段取决于数据源类型(type字段),不同的数据源类型适用的字段不同。', + 'type' => 'object', + 'properties' => [ + 'dsList' => [ + 'title' => 'type=SLS_MULTI_DS时才需要指定,子数据源列表', + 'description' => '适用数据源类型:SLS_MULTI_DS。'."\n" + ."\n" + .'子数据源列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'project' => [ + 'title' => 'sls project', + 'description' => 'SLS project。', + 'type' => 'string', + 'example' => 'mySlsProject', + ], + 'regionId' => [ + 'title' => 'sls project所在的region', + 'description' => 'SLS project所在的region', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'store' => [ + 'title' => 'log/metric store名称', + 'description' => 'LogStore/MetricStore名称', + 'type' => 'string', + 'example' => 'mySlsLogStore', + ], + 'type' => [ + 'title' => 'sls数据子源的类型:'."\n" + .'SLS_LOG_DS: log store数据源'."\n" + .'SLS_METRIC_DS: metric store数据源', + 'description' => 'SLS数据子源的类型:'."\n" + .'- SLS_LOG_DS: LogStore数据源'."\n" + .'- SLS_METRIC_DS: MetricStore数据源', + 'type' => 'string', + 'example' => 'SLS_LOG_DS', + 'default' => 'SLS_LOG_DS', + 'enum' => [ + 'SLS_LOG_DS', + 'SLS_METRIC_DS', + ], + ], + ], + ], + ], + 'instanceId' => [ + 'title' => 'type=PROMETHUES_DS时需指定prometheus实例id', + 'description' => '适用数据源类型:PROMETHEUS_DS'."\n" + ."\n" + .'prometheus实例ID', + 'type' => 'string', + 'example' => 'rw-bbe8961b4a59be0', + 'pattern' => '', + 'default' => '', + ], + 'namespace' => [ + 'title' => 'type=ENTERPRISE_DS时需指定,企业云监控指标仓库的名称', + 'description' => '适用数据源类型:ENTERPRISE_DS'."\n" + ."\n" + .'企业云监控指标仓库的名称。', + 'type' => 'string', + 'example' => 'aliyun-default', + ], + 'type' => [ + 'title' => '数据源类型:'."\n" + .'ENTERPRISE_DS: 企业云监控数据源'."\n" + .'PROMETHEUS_DS:Prometheus数据源(ARMS)'."\n" + .'SLS_MULTI_DS:sls数据源'."\n" + .'APM_DS: APM数据源'."\n" + .'CMS_BASIC_DS: 基础云监控数据源', + 'description' => '数据源类型'."\n" + ."\n" + .'取值范围:'."\n" + .'- PROMETHEUS_DS: Prometheus数据源'."\n" + .'- SLS_MULTI_DS:SLS数据源'."\n" + .'- APM_DS:应用监控数据源'."\n" + .'- CMS_BASIC_DS:基础云监控数据源'."\n" + .'- ENTERPRISE_DS:企业云监控数据源', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'CMS_BASIC_DS' => '基础云监控数据源', + 'APM_DS' => '应用监控数据源', + 'ENTERPRISE_DS' => '企业云监控数据源', + 'SLS_MULTI_DS' => 'SLS数据源', + 'PROMETHEUS_DS' => 'Prometheus数据源', + ], + 'example' => 'PROMETHEUS_DS', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'ENTERPRISE_DS', + 'PROMETHEUS_DS', + 'SLS_MULTI_DS', + 'APM_DS', + 'CMS_BASIC_DS', + 'ENTITY_DS', + 'VIRTUAL_PROMETHEUS_DS', + ], + ], + 'regionId' => [ + 'title' => '数据源所属的regionId。'."\n" + .'对APM_DS,指应用所属的地域'."\n" + .'对于PROMETHEUS_DS,指prometheus实例所属地域。'."\n" + .'如果未指定,则通过规则的regionId访问数据源。', + 'description' => '适用数据源类型:APM_DS、PROMETHEUS_DS。'."\n" + ."\n" + .'数据源所属的regionId。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'appType' => [ + 'title' => '仅对APM_DS有效,应用的类型:'."\n" + .'* apm'."\n" + .'* rum'."\n" + .'* ebpf'."\n" + .'* xtrace', + 'description' => '适用数据源类型:APM_DS。'."\n" + ."\n" + .'应用的类型:'."\n" + .'- apm', + 'type' => 'string', + 'enumValueTitles' => [ + 'apm' => 'APM应用', + ], + 'example' => 'apm', + ], + ], + ], + 'AlertRuleLabelFilter' => [ + 'description' => '标签过滤配置', + 'type' => 'object', + 'properties' => [ + 'opt' => [ + 'description' => '多个标签之间的关系操作符', + 'type' => 'string', + 'required' => false, + 'example' => 'AND', + 'default' => 'AND', + 'enum' => [ + 'AND', + 'OR', + ], + ], + 'labels' => [ + 'description' => '标签过滤器', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '标签的值', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + ], + ], + 'AlertRuleNotification' => [ + 'description' => '告警通知配置对象', + 'type' => 'object', + 'properties' => [ + 'contacts' => [ + 'description' => '联系人ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人ID。', + 'type' => 'string', + 'example' => 'myContactId', + ], + ], + 'customWebhooks' => [ + 'description' => '自定义webhook通知对象ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '自定义webhook通知对象ID', + 'type' => 'string', + 'example' => 'myCustomWebhookId', + ], + ], + 'dingWebhooks' => [ + 'description' => '钉钉webhook通知对象ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '钉钉webhook通知对象ID', + 'type' => 'string', + 'example' => 'myDingWebhookId', + ], + ], + 'fsWebhooks' => [ + 'description' => '飞书webhook通知对象ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '飞书webhook通知对象ID。', + 'type' => 'string', + 'example' => 'myFsWebhookId', + ], + ], + 'groups' => [ + 'description' => '联系人组ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '联系人组ID', + 'type' => 'string', + 'example' => 'myContactGroupId', + ], + ], + 'silenceTime' => [ + 'description' => '通知沉默时间,单位:秒', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86400', + ], + 'slackWebhooks' => [ + 'description' => 'slack webhook通知对象ID列表', + 'type' => 'array', + 'items' => [ + 'description' => 'slack webhook通知对象ID', + 'type' => 'string', + 'example' => 'mySlackWebhookId', + ], + ], + 'wxWebhooks' => [ + 'description' => '微信webhook通知对象ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '微信webhook通知对象ID', + 'type' => 'string', + 'example' => 'myWxWebhookId', + ], + ], + 'notifyTime' => [ + 'title' => '通知时段,只有在该时段内,才发送通知', + 'description' => '通知时段,只有在该时段内,才发送通知', + '$ref' => '#/components/schemas/AlertRuleTimeSpan', + ], + 'dingCoolAppWebhooks' => [ + 'description' => '钉钉酷应用webhook 通知对象 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个钉钉酷应用 webhook ID', + 'type' => 'string', + 'example' => 'myDingCoolAppWebhookId', + ], + ], + ], + ], + 'AlertRuleNotificationFilter' => [ + 'description' => '通知对象过滤配置', + 'type' => 'object', + 'properties' => [ + 'slackWebhooks' => [ + 'description' => 'slack webhook ID过滤列表', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook ID', + 'type' => 'string', + 'example' => 'myWebhookId', + ], + ], + 'wxWebhooks' => [ + 'description' => '微信webhook ID过滤', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook ID', + 'type' => 'string', + 'example' => 'myWebhookId', + ], + ], + 'dingWebhooks' => [ + 'description' => '钉钉webhook ID过滤', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook ID', + 'type' => 'string', + 'example' => 'myWebhookId', + ], + ], + 'customWebhooks' => [ + 'description' => '自定义webhook ID过滤', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook ID', + 'type' => 'string', + 'example' => 'myWebhookId', + ], + ], + 'groups' => [ + 'description' => '联系人组过滤配置', + 'type' => 'array', + 'items' => [ + 'description' => '联系人组ID', + 'type' => 'string', + 'example' => 'myContactGroup', + ], + ], + 'fsWebhooks' => [ + 'description' => '飞书webhook ID过滤', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook ID', + 'type' => 'string', + 'example' => 'myWebhookId', + ], + ], + 'contacts' => [ + 'description' => '联系人ID过滤', + 'type' => 'array', + 'items' => [ + 'description' => '联系人ID', + 'type' => 'string', + 'example' => 'myContactId', + ], + ], + ], + ], + 'AlertRuleQuery' => [ + 'description' => '告警规则的查询配置。 该配置对象所包含的字段取决于查询类型(type字段),不同的数据查询类型适用的字段不同。', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => 'type=PROMQL_QUERY时需指定\\n告警(数据)持续时间,单位:秒。 默认60。', + 'description' => '适用查询类型:PROMQL_QUERY。'."\n" + ."\n" + .'告警数据持续时间,单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'expr' => [ + 'title' => '查询表达式 PROMQL_QUERY时需指定', + 'description' => '适用查询类型:PROMQL_QUERY。'."\n" + ."\n" + .'查询表达式(promQL)', + 'type' => 'string', + 'example' => 'sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000', + ], + 'groupFieldList' => [ + 'title' => '分组字段名', + 'description' => '适用查询类型:SLS_MULTI_QUERY。'."\n" + ."\n" + .'分组字段名列表', + 'type' => 'array', + 'items' => [ + 'description' => '分组字段名', + 'type' => 'string', + 'example' => 'host_name', + ], + ], + 'groupType' => [ + 'title' => '分组类型:'."\n" + .'● none: 不分组'."\n" + .'● label: 标签自动'."\n" + .'● custom: 标签自定义', + 'description' => '适用查询类型:SLS_MULTI_QUERY。'."\n" + ."\n" + .'分组类型,取值类型:'."\n" + .'- none: 不分组'."\n" + .'- label: 标签自动'."\n" + .'- custom: 标签自定义', + 'type' => 'string', + 'example' => 'label', + 'enum' => [ + 'none', + 'label', + 'custom', + ], + ], + 'queries' => [ + 'title' => '子查询列表, type=SLS_MULTI_QUERY或APM_MULTI_QUERY时指定', + 'description' => '适用查询类型:SLS_MULTI_QUERY、APM_MULTI_QUERY。'."\n" + ."\n" + .'子查询列表'."\n" + ."\n" + .'对于SLS_MULTI_QUERY查询类型,最多包含3个子查询,且子查询的数量和顺序必须与datasource.dsList中的子数据源配置匹配。', + 'type' => 'array', + 'items' => [ + 'title' => '子查询', + 'description' => '子查询。', + 'type' => 'object', + 'properties' => [ + 'duration' => [ + 'title' => '仅对ARMS_MULTI_QUERY有效。 告警(数据)持续时间。', + 'description' => '适用查询类型:ARMS_MULTI_QUERY。'."\n" + ."\n" + .'告警(数据)持续时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'end' => [ + 'title' => '仅对SLS_MULTI_QUERY有效。时间偏移结束时间(相对)', + 'description' => '适用查询类型: SLS_MULTI_QUERY。'."\n" + ."\n" + .'时间偏移结束时间(相对)。'."\n" + ."\n" + .'如果指定了start、end,则不指定window。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'pattern' => '', + 'default' => '', + ], + 'expr' => [ + 'title' => '查询表达式。 sls sql/spl或promQL,取决与query.type', + 'description' => '适用查询类型: APM_MULTI_QUERY、SLS_MULTI_QUERY。'."\n" + ."\n" + .'查询表达式'."\n" + ."\n" + .'- 对于APM_MULTI_QUERY,该字段非必须,为预定义指标生成的promQL(用于预览数据)。'."\n" + .'- 对于SLS_MULTI_QUERY,该字段为SQL查询语句。', + 'type' => 'string', + 'example' => 'sum by (rpc,acs_arms_service_id,pid,rpcType) (sum_over_time_lorc(arms_app_requests_count_ign_destid_endpoint_parent_ppid_prpc{callKind=~\\"http|rpc|custom_entry|server|consumer\\",pid=\\"gaddp9ap8q@cb005ffdf44b8ac\\",source=\\"apm\\"}[1m]))', + 'pattern' => '', + 'default' => '', + ], + 'start' => [ + 'title' => '仅对SLS_MULTI_QUERY有效。时间偏移开始时间(相对)', + 'description' => '适用查询类型: SLS_MULTI_QUERY。'."\n" + ."\n" + .'SLS查询的时间偏移开始时间(相对)。'."\n" + ."\n" + .'如果指定了start、end,则不指定window。 例如:start=15, timeUnit=minute,表示15分钟前', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + 'pattern' => '', + 'default' => '', + ], + 'timeUnit' => [ + 'title' => '仅对SLS_MULTI_QUERY有效。start、end、window的时间单位。', + 'description' => '适用查询类型: SLS_MULTI_QUERY。'."\n" + ."\n" + .'start和end、window参数的时间单位: day/hour/minute/second', + 'type' => 'string', + 'example' => 'hour', + 'pattern' => '', + 'default' => 'minute', + 'enum' => [ + 'second', + 'minute', + 'hour', + 'day', + ], + ], + 'window' => [ + 'title' => '仅对SLS_MULTI_QUERY有效。整点时间查询区间。 ', + 'description' => '适用查询类型: SLS_MULTI_QUERY。'."\n" + ."\n" + .'整点时间查询区间。 如果指定了window则不应指定start、end。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'pattern' => '', + 'default' => '', + ], + 'apmAlertMetricId' => [ + 'title' => ' 仅对APM_MULTI_QUERY有效。'."\n" + .'APM指标的alertMetricId,与Apm Datasource配合使用,如果指定,则忽略expr,即不依赖promQL,而是直接通过alertMetricId进程查询。'."\n" + .'当指定apmAlertMetricId时,指标查询的过滤项、聚合维度(group by)通过apmFilters、apmGroupBy字段指定。', + 'description' => '适用查询类型:APM_MULTI_QUERY。'."\n" + ."\n" + .'APM预定义指标的ID。', + 'type' => 'string', + 'example' => 'appstat.jvm.ThreadNewCount', + ], + 'apmFilters' => [ + 'title' => 'APM指标的维度过滤项配置。 必须与apmAlertMetricId配合使用。', + 'description' => '适用查询类型:ARMS_MULTI_QUERY。'."\n" + ."\n" + .'APM指标的维度过滤项配置。 必须与apmAlertMetricId配合使用。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'dim' => [ + 'title' => 'APM指标中为维度', + 'description' => 'APM指标中为维度', + 'type' => 'string', + 'example' => 'rpcType', + ], + 'type' => [ + 'title' => '过滤操作类型:'."\n" + .'* eq: 等于'."\n" + .'* neq:不等于'."\n" + .'* match:正则匹配'."\n" + .'* nmatch:正则不匹配', + 'description' => '过滤操作类型:'."\n" + .'* eq: 等于'."\n" + .'* neq:不等于'."\n" + .'* match:正则匹配'."\n" + .'* nmatch:正则不匹配', + 'type' => 'string', + 'example' => 'eq', + ], + 'value' => [ + 'title' => '与过滤操作对应的取值。', + 'description' => '与过滤操作对应的取值。', + 'type' => 'string', + 'example' => 'h3ji7a0y9i@2ac80e27fdfd0a2', + ], + ], + ], + ], + 'apmGroupBy' => [ + 'title' => '查询的聚合维度参数,即按指标的哪些维度进行聚合', + 'description' => '适用查询类型:ARMS_MULTI_QUERY。'."\n" + ."\n" + .'查询的聚合维度列表,即按指标的哪些维度进行聚合。', + 'type' => 'array', + 'items' => [ + 'description' => '指标的聚合维度', + 'type' => 'string', + 'example' => 'rpcType', + ], + ], + ], + ], + ], + 'firstJoin' => [ + 'description' => '适用查询类型: SLS_MULTI_QUERY。'."\n" + ."\n" + .'子查询1(queries[0])和子查询2(queries[1])结果的集合连接操作配置。', + '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', + ], + 'type' => [ + 'title' => '查询类型,PROMQL_QUERY--prometheus查询;'."\n" + .' APM_MULTI_QUERY -- APM查询;'."\n" + .' SLS_MULTI_QUERY -- SLS查询'."\n" + .'CMS_BASIC_QUERY-- 基础云监控查询', + 'description' => '查询类型。 '."\n" + ."\n" + .'取值范围:'."\n" + .'- PROMQL_QUERY: promQL查询'."\n" + .'- SLS_MULTI_QUERY: SLS查询'."\n" + .'- APM_MULTI_QUERY: APM查询'."\n" + .'- CMS_BASIC_QUERY: 基础云监控查询'."\n" + ."\n" + .'不同的查询类型,查询对象中的有效字段不同,具体见各字段描述中的"适用查询类型"描述。'."\n" + ."\n" + .'查询类型需要数据源类型匹配,对应关系如下:'."\n" + .'- Prometheus数据源(PROMETHEUS_DS): PROMQL_QUERY'."\n" + .'- APM数据源(APM_DS): APM_MULTI_QUERY'."\n" + .'- SLS数据源(SLS_MULTI_DS):SLS_MULTI_QUERY'."\n" + .'- 基础云监控数据源(CMS_BASIC_DS):CMS_BASIC_QUERY', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PROMQL_QUERY' => 'PROMQL_QUERY', + 'CMS_BASIC_QUERY' => 'CMS_BASIC_QUERY', + 'APM_MULTI_QUERY' => 'APM_MULTI_QUERY', + 'SLS_MULTI_QUERY' => 'SLS_MULTI_QUERY', + ], + 'example' => 'PROMQL_QUERY', + 'pattern' => '', + 'default' => 'PROMQL_QUERY', + 'enum' => [ + 'PROMQL_QUERY', + 'SLS_MULTI_QUERY', + 'APM_MULTI_QUERY', + 'CMS_BASIC_QUERY', + 'METRIC_SET_QUERY', + ], + ], + 'secondJoin' => [ + 'description' => '适用查询类型:SLS_MULTI_QUERY。'."\n" + ."\n" + .'子查询2(queries[2])和子查询3(queries[3])结果的集合连接操作配置。', + '$ref' => '#/components/schemas/AlertRuleSlsQueryJoin', + ], + 'checkAfterDataComplete' => [ + 'title' => '仅对PROMQL_QUERY有效,是否数据完整后再执行告警检测', + 'description' => '适用查询类型: PROMQL_QUERY。'."\n" + ."\n" + .'是否数据完整后再执行告警检测。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'relationType' => [ + 'title' => 'CMS_BASIC_QUERY时必须。'."\n" + .'● USER:用户uid下全部资源'."\n" + .'● GROUP: 应用分组'."\n" + .'● INSTANCE:指定实例列表', + 'description' => '适用查询类型: CMS_BASIC_QUERY。'."\n" + ."\n" + .'规则查询的资源范围,允许以下取值:'."\n" + .'- USER:用户uid下全部资源'."\n" + .'- GROUP: 应用分组'."\n" + .'- INSTANCE:指定实例列表', + 'type' => 'string', + 'enumValueTitles' => [ + 'GROUP' => 'GROUP', + 'INSTANCE' => 'INSTANCE', + 'USER' => 'USER', + ], + 'example' => 'USER', + ], + 'groupId' => [ + 'title' => '仅对type=CMS_BASIC_QUERY且relationType=GROUP有效。 关联应用分组id。', + 'description' => '适用查询类型:CMS_BASIC_QUERY。'."\n" + ."\n" + .'关联应用分组id,仅在relationType=GROUP时有效。', + 'type' => 'string', + 'example' => '23423', + ], + 'namespace' => [ + 'title' => '仅对type=CMS_BASIC_QUERY有效,规则关联的指标数据命名空间', + 'description' => '适用查询类型:CMS_BASIC_QUERY。'."\n" + ."\n" + .'指标的命名空间', + 'type' => 'string', + 'example' => 'acs_ecs_dashboard', + ], + 'entityFilter' => [ + 'description' => '资源过滤器,用于筛选目标资源。', + 'type' => 'object', + 'properties' => [ + 'domain' => [ + 'description' => '资源类型域。', + 'type' => 'string', + 'example' => 'rum', + ], + 'type' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'apm', + ], + 'filters' => [ + 'description' => '过滤条件列表,用于进一步筛选资源。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤条件对象。', + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => '字段', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'operator' => [ + 'description' => '比较运算符。', + 'type' => 'string', + 'example' => '=', + ], + 'value' => [ + 'description' => '匹配的值。', + 'type' => 'string', + 'example' => 'wait_throw', + ], + ], + ], + ], + ], + ], + 'domain' => [ + 'description' => '资源所属的领域。', + 'type' => 'string', + 'example' => 'rum', + ], + 'metricSet' => [ + 'description' => '监控指标集合。', + 'type' => 'string', + 'example' => 'cpu_usage', + ], + 'metric' => [ + 'description' => '指标名。', + 'type' => 'string', + 'example' => 'memory', + ], + 'dimensions' => [ + 'title' => '仅对CMS_BASIC_QUERY有效。 资源的过滤维度信息。', + 'description' => '适用查询类型: CMS_BASIC_QUERY。 '."\n" + ."\n" + .'资源的过滤维度列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基础云监控的资源过滤维度', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '维度取值', + 'type' => 'string', + 'example' => 'i-f8zbbutcvfpx7gn457pi', + ], + ], + ], + 'serviceIds' => [ + 'description' => '服务id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务id。', + 'type' => 'string', + 'example' => 'i-bp1234567890abcdef', + ], + ], + 'labelFilters' => [ + 'description' => '标签过滤器数组。', + 'type' => 'array', + 'items' => [ + 'description' => '标签过滤器对象', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '标签名称', + 'type' => 'string', + 'example' => 'app', + ], + 'value' => [ + 'description' => '标签值', + 'type' => 'string', + 'example' => 'web', + ], + 'operator' => [ + 'description' => '比较运算符,决定如何匹配标签值。', + 'type' => 'string', + 'example' => '=', + ], + ], + ], + ], + 'entityFields' => [ + 'description' => '实体字段过滤器数组。', + 'type' => 'array', + 'items' => [ + 'description' => '实体字段过滤器对象', + 'type' => 'object', + 'properties' => [ + 'field' => [ + 'description' => '实体字段名', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'value' => [ + 'description' => '字段值', + 'type' => 'string', + 'example' => 'i-abc123', + ], + ], + ], + ], + ], + ], + 'AlertRuleRcaConfig' => [ + 'type' => 'object', + 'properties' => [ + 'enableRca' => [ + 'type' => 'boolean', + ], + 'digitalEmployeeName' => [ + 'type' => 'string', + ], + ], + ], + 'AlertRuleSend' => [ + 'description' => '告警发送配置对象', + 'type' => 'object', + 'properties' => [ + 'notification' => [ + 'description' => '告警通知配置', + '$ref' => '#/components/schemas/AlertRuleNotification', + ], + 'action' => [ + 'description' => '告警行动集成配置', + '$ref' => '#/components/schemas/AlertRuleAction', + ], + 'sendToArms' => [ + 'title' => '是否将告警事件投递至ARMS告警管理', + 'description' => '是否将告警事件投递至ARMS告警管理', + 'type' => 'boolean', + 'example' => 'true', + ], + 'notifyStrategies' => [ + 'description' => '通知策略列表,定义在不同告警状态(如触发、恢复)下应采取的通知方式或策略名称', + 'type' => 'array', + 'items' => [ + 'description' => '通知策略', + 'type' => 'string', + 'example' => '["trigger", "recovery"]', + ], + ], + 'rcaConfig' => [ + '$ref' => '#/components/schemas/AlertRuleRcaConfig', + ], + ], + ], + 'AlertRuleSlsQueryJoin' => [ + 'description' => 'SLS查询连接配置。', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'description' => '连接条件列表。', + 'type' => 'array', + 'items' => [ + 'title' => '集合操作条件', + 'description' => '集合操作条件。', + 'type' => 'object', + 'properties' => [ + 'oper' => [ + 'title' => '集合联接条件操作符', + 'description' => '比较操作符,取值范围:<, >, ==, !=, <=, >=', + 'type' => 'string', + 'deprecated' => false, + 'example' => '==', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'secondField' => [ + 'title' => '条件的右操作参数', + 'description' => '条件的右操作参数,格式为$<query_idx>.<结果集字段名>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '$0.__topic__', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'firstField' => [ + 'title' => '条件的左操作参数', + 'description' => '条件的左操作参数,格式为$<query_idx>.<结果集字段名>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '$0.__topic__', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + ], + 'deprecated' => false, + 'readOnly' => false, + ], + ], + 'type' => [ + 'title' => '查询结果集合操作类型', + 'description' => '集合操作类型。'."\n" + ."\n" + .'- CrossJoin: 笛卡尔积'."\n" + .'- FullJoin:全联'."\n" + .'- InnerJoin:内联'."\n" + .'- LeftExclude: 左斥'."\n" + .'- RightExclude:右斥'."\n" + .'- LeftJoin:左联'."\n" + .'- RightJoin:右联'."\n" + .'- NoJoin:不合并'."\n" + .'- Concat: 拼接'."\n" + ."\n" + .'参见:'."\n" + .' https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement', + 'type' => 'string', + 'required' => true, + 'example' => 'CrossJoin', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'CrossJoin', + 'FullJoin', + 'InnerJoin', + 'LeftExclude', + 'RightExclude', + 'LeftJoin', + 'RightJoin', + 'NoJoin', + 'Concat', + ], + ], + ], + ], + 'AlertRuleTimeSpan' => [ + 'description' => '时段配置对象。', + 'type' => 'object', + 'properties' => [ + 'dayOfWeek' => [ + 'title' => '每周的星期几', + 'description' => '每周的星期几。', + 'type' => 'array', + 'items' => [ + 'description' => '每周的星期几。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + '6', + '7', + ], + ], + ], + 'gmtOffset' => [ + 'title' => '默认北京时间: +0800', + 'description' => '默认北京时间: +0800', + 'type' => 'string', + 'example' => '+0800', + ], + 'startTime' => [ + 'title' => '开始时间,格式HH:mm', + 'description' => '开始时间,格式HH:mm', + 'type' => 'string', + 'example' => '09:00', + ], + 'endTime' => [ + 'title' => '结束时间,格式HH:mm', + 'description' => '结束时间,格式HH:mm', + 'type' => 'string', + 'example' => '23:00', + ], + ], + ], + 'BizTraceConfig' => [ + 'description' => '业务链路追踪的配置', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => '工作空间。', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default-cms-xxxxxxx-cn-hangzhou', + ], + 'bizTraceId' => [ + 'title' => '业务链路id', + 'description' => '业务链路id', + 'type' => 'string', + 'example' => 'e339260ed64c95d', + ], + 'bizTraceName' => [ + 'title' => '业务链路名称', + 'description' => '业务链路名称', + 'type' => 'string', + 'example' => 'just test', + ], + 'bizTraceCode' => [ + 'title' => '业务链路标识', + 'description' => '业务链路标识', + 'type' => 'string', + 'example' => 'label_env', + ], + 'ruleConfig' => [ + 'title' => '配置规则列表', + 'description' => '配置规则列表', + 'type' => 'string', + 'example' => '[{"entrancePid":"xxxxx@b57c44xx6e86","rpcMatcher":{"matchType":"EQUALS","pattern":"/createApp"},"characteristics":{"operation":"AND","rules":[{"target":"CUSTOM_EXTRACT","matcher":{"matchType":"CONTAINS","pattern":[]}}]}}]', + ], + 'advancedConfig' => [ + 'title' => '高级配置', + 'description' => '高级配置', + 'type' => 'string', + 'example' => '{"sample":{"strategy":"BY_APP"}}', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-12-12 00:00:00', + ], + 'regionId' => [ + 'title' => '地域id', + 'description' => '地域id', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + 'CmsEventForView' => [ + 'description' => '事件展示对象,包含事件的核心信息和上下文', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '事件唯一标识符(全局唯一 ID),由系统生成', + 'type' => 'string', + 'example' => '"event-1234567890"', + ], + 'dedupId' => [ + 'description' => '去重 ID,用于识别同一事件的不同实例(如重复上报)', + 'type' => 'string', + 'example' => '"dedup-abc123"', + ], + 'type' => [ + 'description' => '事件类型', + 'type' => 'string', + 'example' => '"Alert"', + ], + 'subtype' => [ + 'description' => '事件子类型', + 'type' => 'string', + 'example' => '"HighCPUUsage"', + ], + 'source' => [ + 'description' => '事件来源系统或服务名称(如 ECS、RDS、VPC 等)', + 'type' => 'string', + 'example' => '"ECS"', + ], + 'time' => [ + 'description' => '事件发生时间', + 'type' => 'string', + 'example' => '"2025-04-05T10:30:00Z"', + ], + 'timestamp' => [ + 'description' => '事件发生时间的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743846600000', + ], + 'subject' => [ + 'description' => '事件主题或标题,简要描述事件内容', + 'type' => 'string', + 'example' => '"Instance cpu usage exceeds threshold"', + ], + 'severity' => [ + 'description' => '事件严重级别', + 'type' => 'string', + 'example' => '"CRITICAL"', + ], + 'status' => [ + 'description' => '事件当前状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'resource' => [ + 'description' => '事件关联的资源信息,例如实例 ID、IP、地域等', + '$ref' => '#/components/schemas/EventResourceForEventView', + ], + 'labels' => [ + 'description' => '事件标签键值对', + 'type' => 'object', + 'example' => '{\'source\': \'system\'}', + ], + 'annotations' => [ + 'description' => '事件附加注解信息,非结构化描述字段', + 'type' => 'object', + 'example' => '{ "description": "High load detected on server", "operator": "auto" }', + ], + 'dataschema' => [ + 'description' => '数据模式定义,用于描述 data 字段的结构', + 'type' => 'string', + 'example' => '"https://schema.alibabacloud.com/cms/alert/v1"', + ], + 'datacontenttype' => [ + 'description' => 'data 字段的内容类型', + 'type' => 'string', + 'example' => '"application/json"', + ], + 'data' => [ + 'description' => '事件携带的原始数据,具体格式取决于事件类型和 dataschema', + 'type' => 'any', + 'example' => '{ "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }', + ], + 'receiveTime' => [ + 'description' => '事件被接收处理的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743846610000', + ], + 'workspace' => [ + 'description' => '所属工作空间(Workspace)ID 或名称,用于多租户或组织隔离', + 'type' => 'string', + 'example' => '"ws-abc123"', + ], + 'workspaceTags' => [ + 'description' => '工作空间标签,便于按标签维度管理事件', + 'type' => 'object', + 'example' => '{ "department": "finance", "project": "payment-gateway" }', + ], + 'sysId' => [ + 'description' => '系统内部事件 ID,用于内部追踪和日志关联', + 'type' => 'string', + 'example' => '"sys-event-987654321"', + ], + 'integrationUuid' => [ + 'description' => '集成唯一标识,用于跨系统集成时的身份识别', + 'type' => 'string', + 'example' => '"integration-xyz"', + ], + 'sourcetype' => [ + 'description' => '事件源类型,区分是来自监控系统、日志服务、应用观测等', + 'type' => 'string', + 'example' => '"CloudMonitor"', + ], + ], + ], + 'ContactForIncidentView' => [ + 'description' => '联系人展示对象', + 'type' => 'object', + 'properties' => [ + 'contactId' => [ + 'description' => '联系人id', + 'type' => 'string', + 'example' => '"contact-123456"', + ], + 'name' => [ + 'description' => '联系人名称', + 'type' => 'string', + 'example' => '"张三"', + ], + ], + ], + 'DataStorageItem' => [ + 'type' => 'object', + 'properties' => [ + 'storeType' => [ + 'type' => 'string', + ], + 'regionId' => [ + 'type' => 'string', + ], + 'dataType' => [ + 'type' => 'string', + ], + 'project' => [ + 'type' => 'string', + ], + 'storeName' => [ + 'type' => 'string', + ], + ], + ], + 'EffectTimeRange' => [ + 'description' => '生效时间范围配置对象', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'description' => '0-6 标志周日到周六', + 'type' => 'array', + 'items' => [ + 'description' => '0-6 标志周日到周六', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[1, 2, 3]', + ], + ], + 'startTimeInMinute' => [ + 'description' => '开始时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '360', + ], + 'endTimeInMinute' => [ + 'description' => '结束时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1080', + ], + 'timeZone' => [ + 'description' => '时区', + 'type' => 'string', + 'example' => '"Asia/Shanghai"', + ], + ], + ], + 'EntityDiscoverRule' => [ + 'description' => '实体发现规则模型', + 'type' => 'object', + 'properties' => [ + 'ipMatchRule' => [ + 'title' => 'IP匹配规则集合。', + 'description' => 'IP匹配规则集合。', + 'type' => 'array', + 'items' => [ + 'title' => 'IP匹配规则。', + 'description' => 'IP匹配规则。', + 'type' => 'object', + 'properties' => [ + 'ipFieldKey' => [ + 'title' => 'IP字段的Key。', + 'description' => 'IP字段的Key。', + 'type' => 'string', + 'example' => 'hostIp', + ], + 'ipCIDR' => [ + 'title' => 'IP的CIDR。', + 'description' => 'IP的CIDR。', + 'type' => 'string', + 'example' => '192.168.0.1/10', + ], + ], + ], + ], + 'instanceIds' => [ + 'title' => '实例ID集合。', + 'description' => '实例ID集合。', + 'type' => 'array', + 'items' => [ + 'title' => '实例ID。', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-bp1gj8wyq4fxk28k6iy2', + ], + ], + 'fieldRules' => [ + 'title' => '属性匹配规则。', + 'description' => '属性匹配规则。', + 'type' => 'array', + 'items' => [ + 'title' => '属性详情。', + 'description' => '属性详情。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '操作。', + 'description' => '操作。', + 'type' => 'string', + 'example' => 'in', + ], + 'fieldKey' => [ + 'title' => '属性的Key。', + 'description' => '属性的Key。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'fieldValues' => [ + 'title' => '属性的值集合。', + 'description' => '属性的值集合。', + 'type' => 'array', + 'items' => [ + 'title' => '属性的值。', + 'description' => '属性的值。', + 'type' => 'string', + 'example' => 'i-bp1gj8wyq4fxk28k6iy2', + ], + ], + ], + ], + ], + 'annotations' => [ + 'title' => '注解匹配集合。', + 'description' => '注解匹配集合。', + 'type' => 'array', + 'items' => [ + 'title' => '注解详情。', + 'description' => '注解详情。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '操作。', + 'description' => '操作。', + 'type' => 'string', + 'example' => 'in', + ], + 'tagKey' => [ + 'title' => '注解的Key。', + 'description' => '注解的Key。', + 'type' => 'string', + 'example' => 'instanceId', + ], + 'tagValues' => [ + 'title' => '注解的值集合。', + 'description' => '注解的值集合。', + 'type' => 'array', + 'items' => [ + 'title' => '注解的值。', + 'description' => '注解的值。', + 'type' => 'string', + 'example' => 'i-bp1gj8wyq4fxk28k6iy2'."\n", + ], + ], + ], + ], + ], + 'resourceGroupId' => [ + 'title' => '资源组ID。', + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfm2m7atreujs1', + ], + 'entityTypes' => [ + 'title' => '实体类型集合。', + 'description' => '实体类型集合。', + 'type' => 'array', + 'items' => [ + 'title' => '实体类型。', + 'description' => '实体类型。', + 'type' => 'string', + 'example' => 'acs.ecs.instance', + ], + ], + 'regionIds' => [ + 'title' => '地域ID集合。', + 'description' => '地域ID集合。', + 'type' => 'array', + 'items' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + ], + 'tags' => [ + 'title' => '通过Tag进行服务发现。', + 'description' => '通过Tag进行服务发现。', + 'type' => 'array', + 'items' => [ + 'title' => '使用Tag的发现信息。', + 'description' => '使用Tag的发现信息。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '操作。', + 'description' => '操作。', + 'type' => 'string', + 'example' => 'in', + ], + 'tagKey' => [ + 'title' => 'Tag的Key。', + 'description' => 'Tag的Key。', + 'type' => 'string', + 'example' => 'project', + ], + 'tagValues' => [ + 'title' => 'Tag的值集合。', + 'description' => 'Tag的值集合。', + 'type' => 'array', + 'items' => [ + 'title' => 'Tag的值。', + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => 'demo', + ], + ], + ], + ], + ], + 'labels' => [ + 'title' => '标签匹配集合。', + 'description' => '标签匹配集合。', + 'type' => 'array', + 'items' => [ + 'title' => '标签详情。', + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '操作。', + 'description' => '操作。', + 'type' => 'string', + 'example' => 'in', + ], + 'tagKey' => [ + 'title' => '标签的Key。', + 'description' => '标签的Key。', + 'type' => 'string', + 'example' => 'project', + ], + 'tagValues' => [ + 'title' => '标签的值集合。', + 'description' => '标签的值集合。', + 'type' => 'array', + 'items' => [ + 'title' => '标签的值。', + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'demo', + ], + ], + ], + ], + ], + ], + ], + 'EntityGroupBase' => [ + 'title' => '实体的基础结构。', + 'description' => '实体的基础结构。', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => '工作空间。', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default-cms-1654218***343050-cn-hangzhou', + ], + 'regionId' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'entityQueries' => [ + 'title' => '实体查询规则集合。', + 'description' => '实体查询规则集合。', + 'type' => 'array', + 'items' => [ + 'title' => '实体查询规则。', + 'description' => '实体查询规则。', + 'type' => 'object', + 'properties' => [ + 'entityType' => [ + 'title' => '实体类型。', + 'description' => '实体类型。', + 'type' => 'string', + 'example' => 'acs.ecs.instance', + ], + 'spl' => [ + 'title' => 'SPL查询语句。', + 'description' => 'SPL查询语句。', + 'type' => 'string', + 'example' => '.entity with(type=\'acs.ecs.instance\') | where region_id in (\'cn-beijing\')', + ], + ], + ], + ], + 'description' => [ + 'title' => '实体描述。', + 'description' => '实体描述。', + 'type' => 'string', + 'example' => 'ECS 实例', + ], + 'entityGroupId' => [ + 'title' => '实体ID。', + 'description' => '实体ID。', + 'type' => 'string', + 'example' => 'eg-1234567890', + ], + 'entityRules' => [ + 'title' => '用于实体发现的规则。', + 'description' => '用于实体发现的规则。', + '$ref' => '#/components/schemas/EntityDiscoverRule', + ], + 'entityGroupName' => [ + 'title' => '实体名称。', + 'description' => '实体名称。', + 'type' => 'string', + 'example' => 'ECS 全部实体', + ], + 'userId' => [ + 'title' => '用户ID。', + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1654218***343050', + ], + ], + ], + 'Evaluator' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'type' => 'string', + ], + 'resultName' => [ + 'type' => 'string', + ], + 'dataScope' => [ + 'type' => 'string', + ], + 'resultType' => [ + 'type' => 'string', + ], + 'config' => [ + 'type' => 'object', + ], + 'filters' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'variableMapping' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'EventResourceForEventView' => [ + 'description' => '资源展示对象', + 'type' => 'object', + 'properties' => [ + 'entity' => [ + 'description' => '资源实体信息', + 'type' => 'object', + 'properties' => [ + 'domain' => [ + 'description' => '资源所属的产品域(Product Domain)', + 'type' => 'string', + 'example' => '"ECS"', + ], + 'entityType' => [ + 'description' => '资源的具体类型', + 'type' => 'string', + 'example' => '"Instance"', + ], + 'entityId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'example' => '"i-bp123456"', + ], + 'prop' => [ + 'description' => '资源的额外属性字段', + 'type' => 'object', + 'example' => '{ "name": "web-server-01", "ip": "10.0.0.1" }', + ], + ], + ], + 'tags' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'example' => '{ "env": "prod", "project": "payment-gateway" }', + ], + ], + ], + 'EventResourceForIncidentView' => [ + 'description' => '事件关联资源展示对象', + 'type' => 'object', + 'properties' => [ + 'tags' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => '[{\\"value\\":\\"测试\\",\\"key\\":\\"环境\\"}]', + ], + 'probs' => [ + 'description' => '资源的属性描述字符串', + 'type' => 'string', + 'example' => '"{"name":"web-server-01","ip":"10.0.0.1"}"', + ], + 'entityType' => [ + 'description' => '实体类型。', + 'type' => 'string', + 'example' => '"Instance"', + ], + 'entityId' => [ + 'description' => '实体id', + 'type' => 'string', + 'example' => 'default', + ], + 'domain' => [ + 'description' => '资源类型域。', + 'type' => 'string', + 'example' => 'rum', + ], + ], + ], + 'FilterSetting' => [ + 'description' => '过滤配置', + 'type' => 'object', + 'properties' => [ + 'expression' => [ + 'title' => '表达式', + 'description' => '表达式', + 'type' => 'string', + 'example' => '1 and 2 or 3', + ], + 'conditions' => [ + 'title' => '订阅条件', + 'description' => '订阅条件', + 'type' => 'array', + 'items' => [ + 'description' => '单个条件', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'title' => '比较符', + 'description' => '比较符', + 'type' => 'string', + 'example' => 'EQ', + ], + 'field' => [ + 'title' => '字段', + 'description' => '字段', + 'type' => 'string', + 'example' => 'severity', + ], + 'value' => [ + 'title' => '值', + 'description' => '值', + 'type' => 'string', + 'example' => 'CRITICAL', + ], + ], + ], + 'maxItems' => 10, + ], + 'relation' => [ + 'title' => '条件间关系', + 'description' => '条件间关系', + 'type' => 'string', + 'example' => 'AND', + ], + ], + ], + 'IncidentContactStruct' => [ + 'description' => '事件联系人结构', + 'type' => 'object', + 'properties' => [ + 'contactId' => [ + 'description' => '联系人id', + 'type' => 'string', + 'example' => '627415', + ], + 'channel' => [ + 'description' => '通道列表', + 'type' => 'array', + 'items' => [ + 'description' => '通道名', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + 'contactType' => [ + 'description' => '联系类型', + 'type' => 'string', + 'example' => 'GROUP', + ], + ], + ], + 'IncidentEscalationPolicyForModify' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace api monitor create test', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '"Critical-Alert-Escalation"', + ], + 'escalationStageList' => [ + 'description' => '升级阶段列表,定义多个逐级升级的步骤,每个阶段包含触发条件和通知目标', + 'type' => 'array', + 'items' => [ + 'description' => '升级阶段列表,定义多个逐级升级的步骤,每个阶段包含触发条件和通知目标', + '$ref' => '#/components/schemas/IncidentEscalationStageForView', + ], + ], + ], + ], + 'IncidentEscalationPolicyForView' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace api monitor update test', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '"Critical-Alert-Escalation"', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-04-15T02:02:50Z', + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '"user-abc123"', + ], + 'workspace' => [ + 'title' => 'workspace', + 'description' => '所属工作空间', + 'type' => 'string', + 'example' => '"ws-xyz789"', + ], + 'ownerType' => [ + 'description' => 'owner类型。'."\n" + ."\n" + .'- **USER**:用户类型,默认值'."\n" + ."\n" + .'- **APP**:App类型', + 'type' => 'string', + 'example' => '"USER"', + ], + 'source' => [ + 'description' => '来源', + 'type' => 'string', + 'example' => '"MANUAL"', + ], + 'syncFromType' => [ + 'description' => '同步策略,表示其来源类型', + 'type' => 'string', + 'example' => '"ARMS"', + ], + 'uuid' => [ + 'description' => '全局唯一标识符', + 'type' => 'string', + 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', + ], + 'regionId' => [ + 'description' => '所属地域 ID', + 'type' => 'string', + 'example' => '"cn-hangzhou"', + ], + 'escalationStageList' => [ + 'description' => '升级阶段列表', + 'type' => 'array', + 'items' => [ + 'description' => '升级阶段列表', + '$ref' => '#/components/schemas/IncidentEscalationStageForView', + ], + ], + ], + ], + 'IncidentEscalationStageForView' => [ + 'description' => '升级阶段展示对象', + 'type' => 'object', + 'properties' => [ + 'cycleNotifyInterval' => [ + 'description' => '循环通知间隔', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'cycleNotifyCount' => [ + 'description' => '循环通知次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'triggerDelay' => [ + 'description' => '触发延迟时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'effectTimeRange' => [ + 'description' => '生效时间范围', + '$ref' => '#/components/schemas/EffectTimeRange', + ], + 'targetIncidentState' => [ + 'description' => '目标事件状态', + 'type' => 'string', + 'example' => '"Open"', + ], + 'index' => [ + 'description' => '阶段索引', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'notifyChannels' => [ + 'description' => '通知渠道列表', + 'type' => 'array', + 'items' => [ + 'description' => '通知渠道', + '$ref' => '#/components/schemas/NotifyChannel', + ], + ], + ], + ], + 'IncidentEscalationStageStruct' => [ + 'description' => '事件升级阶段结构', + 'type' => 'object', + 'properties' => [ + 'stageIndex' => [ + 'description' => '阶段指数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'cycleNotifyTime' => [ + 'description' => '周期通知时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'contact' => [ + 'description' => '联系人列表', + 'type' => 'array', + 'items' => [ + 'description' => '事件联系人结构体', + '$ref' => '#/components/schemas/IncidentContactStruct', + ], + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => '运维团队', + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '负责处理生产环境告警的主负责人', + ], + 'timeZone' => [ + 'description' => '时区', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'effectTime' => [ + 'description' => '有效时间', + 'type' => 'string', + 'example' => '2025-04-05T00:00:00Z', + ], + 'waitToNextStageTime' => [ + 'description' => '等待进入下一阶段的时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + 'cycleNotifyCount' => [ + 'description' => '周期通知统计次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'IncidentEscalationStruct' => [ + 'description' => '事件升级结构', + 'type' => 'object', + 'properties' => [ + 'incidentEscalationId' => [ + 'description' => '事件升级ID', + 'type' => 'string', + 'example' => '52631388567', + ], + 'workspace' => [ + 'description' => '工作空间', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'modifyTime' => [ + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2025-03-11T08:21:58Z', + ], + 'stage' => [ + 'description' => '阶段', + 'type' => 'array', + 'items' => [ + 'description' => '事件升级阶段结构体', + '$ref' => '#/components/schemas/IncidentEscalationStageStruct', + ], + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2025-03-11T08:21:58Z', + ], + 'regionId' => [ + 'description' => '地域 ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => '生产环境告警升级策略', + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '当告警未响应时,依次通知运维团队、值班经理、CTO', + ], + ], + ], + 'IncidentEventForView' => [ + 'description' => '事件展示对象', + 'type' => 'object', + 'properties' => [ + 'incidentUuid' => [ + 'description' => '事件所属的故障单唯一标识符', + 'type' => 'string', + 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', + ], + 'userId' => [ + 'description' => '创建或触发该事件的用户 ID', + 'type' => 'string', + 'example' => '"user-abc123"', + ], + 'time' => [ + 'description' => '事件发生时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743876000000', + ], + 'incidentEventUuid' => [ + 'description' => '事件本身的唯一标识符', + 'type' => 'string', + 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', + ], + 'title' => [ + 'description' => '事件标题', + 'type' => 'string', + 'example' => '"ECS 实例 i-bp123456 CPU 使用率超过 90%"', + ], + 'workspace' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => '"ws-xyz789"', + ], + 'dimension' => [ + 'description' => '事件维度信息', + 'type' => 'object', + 'example' => '{ "env": "prod", "module": "payment" }', + ], + 'labels' => [ + 'description' => '自定义标签键值对', + 'type' => 'object', + 'example' => '{ "project": "payment-gateway", "owner": "ops-team" }', + ], + 'groupBy' => [ + 'description' => '分组依据', + 'type' => 'object', + 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', + ], + 'eventResource' => [ + 'description' => '关联的资源信息', + '$ref' => '#/components/schemas/EventResourceForIncidentView', + ], + 'content' => [ + 'description' => '事件详细内容', + '$ref' => '#/components/schemas/CmsEventForView', + ], + 'severity' => [ + 'description' => '事件严重等级', + 'type' => 'string', + 'example' => '"Critical"', + ], + 'count' => [ + 'description' => '该事件的触发次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'severityCountMap' => [ + 'description' => '各严重级别事件的数量统计', + 'type' => 'object', + 'example' => '{ "Critical": 2, "High": 1 }', + ], + 'lastTime' => [ + 'description' => '最后一次触发时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743876000000', + ], + 'recoverTime' => [ + 'description' => '恢复时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743876600000', + ], + 'autoRecoverTime' => [ + 'description' => '自动恢复时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743876600000', + ], + 'state' => [ + 'description' => '事件当前状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'searchIndex' => [ + 'description' => '搜索索引字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '搜索索引字段', + 'type' => 'string', + 'example' => '["ECS", "CPU", "high"]', + ], + ], + 'textIndex' => [ + 'description' => '文本索引字段', + 'type' => 'string', + 'example' => '"ECS 实例 CPU 使用率过高"', + ], + ], + ], + 'IncidentEventStruct' => [ + 'description' => '事件事件结构。', + 'type' => 'object', + 'properties' => [ + 'lastTime' => [ + 'description' => '最后时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'recoverTime' => [ + 'description' => '手动恢复时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'autoRecoverTime' => [ + 'description' => '自动恢复时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'resource' => [ + 'description' => '描述事件关联的资源信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'map', + 'type' => 'string', + 'example' => 'map', + ], + ], + 'count' => [ + 'description' => '统计数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'groupBy' => [ + 'description' => '用于分组维度。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'map。', + 'type' => 'string', + 'example' => 'map', + ], + ], + 'title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => '用户服务 CPU 使用率过高', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'content' => [ + 'description' => '内容。', + 'type' => 'string', + 'example' => '检测到 user-service 实例 i-abc123 的 CPU 使用率达到 95%,已触发告警。', + ], + 'time' => [ + 'description' => '时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'incidentId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'incident-001', + ], + 'incidentEventId' => [ + 'description' => '事件事件ID。', + 'type' => 'string', + 'example' => 'event-001', + ], + 'dimension' => [ + 'description' => '维度。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'map', + 'type' => 'string', + 'example' => 'map', + ], + ], + 'status' => [ + 'description' => '状态。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'Running', + ], + ], + ], + 'IncidentForView' => [ + 'description' => '故障单展示对象', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '故障单的详细内容', + 'type' => 'string', + 'example' => '"{"description":"ECS实例CPU过高","impact":"支付服务延迟"}"', + ], + 'incidentId' => [ + 'description' => '故障单唯一标识符', + 'type' => 'string', + 'example' => '"incident-abc123"', + ], + 'plan' => [ + 'description' => '响应计划', + '$ref' => '#/components/schemas/IncidentResponsePlanForView', + ], + 'severity' => [ + 'description' => '故障严重等级', + 'type' => 'string', + 'example' => '"Critical"', + ], + 'time' => [ + 'description' => '故障创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743876000000', + ], + 'title' => [ + 'description' => '故障标题', + 'type' => 'string', + 'example' => '"支付服务不可用"', + ], + 'userId' => [ + 'description' => '创建该故障单的用户 ID', + 'type' => 'string', + 'example' => '"user-abc123"', + ], + 'workspace' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => '"ws-xyz789"', + ], + 'groupUuid' => [ + 'description' => '分组标识。', + 'type' => 'string', + 'example' => '"group-123456"', + ], + 'state' => [ + 'description' => '故障当前状态', + 'type' => 'string', + 'example' => '"Open"', + ], + 'notifyStrategyUuid' => [ + 'description' => '关联的通知策略 UUID,用于触发通知', + 'type' => 'string', + 'example' => '"notify-strategy-789"', + ], + 'subscriptionUuid' => [ + 'description' => '订阅策略 UUID', + 'type' => 'string', + 'example' => '"subscription-abc"', + ], + 'operator' => [ + 'description' => '操作人信息', + '$ref' => '#/components/schemas/ContactForIncidentView', + ], + 'notifyStrategyName' => [ + 'description' => '通知策略名称', + 'type' => 'string', + 'example' => '{ "contactId": "contact-123", "name": "张三" }', + ], + 'subscriptionName' => [ + 'description' => '订阅策略名称', + 'type' => 'string', + 'example' => '"P1-Alert-Notification"', + ], + 'escalations' => [ + 'description' => '升级策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '升级策略', + '$ref' => '#/components/schemas/IncidentEscalationPolicyForView', + ], + ], + 'owners' => [ + 'description' => '责任人列表', + 'type' => 'array', + 'items' => [ + 'description' => '责任人', + '$ref' => '#/components/schemas/ContactForIncidentView', + ], + ], + 'participants' => [ + 'description' => '参与者列表', + 'type' => 'array', + 'items' => [ + 'description' => '参与者', + '$ref' => '#/components/schemas/ContactForIncidentView', + ], + ], + 'groupingKeys' => [ + 'description' => '分组键值对', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '分组键值对', + 'type' => 'string', + 'example' => '{ "resourceId": "i-bp123456", "severity": "Critical" }', + ], + ], + 'relatedResources' => [ + 'description' => '关联资源列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联资源', + '$ref' => '#/components/schemas/EventResourceForIncidentView', + ], + ], + 'solution' => [ + 'description' => '解决方案描述', + 'type' => 'string', + 'example' => '"重启ECS实例后恢复正常"', + ], + 'rootCauseCategory' => [ + 'description' => '根本原因分类', + 'type' => 'string', + 'example' => '"Network"', + ], + ], + ], + 'IncidentMemberStruct' => [ + 'description' => '事件成员结构。', + 'type' => 'object', + 'properties' => [ + 'acknowledge' => [ + 'description' => '确认信息结构体。', + 'type' => 'object', + 'properties' => [ + 'breakLevel' => [ + 'description' => '确认级别。', + 'type' => 'string', + 'example' => '2', + ], + 'verifyTime' => [ + 'description' => '验证时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + ], + ], + 'incidentMemberId' => [ + 'description' => '事件成员ID。', + 'type' => 'string', + 'example' => 'member-001', + ], + 'contactId' => [ + 'description' => '联系人ID。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'escalation' => [ + 'description' => '升级阶段信息。', + 'type' => 'object', + 'properties' => [ + 'stageIndex' => [ + 'description' => '升级阶段索引。', + 'type' => 'string', + 'example' => '1', + ], + 'incidentEscalationId' => [ + 'description' => '事件升级ID。', + 'type' => 'string', + 'example' => 'escalation-001', + ], + 'name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => '第一阶段', + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => '通知运维团队', + ], + 'title' => [ + 'description' => '标题。', + 'type' => 'string', + 'example' => '告警升级至运维团队', + ], + ], + ], + 'scheduleGroup' => [ + 'description' => '调度组。', + 'type' => 'object', + 'properties' => [ + 'contactId' => [ + 'description' => '联系人ID。', + 'type' => 'string', + 'example' => 'group-001', + ], + 'name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => '夜间值班组', + ], + ], + ], + 'time' => [ + 'description' => '时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2025-10-08 10:18:58', + ], + 'incidentId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'incident-001', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4123456', + ], + 'contacts' => [ + 'description' => '联系人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人详情。', + 'type' => 'object', + 'properties' => [ + 'contactMask' => [ + 'description' => '联系人 ID(脱敏)。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'channel' => [ + 'description' => '通道。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + ], + ], + ], + ], + ], + 'IncidentNoteStruct' => [ + 'description' => '事件记录结构', + 'type' => 'object', + 'properties' => [ + 'format' => [ + 'description' => '内容格式。', + 'type' => 'string', + 'example' => 'markdown', + ], + 'noteId' => [ + 'description' => '记录ID。', + 'type' => 'string', + 'example' => 'note-001', + ], + 'time' => [ + 'description' => '时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'incidentId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'incident-001', + ], + 'type' => [ + 'description' => '类型。', + 'type' => 'string', + 'example' => 'apm', + ], + 'content' => [ + 'description' => '内容。', + 'type' => 'string', + 'example' => '已联系运维团队,正在排查问题。', + ], + 'operator' => [ + 'description' => '操作符。', + 'type' => 'object', + 'properties' => [ + 'contactId' => [ + 'description' => '联系人id。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'contact' => [ + 'description' => '联系人。', + 'type' => 'string', + 'example' => '{\\"mobile_phone_num\\":\\"153xxxx8040\\",\\"mobile_country_code\\":\\"86\\",\\"email\\":\\"[email protected]\\"}', + ], + 'name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => '张三', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4123456', + ], + ], + ], + ], + ], + 'IncidentPlanCorporationStruct' => [ + 'description' => '事件预案协作结构。', + 'type' => 'object', + 'properties' => [ + 'channel' => [ + 'description' => '通道名。', + 'type' => 'string', + 'example' => 'ecs', + ], + 'robotId' => [ + 'description' => '机器人唯一ID。', + 'type' => 'string', + 'example' => 'robotId-cs-api-test', + ], + ], + ], + 'IncidentPlanFieldPath' => [ + 'description' => '用于定义事件预案中字段映射路径的结构体。', + 'type' => 'object', + 'properties' => [ + 'fieldAlias' => [ + 'description' => '字段别名。', + 'type' => 'string', + 'example' => '服务名称', + ], + 'fieldPath' => [ + 'description' => '字段路径的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段路径。', + 'type' => 'string', + 'example' => 'service.name', + ], + ], + ], + ], + 'IncidentPlanStruct' => [ + 'description' => '事件预案结构体。', + 'type' => 'object', + 'properties' => [ + 'escalationId' => [ + 'description' => '升级策略 ID的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '升级策略 ID。', + 'type' => 'string', + 'example' => 'escalation-001', + ], + ], + 'gmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'workspace' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'resourceFiled' => [ + 'description' => '资源字段映射路径的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源字段映射路径。', + '$ref' => '#/components/schemas/IncidentPlanFieldPath', + ], + ], + 'corporation' => [ + 'description' => '参与协作的团队或角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件预案结构体。', + '$ref' => '#/components/schemas/IncidentPlanCorporationStruct', + ], + ], + 'description' => [ + 'description' => '预案描述。', + 'type' => 'string', + 'example' => '针对数据库连接数过高的应急处理方案', + ], + 'autoRecoverSeconds' => [ + 'description' => '自动恢复等待时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'groupBy' => [ + 'description' => '分组字段路径', + 'type' => 'array', + 'items' => [ + 'description' => '事件预案中字段映射路径的结构体。', + '$ref' => '#/components/schemas/IncidentPlanFieldPath', + ], + ], + 'gmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'userId' => [ + 'description' => '用户 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'uesr-12345', + ], + 'closeExpire' => [ + 'description' => '事件关闭超时时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '86400000', + ], + 'name' => [ + 'description' => '预案名称。', + 'type' => 'string', + 'example' => '数据库连接数告警预案', + ], + 'incidentPlanId' => [ + 'description' => '事件预案 ID。', + 'type' => 'string', + 'example' => 'plan-001', + ], + 'status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + 'IncidentResourceDetail' => [ + 'description' => '用于描述 事件关联资源详情 的结构体。', + 'type' => 'object', + 'properties' => [ + 'resourceId' => [ + 'description' => '资源 ID 对象。', + 'type' => 'object', + 'example' => '{ "type": "ecs", "id": "i-bp1234567890abcdef" }', + ], + 'extraId' => [ + 'description' => '额外的资源标识符。', + 'type' => 'string', + 'example' => 'app-prod-web-01', + ], + 'type' => [ + 'description' => '资源类型,表示该资源属于哪种云产品。', + 'type' => 'string', + 'example' => 'ecs', + ], + ], + ], + 'IncidentResourceStruct' => [ + 'description' => '用于描述 事件关联资源 的结构体。', + 'type' => 'object', + 'properties' => [ + 'resource' => [ + 'description' => '事件资源详情对象。', + '$ref' => '#/components/schemas/IncidentResourceDetail', + ], + 'description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => '生产环境 Web 服务器', + ], + 'incidentResourceId' => [ + 'description' => '事件中该资源的唯一 ID。', + 'type' => 'string', + 'example' => 'res-001', + ], + 'source' => [ + 'description' => '来源。', + 'type' => 'string', + 'example' => 'cloudmonitor', + ], + 'time' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'incidentId' => [ + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'incident-001', + ], + 'userId' => [ + 'description' => '用户 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'user-12345', + ], + ], + ], + 'IncidentResponsePlanForView' => [ + 'description' => '响应计划展示对象', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '响应计划类型', + 'type' => 'string', + 'example' => '"Standard"', + ], + 'source' => [ + 'description' => '来源', + 'type' => 'string', + 'example' => '"MANUAL"', + ], + 'escalationId' => [ + 'description' => '关联的升级策略 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '升级策略 ID', + 'type' => 'string', + 'example' => '"escalation-123"', + ], + ], + 'repeatNotifySetting' => [ + 'description' => '循环通知设置', + '$ref' => '#/components/schemas/RepeatNotifySetting', + ], + 'mode' => [ + 'description' => '响应模式', + 'type' => 'string', + 'example' => '"Manual"', + ], + 'autoRecoverSeconds' => [ + 'description' => '自动恢复时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'syncFromType' => [ + 'description' => '同步策略来源类型', + 'type' => 'string', + 'example' => '"ARMS"', + ], + 'pushingSetting' => [ + 'description' => '推送设置', + '$ref' => '#/components/schemas/PushingSetting', + ], + 'name' => [ + 'description' => '响应计划名称', + 'type' => 'string', + 'example' => '"P1-Critical-Response-Plan"', + ], + 'uuid' => [ + 'description' => '全局唯一标识符', + 'type' => 'string', + 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', + ], + 'workspace' => [ + 'description' => '工作空间', + 'type' => 'string', + 'example' => '"ws-xyz789"', + ], + 'description' => [ + 'description' => '响应计划描述', + 'type' => 'string', + 'example' => '"针对支付服务不可用的紧急响应流程"', + ], + 'enabled' => [ + 'description' => '是否启用该响应计划', + 'type' => 'boolean', + 'example' => 'true', + ], + 'createTime' => [ + 'description' => '计划创建时间', + 'type' => 'string', + 'example' => '"2025-04-05T10:30:00Z"', + ], + 'updateTime' => [ + 'description' => '计划最后更新时间', + 'type' => 'string', + 'example' => '"2025-04-06T09:15:00Z"', + ], + ], + ], + 'IncidentStruct' => [ + 'description' => '用于表示 一个完整事件(Incident)的核心结构体。', + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'description' => '事件严重等级。', + 'type' => 'string', + 'example' => 'P1', + ], + 'escalations' => [ + 'description' => '升级策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件升级结构体。', + '$ref' => '#/components/schemas/IncidentEscalationStruct', + ], + ], + 'resource' => [ + 'description' => '关联的资源详情。', + '$ref' => '#/components/schemas/IncidentResourceDetail', + ], + 'incidentPlan' => [ + 'description' => '关联的事件预案。', + '$ref' => '#/components/schemas/IncidentPlanStruct', + ], + 'time' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'incidentId' => [ + 'description' => '事件唯一 ID。', + 'type' => 'string', + 'example' => 'incident-001', + ], + 'title' => [ + 'description' => '事件标题。', + 'type' => 'string', + 'example' => '数据库连接数过高', + ], + 'userId' => [ + 'description' => '用户 ID。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'content' => [ + 'description' => '事件内容。', + 'type' => 'string', + 'example' => '检测到 RDS 实例 rds-bp1234567890abcdef 的连接数达到 1000,已触发告警。', + ], + 'status' => [ + 'description' => '当前状态。', + 'type' => 'string', + 'example' => 'OPEN', + ], + ], + ], + 'IncidentTimeline' => [ + 'description' => '用于记录事件处理过程中的时间线节点的结构体', + 'type' => 'object', + 'properties' => [ + 'childType' => [ + 'description' => '子类型。', + 'type' => 'string', + 'example' => 'comment', + ], + 'incidentTimelineId' => [ + 'description' => '时间线节点唯一 ID。', + 'type' => 'string', + 'example' => 'timeline-001', + ], + 'timelineId' => [ + 'description' => '所属时间线 ID。', + 'type' => 'string', + 'example' => 'timeline-main-001', + ], + 'time' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741234567890', + ], + 'incidentId' => [ + 'description' => '所属事件 ID。', + 'type' => 'string', + 'example' => 'incident-001', + ], + 'title' => [ + 'description' => '时间线标题。', + 'type' => 'string', + 'example' => '已联系运维团队', + ], + 'type' => [ + 'description' => '类型。', + 'type' => 'string', + 'example' => 'ACTION', + ], + 'userId' => [ + 'description' => '用户 ID。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'content' => [ + 'description' => '内容。', + 'type' => 'string', + 'example' => '已通知运维团队进行排查', + ], + ], + ], + 'IncidentTimelineForView' => [ + 'description' => '事件时间线展示对象', + 'type' => 'object', + 'properties' => [ + 'incidentUuid' => [ + 'description' => '所属事件的唯一标识符', + 'type' => 'string', + 'example' => '"a1b2c3d4-e5f6-7890-1234-567890abcdef"', + ], + 'userId' => [ + 'description' => '用户 ID', + 'type' => 'string', + 'example' => '"user-abc123"', + ], + 'time' => [ + 'description' => '时间线事件发生时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743876000000', + ], + 'timelineUuid' => [ + 'description' => '时间线记录本身的唯一标识符', + 'type' => 'string', + 'example' => '"x1y2z3a4-b5c6-d7e8-f9g0-h1i2j3k4l5m6"', + ], + 'type' => [ + 'description' => '时间线事件类型', + 'type' => 'string', + 'example' => '"Comment"', + ], + 'changeType' => [ + 'description' => '状态变更类型', + 'type' => 'string', + 'example' => '"Open -> In Progress"', + ], + 'title' => [ + 'description' => '时间线标题', + 'type' => 'string', + 'example' => '"故障已升级至值班主管"', + ], + 'content' => [ + 'description' => '时间线内容', + 'type' => 'any', + 'example' => '"{"action":"restart","resourceId":"i-bp123456"}"', + ], + 'workspace' => [ + 'description' => '所属工作空间', + 'type' => 'string', + 'example' => '"ws-xyz789"', + ], + 'operator' => [ + 'description' => '操作人信息', + '$ref' => '#/components/schemas/ContactForIncidentView', + ], + ], + ], + 'MaintainWindowForModify' => [ + 'title' => 'A short description of struct', + 'description' => '静默策略对象。', + 'type' => 'object', + 'properties' => [ + 'effective' => [ + 'title' => 'Crontab 表达式', + 'description' => 'Crontab 表达式', + 'type' => 'string', + 'example' => '* * 14-18 ? * *', + ], + 'description' => [ + 'title' => '创建时间', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'filterSetting' => [ + 'description' => '筛选条件', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'maintainWindowName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test strategy', + ], + 'startTime' => [ + 'title' => '生效开始时间', + 'description' => '生效开始时间', + 'type' => 'string', + 'example' => '2025-04-11 07:55:00', + ], + 'effectTimeRange' => [ + 'description' => '生效时间范围', + 'type' => 'object', + 'properties' => [ + 'startTimeInMinute' => [ + 'title' => '开始时间(分钟数)', + 'description' => '开始时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1438', + 'minimum' => '0', + 'example' => '60', + ], + 'timeZone' => [ + 'title' => '时区', + 'description' => '时区', + 'type' => 'string', + 'example' => '+08:00', + ], + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => [ + 'description' => '0-6 表示周日到周六', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'endTimeInMinute' => [ + 'title' => '结束时间(分钟数)', + 'description' => '结束时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1439', + 'minimum' => '0', + 'example' => '60', + ], + ], + ], + 'endTime' => [ + 'title' => '生效结束时间', + 'description' => '生效结束时间', + 'type' => 'string', + 'example' => '2024-09-05 09:30:40', + ], + ], + ], + 'MaintainWindowForView' => [ + 'title' => 'A short description of struct', + 'description' => '沉默策略对象。', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => 'workspace', + 'description' => 'workspace', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'maintainWindowId' => [ + 'title' => 'UUID', + 'description' => 'UUID', + 'type' => 'string', + 'example' => '123-12-312-31-23123', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'filterSetting' => [ + 'description' => '筛选条件', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'maintainWindowName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试策略', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-05-07T02:19:05Z', + ], + 'effectTimeRange' => [ + 'description' => '生效时间范围', + 'type' => 'object', + 'properties' => [ + 'startTimeInMinute' => [ + 'title' => '开始时间(分钟数)', + 'description' => '开始时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1438', + 'minimum' => '0', + 'example' => '60', + ], + 'timeZone' => [ + 'title' => '时区', + 'description' => '时区', + 'type' => 'string', + 'example' => '+08:00', + ], + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => [ + 'description' => '0-6 标志周日到周六', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + 'endTimeInMinute' => [ + 'title' => '结束时间(分钟数)', + 'description' => '结束时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1439', + 'minimum' => '0', + 'example' => '360', + ], + ], + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '12312312***', + ], + 'effective' => [ + 'title' => 'Crontab 表达式', + 'description' => 'Crontab 表达式', + 'type' => 'string', + 'example' => '* * 14-18 ? * *', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'startTime' => [ + 'title' => '生效开始时间', + 'description' => '生效开始时间', + 'type' => 'string', + 'example' => '2024-11-26 10:02:01', + ], + 'endTime' => [ + 'title' => '生效结束时间', + 'description' => '生效结束时间', + 'type' => 'string', + 'example' => '2024-11-26 12:02:01', + ], + ], + ], + 'MergeContact' => [ + 'description' => '用于表示 联系人信息的合并对象 的结构体。', + 'type' => 'object', + 'properties' => [ + 'gmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'name' => [ + 'description' => '联系人姓名。', + 'type' => 'string', + 'example' => '张三', + ], + 'gmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'identifier' => [ + 'description' => '联系人唯一标识符。', + 'type' => 'string', + 'example' => 'user-12345', + ], + 'phoneCode' => [ + 'description' => '手机号码国家区号。', + 'type' => 'string', + 'example' => '86', + ], + 'phone' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '13800138000', + ], + 'phoneVerify' => [ + 'description' => '手机号码是否已验证。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'email' => [ + 'description' => '邮箱地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'emailVerify' => [ + 'description' => '邮箱是否已验证。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'lang' => [ + 'description' => '语言偏好。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'source' => [ + 'description' => '联系人来源系统。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + 'extend' => [ + 'description' => '扩展字段,用于存储额外信息。', + 'type' => 'object', + 'example' => '{ "department": "运维部", "role": "工程师" }', + ], + ], + ], + 'MergeContactGroup' => [ + 'description' => '用于表示 联系人组的合并对象 的结构体。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '联系人组名称。', + 'type' => 'string', + 'example' => '运维团队', + ], + 'gmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'identifier' => [ + 'description' => '联系人组唯一标识符。', + 'type' => 'string', + 'example' => 'group-12345', + ], + 'gmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'contacts' => [ + 'description' => '组内成员的唯一标识符列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组内成员的唯一标识符。', + 'type' => 'string', + 'example' => 'user-12345', + ], + ], + 'extend' => [ + 'description' => '扩展字段,用于存储额外信息。', + 'type' => 'object', + 'example' => '{ "department": "运维部", "role": "工程师" }', + ], + 'source' => [ + 'description' => '联系人组来源系统。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + ], + ], + 'MergeRobot' => [ + 'description' => '用于表示 机器人(Bot)的合并对象 的结构体。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '机器人名称。', + 'type' => 'string', + 'example' => '运维告警机器人', + ], + 'webhook' => [ + 'description' => 'Webhook 地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', + ], + 'type' => [ + 'description' => '机器人类型。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + 'createTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'gmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'identifier' => [ + 'description' => '机器人唯一标识符。', + 'type' => 'string', + 'example' => 'robot-12345', + ], + 'lang' => [ + 'description' => '语言偏好。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'extend' => [ + 'description' => '扩展字段。', + 'type' => 'object', + 'properties' => [ + 'dailyNoc' => [ + 'description' => '是否启用每日值班报告。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'dingSignKey' => [ + 'description' => '钉钉签名密钥。', + 'type' => 'string', + 'example' => 'abc123', + ], + 'enableOutgoing' => [ + 'description' => '是否启用出站请求。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'cardTemplate' => [ + 'description' => '卡片模板。', + 'type' => 'string', + 'example' => 'incident-card-template', + ], + 'dailyNocTime' => [ + 'description' => '每日值班报告时间。', + 'type' => 'string', + 'example' => '09:00', + ], + 'token' => [ + 'description' => '认证令牌。', + 'type' => 'string', + 'example' => 'token-abc123', + ], + ], + ], + 'source' => [ + 'description' => '机器人来源系统。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + ], + ], + 'MergeWebhook' => [ + 'description' => '用于表示 Webhook 的合并对象 的结构体。', + 'type' => 'object', + 'properties' => [ + 'gmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'name' => [ + 'description' => 'Webhook 名称。', + 'type' => 'string', + 'example' => '运维告警通知', + ], + 'gmtModified' => [ + 'description' => '最后修改时间。', + 'type' => 'object', + 'example' => '2025-03-11T08:21:58.789Z', + ], + 'identifier' => [ + 'description' => 'Webhook 唯一标识符。', + 'type' => 'string', + 'example' => 'webhook-12345', + ], + 'webhook' => [ + 'description' => 'Webhook 地址,用于发送请求。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=abc123', + ], + 'type' => [ + 'description' => 'Webhook 类型,表示其目标平台。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + 'headers' => [ + 'description' => '请求头信息。', + 'type' => 'string', + 'example' => '{"Authorization": "Bearer abc123"}', + ], + 'method' => [ + 'description' => 'HTTP 请求方法。', + 'type' => 'string', + 'example' => 'POST', + ], + 'contentType' => [ + 'description' => '内容类型。', + 'type' => 'string', + 'example' => 'application/json', + ], + 'lang' => [ + 'description' => '语言偏好。', + 'type' => 'string', + 'example' => 'zh-CN', + ], + 'extend' => [ + 'description' => '扩展字段,用于存储额外配置。', + 'type' => 'string', + 'example' => '{"timeout": 3000}', + ], + 'source' => [ + 'description' => 'Webhook 来源系统。', + 'type' => 'string', + 'example' => 'dingtalk', + ], + ], + ], + 'NotifyChannel' => [ + 'description' => '通知渠道配置对象', + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'description' => '通知渠道类型', + 'type' => 'string', + 'example' => '"DingTalk"', + ], + 'receivers' => [ + 'description' => '接收者列表', + 'type' => 'array', + 'items' => [ + 'description' => '接收者。', + 'type' => 'string', + 'example' => '[]', + ], + ], + 'enabledSubChannels' => [ + 'description' => '启用的子渠道列表', + 'type' => 'array', + 'items' => [ + 'description' => '渠道', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + 'NotifyStrategyForModify' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'groupingSetting' => [ + 'title' => '合并设置', + 'description' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'description' => '合并keys', + 'type' => 'array', + 'items' => [ + 'description' => '合并字段', + 'type' => 'string', + 'example' => 'severity', + ], + ], + 'periodMin' => [ + 'title' => '检查周期分钟数', + 'description' => '检查周期分钟数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'silenceSec' => [ + 'title' => '沉默秒数', + 'description' => '沉默秒数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'times' => [ + 'title' => '触发次数', + 'description' => '触发次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'required' => true, + ], + 'ignoreRestoredNotification' => [ + 'title' => '恢复是否通知', + 'description' => '恢复是否通知', + 'type' => 'boolean', + 'example' => 'false', + ], + 'notifyStrategyName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '策略名称', + ], + 'routes' => [ + 'title' => '通知渠道路由设置', + 'description' => '通知渠道路由设置', + 'type' => 'array', + 'items' => [ + 'description' => '通知渠道路由设置', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'description' => '通知渠道', + 'type' => 'array', + 'items' => [ + 'description' => '通知渠道。', + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => '渠道类型', + 'type' => 'string', + 'required' => true, + 'example' => 'CONTACT', + 'enum' => [ + 'DING', + 'WEIXIN', + 'FEISHU', + 'SLACK', + 'TEAMS', + 'CONTACT', + 'GROUP', + 'DUTY', + 'DING_COOL_APP', + ], + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'description' => '启用通知类型', + 'type' => 'array', + 'items' => [ + 'description' => '通知渠道', + 'type' => 'string', + 'example' => 'SMS', + ], + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'description' => '渠道接收方', + 'type' => 'array', + 'items' => [ + 'description' => '指定接受人', + 'type' => 'string', + 'example' => 'contactId', + ], + 'required' => true, + ], + ], + ], + ], + 'effectTimeRange' => [ + 'title' => '字段', + 'description' => '有效时间范围', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => [ + 'description' => '1-7 表示周一到周日', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'endTimeInMinute' => [ + 'title' => '结束时间(分钟数)', + 'description' => '结束时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1439', + 'minimum' => '0', + 'example' => '30', + ], + 'startTimeInMinute' => [ + 'title' => '开始时间(分钟数)', + 'description' => '开始时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1438', + 'minimum' => '0', + 'example' => '60', + ], + 'timeZone' => [ + 'title' => '时区', + 'description' => '时区', + 'type' => 'string', + 'example' => '+08:00', + ], + ], + ], + 'filterSetting' => [ + 'description' => '路由条件', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'severities' => [ + 'description' => '严重级别列表', + 'type' => 'array', + 'items' => [ + 'description' => '严重级别,CRITICAL WARNING INFO', + 'type' => 'string', + 'example' => 'INFO', + ], + ], + 'digitalEmployeeName' => [ + 'type' => 'string', + ], + 'enableRca' => [ + 'type' => 'boolean', + ], + ], + ], + 'required' => true, + ], + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'description' => '通知渠道模板', + 'type' => 'array', + 'items' => [ + 'description' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'targetType' => [ + 'title' => '通知类型', + 'description' => '通知类型', + 'type' => 'string', + 'required' => true, + 'example' => 'SMS', + ], + 'templateUuid' => [ + 'title' => '模板UUID', + 'description' => '模板UUID', + 'type' => 'string', + 'required' => true, + 'example' => '123123-12-31-231-23-12-3123', + ], + ], + ], + ], + 'enableIncidentManagement' => [ + 'description' => '是否启用事件管理', + 'type' => 'boolean', + 'example' => 'true', + ], + 'filterSetting' => [ + 'description' => '过滤设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'workspaceFilterSetting' => [ + 'description' => '工作空间过滤设置', + '$ref' => '#/components/schemas/WorkspaceFilterSetting', + ], + 'pushingSetting' => [ + 'description' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => [ + 'description' => '消息模板 UUID', + 'type' => 'string', + 'example' => '模板 UUID', + ], + 'alertActionIds' => [ + 'description' => '告警动作 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '告警动作 ID', + 'type' => 'string', + 'example' => '["action-123", "action-456"]', + ], + ], + 'restoreActionIds' => [ + 'description' => '恢复动作 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '恢复动作 ID', + 'type' => 'string', + 'example' => '["restore-789"]', + ], + ], + ], + ], + 'repeatNotifySetting' => [ + 'description' => '循环通知设置', + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => [ + 'description' => '结束事件状态', + 'type' => 'string', + 'example' => '"Resolved"', + ], + 'repeatInterval' => [ + 'description' => '重复通知的时间间隔', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'autoRecoverSeconds' => [ + 'description' => '自动恢复时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'escalationId' => [ + 'description' => '升级策略 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '升级策略 ID', + 'type' => 'string', + 'example' => '["escalation-123", "escalation-456"]', + ], + ], + ], + ], + 'NotifyStrategyForView' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'groupingSetting' => [ + 'title' => '合并设置', + 'description' => '合并设置', + 'type' => 'object', + 'properties' => [ + 'groupingKeys' => [ + 'title' => '合并keys', + 'description' => '合并keys', + 'type' => 'array', + 'items' => [ + 'description' => '合并key', + 'type' => 'string', + 'example' => 'severity', + ], + ], + 'periodMin' => [ + 'title' => '检查周期分钟数', + 'description' => '检查周期分钟数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'silenceSec' => [ + 'title' => '沉默秒数', + 'description' => '沉默秒数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'times' => [ + 'title' => '触发次数', + 'description' => '触发次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + 'required' => true, + ], + 'ignoreRestoredNotification' => [ + 'title' => '恢复是否通知', + 'description' => '恢复是否通知', + 'type' => 'boolean', + 'example' => 'true', + ], + 'notifyStrategyName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试策略', + ], + 'routes' => [ + 'title' => '通知渠道路由设置', + 'description' => '通知渠道路由设置', + 'type' => 'array', + 'items' => [ + 'description' => '路由对象', + 'type' => 'object', + 'properties' => [ + 'channels' => [ + 'title' => '通知渠道', + 'description' => '通知渠道', + 'type' => 'array', + 'items' => [ + 'description' => '通知渠道。', + 'type' => 'object', + 'properties' => [ + 'channelType' => [ + 'title' => '渠道类型', + 'description' => '渠道类型', + 'type' => 'string', + 'required' => true, + 'example' => 'CONTACT', + 'enum' => [ + 'DING', + 'WEIXIN', + 'FEISHU', + 'SLACK', + 'TEAMS', + 'CONTACT', + 'GROUP', + 'DUTY', + 'DING_COOL_APP', + ], + ], + 'enabledSubChannels' => [ + 'title' => '启用通知类型', + 'description' => '启用通知类型', + 'type' => 'array', + 'items' => [ + 'description' => '渠道', + 'type' => 'string', + 'example' => 'SMS', + ], + ], + 'receivers' => [ + 'title' => '渠道接收方', + 'description' => '渠道接收方', + 'type' => 'array', + 'items' => [ + 'description' => '接收方', + 'type' => 'string', + 'example' => 'user1', + ], + 'required' => true, + ], + ], + ], + ], + 'effectTimeRange' => [ + 'title' => '字段', + 'description' => '字段', + 'type' => 'object', + 'properties' => [ + 'dayInWeek' => [ + 'title' => '生效天(周一到周日)', + 'description' => '生效天(周一到周日)', + 'type' => 'array', + 'items' => [ + 'description' => '1-7表示周一到周日', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + 'endTimeInMinute' => [ + 'title' => '结束时间(分钟数)', + 'description' => '结束时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1439', + 'minimum' => '0', + 'example' => '60', + ], + 'startTimeInMinute' => [ + 'title' => '开始时间(分钟数)', + 'description' => '开始时间(分钟数)', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '1438', + 'minimum' => '0', + 'example' => '60', + ], + 'timeZone' => [ + 'title' => '时区', + 'description' => '时区', + 'type' => 'string', + 'example' => '+08:00', + ], + ], + ], + 'filterSetting' => [ + 'description' => '路由设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'severities' => [ + 'description' => '严重级别列表', + 'type' => 'array', + 'items' => [ + 'description' => '严重级别 CRITICAL WARNING INFO', + 'type' => 'string', + 'example' => 'INFO', + ], + ], + 'digitalEmployeeName' => [ + 'type' => 'string', + ], + 'enableRca' => [ + 'type' => 'boolean', + ], + ], + ], + 'required' => true, + ], + 'customTemplateEntries' => [ + 'title' => '通知渠道模板', + 'description' => '通知渠道模板', + 'type' => 'array', + 'items' => [ + 'description' => '通知模版配置', + 'type' => 'object', + 'properties' => [ + 'targetType' => [ + 'title' => '通知类型', + 'description' => '通知类型', + 'type' => 'string', + 'required' => true, + 'example' => 'SMS', + ], + 'templateUuid' => [ + 'title' => '模板UUID', + 'description' => '模板UUID', + 'type' => 'string', + 'required' => true, + 'example' => '123-12-312-312-31-23', + ], + ], + ], + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-05-30T02:29:09Z', + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '123123****', + ], + 'notifyStrategyId' => [ + 'title' => 'UUID', + 'description' => 'UUID', + 'type' => 'string', + 'example' => '12312-31-23-123-1-23123', + ], + 'workspace' => [ + 'title' => 'workspace', + 'description' => '工作空间', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'filterSetting' => [ + 'description' => '过滤设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'workspaceFilterSetting' => [ + 'description' => '工作空间过滤设置', + '$ref' => '#/components/schemas/WorkspaceFilterSetting', + ], + 'pushingSetting' => [ + 'description' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => [ + 'description' => '模板 UUID', + 'type' => 'string', + 'example' => '"template-abc123"', + ], + 'alertActionIds' => [ + 'description' => '告警动作 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '告警动作 ID', + 'type' => 'string', + 'example' => '"action-123"', + ], + ], + 'restoreActionIds' => [ + 'description' => '恢复动作 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '恢复动作 ID', + 'type' => 'string', + 'example' => '"restore-789"', + ], + ], + ], + ], + 'repeatNotifySetting' => [ + 'description' => '循环通知设置', + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => [ + 'description' => '结束事件状态', + 'type' => 'string', + 'example' => '"Resolved"', + ], + 'repeatInterval' => [ + 'description' => '重复通知的时间间隔', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'autoRecoverSeconds' => [ + 'description' => '自动恢复时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'syncFromType' => [ + 'description' => '同步策略来源类型', + 'type' => 'string', + 'example' => '"ARMS"', + ], + 'receiverNames' => [ + 'description' => '接收者名称列表', + 'type' => 'array', + 'items' => [ + 'description' => '接收者名称', + 'type' => 'string', + 'example' => '"张三"', + ], + ], + 'incidentEscalationPolicies' => [ + 'description' => '关联的升级策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '升级策略', + 'type' => 'any', + 'example' => '{ "name": "Critical-Escalation"}', + ], + ], + ], + ], + 'PrometheusManagedInstance' => [ + 'description' => 'Prometheus纳管实例结构', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => [ + 'title' => 'RUM关联的Prometheus实例ID', + 'description' => 'RUM关联的Prometheus实例ID', + 'type' => 'string', + 'example' => 'rum-xxx', + ], + 'prometheusInstanceName' => [ + 'title' => 'RUM关联的Prometheus实例名称', + 'description' => 'RUM关联的Prometheus实例名称', + 'type' => 'string', + 'example' => 'rum-xxx', + ], + 'regionId' => [ + 'title' => '阿里云RegionId', + 'description' => '阿里云RegionId', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'workspace' => [ + 'title' => '云监控2.0 workspace', + 'description' => '云监控2.0 workspace', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'instanceType' => [ + 'title' => '实例类型', + 'description' => '实例类型', + 'type' => 'string', + 'example' => 'test', + ], + 'status' => [ + 'title' => '实例状态', + 'description' => '实例状态', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + 'PushingSetting' => [ + 'description' => '推送设置对象', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => [ + 'description' => '消息模板 UUID', + 'type' => 'string', + 'example' => '"template-abc123"', + ], + 'alertActionIds' => [ + 'description' => '告警动作 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '告警动作 ID', + 'type' => 'string', + 'example' => '"action-123"', + ], + ], + 'restoreActionIds' => [ + 'description' => '恢复动作 ID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '恢复动作 ID', + 'type' => 'string', + 'example' => '"restore-789"', + ], + ], + ], + ], + 'RepeatNotifySetting' => [ + 'description' => '循环通知设置对象', + 'type' => 'object', + 'properties' => [ + 'endIncidentState' => [ + 'description' => '结束事件状态', + 'type' => 'string', + 'example' => '"Resolved"', + ], + 'repeatInterval' => [ + 'description' => '重复通知的时间间隔', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + 'RumDnsResponse' => [ + 'description' => 'RUM上报域名', + 'type' => 'object', + 'properties' => [ + 'domain' => [ + 'title' => 'RUM上报域名', + 'description' => 'RUM上报域名', + 'type' => 'string', + 'example' => 'rum', + ], + 'result' => [ + 'title' => '域名DNS初始化状态', + 'description' => '域名DNS初始化状态', + 'type' => 'boolean', + 'example' => 'true', + ], + 'message' => [ + 'title' => '初始化message(失败场景)', + 'description' => '初始化message(失败场景)', + 'type' => 'string', + 'example' => '""', + ], + ], + ], + 'SubscriptionForModify' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'subscriptionName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试订阅', + ], + 'notifyStrategyId' => [ + 'title' => '通知策略UUID', + 'description' => '通知策略UUID', + 'type' => 'string', + 'example' => '123123', + ], + 'filterSetting' => [ + 'description' => '筛选设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'pushingSetting' => [ + 'title' => '推送设置', + 'description' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => [ + 'title' => '模板UUID', + 'description' => '模板UUID', + 'type' => 'string', + 'example' => '123123123', + ], + 'alertActionIds' => [ + 'title' => '报警推送行动计划ID列表', + 'description' => '报警推送行动计划ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成ID', + 'type' => 'string', + 'example' => '123123123', + ], + ], + 'restoreActionIds' => [ + 'title' => '恢复推送行动计划ID列表', + 'description' => '行动集成计划ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成计划ID', + 'type' => 'string', + 'example' => '123123123', + ], + ], + 'responsePlanId' => [ + 'title' => '行动计划ID', + 'description' => '行动计划ID', + 'type' => 'string', + 'example' => '123123123', + ], + ], + ], + 'workspaceFilterSetting' => [ + '$ref' => '#/components/schemas/WorkspaceFilterSetting', + ], + ], + ], + 'SubscriptionForView' => [ + 'title' => 'A short description of struct', + 'description' => '用于查看的实体。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'subscriptionName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '订阅测试', + ], + 'notifyStrategyId' => [ + 'title' => '通知策略UUID', + 'description' => '通知策略UUID', + 'type' => 'string', + 'example' => '23123123', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-05-23T02:29:02Z', + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '123123123', + ], + 'subscriptionId' => [ + 'title' => 'UUID', + 'description' => 'UUID', + 'type' => 'string', + 'example' => '123123123123', + ], + 'workspace' => [ + 'title' => 'workspace', + 'description' => 'workspace', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'filterSetting' => [ + 'description' => '筛选设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'pushingSetting' => [ + 'title' => '推送设置', + 'description' => '推送设置', + 'type' => 'object', + 'properties' => [ + 'templateUuid' => [ + 'title' => '模板UUID', + 'description' => '模板UUID', + 'type' => 'string', + 'example' => '123123123', + ], + 'alertActionIds' => [ + 'title' => '报警推送行动计划ID列表', + 'description' => '报警推送行动集成ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成Id', + 'type' => 'string', + 'example' => '123123123', + ], + ], + 'restoreActionIds' => [ + 'title' => '恢复推送行动计划ID列表', + 'description' => '恢复推送行动集成ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成Id', + 'type' => 'string', + 'example' => '123123123', + ], + ], + 'responsePlanId' => [ + 'title' => '行动计划ID', + 'description' => '行动计划ID', + 'type' => 'string', + 'example' => '123123123', + ], + ], + ], + 'syncFromType' => [ + 'description' => '同步策略来源类型', + 'type' => 'string', + 'example' => '"ARMS"', + ], + 'workspaceFilterSetting' => [ + '$ref' => '#/components/schemas/WorkspaceFilterSetting', + ], + ], + ], + 'Tag' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'example' => 'env', + 'maxLength' => 128, + ], + 'value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'example' => 'test', + 'maxLength' => 256, + ], + ], + ], + 'TransformAction' => [ + 'description' => '转换配置', + 'type' => 'object', + 'properties' => [ + 'mapping' => [ + 'description' => 'Mapping配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '严重级别Mapping配置。', + 'type' => 'string', + 'example' => '{"warning":"WARNING"}', + ], + ], + 'variable' => [ + 'description' => '变量名', + 'type' => 'string', + 'example' => 'var1', + ], + 'filterSetting' => [ + 'description' => '筛选配置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'source' => [ + 'description' => '引用路径', + 'type' => 'string', + 'example' => 'data.subject', + ], + 'labelKey' => [ + 'description' => '标签名', + 'type' => 'string', + 'example' => 'labelkey1', + ], + 'type' => [ + 'description' => '转换类型', + 'type' => 'string', + 'example' => 'SET_FIELD', + ], + 'value' => [ + 'description' => '设置的值', + 'type' => 'string', + 'example' => 'value1', + ], + 'regExp' => [ + 'description' => '正则表达式', + 'type' => 'string', + 'example' => '(.*):(.*)', + ], + 'target' => [ + 'description' => '目标位置', + 'type' => 'string', + 'example' => 'SUBJECT', + ], + ], + ], + 'TransformerForModify' => [ + 'title' => 'A short description of struct', + 'description' => '数据转换器。', + 'type' => 'object', + 'properties' => [ + 'sortId' => [ + 'title' => '排序数', + 'description' => '排序数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'quitAfterMatch' => [ + 'title' => '匹配处理后退出', + 'description' => '匹配处理后退出', + 'type' => 'boolean', + 'example' => 'true', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'filterSetting' => [ + 'description' => '筛选条件', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'transformerName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + 'actions' => [ + 'title' => '转换操作', + 'description' => '转换操作', + 'type' => 'array', + 'items' => [ + 'description' => '处理行动', + '$ref' => '#/components/schemas/TransformAction', + ], + ], + ], + ], + 'TransformerForView' => [ + 'title' => 'A short description of struct', + 'description' => '数据转换器。', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'title' => 'workspace', + 'description' => 'workspace', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-03-11T08:21:58Z', + ], + 'enable' => [ + 'title' => '是否启用', + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'sortId' => [ + 'title' => '排序数', + 'description' => '排序数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'transformerId' => [ + 'title' => 'transformer Id', + 'description' => 'transformer Id', + 'type' => 'string', + 'example' => '1123123123123', + ], + 'quitAfterMatch' => [ + 'title' => '匹配处理后退出', + 'description' => '匹配处理后退出', + 'type' => 'boolean', + 'example' => 'false', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'filterSetting' => [ + 'description' => '筛选设置', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'updateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-01-16T02:27:01Z', + ], + 'transformerName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'required' => true, + 'example' => '测试处理流', + ], + 'actions' => [ + 'title' => '转换操作', + 'description' => '转换操作', + 'type' => 'array', + 'items' => [ + 'description' => '处理行动', + '$ref' => '#/components/schemas/TransformAction', + ], + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户id', + 'type' => 'string', + 'example' => '123123123**', + ], + ], + ], + 'WorkspaceFilterSetting' => [ + 'description' => '工作空间过滤设置对象', + 'type' => 'object', + 'properties' => [ + 'tagSelector' => [ + 'description' => '标签筛选器', + '$ref' => '#/components/schemas/FilterSetting', + ], + 'workspaceUuids' => [ + 'description' => '工作空间 UUID 列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间 UUID', + 'type' => 'string', + 'example' => '"ws-abc123"', + ], + ], + ], + ], + ], + ], + 'apis' => [ + 'PutWorkspace' => [ + 'summary' => '创建工作空间。', + 'path' => '/workspace/{workspaceName}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'body参数', + 'description' => 'body参数', + 'type' => 'object', + 'properties' => [ + 'displayName' => [ + 'title' => '', + 'description' => '工作空间展示名称', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-test', + 'maxLength' => 256, + ], + 'description' => [ + 'title' => '工作空间描述', + 'description' => '工作空间描述', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace test', + 'maxLength' => 256, + 'pattern' => '', + 'default' => '', + ], + 'slsProject' => [ + 'title' => '日志服务项目名称', + 'description' => '日志服务项目名称', + 'type' => 'string', + 'required' => true, + 'example' => 'sls-project-test-001', + 'maxLength' => 128, + 'minLength' => 1, + 'default' => '', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + 'maxLength' => 56, + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'workspaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'workspace-test-001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + 'title' => '创建修改工作空间', + ], + 'GetWorkspace' => [ + 'summary' => '获取工作空间。', + 'path' => '/workspace/{workspaceName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => '实例 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2025-03-11T08:21:58Z', + ], + 'description' => [ + 'title' => '工作空间描述', + 'description' => '工作空间描述', + 'type' => 'string', + 'example' => 'workspace test', + 'pattern' => '', + 'default' => '', + ], + 'lastModifyTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2025-03-11T08:21:58Z', + ], + 'regionId' => [ + 'title' => '地域ID', + 'description' => '地域 ID', + 'type' => 'string', + 'example' => 'cn-heyuan', + 'pattern' => '', + 'default' => '', + ], + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'slsProject' => [ + 'title' => '日志服务项目名称', + 'description' => '日志服务项目名称', + 'type' => 'string', + 'example' => 'sls-project-test-001', + 'pattern' => '', + 'default' => '', + ], + 'workspaceName' => [ + 'title' => '工作空间名称', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + 'pattern' => '', + 'default' => '', + ], + 'displayName' => [ + 'description' => '工作空间展示名称', + 'type' => 'string', + 'example' => 'workspace-test', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\",\\n \\"displayName\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => '获取工作空间', + ], + 'ListWorkspaces' => [ + 'summary' => '获取工作空间列表。', + 'path' => '/workspace', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcms5OJOSH', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称,模糊查找', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-test-001', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页 Token', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小'."\n" + .'默认值:'."\n" + .' 50'."\n" + .'最大值:'."\n" + .' 50', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '0', + 'example' => '10', + 'default' => '100', + ], + ], + [ + 'name' => 'workspaceNameList', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '工作空间名称,精确查找', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间名称,精确查找', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-test-001', + ], + 'required' => false, + 'example' => 'workspace-test-001', + ], + ], + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-heyuan', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'description' => '分页大小'."\n" + .'默认值:'."\n" + .' 50'."\n" + .'最大值:'."\n" + .' 50', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'nextToken' => [ + 'description' => '分页 Token', + 'type' => 'string', + 'example' => 'xxxxxxxxxx', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID'."\n" + ."\n", + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'total' => [ + 'title' => '当总结果个数大于MaxResults时,用于翻页的token。', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'workspaces' => [ + 'title' => '数组,返回示例目录。', + 'description' => '工作空间列表', + 'type' => 'array', + 'items' => [ + 'title' => 'WorkspaceItemType', + 'description' => 'WorkspaceItemType', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2025-03-11T08:21:58Z', + ], + 'displayName' => [ + 'description' => '工作空间展示名称', + 'type' => 'string', + 'example' => 'workspace-test', + ], + 'description' => [ + 'title' => '工作空间描述', + 'description' => '工作空间描述', + 'type' => 'string', + 'example' => 'workspace test', + 'pattern' => '', + 'default' => '', + ], + 'lastModifyTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2025-03-11T08:21:58Z', + ], + 'regionId' => [ + 'title' => '地域ID', + 'description' => '地域 ID', + 'type' => 'string', + 'example' => 'cn-heyuan', + 'pattern' => '', + 'default' => '', + ], + 'slsProject' => [ + 'title' => '日志服务项目名称', + 'description' => '日志服务项目名称', + 'type' => 'string', + 'example' => 'sls-project-test-001', + 'pattern' => '', + 'default' => '', + ], + 'workspaceName' => [ + 'title' => '工作空间名称', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + 'pattern' => '', + 'default' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"total\\": 1,\\n \\"workspaces\\": [\\n {\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"displayName\\": \\"workspace-test\\",\\n \\"description\\": \\"workspace test\\",\\n \\"lastModifyTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"slsProject\\": \\"sls-project-test-001\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取工作空间列表', + ], + 'DeleteWorkspace' => [ + 'summary' => '删除工作空间。', + 'path' => '/workspace/{workspaceName}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '删除工作空间', + ], + 'CreateCloudResource' => [ + 'summary' => '创建云资源中心', + 'path' => '/cloudresource', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '创建云资源中心', + ], + 'GetCloudResource' => [ + 'summary' => '查询云资源中心', + 'path' => '/cloudresource', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcms5OJOSH', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '区域 ID', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '获取云资源中心属性', + ], + 'GetCloudResourceData' => [ + 'summary' => '查询云资源中心数据', + 'path' => '/cloudresource/data', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'from', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间点。'."\n" + ."\n" + .'Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1721767203', + ], + ], + [ + 'name' => 'to', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间点。'."\n" + ."\n" + .'Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1721767203', + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'description' => '查询语句', + 'type' => 'string', + 'required' => true, + 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回数据列表总和', + 'type' => 'array', + 'items' => [ + 'description' => '请求头对应的数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '请求头对应的数据', + 'type' => 'string', + 'example' => 'data1', + ], + ], + ], + 'header' => [ + 'description' => '请求头列表', + 'type' => 'array', + 'items' => [ + 'description' => '请求头', + 'type' => 'string', + 'example' => 'headerKey', + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n [\\n \\"data1\\"\\n ]\\n ],\\n \\"header\\": [\\n \\"headerKey\\"\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '查询云资源中心数据', + ], + 'DeleteCloudResource' => [ + 'summary' => '删除云资源中心', + 'path' => '/cloudresource', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '删除云资源中心', + ], + 'CreateEntityStore' => [ + 'summary' => '创建EntityStore相关存储', + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'workspaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'workspace-test-001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + 'title' => '创建EntityStore', + ], + 'GetEntityStore' => [ + 'summary' => '获取EntityStore相关存储信息', + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '区域 ID', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC'."\n", + ], + 'workspaceName' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'workspace-test-001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\\\n\\",\\n \\"workspaceName\\": \\"workspace-test-001\\"\\n}","type":"json"}]', + 'title' => '获取EntityStore', + ], + 'GetEntityStoreData' => [ + 'summary' => '查询指定Workspace下的实体和关系数据,返回结果显示某时间区间中的实体数据。', + 'path' => '/workspace/{workspace}/entitiesAndRelations', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'acceptEncoding', + 'in' => 'header', + 'schema' => [ + 'description' => '压缩算法内容编码类型', + 'type' => 'string', + 'required' => false, + 'example' => 'gzip', + 'default' => 'gzip', + ], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'from' => [ + 'description' => '查询开始时间点。'."\n" + ."\n" + .'Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1721767203', + ], + 'query' => [ + 'description' => '查询语句。', + 'type' => 'string', + 'required' => true, + 'example' => '.entity with(domain=\'acs\', type=\'acs.k8s.node\') | limit 0, 10', + ], + 'to' => [ + 'description' => '查询结束时间点。'."\n" + ."\n" + .'Unix时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1721767283', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '返回数据列表总和', + 'type' => 'array', + 'items' => [ + 'description' => '请求头对应的数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '请求头对应的数据', + 'type' => 'string', + 'example' => 'data1', + ], + ], + ], + 'header' => [ + 'description' => '请求头列表', + 'type' => 'array', + 'items' => [ + 'description' => '请求头', + 'type' => 'string', + 'example' => 'headerKey', + ], + ], + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'responseStatus' => [ + 'description' => '结果状态', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '执行结果', + 'type' => 'string', + 'example' => 'Success,PartialSuccess,Error', + ], + 'retryPolicy' => [ + 'description' => '重试策略', + 'type' => 'string', + 'example' => 'None,Once,Continuous', + ], + 'level' => [ + 'description' => '状态级别', + 'type' => 'string', + 'example' => 'Info,Warn,Error', + ], + 'statusItem' => [ + 'description' => '详细的状态信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '详细的状态信息', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => 'Success,ExecuteTimeout,UModelNotExist', + ], + 'level' => [ + 'description' => '状态级别', + 'type' => 'string', + 'example' => 'Info,Warn,Error', + ], + 'message' => [ + 'description' => '计算执行信息', + 'type' => 'string', + 'example' => 'Query execution timeout after 30 seconds', + ], + 'suggestion' => [ + 'description' => '执行错误时的建议', + 'type' => 'string', + 'example' => 'Try to reduce the query scope or increase timeout limit, then retry', + ], + ], + ], + ], + 'executionStates' => [ + 'description' => '执行过程中的信息', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n [\\n \\"data1\\"\\n ]\\n ],\\n \\"header\\": [\\n \\"headerKey\\"\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"responseStatus\\": {\\n \\"result\\": \\"Success,PartialSuccess,Error\\",\\n \\"retryPolicy\\": \\"None,Once,Continuous\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"statusItem\\": [\\n {\\n \\"code\\": \\"Success,ExecuteTimeout,UModelNotExist\\",\\n \\"level\\": \\"Info,Warn,Error\\",\\n \\"message\\": \\"Query execution timeout after 30 seconds\\",\\n \\"suggestion\\": \\"Try to reduce the query scope or increase timeout limit, then retry\\"\\n }\\n ],\\n \\"executionStates\\": \\"{}\\"\\n }\\n}","type":"json"}]', + 'title' => '查询实体和关系数据', + ], + 'DeleteEntityStore' => [ + 'summary' => '删除EntityStore相关存储', + 'path' => '/workspace/{workspaceName}/entitystore', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspaceName', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test-001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '删除EntityStore', + ], + 'CreateUmodel' => [ + 'summary' => '创建Umodel配置。', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => 'Umodel描述', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '123-0F43-23423-AC43-34234', + ], + 'workspace' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'workspace-test', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => '创建 Umodel', + 'description' => '在指定工作空间里创建 Umodel配置', + ], + 'GetUmodel' => [ + 'summary' => '获取Umodel配置信息。', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'commonSchemaRef' => [ + 'description' => '目前无需填充该字段内容', + 'type' => 'array', + 'items' => [ + 'description' => '目前无需填充该字段内容', + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'description' => '公共Umodel Schema group', + 'type' => 'string', + 'example' => 'test-job-123123', + ], + 'version' => [ + 'description' => '版本', + 'type' => 'string', + 'example' => '5', + ], + ], + ], + ], + 'description' => [ + 'description' => 'Umodel描述', + 'type' => 'string', + 'example' => 'workspace test', + ], + 'regionId' => [ + 'description' => '所在地域', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '123-123123-sdf-435-3123', + ], + 'workspace' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'workspace-test', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"test-job-123123\\",\\n \\"version\\": \\"5\\"\\n }\\n ],\\n \\"description\\": \\"workspace test\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"requestId\\": \\"123-123123-sdf-435-3123\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => '获取 Umodel', + 'description' => '获取Umodel配置信息', + ], + 'UpdateUmodel' => [ + 'summary' => '更新Umodel配置信息。', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '234324-123-123-123-23423', + ], + 'workspace' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'workspace-test', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"234324-123-123-123-23423\\",\\n \\"workspace\\": \\"workspace-test\\"\\n}","type":"json"}]', + 'title' => '更新 Umodel', + 'description' => '更新Umodel配置信息', + ], + 'DeleteUmodel' => [ + 'summary' => '删除Umodel配置信息。', + 'path' => '/workspace/{workspace}/umodel', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '123123-3213-345-9941-345345345', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123123-3213-345-9941-345345345\\"\\n}","type":"json"}]', + 'title' => '删除 Umodel', + 'description' => '删除指定 workspace 下的Umodel', + ], + 'GetUmodelData' => [ + 'summary' => '获取相关联的 Umodel 图数据。', + 'path' => '/workspace/{workspace}/umodel/graph', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'method', + 'in' => 'query', + 'schema' => [ + 'description' => '方法', + 'type' => 'string', + 'required' => true, + 'example' => 'ListData', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'content' => [ + 'description' => '查询条件', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "filter": {'."\n" + .' "domains": []'."\n" + .' },'."\n" + .' "offset": 0,'."\n" + .' "size": 100000'."\n" + .'}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点。', + 'type' => 'any', + 'example' => '{}', + ], + ], + 'links' => [ + 'description' => '节点 link 关系列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点 link 关系', + 'type' => 'any', + 'example' => '{}', + ], + ], + 'totalNodesCount' => [ + 'description' => '总节点数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'totalLinksCount' => [ + 'description' => '总节点 link 关系数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'errors' => [ + 'description' => '错误信息', + 'type' => 'array', + 'items' => [ + 'description' => '错误信息', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'description' => '详细信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'type' => [ + 'description' => '错误类型', + 'type' => 'string', + 'example' => 'external', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '123-123-234-345-123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nodes\\": [\\n \\"{}\\"\\n ],\\n \\"links\\": [\\n \\"{}\\"\\n ],\\n \\"totalNodesCount\\": 0,\\n \\"totalLinksCount\\": 0,\\n \\"errors\\": [\\n {\\n \\"message\\": \\"ok\\",\\n \\"type\\": \\"external\\"\\n }\\n ],\\n \\"requestId\\": \\"123-123-234-345-123\\"\\n}","type":"json"}]', + 'title' => '获取 Umodel Data', + 'description' => '查找Umodel', + ], + 'UpsertUmodelData' => [ + 'summary' => '写入 Umodel Elements。', + 'path' => '/workspace/{workspace}/umodel/data', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'method', + 'in' => 'query', + 'schema' => [ + 'description' => '方法', + 'type' => 'string', + 'required' => false, + 'example' => 'Upsert', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '元素列表', + 'type' => 'object', + 'properties' => [ + 'elements' => [ + 'description' => '元素内容', + 'type' => 'array', + 'items' => [ + 'description' => '元素内容', + 'type' => 'any', + 'required' => false, + 'example' => '{}', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + 'title' => '添加或覆盖Umodel(元素)', + ], + 'DeleteUmodelData' => [ + 'summary' => '删除 Umodel Elements。', + 'path' => '/workspace/{workspace}/umodel/data', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'domain', + 'in' => 'query', + 'schema' => [ + 'description' => '可以指定特定Umodel data 的name,不传代表全部', + 'type' => 'string', + 'required' => false, + 'example' => 'apm', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '可以指定特定Umodel data 的name,不传代表全部', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'kind', + 'in' => 'query', + 'schema' => [ + 'description' => '可以指定特定Umodel data 的kind,不传代表全部', + 'type' => 'string', + 'required' => false, + 'example' => 'metric_set', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '111111-222-333-1111-33333', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"111111-222-333-1111-33333\\"\\n}","type":"json"}]', + 'title' => '删除Umodel Data', + 'description' => '删除指定工作空间下Umodel的 Data', + ], + 'GetUmodelCommonSchemaRef' => [ + 'summary' => '获取引用的公共Umodel Schema。', + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'commonSchemaRef' => [ + 'description' => '引用的公共Umodel Schema。', + 'type' => 'array', + 'items' => [ + 'description' => '引用的公共Umodel Schema。', + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'description' => '公共Umodel Schema group', + 'type' => 'string', + 'example' => 'apm-common', + ], + 'version' => [ + 'description' => '版本。', + 'type' => 'string', + 'example' => '0.1.0', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"commonSchemaRef\\": [\\n {\\n \\"group\\": \\"apm-common\\",\\n \\"version\\": \\"0.1.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取引用的公共Umodel Schema', + ], + 'DeleteUmodelCommonSchemaRef' => [ + 'summary' => '删除引用的公共Umodel Schema。', + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'group', + 'in' => 'query', + 'schema' => [ + 'description' => '公共Umodel Schema group', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'apm-common', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '删除指定的公共Umodel Schema引用', + ], + 'UpsertUmodelCommonSchemaRef' => [ + 'summary' => '更新引用的公共Umodel Schema。', + 'path' => '/workspace/{workspace}/umodel/common-schema-ref', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'group', + 'in' => 'query', + 'schema' => [ + 'description' => '公共Umodel Schema group', + 'type' => 'string', + 'required' => true, + 'example' => 'card-service-daily01', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'description' => '版本号', + 'type' => 'string', + 'required' => true, + 'example' => '0.1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\"\\n}","type":"json"}]', + 'title' => '引用指定的公共Umodel Schema', + ], + 'CreateChat' => [ + 'summary' => '创建对话。', + 'path' => '/chat', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/octet-stream', + ], + 'produces' => [ + 'application/octet-stream', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体', + 'type' => 'object', + 'properties' => [ + 'digitalEmployeeName' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'threadId' => [ + 'description' => '会话线程ID', + 'type' => 'string', + 'required' => false, + 'example' => 'thread_id01', + ], + 'action' => [ + 'description' => '操作类型: create(默认), reconnect, stop', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'reconnect' => 'reconnect', + 'stop' => 'stop', + 'create' => 'create', + 'interact' => 'interact', + ], + 'example' => 'create', + ], + 'variables' => [ + 'description' => '变量列表', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "workspace": "test",'."\n" + .' "region": "cn-beijing",'."\n" + .' "project": "test",'."\n" + .' "language": "zh",'."\n" + .' "timeZone": "Asia/Shanghai",'."\n" + .' "timeStamp": "1768893948",'."\n" + .' "startTime": 1768887171,'."\n" + .' "endTime": 1768890771,'."\n" + .' "skill": "trace"'."\n" + .'}', + ], + 'messages' => [ + 'description' => '消息列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息', + 'type' => 'object', + 'properties' => [ + 'messageId' => [ + 'description' => '当前消息唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'message_id02', + ], + 'role' => [ + 'description' => '消息的角色', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'system' => 'system', + 'assistant' => 'assistant', + 'user' => 'user', + 'tool' => 'tool', + ], + 'example' => 'system', + ], + 'contents' => [ + 'description' => '文本或多模态数组', + 'type' => 'array', + 'items' => [ + 'description' => '文本或多模态', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '内容类型', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'value' => [ + 'description' => '内容的值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'tools' => [ + 'description' => '工具调用列表', + 'type' => 'array', + 'items' => [ + 'description' => '工具调用', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "arguments": {'."\n" + .' "confidence": "high",'."\n" + .' "intent": "analyser",'."\n" + .' "is_new_turn": true,'."\n" + .' "language": "en",'."\n" + .' "title": "Root Cause of Alert"'."\n" + .' },'."\n" + .' "id": "IntentRecognition",'."\n" + .'}', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'messages' => [ + 'title' => '会话的消息列表', + 'description' => '消息列表', + 'type' => 'array', + 'items' => [ + 'title' => '消息数据明细结构', + 'description' => '消息', + 'type' => 'object', + 'properties' => [ + 'version' => [ + 'title' => '消息版本号', + 'description' => '消息版本号', + 'type' => 'string', + 'example' => 'v0.1.0', + ], + 'parentCallId' => [ + 'title' => '上一层级执行ID', + 'description' => '父节点的调用 ID', + 'type' => 'string', + 'example' => 'sess_abc123', + ], + 'callId' => [ + 'title' => '当前执行ID', + 'description' => '当前节点的调用 ID', + 'type' => 'string', + 'example' => 'call_search_001', + ], + 'role' => [ + 'title' => '消息发起角色', + 'description' => '消息角色', + 'type' => 'string', + 'example' => 'tool', + ], + 'seq' => [ + 'title' => '消息序列号', + 'description' => '事件序列号,递增,用于保证事件顺序', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'timestamp' => [ + 'title' => 'timestamp / 纳秒', + 'description' => 'Unix 时间戳(秒)', + 'type' => 'string', + 'example' => '1765000005', + ], + 'type' => [ + 'title' => '消息具体类型', + 'description' => '特殊事件类型(如 done, error, heartbeat)', + 'type' => 'string', + 'example' => 'done', + ], + 'detail' => [ + 'title' => '消息明细', + 'description' => '详细信息(如工具进度描述)', + 'type' => 'string', + 'example' => 'test', + ], + 'contents' => [ + 'title' => '内容信息', + 'description' => '消息内容数组', + 'type' => 'array', + 'items' => [ + 'title' => '内容信息明细结构', + 'description' => '消息内容', + 'type' => 'object', + 'example' => '{'."\n" + .' "append": false,'."\n" + .' "lastChunk": false,'."\n" + .' "type": "text",'."\n" + .' "value": "result output chunk"'."\n" + .'}', + ], + ], + 'tools' => [ + 'title' => '工具使用列表', + 'description' => '工具调用数组', + 'type' => 'array', + 'items' => [ + 'title' => '工具明细结构', + 'description' => '工具调用', + 'type' => 'object', + 'example' => "\n" + .'{'."\n" + .' "arguments": {'."\n" + .' "confidence": "high",'."\n" + .' "intent": "analyser",'."\n" + .' "is_new_turn": true,'."\n" + .' "language": "en",'."\n" + .' "title": "Root Cause of Alert"'."\n" + .' },'."\n" + .' "id": "IntentRecognition",'."\n" + .' "name": "IntentRecognition",'."\n" + .' "status": "start",'."\n" + .' "toolCallId": "019bc1cb-adad"'."\n" + .'}', + ], + ], + 'agents' => [ + 'title' => '调用的Agent列表', + 'description' => '智能体列表', + 'type' => 'array', + 'items' => [ + 'title' => '调用的Agent详细内容', + 'description' => '智能体', + 'type' => 'object', + 'example' => '{'."\n" + .' "callId": "019bc1cb-adad",'."\n" + .' "id": "analyser",'."\n" + .' "inputs": ['."\n" + .' {'."\n" + .' "append": false,'."\n" + .' "lastChunk": false,'."\n" + .' "type": "text",'."\n" + .' "value": "Analyze this trace: TraceID=xxx"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name": "analyser",'."\n" + .' "status": "start"'."\n" + .'}', + ], + ], + 'events' => [ + 'title' => '事件列表', + 'description' => '事件列表', + 'type' => 'array', + 'items' => [ + 'title' => '事件详细内容', + 'description' => '事件详细内容', + 'type' => 'object', + 'example' => '{'."\n" + .' "payload": {'."\n" + .' "error": {'."\n" + .' "code": "TASK_FAILED",'."\n" + .' "message": "Invalid task parameter",'."\n" + .' "suggestion": ""'."\n" + .' },'."\n" + .' "statistics": {'."\n" + .' "duration": 300000'."\n" + .' },'."\n" + .' "success": false'."\n" + .' },'."\n" + .' "type": "task_finished"'."\n" + .'}', + ], + ], + 'artifacts' => [ + 'title' => '产物产出信息', + 'description' => '产物产出信息', + 'type' => 'array', + 'items' => [ + 'title' => '产物明细的结构', + 'description' => '产物明细的结构', + 'type' => 'object', + 'example' => '{'."\n" + .' "artifactId": "019bc1cb-9600-703axxx",'."\n" + .' "name": "sql output",'."\n" + .' "description": "sql generation task result",'."\n" + .' "extensions": ["sql_generation_tool", "sql_diagnosis"],'."\n" + .' "metadata": {'."\n" + .' "model": "qwen3-coder-plus"'."\n" + .' },'."\n" + .' "parts": ['."\n" + .' {'."\n" + .' "text": "select * from table",'."\n" + .' "kind": "text"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + ], + ], + 'traceId' => [ + 'title' => '当前message请求的id数据'."\n" + .'根数据中第一个追踪ID', + 'description' => '跟踪请求全局的标识符', + 'type' => 'string', + 'example' => '21504600000008405622576e3b48', + ], + 'requestId' => [ + 'title' => '当前message请求的id数据'."\n" + .'根数据中第一个RequestID', + 'description' => '请求唯一标识', + 'type' => 'string', + 'example' => '0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"messages\\": [\\n {\\n \\"version\\": \\"v0.1.0\\",\\n \\"parentCallId\\": \\"sess_abc123\\",\\n \\"callId\\": \\"call_search_001\\",\\n \\"role\\": \\"tool\\",\\n \\"seq\\": 1,\\n \\"timestamp\\": \\"1765000005\\",\\n \\"type\\": \\"done\\",\\n \\"detail\\": \\"test\\",\\n \\"contents\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"result output chunk\\"\\n }\\n ],\\n \\"tools\\": [\\n {\\n \\"arguments\\": {\\n \\"confidence\\": \\"high\\",\\n \\"intent\\": \\"analyser\\",\\n \\"is_new_turn\\": true,\\n \\"language\\": \\"en\\",\\n \\"title\\": \\"Root Cause of Alert\\"\\n },\\n \\"id\\": \\"IntentRecognition\\",\\n \\"name\\": \\"IntentRecognition\\",\\n \\"status\\": \\"start\\",\\n \\"toolCallId\\": \\"019bc1cb-adad\\"\\n }\\n ],\\n \\"agents\\": [\\n {\\n \\"callId\\": \\"019bc1cb-adad\\",\\n \\"id\\": \\"analyser\\",\\n \\"inputs\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"Analyze this trace: TraceID=xxx\\"\\n }\\n ],\\n \\"name\\": \\"analyser\\",\\n \\"status\\": \\"start\\"\\n }\\n ],\\n \\"events\\": [\\n {\\n \\"payload\\": {\\n \\"error\\": {\\n \\"code\\": \\"TASK_FAILED\\",\\n \\"message\\": \\"Invalid task parameter\\",\\n \\"suggestion\\": \\"\\"\\n },\\n \\"statistics\\": {\\n \\"duration\\": 300000\\n },\\n \\"success\\": false\\n },\\n \\"type\\": \\"task_finished\\"\\n }\\n ],\\n \\"artifacts\\": [\\n {\\n \\"artifactId\\": \\"019bc1cb-9600-703axxx\\",\\n \\"name\\": \\"sql output\\",\\n \\"description\\": \\"sql generation task result\\",\\n \\"extensions\\": [\\n \\"sql_generation_tool\\",\\n \\"sql_diagnosis\\"\\n ],\\n \\"metadata\\": {\\n \\"model\\": \\"qwen3-coder-plus\\"\\n },\\n \\"parts\\": [\\n {\\n \\"text\\": \\"select * from table\\",\\n \\"kind\\": \\"text\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"traceId\\": \\"21504600000008405622576e3b48\\",\\n \\"requestId\\": \\"0CEC5375-XXXX-XXXX-XXXX-9A629907C1F0\\"\\n}","type":"json"}]', + 'title' => '发起会话', + 'description' => '用于创建一个站点监控任务', + ], + 'CreateDigitalEmployee' => [ + 'summary' => '创建DigitalEmployee。', + 'path' => '/digital-employee', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '数字员工结构', + 'type' => 'object', + 'properties' => [ + 'defaultRule' => [ + 'description' => '默认规则', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'description' => [ + 'description' => '数字员工描述信息', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'aaa', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'displayName' => [ + 'description' => '数字员工显示名称', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'digial-employee-test', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'roleArn' => [ + 'description' => '角色ARN', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'acs:ram::12345678912:role/testrole', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'name' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'knowledges' => [ + 'description' => '知识库列表', + 'type' => 'object', + 'properties' => [ + 'bailian' => [ + 'description' => '百练知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => '百练知识库', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => [ + 'description' => '百练工作空间 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'llm-xxxxx', + ], + 'indexId' => [ + 'description' => '百练索引 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'index-xxxx', + ], + 'region' => [ + 'description' => '百练知识库地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'attributes' => [ + 'description' => '知识库属性', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'sop' => [ + 'description' => 'SOP知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => 'SOP 知识库', + 'type' => 'object', + 'required' => false, + 'example' => ' {'."\n" + .' "type": "oss",'."\n" + .' "basePath": "docs/",'."\n" + .' "region": "cn-hangzhou",'."\n" + .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" + .' "bucket": "my-sop-bucket",'."\n" + .' "description": "sls sop"'."\n" + .' }', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'resourceGroupId' => [ + 'title' => '资源组 ID', + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******ey', + ], + 'tags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'required' => false, + '$ref' => '#/components/schemas/Tag', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', + ], + 'name' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\",\\n \\"name\\": \\"test\\"\\n}","type":"json"}]', + 'title' => '创建数字员工', + 'description' => '用于创建一个站点监控任务', + ], + 'GetDigitalEmployee' => [ + 'summary' => '查询 DigitalEmployee。', + 'path' => '/digital-employee/{name}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-************', + ], + 'name' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'example' => 'test', + ], + 'defaultRule' => [ + 'description' => '默认规则', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'description' => [ + 'description' => '数字员工描述信息', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'deprecated' => false, + 'example' => '2025-03-11T08:21:58Z', + 'pattern' => '', + 'default' => '', + ], + 'displayName' => [ + 'description' => '数字员工显示名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'updateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'deprecated' => false, + 'example' => '2025-02-18T02:25:06Z', + 'pattern' => '', + 'default' => '', + ], + 'roleArn' => [ + 'description' => '角色ARN', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'acs:ram::12345678912:role/testrole', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'regionId' => [ + 'description' => '区域 ID', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'knowledges' => [ + 'description' => '知识库列表', + 'type' => 'object', + 'properties' => [ + 'bailian' => [ + 'description' => '百练知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => '百练知识库列表', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => [ + 'description' => '百练工作空间 ID', + 'type' => 'string', + 'example' => 'llm-xxxxx', + ], + 'indexId' => [ + 'description' => '百练索引 ID', + 'type' => 'string', + 'example' => 'index-xxxx', + ], + 'region' => [ + 'description' => '百练知识库地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'attributes' => [ + 'description' => '知识库属性', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'sop' => [ + 'description' => 'SOP 知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => 'SOP 知识库', + 'type' => 'object', + 'example' => ' {'."\n" + .' "type": "oss",'."\n" + .' "basePath": "docs/",'."\n" + .' "region": "cn-hangzhou",'."\n" + .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" + .' "bucket": "my-sop-bucket",'."\n" + .' "description": "sls sop"'."\n" + .' }', + ], + ], + ], + ], + 'employeeType' => [ + 'description' => '数字员工类型', + 'type' => 'string', + 'example' => 'custom', + ], + 'tags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + '$ref' => '#/components/schemas/Tag', + ], + ], + 'resourceGroupId' => [ + 'title' => '资源组 ID', + 'description' => '资源组 ID', + 'type' => 'string', + 'example' => 'rg-ae******ey', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDigitalEmployee.NotFound', + 'errorMessage' => 'The specified DigitalEmployee does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"name\\": \\"test\\",\\n \\"defaultRule\\": \\"test\\",\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"2025-03-11T08:21:58Z\\",\\n \\"displayName\\": \\"test\\",\\n \\"updateTime\\": \\"2025-02-18T02:25:06Z\\",\\n \\"roleArn\\": \\"acs:ram::12345678912:role/testrole\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"knowledges\\": {\\n \\"bailian\\": [\\n {\\n \\"workspaceId\\": \\"llm-xxxxx\\",\\n \\"indexId\\": \\"index-xxxx\\",\\n \\"region\\": \\"cn-beijing\\",\\n \\"attributes\\": \\"test\\"\\n }\\n ],\\n \\"sop\\": [\\n {\\n \\"type\\": \\"oss\\",\\n \\"basePath\\": \\"docs/\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"my-sop-bucket\\",\\n \\"description\\": \\"sls sop\\"\\n }\\n ]\\n },\\n \\"employeeType\\": \\"custom\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"test-key\\",\\n \\"value\\": \\"test-value\\"\\n }\\n ],\\n \\"resourceGroupId\\": \\"rg-ae******ey\\"\\n}","type":"json"}]', + 'title' => '获取数字员工', + ], + 'UpdateDigitalEmployee' => [ + 'summary' => '更新UpdateDigitalEmployee。', + 'path' => '/digital-employee/{name}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '数字员工结构', + 'type' => 'object', + 'properties' => [ + 'defaultRule' => [ + 'description' => '默认规则', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'displayName' => [ + 'description' => '数字员工显示名称', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'test', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'roleArn' => [ + 'description' => '角色ARN', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'acs:ram::12345678912:role/testrole', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'knowledges' => [ + 'description' => '知识库列表', + 'type' => 'object', + 'properties' => [ + 'bailian' => [ + 'description' => '百练知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => '百练知识库列表', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => [ + 'description' => '百练工作空间 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'llm-xxxx', + ], + 'indexId' => [ + 'description' => '百练索引 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'index-xxxx', + ], + 'region' => [ + 'description' => '百练知识库地域', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'attributes' => [ + 'description' => '知识库属性', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'sop' => [ + 'description' => 'SOP 知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => 'SOP 知识库', + 'type' => 'object', + 'required' => false, + 'example' => ' {'."\n" + .' "type": "oss",'."\n" + .' "basePath": "docs/",'."\n" + .' "region": "cn-hangzhou",'."\n" + .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" + .' "bucket": "my-sop-bucket",'."\n" + .' "description": "sls sop"'."\n" + .' }', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-***', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', + 'title' => '更新数字员工', + ], + 'ListDigitalEmployees' => [ + 'summary' => '列出资源DigitalEmployee。', + 'path' => '/digital-employee', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '分页大小'."\n" + .'默认值:'."\n" + .' 20'."\n" + .'最大值:'."\n" + .' 100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '下一次查询的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'employeeType', + 'in' => 'query', + 'schema' => [ + 'description' => '数字员工类型', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + 'enum' => [ + 'system', + 'custom', + ], + ], + ], + [ + 'name' => 'displayName', + 'in' => 'query', + 'schema' => [ + 'description' => '数字员工显示名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'required' => false, + '$ref' => '#/components/schemas/Tag', + ], + 'required' => false, + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组 ID', + 'description' => '资源组 ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******ey', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'nextToken' => [ + 'description' => '下一次查询的令牌。', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'total' => [ + 'description' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '56', + ], + 'maxResults' => [ + 'description' => '最大返回结果数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'digitalEmployees' => [ + 'description' => '数字员工列表', + 'type' => 'array', + 'items' => [ + 'description' => '数字员工', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'example' => 'test', + ], + 'defaultRule' => [ + 'description' => '默认规则', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'deprecated' => false, + 'example' => '2025-11-04T08:08:57Z', + 'pattern' => '', + 'default' => '', + ], + 'displayName' => [ + 'description' => '数字员工显示名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'test', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'updateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'deprecated' => false, + 'example' => '2025-05-07T02:26:01Z', + 'pattern' => '', + 'default' => '', + ], + 'roleArn' => [ + 'description' => '角色ARN', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'acs:ram::12345678912:role/testrole', + 'pattern' => '', + 'readOnly' => false, + 'default' => '', + ], + 'knowledges' => [ + 'description' => '知识库列表', + 'type' => 'object', + 'properties' => [ + 'bailian' => [ + 'description' => '百练知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => '百练知识库', + 'type' => 'object', + 'properties' => [ + 'workspaceId' => [ + 'description' => '百练工作空间 ID', + 'type' => 'string', + 'example' => 'llm-xxxx', + ], + 'indexId' => [ + 'description' => '百练索引 ID', + 'type' => 'string', + 'example' => 'index-xxxx', + ], + 'region' => [ + 'description' => '百练知识库地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'attributes' => [ + 'description' => '知识库属性', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'sop' => [ + 'description' => 'SOP 知识库列表', + 'type' => 'array', + 'items' => [ + 'description' => 'SOP 知识库', + 'type' => 'object', + 'example' => ' {'."\n" + .' "type": "oss",'."\n" + .' "basePath": "docs/",'."\n" + .' "region": "cn-hangzhou",'."\n" + .' "endpoint": "oss-cn-hangzhou.aliyuncs.com",'."\n" + .' "bucket": "my-sop-bucket",'."\n" + .' "description": "sls sop"'."\n" + .' }', + ], + ], + ], + ], + 'employeeType' => [ + 'description' => '数字员工类型', + 'type' => 'string', + 'example' => 'custom', + ], + 'resourceGroupId' => [ + 'title' => '资源组 ID', + 'description' => '资源组 ID', + 'type' => 'string', + 'example' => 'rg-ae******ey', + ], + 'tags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + '$ref' => '#/components/schemas/Tag', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"nextToken\\": \\"xxxxx\\",\\n \\"total\\": 56,\\n \\"maxResults\\": 10,\\n \\"digitalEmployees\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"defaultRule\\": \\"test\\",\\n \\"description\\": \\"test\\",\\n \\"createTime\\": \\"2025-11-04T08:08:57Z\\",\\n \\"displayName\\": \\"test\\",\\n \\"updateTime\\": \\"2025-05-07T02:26:01Z\\",\\n \\"roleArn\\": \\"acs:ram::12345678912:role/testrole\\",\\n \\"knowledges\\": {\\n \\"bailian\\": [\\n {\\n \\"workspaceId\\": \\"llm-xxxx\\",\\n \\"indexId\\": \\"index-xxxx\\",\\n \\"region\\": \\"cn-beijing\\",\\n \\"attributes\\": \\"test\\"\\n }\\n ],\\n \\"sop\\": [\\n {\\n \\"type\\": \\"oss\\",\\n \\"basePath\\": \\"docs/\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"my-sop-bucket\\",\\n \\"description\\": \\"sls sop\\"\\n }\\n ]\\n },\\n \\"employeeType\\": \\"custom\\",\\n \\"resourceGroupId\\": \\"rg-ae******ey\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"test-key\\",\\n \\"value\\": \\"test-value\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列出数字员工', + ], + 'DeleteDigitalEmployee' => [ + 'summary' => '删除DigitalEmployee。', + 'path' => '/digital-employee/{name}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '删除数字员工', + ], + 'CreateThread' => [ + 'summary' => '创建会话。', + 'path' => '/digitalEmployee/{name}/thread', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '会话标题', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'variables' => [ + 'description' => '会话属性', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace', + ], + 'project' => [ + 'description' => '日志服务项目名称', + 'type' => 'string', + 'required' => false, + 'example' => 'project', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'threadId' => [ + 'description' => '会话 id', + 'type' => 'string', + 'example' => 'thread_id01', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\"\\n}","type":"json"}]', + 'title' => '创建会话', + 'description' => '用于创建一个会话', + ], + 'GetThread' => [ + 'summary' => '获取会话。', + 'path' => '/digitalEmployee/{name}/thread/{threadId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'threadId', + 'in' => 'path', + 'schema' => [ + 'description' => '会话 id', + 'type' => 'string', + 'required' => true, + 'example' => 'thread_id01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'threadId' => [ + 'description' => '会话 id', + 'type' => 'string', + 'example' => 'thread_id01', + ], + 'digitalEmployeeName' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'example' => 'test', + ], + 'title' => [ + 'description' => '会话标题', + 'type' => 'string', + 'example' => 'testLive', + ], + 'status' => [ + 'description' => '会话状态', + 'type' => 'string', + 'example' => 'active', + ], + 'version' => [ + 'description' => '版本', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1231', + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-12-19T15:19:55.040403272+08:00', + ], + 'updateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-12-19T15:19:55.040403272+08:00', + ], + 'variables' => [ + 'description' => '会话属性', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'project' => [ + 'description' => 'SLS 项目名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\",\\n \\"digitalEmployeeName\\": \\"test\\",\\n \\"title\\": \\"testLive\\",\\n \\"status\\": \\"active\\",\\n \\"version\\": 1231,\\n \\"createTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\",\\n \\"updateTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\",\\n \\"variables\\": {\\n \\"workspace\\": \\"test\\",\\n \\"project\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => '获取会话', + 'description' => '获取会话', + ], + 'GetThreadData' => [ + 'summary' => '获取会话数据。', + 'path' => '/digitalEmployee/{name}/thread/{threadId}/data', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'threadId', + 'in' => 'path', + 'schema' => [ + 'description' => '会话 id', + 'type' => 'string', + 'required' => true, + 'example' => 'thread_id01', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回会话数据最大数据,最大值:100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'title' => '最大结果数量', + 'description' => '最大结果数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'data' => [ + 'title' => '消息数据', + 'description' => '消息数据', + 'type' => 'array', + 'items' => [ + 'title' => '消息数据', + 'description' => '消息数据', + 'type' => 'object', + 'properties' => [ + 'traceId' => [ + 'title' => '当前message请求的id数据'."\n" + .'根数据中第一个追踪ID', + 'description' => '当前message请求的id数据'."\n" + .'根数据中第一个追踪ID', + 'type' => 'string', + 'example' => '3b5287b717636040171772050d0095', + ], + 'requestId' => [ + 'title' => '当前message请求的id数据'."\n" + .'根数据中第一个RequestID', + 'description' => '当前message请求的id数据'."\n" + .'根数据中第一个RequestID', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'messages' => [ + 'title' => '会话的消息列表', + 'description' => '会话的消息列表', + 'type' => 'array', + 'items' => [ + 'title' => '消息数据明细结构', + 'description' => '消息数据明细结构', + 'type' => 'object', + 'properties' => [ + 'version' => [ + 'title' => '消息数据的版本号', + 'description' => '消息数据的版本号', + 'type' => 'string', + 'example' => 'v0.1.0', + ], + 'parentCallId' => [ + 'title' => '上一层级执行ID', + 'description' => '上一层级执行ID', + 'type' => 'string', + 'example' => '3b5287b7176360', + ], + 'callId' => [ + 'title' => '当前执行ID', + 'description' => '当前执行ID', + 'type' => 'string', + 'example' => '3b5287b7176360', + ], + 'role' => [ + 'title' => '消息发起角色', + 'description' => '消息发起角色', + 'type' => 'string', + 'example' => 'user', + ], + 'seq' => [ + 'title' => '消息序列号', + 'description' => '消息序列号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'timestamp' => [ + 'title' => 'timestamp / 纳秒', + 'description' => 'timestamp / 纳秒', + 'type' => 'string', + 'example' => '1768702985000000000', + ], + 'type' => [ + 'title' => '消息具体类型', + 'description' => '消息具体类型', + 'type' => 'string', + 'example' => 'task_finished', + ], + 'detail' => [ + 'title' => '消息明细', + 'description' => '消息明细', + 'type' => 'string', + 'example' => 'context of model exceed', + ], + 'contents' => [ + 'title' => '内容信息', + 'description' => '内容信息', + 'type' => 'array', + 'items' => [ + 'title' => '内容信息明细结构', + 'description' => '内容信息明细结构', + 'type' => 'object', + 'example' => '{'."\n" + .' "append": false,'."\n" + .' "lastChunk": false,'."\n" + .' "type": "text",'."\n" + .' "value": "result output chunk"'."\n" + .'}', + ], + ], + 'tools' => [ + 'title' => '工具使用列表', + 'description' => '工具使用列表', + 'type' => 'array', + 'items' => [ + 'title' => '工具明细结构', + 'description' => '工具明细结构', + 'type' => 'object', + 'example' => '{'."\n" + .' "arguments": {'."\n" + .' "confidence": "high",'."\n" + .' "intent": "analyser",'."\n" + .' "is_new_turn": true,'."\n" + .' "language": "en",'."\n" + .' "title": "Root Cause of Alert"'."\n" + .' },'."\n" + .' "id": "IntentRecognition",'."\n" + .' "name": "IntentRecognition",'."\n" + .' "status": "start",'."\n" + .' "toolCallId": "019bc1cb-adad"'."\n" + .'}', + ], + ], + 'agents' => [ + 'title' => '调用的Agent列表', + 'description' => '调用的Agent列表', + 'type' => 'array', + 'items' => [ + 'title' => '调用的Agent详细内容', + 'description' => '调用的Agent详细内容', + 'type' => 'object', + 'example' => '{'."\n" + .' "callId": "019bc1cb-adad",'."\n" + .' "id": "analyser",'."\n" + .' "inputs": ['."\n" + .' {'."\n" + .' "append": false,'."\n" + .' "lastChunk": false,'."\n" + .' "type": "text",'."\n" + .' "value": "Analyze this trace: TraceID=xxx"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name": "analyser",'."\n" + .' "status": "start"'."\n" + .'}', + ], + ], + 'events' => [ + 'title' => '事件列表', + 'description' => '事件列表', + 'type' => 'array', + 'items' => [ + 'title' => '事件详细内容', + 'description' => '事件详细内容', + 'type' => 'object', + 'example' => '{'."\n" + .' "payload": {'."\n" + .' "error": {'."\n" + .' "code": "TASK_FAILED",'."\n" + .' "message": "Invalid task parameter",'."\n" + .' "suggestion": ""'."\n" + .' },'."\n" + .' "statistics": {'."\n" + .' "duration": 300000'."\n" + .' },'."\n" + .' "success": false'."\n" + .' },'."\n" + .' "type": "task_finished"'."\n" + .'}', + ], + ], + 'artifacts' => [ + 'title' => '产物产出信息', + 'description' => '产物产出信息', + 'type' => 'array', + 'items' => [ + 'title' => '产物明细的结构', + 'description' => '产物明细的结构', + 'type' => 'object', + 'example' => '{'."\n" + .' "artifactId": "019bc1cb-9600-703axxx",'."\n" + .' "name": "sql output",'."\n" + .' "description": "sql generation task result",'."\n" + .' "extensions": ["sql_generation_tool", "sql_diagnosis"],'."\n" + .' "metadata": {'."\n" + .' "model": "qwen3-coder-plus"'."\n" + .' },'."\n" + .' "parts": ['."\n" + .' {'."\n" + .' "text": "select * from table",'."\n" + .' "kind": "text"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + 'nextToken' => [ + 'title' => '分页参数,下一页信息', + 'description' => '分页游标。', + 'type' => 'string', + 'example' => 'xxxxxxxxx', + ], + 'requestId' => [ + 'title' => '当前请求ID', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'threadId' => [ + 'title' => '当前会话ID', + 'description' => '会话 id', + 'type' => 'string', + 'example' => 'thread_id01', + ], + 'digitalEmployeeName' => [ + 'title' => '当前数字员工信息', + 'description' => '数字员工名称', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 1,\\n \\"data\\": [\\n {\\n \\"traceId\\": \\"3b5287b717636040171772050d0095\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"messages\\": [\\n {\\n \\"version\\": \\"v0.1.0\\",\\n \\"parentCallId\\": \\"3b5287b7176360\\",\\n \\"callId\\": \\"3b5287b7176360\\",\\n \\"role\\": \\"user\\",\\n \\"seq\\": 0,\\n \\"timestamp\\": \\"1768702985000000000\\",\\n \\"type\\": \\"task_finished\\",\\n \\"detail\\": \\"context of model exceed\\",\\n \\"contents\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"result output chunk\\"\\n }\\n ],\\n \\"tools\\": [\\n {\\n \\"arguments\\": {\\n \\"confidence\\": \\"high\\",\\n \\"intent\\": \\"analyser\\",\\n \\"is_new_turn\\": true,\\n \\"language\\": \\"en\\",\\n \\"title\\": \\"Root Cause of Alert\\"\\n },\\n \\"id\\": \\"IntentRecognition\\",\\n \\"name\\": \\"IntentRecognition\\",\\n \\"status\\": \\"start\\",\\n \\"toolCallId\\": \\"019bc1cb-adad\\"\\n }\\n ],\\n \\"agents\\": [\\n {\\n \\"callId\\": \\"019bc1cb-adad\\",\\n \\"id\\": \\"analyser\\",\\n \\"inputs\\": [\\n {\\n \\"append\\": false,\\n \\"lastChunk\\": false,\\n \\"type\\": \\"text\\",\\n \\"value\\": \\"Analyze this trace: TraceID=xxx\\"\\n }\\n ],\\n \\"name\\": \\"analyser\\",\\n \\"status\\": \\"start\\"\\n }\\n ],\\n \\"events\\": [\\n {\\n \\"payload\\": {\\n \\"error\\": {\\n \\"code\\": \\"TASK_FAILED\\",\\n \\"message\\": \\"Invalid task parameter\\",\\n \\"suggestion\\": \\"\\"\\n },\\n \\"statistics\\": {\\n \\"duration\\": 300000\\n },\\n \\"success\\": false\\n },\\n \\"type\\": \\"task_finished\\"\\n }\\n ],\\n \\"artifacts\\": [\\n {\\n \\"artifactId\\": \\"019bc1cb-9600-703axxx\\",\\n \\"name\\": \\"sql output\\",\\n \\"description\\": \\"sql generation task result\\",\\n \\"extensions\\": [\\n \\"sql_generation_tool\\",\\n \\"sql_diagnosis\\"\\n ],\\n \\"metadata\\": {\\n \\"model\\": \\"qwen3-coder-plus\\"\\n },\\n \\"parts\\": [\\n {\\n \\"text\\": \\"select * from table\\",\\n \\"kind\\": \\"text\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"xxxxxxxxx\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"threadId\\": \\"thread_id01\\",\\n \\"digitalEmployeeName\\": \\"test\\"\\n}","type":"json"}]', + 'title' => '获取会话数据', + 'description' => '获取会话数据', + ], + 'ListThreads' => [ + 'summary' => '列出会话', + 'path' => '/digitalEmployee/{name}/threads', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '会话状态', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + [ + 'name' => 'threadId', + 'in' => 'query', + 'schema' => [ + 'description' => '会话 id', + 'type' => 'string', + 'required' => false, + 'example' => 'thread-123123', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回结果数,最大值200', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页 Token', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询的过滤条件,若不输入则查询该实例下所有的主题。', + 'type' => 'array', + 'items' => [ + 'description' => '查询的过滤条件,若不输入则查询该实例下所有的主题。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '过滤 key,当前支持 title、workspace、project', + 'type' => 'string', + 'required' => true, + 'example' => 'title', + ], + 'value' => [ + 'description' => '设置的值', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-xxxx', + ], + 'threadId' => [ + 'description' => '会话 id', + 'type' => 'string', + 'example' => 'thread-123123', + ], + 'total' => [ + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'maxResults' => [ + 'description' => '最大返回结果数,最大值200', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'threads' => [ + 'description' => '会话', + 'type' => 'array', + 'items' => [ + 'description' => '会话', + 'type' => 'object', + 'properties' => [ + 'threadId' => [ + 'description' => '会话 id', + 'type' => 'string', + 'example' => 'thread-123123', + ], + 'digitalEmployeeName' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'example' => 'test', + ], + 'title' => [ + 'description' => '会话标题', + 'type' => 'string', + 'example' => 'test', + ], + 'status' => [ + 'description' => '会话状态', + 'type' => 'string', + 'example' => 'active', + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'variables' => [ + 'description' => '会话属性', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'workspace', + ], + 'project' => [ + 'description' => 'SLS project。', + 'type' => 'string', + 'example' => 'project', + ], + ], + ], + 'createTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-12-19T15:19:55.040403272+08:00', + ], + 'updateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-12-19T15:19:55.040403272+08:00', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '分页 Token', + 'type' => 'string', + 'example' => 'xxxxxxxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-xxxx\\",\\n \\"threadId\\": \\"thread-123123\\",\\n \\"total\\": 1,\\n \\"maxResults\\": 20,\\n \\"threads\\": [\\n {\\n \\"threadId\\": \\"thread-123123\\",\\n \\"digitalEmployeeName\\": \\"test\\",\\n \\"title\\": \\"test\\",\\n \\"status\\": \\"active\\",\\n \\"version\\": 123123,\\n \\"variables\\": {\\n \\"workspace\\": \\"workspace\\",\\n \\"project\\": \\"project\\"\\n },\\n \\"createTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\",\\n \\"updateTime\\": \\"2025-12-19T15:19:55.040403272+08:00\\"\\n }\\n ],\\n \\"nextToken\\": \\"xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => '列出会话', + 'description' => '列出会话', + ], + 'UpdateThread' => [ + 'summary' => '更新会话。', + 'path' => '/digitalEmployee/{name}/thread/{threadId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'threadId', + 'in' => 'path', + 'schema' => [ + 'description' => '会话 id', + 'type' => 'string', + 'required' => true, + 'example' => 'thread-12313', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 body', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'description' => '会话标题', + 'type' => 'string', + 'required' => false, + 'example' => 'title', + ], + 'status' => [ + 'description' => '会话状态', + 'type' => 'string', + 'required' => false, + 'example' => 'active', + 'enum' => [ + 'active', + 'archived', + 'failed', + 'suspended', + 'cancelled', + 'unknown', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'threadId' => [ + 'description' => '会话 id', + 'type' => 'string', + 'example' => 'thread-12313', + ], + 'version' => [ + 'description' => '版本号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"threadId\\": \\"thread-12313\\",\\n \\"version\\": 123123\\n}","type":"json"}]', + 'title' => '更新会话', + 'description' => '更新会话', + ], + 'DeleteThread' => [ + 'summary' => '删除会话。', + 'path' => '/digitalEmployee/{name}/thread/{threadId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => [ + 'description' => '数字员工名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'threadId', + 'in' => 'path', + 'schema' => [ + 'description' => '会话 id', + 'type' => 'string', + 'required' => true, + 'example' => 'thread_id01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '123-0F43-23423-AC43-34234', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\"\\n}","type":"json"}]', + 'title' => '删除会话', + 'description' => '删除会话', + ], + 'UpdateIntegrationPolicy' => [ + 'summary' => '更新指定策略', + 'path' => '/integration-policies/{integrationPolicyId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'feePackage' => [ + 'description' => '付费套餐类型,CS_Pro/CS_Basic/空。', + 'type' => 'string', + 'required' => false, + 'example' => 'CS_Pro', + ], + 'policyName' => [ + 'description' => '规则名称,最短3个字符,最长63个字符,必须以字母开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'metrics-inner-manage', + ], + 'resourceGroupId' => [ + 'description' => '实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzoiafjtr7zyq', + ], + 'tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'algo_bhv_expose_in_airec_exposure', + ], + 'value' => [ + 'description' => '标签`value`值。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\'Id\': \'kgqie6hm\', \'Name\': \'Sheet1\'}]', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'integrationPolicyId', + 'in' => 'path', + 'schema' => [ + 'description' => '接入中心策略ID', + 'type' => 'string', + 'required' => true, + 'example' => 'polixy-xxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + 'title' => '更新接入中心策略', + ], + 'DeleteIntegrationPolicy' => [ + 'summary' => '删除接入中心策略', + 'path' => '/integration-policies/{policyId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除云原生一体机。'."\n" + .'默认值:`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'description' => '策略环境 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-273c360bed1948818c5fb861886bc405', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + 'title' => '删除接入中心策略', + ], + 'CreateIntegrationPolicy' => [ + 'summary' => '创建接入中心策略', + 'path' => '/integration-policies', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'entityGroup' => [ + 'description' => '用于创建策略的实体组,可以通过实体组快速创建,clusterId和vpcId是互相独立的。', + 'type' => 'object', + 'properties' => [ + 'clusterEntityType' => [ + 'description' => '集群实体类型,acs.ack.cluster/acs.one.cluster/acs.asi.cluster或其他。', + 'type' => 'string', + 'required' => false, + 'example' => 'acs.ack.cluster', + ], + 'clusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'na61prod3-na61cloudhdfsssd', + ], + 'entityUserId' => [ + 'description' => '集群归属用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12xxxx', + ], + 'entityGroupId' => [ + 'description' => '实体组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', + ], + 'vpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp18fgg3ffxa9czna40xt', + ], + 'disablePolicyShare' => [ + 'description' => '是否禁用 Policy 唯一绑定,如果开启则可以为一个容器集群创建多个Policy', + 'type' => 'boolean', + 'required' => false, + 'example' => 'ture', + ], + 'clusterNamespace' => [ + 'title' => '', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'policyName' => [ + 'title' => '策略名称', + 'description' => '策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod-database', + ], + 'policyType' => [ + 'title' => '策略类型:CS/ECS/Cloud', + 'description' => '策略类型:CS/ECS/Cloud', + 'type' => 'string', + 'required' => true, + 'example' => 'CS', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekz2km4kmhtbii', + ], + 'tags' => [ + 'description' => '资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'use', + ], + 'value' => [ + 'description' => '标签`value`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'workspace' => [ + 'title' => '工作空间,不填则创建或使用默认工作空间。', + 'description' => '工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'prometheus', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'policy' => [ + 'description' => '上传策略。', + 'type' => 'object', + 'properties' => [ + 'entityGroupId' => [ + 'description' => '实体组ID。', + 'type' => 'string', + 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', + ], + 'policyId' => [ + 'title' => '策略id', + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'policy-14c8e9a29b0a46da843f8781471062ff', + ], + 'policyName' => [ + 'title' => '策略名称', + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'metrics-inner-manage', + ], + 'policyType' => [ + 'title' => '策略类型', + 'description' => '策略类型。', + 'type' => 'string', + 'example' => 'CS', + ], + 'regionId' => [ + 'title' => 'region', + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'u1234567', + ], + 'workspace' => [ + 'title' => 'Policy所在的工作空间。', + 'description' => 'Policy所在的工作空间。', + 'type' => 'string', + 'example' => 'prometheus', + ], + ], + ], + 'requestId' => [ + 'title' => '', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + 'created' => [ + 'description' => '是否创建。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"policy\\": {\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"policyId\\": \\"policy-14c8e9a29b0a46da843f8781471062ff\\",\\n \\"policyName\\": \\"metrics-inner-manage\\",\\n \\"policyType\\": \\"CS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"u1234567\\",\\n \\"workspace\\": \\"prometheus\\"\\n },\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"created\\": true\\n}","type":"json"}]', + 'title' => '创建接入中心策略', + 'description' => '本接口用于支持用户创建事件集成', + ], + 'UpdateAddonRelease' => [ + 'summary' => '升级接入组件', + 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'releaseName', + 'in' => 'path', + 'schema' => [ + 'title' => 'Release 的名称。', + 'description' => 'Release 的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-gpu-integration-name', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'addonVersion' => [ + 'title' => 'Addon 的版本信息。', + 'description' => 'Addon 的版本信息。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.2', + ], + 'dryRun' => [ + 'title' => '是否预检本次请求。', + 'description' => '是否预检本次请求。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'values' => [ + 'title' => '元数据信息。', + 'description' => '元数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + ], + 'entityRules' => [ + 'title' => '实体发现规则。', + 'description' => '实体发现规则。', + 'required' => false, + '$ref' => '#/components/schemas/EntityDiscoverRule', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '策略环境 ID。', + 'description' => '策略环境 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-xxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F00A7AF-2728-5424-B321-79D39C00A1EC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9F00A7AF-2728-5424-B321-79D39C00A1EC\\"\\n}","type":"json"}]', + 'title' => '更新接入组件配置', + ], + 'ListIntegrationPolicyStorageRequirements' => [ + 'summary' => '获取接入中心策略的存储要求信息', + 'path' => '/integration-policies/{policyId}/storage-requirements', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '接入中心策略ID', + 'description' => '接入中心策略ID', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', + ], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon名称,如mysql。', + 'description' => 'Addon Release名称', + 'type' => 'string', + 'required' => false, + 'example' => 'release-1234357', + ], + ], + [ + 'name' => 'storageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型', + 'description' => '存储类型,LogStore/Prometheus/TraceStore/EventStore/EntityStore。', + 'type' => 'string', + 'required' => false, + 'example' => 'LogStore', + ], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'AddonRelease的名称。', + 'description' => 'AddonRelease的名称', + 'type' => 'string', + 'required' => false, + 'example' => 'kafka-17201012937917', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + 'storageRequirements' => [ + 'description' => '存储需求列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'apiVersion' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => 'v1', + ], + 'kind' => [ + 'description' => '资源kind', + 'type' => 'string', + 'example' => 'Pod', + ], + 'metadata' => [ + 'description' => '元数据', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => '注释', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '注释', + 'example' => 'prometheus.io/path', + ], + ], + 'labels' => [ + 'description' => '资源标签', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '资源标签', + 'example' => 'key=value', + ], + ], + 'name' => [ + 'description' => '资源名称', + 'type' => 'string', + 'example' => 'pod-1234567', + ], + 'namespace' => [ + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'arms-prom', + ], + ], + ], + 'spec' => [ + 'description' => '资源的spec', + 'type' => 'object', + 'properties' => [ + 'entityId' => [ + 'description' => '实例ID,如需精确到实例级别,则可以指定。依赖于 EntityStore 中的数据。', + 'type' => 'string', + 'example' => 'es-xxxxx', + ], + 'instance' => [ + 'description' => 'Prom实例ID。', + 'type' => 'string', + 'example' => 'i-bp122p85gthbniw8rsu9', + ], + 'instanceName' => [ + 'description' => 'Prom实例名称', + 'type' => 'string', + 'example' => 'category_predict', + ], + 'project' => [ + 'description' => '可选参数,根据当前环境类型情况判断 Project', + 'type' => 'string', + 'example' => 'datagrid_cdm', + ], + 'region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-shenzhen', + ], + 'shareScope' => [ + 'description' => '存储共享的范围 Environment | Region | Workspace | Custom', + 'type' => 'string', + 'example' => 'Region', + ], + 'storageType' => [ + 'description' => '实例存储类型', + 'type' => 'string', + 'example' => 'Prometheus', + ], + 'systemTags' => [ + 'description' => '需要打到目标存储上的标签(以系统标签的方式注入)', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'system-key=value', + 'description' => '需要打到目标存储上的标签(以系统标签的方式注入)', + ], + ], + 'tags' => [ + 'description' => '需要打到目标存储上的标签(以普通标签的方式注入)', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'key=value', + 'description' => '需要打到目标存储上的标签(以普通标签的方式注入)', + ], + ], + 'userId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '12345678', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'test-api', + ], + ], + ], + 'status' => [ + 'description' => '存储需求状态。', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'rmq-cn-uqm3ket1t0u', + ], + 'interUrl' => [ + 'description' => '内部url', + 'type' => 'string', + 'example' => 'http://192.168.xxxxxx', + ], + 'intraUrl' => [ + 'description' => '外部url', + 'type' => 'string', + 'example' => 'http://100.100.xxxxxx', + ], + 'name' => [ + 'description' => '存储需求名称', + 'type' => 'string', + 'example' => 'sr-xxxx', + ], + 'project' => [ + 'description' => '存储需求项目', + 'type' => 'string', + 'example' => 'jiuwu_algo', + ], + 'promMetricStore' => [ + 'description' => 'Prom的指标中心', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'storageType' => [ + 'description' => '实例存储类型', + 'type' => 'string', + 'example' => 'Prometheus', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default', + ], + ], + ], + 'addonReleaseNames' => [ + 'description' => 'AddonRelease的集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'AddonRelease的名称。', + 'type' => 'string', + 'example' => 'kafka-17201238912', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"storageRequirements\\": [\\n {\\n \\"apiVersion\\": \\"v1\\",\\n \\"kind\\": \\"Pod\\",\\n \\"metadata\\": {\\n \\"annotations\\": {\\n \\"key\\": \\"prometheus.io/path\\"\\n },\\n \\"labels\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"name\\": \\"pod-1234567\\",\\n \\"namespace\\": \\"arms-prom\\"\\n },\\n \\"spec\\": {\\n \\"entityId\\": \\"es-xxxxx\\",\\n \\"instance\\": \\"i-bp122p85gthbniw8rsu9\\",\\n \\"instanceName\\": \\"category_predict\\",\\n \\"project\\": \\"datagrid_cdm\\",\\n \\"region\\": \\"cn-shenzhen\\",\\n \\"shareScope\\": \\"Region\\",\\n \\"storageType\\": \\"Prometheus\\",\\n \\"systemTags\\": {\\n \\"key\\": \\"system-key=value\\"\\n },\\n \\"tags\\": {\\n \\"key\\": \\"key=value\\"\\n },\\n \\"userId\\": \\"12345678\\",\\n \\"workspace\\": \\"test-api\\"\\n },\\n \\"status\\": {\\n \\"instanceId\\": \\"rmq-cn-uqm3ket1t0u\\",\\n \\"interUrl\\": \\"http://192.168.xxxxxx\\",\\n \\"intraUrl\\": \\"http://100.100.xxxxxx\\",\\n \\"name\\": \\"sr-xxxx\\",\\n \\"project\\": \\"jiuwu_algo\\",\\n \\"promMetricStore\\": \\"xxxx\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"storageType\\": \\"Prometheus\\",\\n \\"workspace\\": \\"default\\"\\n },\\n \\"addonReleaseNames\\": [\\n \\"kafka-17201238912\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取接入中心策略的存储要求信息', + 'description' => '在策略的生效期间内,应用分组内发生的所有报警都不再发送通知。'."\n" + .' '."\n" + .'本文将提供一个示例,为应用分组`7301****`创建暂停报警通知策略`PauseNotify`,该应用分组将在`1622949300000`至`1623208500000`(北京时间`2021-06-06 11:15:00`至`2021-06-09 11:15:00`)期间暂停报警。 ', + ], + 'ListIntegrationPolicyPodMonitors' => [ + 'summary' => '获取接入中心策略的PodMonitor资源。', + 'path' => '/integration-policies/{policyId}/pod-monitors', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '接入中心策略ID。', + 'description' => '接入中心策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-1d4634924c8ba599822c601fcee3', + ], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon Release名称。', + 'description' => 'Addon Release名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'release-123456789', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间。', + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => [ + 'title' => '是否加密Yaml。', + 'description' => '是否加密Yaml。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'et15prod-et15storage', + ], + 'podMonitors' => [ + 'description' => 'PodMontior列表', + 'type' => 'array', + 'items' => [ + 'description' => 'PodMontior列表', + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'description' => 'Addon 名称。', + 'type' => 'string', + 'example' => 'cloud-ecs', + ], + 'addonReleaseName' => [ + 'description' => 'AddonRelease名称。', + 'type' => 'string', + 'example' => 'release-2345678', + ], + 'addonVersion' => [ + 'description' => 'Addon版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'configYaml' => [ + 'description' => '配置yaml。', + 'type' => 'string', + 'example' => 'apiVersion: xxxxx', + ], + 'enableStatus' => [ + 'description' => '启用状态。', + 'type' => 'string', + 'example' => 'run', + ], + 'encryptYaml' => [ + 'description' => '加密yaml。', + 'type' => 'boolean', + 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', + ], + 'endpoints' => [ + 'description' => '实例的接入点。', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint详情', + 'type' => 'object', + 'properties' => [ + 'interval' => [ + 'description' => '采集间隔', + 'type' => 'string', + 'example' => '30s', + ], + 'matchedTargetCount' => [ + 'description' => '匹配的target数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'path' => [ + 'description' => '指标采集路径', + 'type' => 'string', + 'example' => '/metrics', + ], + 'port' => [ + 'description' => '端口号', + 'type' => 'string', + 'example' => '9100', + ], + 'targetPort' => [ + 'description' => '目标端口', + 'type' => 'string', + 'example' => 'https', + ], + ], + ], + ], + 'matchedPodCount' => [ + 'description' => '匹配pod的数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'name' => [ + 'description' => '采集名称。', + 'type' => 'string', + 'example' => 'znzmo_entity_test', + ], + 'namespace' => [ + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'sla-ns-d5aeb2b4f91b47', + ], + ], + ], + ], + 'policyId' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"et15prod-et15storage\\",\\n \\"podMonitors\\": [\\n {\\n \\"addonName\\": \\"cloud-ecs\\",\\n \\"addonReleaseName\\": \\"release-2345678\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"apiVersion: xxxxx\\",\\n \\"enableStatus\\": \\"run\\",\\n \\"encryptYaml\\": true,\\n \\"endpoints\\": [\\n {\\n \\"interval\\": \\"30s\\",\\n \\"matchedTargetCount\\": 1,\\n \\"path\\": \\"/metrics\\",\\n \\"port\\": \\"9100\\",\\n \\"targetPort\\": \\"https\\"\\n }\\n ],\\n \\"matchedPodCount\\": 3,\\n \\"name\\": \\"znzmo_entity_test\\",\\n \\"namespace\\": \\"sla-ns-d5aeb2b4f91b47\\"\\n }\\n ],\\n \\"policyId\\": \\"policy-c9efed2b99c348d49e589c5f780fc074\\",\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + 'title' => '查询接入中心策略的PodMonitor资源', + 'description' => '本文将提供一个示例,查询报警模板列表。返回结果显示,报警模板列表中共有2个报警模板,分别是`ECS_Template1`和`ECS_Template2`。', + ], + 'ListIntegrationPolicyDashboards' => [ + 'summary' => '查询大盘列表。', + 'path' => '/integration-policies/{policyId}/dashboards', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', + ], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Addon 名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cs-default', + ], + ], + [ + 'name' => 'scene', + 'in' => 'query', + 'schema' => [ + 'description' => '组件场景。', + 'type' => 'string', + 'required' => false, + 'example' => 'databse', + ], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '查询语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + 'enum' => [ + 'zh', + 'en', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + 'total' => [ + 'description' => '组件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘的列表。', + 'type' => 'object', + 'properties' => [ + 'uid' => [ + 'description' => '当前阿里云主账号的ID,只读', + 'type' => 'string', + 'example' => '1258199346721590', + ], + 'engine' => [ + 'title' => '大盘引擎:'."\n" + .'grafana:共享grafana。'."\n" + .'cms:cms自研大盘引擎。', + 'description' => '大盘引擎:'."\n" + .'grafana:共享grafana。'."\n" + .'cms:cms自研大盘引擎。', + 'type' => 'string', + 'example' => 'grafana', + ], + 'title' => [ + 'description' => 'UI模块的标题(非name)', + 'type' => 'string', + 'example' => 'test', + ], + 'name' => [ + 'title' => '大盘名称', + 'description' => '大盘名称', + 'type' => 'string', + 'example' => 'k8s-pod', + ], + 'url' => [ + 'description' => 'pagerDuty的集成webhook。支持V1和V2版', + 'type' => 'string', + 'example' => 'https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg', + ], + 'region' => [ + 'description' => '地域', + 'type' => 'string', + 'example' => 'cn-hongkong', + ], + 'folderUid' => [ + 'description' => '大盘目录UID。', + 'type' => 'string', + 'example' => 'Env-AAA', + ], + 'tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tag1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1,\\n \\"dashboards\\": [\\n {\\n \\"uid\\": \\"1258199346721590\\",\\n \\"engine\\": \\"grafana\\",\\n \\"title\\": \\"test\\",\\n \\"name\\": \\"k8s-pod\\",\\n \\"url\\": \\"https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg\\",\\n \\"region\\": \\"cn-hongkong\\",\\n \\"folderUid\\": \\"Env-AAA\\",\\n \\"tags\\": [\\n \\"tag1\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询大盘列表', + 'description' => '本文将提供一个示例,查询报警模板列表。返回结果显示,报警模板列表中共有2个报警模板,分别是`ECS_Template1`和`ECS_Template2`。', + ], + 'ListIntegrationPolicyCustomScrapeJobRules' => [ + 'summary' => '获取接入中心策略的自定义服务发现规则。', + 'path' => '/integration-policies/{policyId}/custom-scrape-job-rules', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '接入中心策略ID。', + 'description' => '接入中心策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-d95435164593aece55f9999ce45c', + ], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon Release名称。', + 'description' => 'Addon Release名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'release12345678', + ], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => [ + 'title' => '是否加密Yaml。', + 'description' => '是否加密Yaml。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间。', + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-prom', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'et15prod-et15storage', + ], + 'customScrapeJobRules' => [ + 'description' => '自定义采集任务规则', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务发现规则', + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'description' => 'Addon 名称。', + 'type' => 'string', + 'example' => 'cloud-ecs', + ], + 'addonReleaseName' => [ + 'description' => 'AddonRelease 名称', + 'type' => 'string', + 'example' => 'release-12345678', + ], + 'addonVersion' => [ + 'description' => 'Addon 版本', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'configYaml' => [ + 'description' => '配置yaml', + 'type' => 'string', + 'example' => 'scrape_cofnigs:'."\n" + .'- jobxxxxxx', + ], + 'enableStatus' => [ + 'description' => '启用状态', + 'type' => 'string', + 'example' => 'mini', + ], + 'encryptYaml' => [ + 'description' => '加密yaml', + 'type' => 'boolean', + 'example' => 'true', + ], + 'matchedPodCount' => [ + 'description' => '匹配到的pod数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'name' => [ + 'description' => '服务名。', + 'type' => 'string', + 'example' => 'dlab1', + ], + 'namespace' => [ + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'prod-data', + ], + 'scrapeConfigs' => [ + 'description' => '自定义配置', + 'type' => 'array', + 'items' => [ + 'description' => '自定义配置', + 'type' => 'object', + 'properties' => [ + 'jobName' => [ + 'description' => '采集名称', + 'type' => 'string', + 'example' => 'mysql-exporter', + ], + 'message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'metricsPath' => [ + 'description' => '采集path', + 'type' => 'string', + 'example' => '/metrics', + ], + 'scheme' => [ + 'description' => '调用方式。', + 'type' => 'string', + 'example' => 'http', + ], + 'scrapeInterval' => [ + 'description' => '采集间隔', + 'type' => 'string', + 'example' => '30s', + ], + 'scrapeTimeout' => [ + 'description' => '采集超时时间', + 'type' => 'string', + 'example' => '60s', + ], + 'serviceDiscoveryConfigs' => [ + 'description' => '服务发现配置', + 'type' => 'array', + 'items' => [ + 'description' => '服务发现配置', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + 'policyId' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-15abcc24c06f4797832b5954198e1ed1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"et15prod-et15storage\\",\\n \\"customScrapeJobRules\\": [\\n {\\n \\"addonName\\": \\"cloud-ecs\\",\\n \\"addonReleaseName\\": \\"release-12345678\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"scrape_cofnigs:\\\\n- jobxxxxxx\\",\\n \\"enableStatus\\": \\"mini\\",\\n \\"encryptYaml\\": true,\\n \\"matchedPodCount\\": 1,\\n \\"message\\": \\"ok\\",\\n \\"name\\": \\"dlab1\\",\\n \\"namespace\\": \\"prod-data\\",\\n \\"scrapeConfigs\\": [\\n {\\n \\"jobName\\": \\"mysql-exporter\\",\\n \\"message\\": \\"successful\\",\\n \\"metricsPath\\": \\"/metrics\\",\\n \\"scheme\\": \\"http\\",\\n \\"scrapeInterval\\": \\"30s\\",\\n \\"scrapeTimeout\\": \\"60s\\",\\n \\"serviceDiscoveryConfigs\\": [\\n \\"{}\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"policyId\\": \\"policy-15abcc24c06f4797832b5954198e1ed1\\",\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + 'title' => '获取接入中心策略的自定义服务发现规则', + ], + 'ListIntegrationPolicies' => [ + 'summary' => '查询接入中心策略列表信息', + 'path' => '/integration-policies', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'query', + 'schema' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-93817a401f78435596d745a97d2e85a1', + ], + ], + [ + 'name' => 'policyName', + 'in' => 'query', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod-database', + ], + ], + [ + 'name' => 'policyType', + 'in' => 'query', + 'schema' => [ + 'description' => '策略类型', + 'type' => 'string', + 'required' => false, + 'example' => 'CS', + ], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Addon 名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cs-default', + ], + ], + [ + 'name' => 'filterRegionIds', + 'in' => 'query', + 'schema' => [ + 'title' => '指定筛选的regionId(目前仅支持单regioinId,暂不支持多值)。', + 'description' => '用于Region查询,以英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing,cn-hangzhou', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxxx', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表,JSON格式。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'value' => [ + 'description' => '标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '用来返回更多结果。第一次查询不需要提供这个参数,后续查询所需使用的Token,从返回结果中获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'mvnX6zqg3P', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回结果数。默认30,最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'entityGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '实体ID的过滤,以英文逗号分隔', + 'type' => 'string', + 'required' => false, + 'example' => 'eg-1,eg-2,eg-3', + ], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo', + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'description' => '用于通用查询', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'prometheusInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'cmee-622d27c2e87d49debceeebc7c642610e', + ], + ], + [ + 'name' => 'bindResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定的资源Id', + 'description' => '绑定的资源Id', + 'type' => 'string', + 'required' => false, + 'example' => '622d27c2e87d49debceeebc7c642610e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'description' => '分页大小'."\n" + .'默认值:'."\n" + .' 50'."\n" + .'最大值:'."\n" + .' 50', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'nextToken' => [ + 'description' => '分页Token', + 'type' => 'string', + 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', + ], + 'policies' => [ + 'description' => '接入策略列表', + 'type' => 'array', + 'items' => [ + 'description' => '接入策略', + 'type' => 'object', + 'properties' => [ + 'bindResource' => [ + 'description' => '绑定的资源信息', + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cv68tt87d78vyc89zy9v', + ], + 'clusterType' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'vpcCidr' => [ + 'description' => 'VPC网段', + 'type' => 'string', + 'example' => '100.100.0.1/16', + ], + 'vpcId' => [ + 'description' => '虚拟专有网络。', + 'type' => 'string', + 'example' => 'vpc-uf664nyle5khp5d4d7hdo', + ], + ], + ], + 'entityGroup' => [ + 'description' => '实体组', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'entityGroupId' => [ + 'description' => '实体组ID', + 'type' => 'string', + 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', + ], + 'entityGroupName' => [ + 'description' => '实体组名称', + 'type' => 'string', + 'example' => 'test-eg', + ], + 'entityRules' => [ + 'description' => '实体组', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => '注释', + 'type' => 'array', + 'items' => [ + 'description' => '注释', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + 'tagKey' => [ + 'description' => '标签的键。', + 'type' => 'string', + 'example' => 'key', + ], + 'tagValues' => [ + 'description' => '标签的值', + 'type' => 'array', + 'items' => [ + 'description' => '标签的值', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + 'entityTypes' => [ + 'description' => '实体类型列表', + 'type' => 'array', + 'items' => [ + 'description' => '实体类型', + 'type' => 'string', + 'example' => 'ECS', + ], + ], + 'fieldRules' => [ + 'description' => '字段规则', + 'type' => 'array', + 'items' => [ + 'description' => '字段规则', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => [ + 'description' => '字段的唯一标识。', + 'type' => 'string', + 'example' => 'test', + ], + 'fieldValues' => [ + 'description' => '字段内容,多值用英文,分隔。', + 'type' => 'array', + 'items' => [ + 'description' => '字段内容,多值用英文,分隔。', + 'type' => 'string', + 'example' => 'field1,fieled2', + ], + ], + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + ], + ], + ], + 'instanceIds' => [ + 'description' => '实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => '6fq8fvvcb,owqeq789r', + ], + ], + 'ipMatchRule' => [ + 'description' => 'IP匹配规则', + 'type' => 'object', + 'properties' => [ + 'ipCidr' => [ + 'description' => 'IP网段', + 'type' => 'string', + 'example' => '100.100.1.0/16', + ], + 'ipFieldKey' => [ + 'description' => 'IP字段的key', + 'type' => 'string', + 'example' => 'xxxx', + ], + ], + ], + 'labels' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签`value`值。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + 'tagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'test', + ], + 'tagValues' => [ + 'description' => '标签的值', + 'type' => 'array', + 'items' => [ + 'description' => '标签的值', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + 'regionIds' => [ + 'description' => '地域ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'cn-beijing,cn-hangzhou', + ], + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-5i6dbwxfxuqihk7k', + ], + 'tags' => [ + 'description' => '实例的标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + 'tagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key', + ], + 'tagValues' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + ], + 'query' => [ + 'description' => '搜索的关键词,支持文档库名称和描述', + 'type' => 'string', + 'example' => '哈弗', + ], + 'regionId' => [ + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'userId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '1236812738', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'test-api', + ], + ], + ], + 'managedInfo' => [ + 'description' => '策略网络管理信息。', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => [ + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-xxxxx', + ], + 'vswitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-xxxxxx', + ], + 'eniId' => [ + 'title' => '托管探针的eni网卡id。例如: eni-xxxx。', + 'description' => '托管探针的eni网卡id。例如: eni-xxxx。', + 'type' => 'string', + 'example' => 'eni-12345678', + ], + ], + ], + 'policyId' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', + ], + 'policyName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => '6f5HSsg3AP', + ], + 'policyType' => [ + 'description' => '接入中心策略类型', + 'type' => 'string', + 'example' => 'ECS', + ], + 'regionId' => [ + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-xxxxx', + ], + 'userId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '128470923', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'test-api', + ], + 'feePackage' => [ + 'description' => '计费类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CS_Pro' => 'CS_Pro', + 'CS_Basic' => 'CS_Basic', + ], + 'example' => 'CS_Pro', + ], + 'subAddonRelease' => [ + 'description' => '子Release数量', + 'type' => 'object', + 'properties' => [ + 'total' => [ + 'description' => '规则数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '278', + ], + 'ready' => [ + 'description' => '已就绪的子Release数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + 'csUmodelStatus' => [ + 'description' => '容器环境umodel安装状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + 'totalCount' => [ + 'description' => '条目总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE\\",\\n \\"policies\\": [\\n {\\n \\"bindResource\\": {\\n \\"clusterId\\": \\"cv68tt87d78vyc89zy9v\\",\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcCidr\\": \\"100.100.0.1/16\\",\\n \\"vpcId\\": \\"vpc-uf664nyle5khp5d4d7hdo\\"\\n },\\n \\"entityGroup\\": {\\n \\"description\\": \\"xxxx\\",\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"entityGroupName\\": \\"test-eg\\",\\n \\"entityRules\\": {\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key\\",\\n \\"tagValues\\": [\\n \\"value\\"\\n ]\\n }\\n ],\\n \\"entityTypes\\": [\\n \\"ECS\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"test\\",\\n \\"fieldValues\\": [\\n \\"field1,fieled2\\"\\n ],\\n \\"op\\": \\"add\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"6fq8fvvcb,owqeq789r\\"\\n ],\\n \\"ipMatchRule\\": {\\n \\"ipCidr\\": \\"100.100.1.0/16\\",\\n \\"ipFieldKey\\": \\"xxxx\\"\\n },\\n \\"labels\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"test\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ],\\n \\"regionIds\\": [\\n \\"cn-beijing,cn-hangzhou\\"\\n ],\\n \\"resourceGroupId\\": \\"rg-5i6dbwxfxuqihk7k\\",\\n \\"tags\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ]\\n },\\n \\"query\\": \\"哈弗\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"1236812738\\",\\n \\"workspace\\": \\"test-api\\"\\n },\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxx\\",\\n \\"eniId\\": \\"eni-12345678\\"\\n },\\n \\"policyId\\": \\"policy-ac38a7cb02d14ff48bc9f97d0a75063e\\",\\n \\"policyName\\": \\"6f5HSsg3AP\\",\\n \\"policyType\\": \\"ECS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"resourceGroupId\\": \\"rg-xxxxx\\",\\n \\"userId\\": \\"128470923\\",\\n \\"workspace\\": \\"test-api\\",\\n \\"feePackage\\": \\"CS_Pro\\",\\n \\"subAddonRelease\\": {\\n \\"total\\": 278,\\n \\"ready\\": 30\\n },\\n \\"csUmodelStatus\\": true\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"totalCount\\": 0\\n}","type":"json"}]', + 'title' => '查询接入中心策略列表信息', + 'description' => '查询集成列表', + ], + 'ListAddonReleases' => [ + 'summary' => 'addon的release列表', + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '策略环境 ID。', + 'description' => '策略环境 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-xxxxxxxxxxxx', + ], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => [ + 'title' => '组件 Addon 名称。', + 'description' => '组件 Addon 名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cs-gpu', + ], + ], + [ + 'name' => 'parentAddonReleaseId', + 'in' => 'query', + 'schema' => [ + 'title' => '父级 AddonReleaseId。', + 'description' => '父级 AddonReleaseId。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-xxxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'releases' => [ + 'description' => '接入组件信息集。', + 'type' => 'array', + 'items' => [ + 'description' => '接入组件信息集。', + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'title' => 'Addon 名称。', + 'description' => 'Addon 名称。', + 'type' => 'string', + 'example' => 'cs-gpu', + ], + 'alertRuleCount' => [ + 'title' => '告警规则数量。', + 'description' => '告警规则数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'conditions' => [ + 'title' => '安装阶段状况信息汇总。'."\n" + ."\n" + .'Type 包括四个:Loaded(加载配置),Installed(执行安装),Ready(执行安装后就绪检查),UnInstalled(执行卸载)。四个状况理论上顺序出现。'."\n" + ."\n" + .'Status: 可选值包括:Unknown(正处在当前阶段执行),True(执行就绪),False(执行失败)'."\n" + ."\n" + .'完整状态判断说明:'."\n" + .'Loaded,Installed,Ready 只要有一个的 Status=False,则代表安装失败,Ready 的 Status=True,则代表安装成功,其他情况则代表正在安装中。'."\n" + ."\n" + .'UnInstalled 只要存在,则代表正在执行卸载。Status=True 则代表卸载成功,Status=Unknown 代表执行卸载中,Status=False 代表卸载失败。'."\n", + 'description' => '安装阶段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '安装阶段信息。', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => [ + 'title' => '第一次转换时间。', + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:22+08:00', + ], + 'lastTransitionTime' => [ + 'title' => '最后一次转换时间。', + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:22+08:00', + ], + 'message' => [ + 'title' => '详细信息。', + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'The addon loaded successfully', + ], + 'status' => [ + 'title' => '阶段状态。', + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => 'True', + ], + 'type' => [ + 'title' => '阶段类型。', + 'description' => '阶段类型。', + 'type' => 'string', + 'example' => 'Loaded', + ], + ], + ], + ], + 'config' => [ + 'title' => '组件配置信息。', + 'description' => '组件配置信息。', + 'type' => 'string', + 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + ], + 'createTime' => [ + 'title' => '接入时间。', + 'description' => '接入时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:12+08:00', + ], + 'dashboardCount' => [ + 'title' => '大盘数量。', + 'description' => '大盘数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'environmentId' => [ + 'title' => '环境 ID。', + 'description' => '环境 ID。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxxx', + ], + 'exporterCount' => [ + 'title' => '插件数量。', + 'description' => '插件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'haveConfig' => [ + 'title' => '是否有配置。', + 'description' => '是否有配置。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'installUserId' => [ + 'title' => '接入用户 ID。', + 'description' => '接入用户 ID。', + 'type' => 'string', + 'example' => '175xxxxxxxxx', + ], + 'language' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'managed' => [ + 'title' => '是否为托管组件。', + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'parentAddonReleaseId' => [ + 'title' => '父级 AddonReleaseId。', + 'description' => '父级 AddonReleaseId。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxxxxx', + ], + 'policyId' => [ + 'title' => '策略 ID。', + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxxxxx', + ], + 'regionId' => [ + 'title' => '区域 ID。', + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'releaseId' => [ + 'title' => 'Release ID。', + 'description' => 'Release ID。', + 'type' => 'string', + 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx', + ], + 'releaseName' => [ + 'title' => 'Release 名称。', + 'description' => 'Release 名称。', + 'type' => 'string', + 'example' => 'test-gpu-integration-name', + ], + 'scene' => [ + 'title' => '组件场景。', + 'description' => '组件场景。', + 'type' => 'string', + 'example' => 'container', + ], + 'status' => [ + 'title' => '状态。', + 'description' => '状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'updateTime' => [ + 'title' => '更新时间。', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:23+08:00', + ], + 'userId' => [ + 'title' => '所属用户 ID。', + 'description' => '所属用户 ID。', + 'type' => 'string', + 'example' => '175xxxxxxxxxxxxx', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '0.0.2', + ], + 'envType' => [ + 'title' => '环境类型。', + 'description' => '环境类型。', + 'type' => 'string', + 'example' => 'CS', + ], + 'workspace' => [ + 'title' => '工作空间。', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'subAddonRelease' => [ + 'title' => '子AddonRelease的统计信息', + 'description' => '子AddonRelease的统计信息。', + 'type' => 'object', + 'properties' => [ + 'ready' => [ + 'title' => '已就绪的子Release数量', + 'description' => '已就绪的子Release数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'total' => [ + 'title' => '子Release数量', + 'description' => '子Release数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'nextVersion' => [ + 'description' => '剩余列表起始版本号。', + 'type' => 'string', + 'example' => 'None', + ], + 'entityRules' => [ + 'title' => '实体详情。', + 'description' => '实体详情。', + '$ref' => '#/components/schemas/EntityGroupBase', + ], + 'apiVersion' => [ + 'description' => '版本号', + 'type' => 'string', + 'example' => '2023-03-30', + ], + ], + ], + ], + 'requestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + 'total' => [ + 'title' => '组件数量。', + 'description' => '组件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"releases\\": [\\n {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"175xxxxxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"7339d808-66f9-4d40-83fa-xxxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"container\\",\\n \\"status\\": \\"running\\",\\n \\"updateTime\\": \\"2024-11-04T16:10:23+08:00\\",\\n \\"userId\\": \\"175xxxxxxxxxxxxx\\",\\n \\"version\\": \\"0.0.2\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"subAddonRelease\\": {\\n \\"ready\\": 2,\\n \\"total\\": 3\\n },\\n \\"nextVersion\\": \\"None\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"\\",\\n \\"spl\\": \\"\\"\\n }\\n ],\\n \\"description\\": \\"\\",\\n \\"entityGroupId\\": \\"\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"fieldKey\\": \\"\\",\\n \\"fieldValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"\\",\\n \\"entityTypes\\": [\\n \\"\\"\\n ],\\n \\"regionIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"\\",\\n \\"userId\\": \\"\\"\\n },\\n \\"apiVersion\\": \\"2023-03-30\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\",\\n \\"total\\": 1\\n}","type":"json"}]', + 'title' => '查看接入组件列表', + 'description' => '查询接入配置列表', + ], + 'GetIntegrationPolicy' => [ + 'summary' => '查询接入中心策略信息', + 'path' => '/integration-policies/{policyId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'description' => '策略 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'policy' => [ + 'description' => '接入策略。', + 'type' => 'object', + 'properties' => [ + 'bindResource' => [ + 'description' => '绑定的资源信息。', + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'description' => '集群ID。'."\n", + 'type' => 'string', + 'example' => '00b1630f02814f95a9bce717d8d56bb2 ', + ], + 'clusterType' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'vpcCidr' => [ + 'description' => 'VPC网段。', + 'type' => 'string', + 'example' => '10.12.0.1/16', + ], + 'vpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-2zegqpeyxplhtmdg70xnr', + ], + ], + ], + 'entityGroup' => [ + 'description' => '实体组。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'xxxxxx', + ], + 'entityGroupId' => [ + 'description' => '实体组ID。', + 'type' => 'string', + 'example' => 'eg-b79f65d11fb94e779867cf937c3a3002', + ], + 'entityGroupName' => [ + 'description' => '实体组名称。', + 'type' => 'string', + 'example' => 'prod-database', + ], + 'entityRules' => [ + 'description' => '实体规则。', + 'type' => 'object', + 'properties' => [ + 'annotations' => [ + 'description' => '注释。', + 'type' => 'array', + 'items' => [ + 'description' => '注释。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + 'tagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'use', + ], + 'tagValues' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'db', + ], + ], + ], + ], + ], + 'entityTypes' => [ + 'description' => '实体类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实体类型。', + 'type' => 'string', + 'example' => 'CS', + ], + ], + 'fieldRules' => [ + 'description' => '属性规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '属性规则。', + 'type' => 'object', + 'properties' => [ + 'fieldKey' => [ + 'description' => '字段的唯一标识。', + 'type' => 'string', + 'example' => 'test', + ], + 'fieldValues' => [ + 'description' => '字段内容。', + 'type' => 'array', + 'items' => [ + 'description' => '字段内容。', + 'type' => 'string', + 'example' => 'test-value', + ], + ], + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + ], + ], + ], + 'instanceIds' => [ + 'description' => '实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u', + ], + ], + 'ipMatchRule' => [ + 'description' => 'IP匹配规则。', + 'type' => 'object', + 'properties' => [ + 'ipCidr' => [ + 'description' => 'IP网段。', + 'type' => 'string', + 'example' => '10.10.0.1/16', + ], + 'ipFieldKey' => [ + 'description' => 'IP字段的Key。', + 'type' => 'string', + 'example' => 'test-key', + ], + ], + ], + 'labels' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签`key`值。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + 'tagKey' => [ + 'description' => '实例的标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'tagValues' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + 'regionIds' => [ + 'description' => '地域 ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek3aqsuvlv3yyq', + ], + 'tags' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签value值。', + 'type' => 'object', + 'properties' => [ + 'op' => [ + 'description' => '执行的操作。', + 'type' => 'string', + 'example' => 'add', + ], + 'tagKey' => [ + 'description' => '实例的标签键。', + 'type' => 'string', + 'example' => 'key2', + ], + 'tagValues' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'values', + ], + ], + ], + ], + ], + ], + ], + 'regionId' => [ + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'u123456', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'test-api', + ], + 'query' => [ + 'description' => '用于查询', + 'type' => 'string', + 'example' => 'status: 200 AND totalTime > 0.5', + ], + ], + ], + 'managedInfo' => [ + 'description' => '策略管理信息。', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-xxxxxx', + ], + 'vswitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-xxxxxxxxx', + ], + ], + ], + 'policyId' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-c9efed2b99c348d49e589c5f780fc074', + ], + 'policyName' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'ControlPolicy4DetailVportInfo', + ], + 'policyType' => [ + 'description' => '接入策略类型。', + 'type' => 'string', + 'example' => 'CS', + ], + 'regionId' => [ + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-xxxxx', + ], + 'tags' => [ + 'description' => '标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签Key。', + 'type' => 'string', + 'example' => 'use', + ], + 'value' => [ + 'description' => '标签Value。', + 'type' => 'string', + 'example' => 'db', + ], + ], + ], + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'u123456', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'prometheus', + ], + 'csUmodelStatus' => [ + 'description' => '容器环境umodel安装状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"policy\\": {\\n \\"bindResource\\": {\\n \\"clusterId\\": \\"00b1630f02814f95a9bce717d8d56bb2 \\",\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcCidr\\": \\"10.12.0.1/16\\",\\n \\"vpcId\\": \\"vpc-2zegqpeyxplhtmdg70xnr\\"\\n },\\n \\"entityGroup\\": {\\n \\"description\\": \\"xxxxxx\\",\\n \\"entityGroupId\\": \\"eg-b79f65d11fb94e779867cf937c3a3002\\",\\n \\"entityGroupName\\": \\"prod-database\\",\\n \\"entityRules\\": {\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"use\\",\\n \\"tagValues\\": [\\n \\"db\\"\\n ]\\n }\\n ],\\n \\"entityTypes\\": [\\n \\"CS\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"fieldKey\\": \\"test\\",\\n \\"fieldValues\\": [\\n \\"test-value\\"\\n ],\\n \\"op\\": \\"add\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"i-uf6bsi1aivfbn581buj6,i-uf6eu25p75drryo4712u\\"\\n ],\\n \\"ipMatchRule\\": {\\n \\"ipCidr\\": \\"10.10.0.1/16\\",\\n \\"ipFieldKey\\": \\"test-key\\"\\n },\\n \\"labels\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key1\\",\\n \\"tagValues\\": [\\n \\"value1\\"\\n ]\\n }\\n ],\\n \\"regionIds\\": [\\n \\"cn-beijing\\"\\n ],\\n \\"resourceGroupId\\": \\"rg-aek3aqsuvlv3yyq\\",\\n \\"tags\\": [\\n {\\n \\"op\\": \\"add\\",\\n \\"tagKey\\": \\"key2\\",\\n \\"tagValues\\": [\\n \\"values\\"\\n ]\\n }\\n ]\\n },\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"userId\\": \\"u123456\\",\\n \\"workspace\\": \\"test-api\\",\\n \\"query\\": \\"status: 200 AND totalTime > 0.5\\"\\n },\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxxxxx\\"\\n },\\n \\"policyId\\": \\"policy-c9efed2b99c348d49e589c5f780fc074\\",\\n \\"policyName\\": \\"ControlPolicy4DetailVportInfo\\",\\n \\"policyType\\": \\"CS\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"resourceGroupId\\": \\"rg-xxxxx\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"use\\",\\n \\"value\\": \\"db\\"\\n }\\n ],\\n \\"userId\\": \\"u123456\\",\\n \\"workspace\\": \\"prometheus\\",\\n \\"csUmodelStatus\\": true\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '查询接入中心策略详情', + ], + 'GetAddonRelease' => [ + 'summary' => '查看addon release(查看接入状态)。', + 'path' => '/integration-policies/{policyId}/addon-releases/{releaseName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'releaseName', + 'in' => 'path', + 'schema' => [ + 'title' => 'AddonRelease 的名称。', + 'description' => 'AddonRelease 的名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test-gpu-integration-name', + ], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '环境 ID。', + 'description' => '环境 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-xxxxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'title' => '组件配置。', + 'description' => '组件配置。', + 'type' => 'string', + 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + ], + 'release' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'title' => '组件 Addon 名称。', + 'description' => '组件 Addon 名称。', + 'type' => 'string', + 'example' => 'cs-gpu', + ], + 'alertRuleCount' => [ + 'title' => '告警规则数量。', + 'description' => '告警规则数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'conditions' => [ + 'title' => '安装阶段状况信息汇总。'."\n" + ."\n" + .'Type 包括四个:Loaded(加载配置),Installed(执行安装),Ready(执行安装后就绪检查),UnInstalled(执行卸载)。四个状况理论上顺序出现。'."\n" + ."\n" + .'Status: 可选值包括:Unknown(正处在当前阶段执行),True(执行就绪),False(执行失败)'."\n" + ."\n" + .'完整状态判断说明:'."\n" + .'Loaded,Installed,Ready 只要有一个的 Status=False,则代表安装失败,Ready 的 Status=True,则代表安装成功,其他情况则代表正在安装中。'."\n" + ."\n" + .'UnInstalled 只要存在,则代表正在执行卸载。Status=True 则代表卸载成功,Status=Unknown 代表执行卸载中,Status=False 代表卸载失败。', + 'description' => '安装阶段信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => [ + 'title' => '第一次转换时间。', + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:22+08:00', + ], + 'lastTransitionTime' => [ + 'title' => '最后一次转换时间。', + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:22+08:00', + ], + 'message' => [ + 'title' => '详细信息。', + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'The addon loaded successfully', + ], + 'status' => [ + 'title' => '阶段状态。', + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => 'True', + ], + 'type' => [ + 'title' => '阶段类型。', + 'description' => '阶段类型。', + 'type' => 'string', + 'example' => 'Loaded', + ], + ], + ], + ], + 'config' => [ + 'title' => '组件配置信息。', + 'description' => '组件配置信息。', + 'type' => 'string', + 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + ], + 'createTime' => [ + 'title' => '接入时间。', + 'description' => '接入时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:12+08:00', + ], + 'dashboardCount' => [ + 'title' => '大盘数量。', + 'description' => '大盘数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'environmentId' => [ + 'title' => '环境 ID。', + 'description' => '环境 ID。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxx', + ], + 'exporterCount' => [ + 'title' => '插件数量。', + 'description' => '插件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'haveConfig' => [ + 'title' => '是否有配置。', + 'description' => '是否有配置。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'installUserId' => [ + 'title' => '接入用户 ID。', + 'description' => '接入用户 ID。', + 'type' => 'string', + 'example' => '1707xxxxxxxxxxxx', + ], + 'language' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'managed' => [ + 'title' => '是否为托管组件。', + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'parentAddonReleaseId' => [ + 'title' => '父级 AddonReleaseId。', + 'description' => '父级 AddonReleaseId。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxxxx', + ], + 'policyId' => [ + 'title' => '策略 ID。', + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxxxx', + ], + 'regionId' => [ + 'title' => '区域 ID。', + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'releaseId' => [ + 'title' => 'Release ID。', + 'description' => 'Release ID。', + 'type' => 'string', + 'example' => '7339d808-66f9-4d40-83fa-xxxxxxxxxxx', + ], + 'releaseName' => [ + 'title' => 'Release 的名称。', + 'description' => 'Release 的名称。', + 'type' => 'string', + 'example' => 'test-gpu-integration-name', + ], + 'scene' => [ + 'title' => '组件场景。', + 'description' => '组件场景。', + 'type' => 'string', + 'example' => 'container', + ], + 'status' => [ + 'title' => '组件状态。', + 'description' => '组件状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'updateTime' => [ + 'title' => '更新时间。', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:12+08:00', + ], + 'userId' => [ + 'title' => '所属用户 ID。', + 'description' => '所属用户 ID。', + 'type' => 'string', + 'example' => '1707xxxxxxxxxxxx', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '0.0.2', + ], + 'envType' => [ + 'title' => '环境类型。', + 'description' => '环境类型。', + 'type' => 'string', + 'example' => 'CS', + ], + 'workspace' => [ + 'title' => '工作空间。', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'entityRules' => [ + 'title' => '实体详情。', + 'description' => '实体详情。', + '$ref' => '#/components/schemas/EntityGroupBase', + ], + ], + ], + 'requestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"release\\": {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"1707xxxxxxxxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"7339d808-66f9-4d40-83fa-xxxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"container\\",\\n \\"status\\": \\"running\\",\\n \\"updateTime\\": \\"2024-11-04T16:10:12+08:00\\",\\n \\"userId\\": \\"1707xxxxxxxxxxxx\\",\\n \\"version\\": \\"0.0.2\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"\\",\\n \\"spl\\": \\"\\"\\n }\\n ],\\n \\"description\\": \\"\\",\\n \\"entityGroupId\\": \\"\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"fieldKey\\": \\"\\",\\n \\"fieldValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"\\",\\n \\"entityTypes\\": [\\n \\"\\"\\n ],\\n \\"regionIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"\\",\\n \\"userId\\": \\"\\"\\n }\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '查看接入组件信息', + ], + 'DeleteAddonRelease' => [ + 'summary' => '删除addon release信息。', + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'releaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'AddonRelease 的名称。', + 'description' => 'AddonRelease 的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-gpu-integration-name', + ], + ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => [ + 'title' => '是否硬性删除,默认 false。', + 'description' => '是否硬性删除,默认 false。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '环境 ID。', + 'description' => '环境 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-xxxxxxxxxxxxx', + ], + ], + [ + 'name' => 'addonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon 名称,当 AddonName 赋值时,将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', + 'description' => 'Addon 名称。当 AddonName 赋值时,将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', + 'type' => 'string', + 'required' => false, + 'example' => 'cs-gpu', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '卸载接入组件', + ], + 'CreateAddonRelease' => [ + 'summary' => '安装接入组件,代表进行一次接入', + 'path' => '/integration-policies/{policyId}/addon-releases', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'title' => '需要接入监控的组件 Addon 名称。', + 'description' => '需要接入监控的组件 Addon 名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'cs-gpu', + ], + 'aliyunLang' => [ + 'title' => '组件的语言类型。', + 'description' => '组件的语言类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英语', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + 'dryRun' => [ + 'title' => '是否试运行,默认为 false。', + 'description' => '是否试运行,默认为 false。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '试运行', + 'false' => '不试运行', + ], + 'example' => 'false', + ], + 'envType' => [ + 'title' => '环境类型。如果 Policy 类型为 CS 和 ECS,对应使用,其他类型统一为 Cloud。', + 'description' => '环境类型。如果 Policy 类型为 CS 和 ECS,对应使用,其他类型统一为 Cloud。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CS' => '容器环境', + 'ECS' => 'ECS环境', + 'Cloud' => '云服务环境', + ], + 'example' => 'CS', + ], + 'parentAddonReleaseId' => [ + 'title' => '父级 AddonReleaseId。', + 'description' => '父级 AddonReleaseId。', + 'type' => 'string', + 'required' => false, + 'example' => 'policy-xxxxxxxxxxx', + ], + 'releaseName' => [ + 'title' => '接入后的插件名称,如果不指定则生成默认规则名称。', + 'description' => '接入后的插件名称。如果不指定则生成默认规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-gpu-integration-name', + ], + 'values' => [ + 'title' => '输入的元数据。', + 'description' => '输入的元数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + ], + 'version' => [ + 'title' => '需要接入监控的组件 Addon 版本。', + 'description' => '需要接入监控的组件 Addon 版本。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.2', + ], + 'workspace' => [ + 'title' => '安装组件资源的工作空间名称。'."\n", + 'description' => '安装组件资源的工作空间名称。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'entityRules' => [ + 'title' => '实体发现规则。', + 'description' => '字段规则', + 'required' => false, + '$ref' => '#/components/schemas/EntityDiscoverRule', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '环境策略 ID。', + 'description' => '环境策略 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-yyyyyyyyyy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据。', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'release' => [ + 'title' => '接入组件信息。', + 'description' => '接入组件信息。', + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'title' => '接入监控的组件 Addon 名称。', + 'description' => '接入监控的组件 Addon 名称。', + 'type' => 'string', + 'example' => 'cs-gpu', + ], + 'alertRuleCount' => [ + 'title' => '告警组数量。', + 'description' => '告警组数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'conditions' => [ + 'title' => '组件安装阶段信息。', + 'description' => '组件安装阶段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '操作符,支持精确匹配、前缀匹配、正则表达式三种方式。', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => [ + 'title' => '第一次转换时间。', + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:22+08:00', + ], + 'lastTransitionTime' => [ + 'title' => '最后一次转换时间。', + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2024-11-04T16:10:22+08:00', + ], + 'message' => [ + 'title' => '详细信息。', + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'The addon loaded successfully', + ], + 'status' => [ + 'title' => '阶段状态。', + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => '{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}', + ], + 'type' => [ + 'title' => '阶段类型。', + 'description' => '阶段类型。', + 'type' => 'string', + 'example' => 'Loaded', + ], + ], + ], + ], + 'config' => [ + 'title' => '组件配置。', + 'description' => '组件配置。', + 'type' => 'string', + 'example' => '{"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}', + ], + 'createTime' => [ + 'title' => '接入时间。', + 'description' => '接入时间。', + 'type' => 'string', + 'example' => '2024-11-05T15:21:30+08:00', + ], + 'dashboardCount' => [ + 'title' => '大盘数量。', + 'description' => '大盘数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'environmentId' => [ + 'title' => '环境 ID。', + 'description' => '环境 ID。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxx', + ], + 'exporterCount' => [ + 'title' => '插件数量。', + 'description' => '插件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'haveConfig' => [ + 'title' => '是否有配置。', + 'description' => '是否有配置。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'installUserId' => [ + 'title' => '安装的用户 ID。', + 'description' => '安装的用户 ID。', + 'type' => 'string', + 'example' => '1654218965xxxxxx', + ], + 'language' => [ + 'title' => '语言。', + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'managed' => [ + 'title' => '是否为托管组件。', + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'parentAddonReleaseId' => [ + 'title' => '父级 AddonReleaseId。', + 'description' => '父级 AddonReleaseId。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxxx', + ], + 'policyId' => [ + 'title' => '策略环境 ID。', + 'description' => '策略环境 ID。', + 'type' => 'string', + 'example' => 'policy-xxxxxxxxxx', + ], + 'regionId' => [ + 'title' => '地域 ID。', + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'releaseId' => [ + 'title' => '安装后的 ReleaseID。', + 'description' => '安装后的 ReleaseID。', + 'type' => 'string', + 'example' => '2e898e60-5e6a-46d1-a994-xxxxxxxxxx', + ], + 'releaseName' => [ + 'title' => 'Release 的名称。', + 'description' => 'Release 的名称。', + 'type' => 'string', + 'example' => 'test-gpu-integration-name', + ], + 'scene' => [ + 'title' => '组件场景。', + 'description' => '组件场景。', + 'type' => 'string', + 'example' => '1', + ], + 'status' => [ + 'title' => '组件状态。', + 'description' => '组件状态。', + 'type' => 'string', + 'example' => '200', + ], + 'updateTime' => [ + 'title' => '更新时间。', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2024-09-13T02:21:02Z', + ], + 'userId' => [ + 'title' => '所属用户 ID。', + 'description' => '所属用户 ID。', + 'type' => 'string', + 'example' => '165421896xxxxxx', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'envType' => [ + 'title' => '环境类型。', + 'description' => '环境类型。', + 'type' => 'string', + 'example' => 'CS', + ], + 'workspace' => [ + 'title' => '工作空间。', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'entityRules' => [ + 'title' => '实体详情。', + 'description' => '实体详情。', + '$ref' => '#/components/schemas/EntityGroupBase', + ], + ], + ], + 'requestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"release\\": {\\n \\"addonName\\": \\"cs-gpu\\",\\n \\"alertRuleCount\\": 6,\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-11-04T16:10:22+08:00\\",\\n \\"message\\": \\"The addon loaded successfully\\",\\n \\"status\\": \\"{\'phase\': \'Created\', \'executionDetails\': [], \'invocations\': [], \'latestExecError\': {\'message\': \'\', \'code\': \'\', \'requestId\': \'\', \'extraInfo\': \'\', \'title\': \'\'}}\\",\\n \\"type\\": \\"Loaded\\"\\n }\\n ],\\n \\"config\\": \\"{\\\\\\"install\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"auto-install\\\\\\",\\\\\\"listenPort\\\\\\":\\\\\\"9400\\\\\\"},\\\\\\"discoverMode\\\\\\":\\\\\\"instances\\\\\\",\\\\\\"discover\\\\\\":{\\\\\\"instances\\\\\\":\\\\\\"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44\\\\\\"},\\\\\\"scrapeInterval\\\\\\":\\\\\\"15\\\\\\",\\\\\\"enableSecuritecs-nodeyGroupInjection\\\\\\":\\\\\\"true\\\\\\",\\\\\\"metricTags\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"createTime\\": \\"2024-11-05T15:21:30+08:00\\",\\n \\"dashboardCount\\": 3,\\n \\"environmentId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"exporterCount\\": 2,\\n \\"haveConfig\\": true,\\n \\"installUserId\\": \\"1654218965xxxxxx\\",\\n \\"language\\": \\"zh\\",\\n \\"managed\\": true,\\n \\"parentAddonReleaseId\\": \\"policy-xxxxxxxxxxx\\",\\n \\"policyId\\": \\"policy-xxxxxxxxxx\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"releaseId\\": \\"2e898e60-5e6a-46d1-a994-xxxxxxxxxx\\",\\n \\"releaseName\\": \\"test-gpu-integration-name\\",\\n \\"scene\\": \\"1\\",\\n \\"status\\": \\"200\\",\\n \\"updateTime\\": \\"2024-09-13T02:21:02Z\\",\\n \\"userId\\": \\"165421896xxxxxx\\",\\n \\"version\\": \\"1.0.0\\",\\n \\"envType\\": \\"CS\\",\\n \\"workspace\\": \\"default\\",\\n \\"entityRules\\": {\\n \\"workspace\\": \\"\\",\\n \\"regionId\\": \\"\\",\\n \\"entityQueries\\": [\\n {\\n \\"entityType\\": \\"\\",\\n \\"spl\\": \\"\\"\\n }\\n ],\\n \\"description\\": \\"\\",\\n \\"entityGroupId\\": \\"\\",\\n \\"entityRules\\": {\\n \\"ipMatchRule\\": [\\n {\\n \\"ipFieldKey\\": \\"\\",\\n \\"ipCIDR\\": \\"\\"\\n }\\n ],\\n \\"instanceIds\\": [\\n \\"\\"\\n ],\\n \\"fieldRules\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"fieldKey\\": \\"\\",\\n \\"fieldValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"resourceGroupId\\": \\"\\",\\n \\"entityTypes\\": [\\n \\"\\"\\n ],\\n \\"regionIds\\": [\\n \\"\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"op\\": \\"\\",\\n \\"tagKey\\": \\"\\",\\n \\"tagValues\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n },\\n \\"entityGroupName\\": \\"\\",\\n \\"userId\\": \\"\\"\\n }\\n },\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + 'title' => '安装接入组件', + 'description' => '用于创建一个站点监控任务', + ], + 'GetServiceObservability' => [ + 'summary' => '获取应用可观测实例', + 'path' => '/workspace/{workspace}/service-observability/{type}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => 'CMS2.0工作空间', + 'type' => 'string', + 'required' => true, + 'example' => 'my-test-ws', + ], + ], + [ + 'name' => 'type', + 'in' => 'path', + 'schema' => [ + 'description' => '应用可观测类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'rum' => '用户体验监控', + 'apm' => '应用性能监控', + ], + 'example' => 'apm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4852B9B5-345C-5CBC-A15F-786D83ECCBBA', + ], + 'type' => [ + 'description' => '应用可观测类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'rum' => 'rum', + 'apm' => 'apm', + ], + 'example' => 'apm', + ], + 'regionId' => [ + 'description' => '区域', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'workspace' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'default-cms-1654218***343050-cn-hangzhou', + ], + 'status' => [ + 'description' => '资源初始化状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Running' => '正常', + ], + 'example' => 'Running', + ], + 'entryPointInfo' => [ + 'description' => '接入点以及认证信息', + 'type' => 'object', + 'properties' => [ + 'authToken' => [ + 'description' => '上报数据的认证Token', + 'type' => 'string', + 'example' => 'gaddp****@de20f2***1ce***', + ], + 'publicDomain' => [ + 'description' => '公网访问地址。', + 'type' => 'string', + 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com', + ], + 'privateDomain' => [ + 'description' => '私网访问地址', + 'type' => 'string', + 'example' => 'project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com', + ], + 'project' => [ + 'description' => 'SLS Project', + 'type' => 'string', + 'example' => 'proj-xtrace-xxxxx', + ], + ], + ], + 'feeType' => [ + 'description' => '计费类型', + 'type' => 'string', + 'example' => 'arms=serverless;xtrace=serverless', + ], + 'settings' => [ + 'description' => '系统配置', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"trace_aggregate":"enable"}', + 'description' => '配置KV对', + ], + ], + 'quotas' => [ + 'description' => '限额配置', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"arms_agent_hour": "48"}', + 'description' => '限额配置项Key。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"4852B9B5-345C-5CBC-A15F-786D83ECCBBA\\",\\n \\"type\\": \\"apm\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"workspace\\": \\"default-cms-1654218***343050-cn-hangzhou\\",\\n \\"status\\": \\"Running\\",\\n \\"entryPointInfo\\": {\\n \\"authToken\\": \\"gaddp****@de20f2***1ce***\\",\\n \\"publicDomain\\": \\"project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com\\",\\n \\"privateDomain\\": \\"project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"proj-xtrace-xxxxx\\"\\n },\\n \\"feeType\\": \\"arms=serverless;xtrace=serverless\\",\\n \\"settings\\": {\\n \\"key\\": \\"{\\\\\\"trace_aggregate\\\\\\":\\\\\\"enable\\\\\\"}\\"\\n },\\n \\"quotas\\": {\\n \\"key\\": \\"{\\\\\\"arms_agent_hour\\\\\\": \\\\\\"48\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => '获取应用可观测', + 'extraInfo' => 'settIngs系统配置支持如下:'."\n" + .'* trace_aggregate : enable / disable,用于开源探针接入场景控制是否关闭指标生成', + ], + 'DeleteService' => [ + 'summary' => '删除应用可观测服务', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间', + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用服务id', + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '51B6A3E8-EA9E-5143-BE11-8E5F83474C95', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"51B6A3E8-EA9E-5143-BE11-8E5F83474C95\\"\\n}","type":"json"}]', + 'title' => '删除应用可观测服务', + ], + 'UpdateService' => [ + 'summary' => '更新应用可观测服务', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间', + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用资源id', + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '应用服务', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'displayName' => [ + 'title' => '别名', + 'description' => '显示名称,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'api-monitor-test', + ], + 'description' => [ + 'title' => '应用描述信息。', + 'description' => '服务描述,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'attributes' => [ + 'title' => '特征信息,key:value格式', + 'description' => '扩展属性。', + 'type' => 'string', + 'required' => false, + 'example' => '{"language":"java"}', + ], + 'serviceStatus' => [ + 'title' => '应用体验监控的服务状态,Running/Stopped/Created/Suspend', + 'description' => '服务状态,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'Stopped', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '123-0F43-23423-AC43-34234', + ], + 'serviceId' => [ + 'title' => '应用服务id', + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'em87vd@c2e25bcfe0e21ce0***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"123-0F43-23423-AC43-34234\\",\\n \\"serviceId\\": \\"em87vd@c2e25bcfe0e21ce0***\\"\\n}","type":"json"}]', + 'title' => '更新应用可观测服务', + ], + 'GetService' => [ + 'summary' => '查询应用可观测服务', + 'path' => '/workspace/{workspace}/service/{serviceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间', + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'serviceId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用服务id', + 'description' => '服务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', + ], + 'service' => [ + 'title' => '应用服务', + 'description' => '服务对象。', + 'type' => 'object', + 'properties' => [ + 'serviceId' => [ + 'title' => '应用服务id', + 'description' => '服务ID。', + 'type' => 'string', + 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb'."\n", + ], + 'serviceName' => [ + 'title' => '应用资源名称', + 'description' => '服务名称', + 'type' => 'string', + 'example' => 'demo-app', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-05-13T03:32:55Z', + ], + 'serviceType' => [ + 'title' => '类型:TRACE(应用监控)/ RUM(用户体验监控)/ XTRACE(OT版)', + 'description' => '服务类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TRACE' => 'TRACE', + 'RUM' => 'RUM', + 'XTRACE' => 'XTRACE', + ], + 'example' => 'TRACE', + ], + 'serviceStatus' => [ + 'title' => '应用体验监控的服务状态,Running/Stopped/Created/Suspend', + 'description' => '服务状态,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'example' => 'Running', + ], + 'displayName' => [ + 'title' => '别名', + 'description' => '显示名称,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'example' => 'demo应用', + ], + 'regionId' => [ + 'title' => '地域 ID。', + 'description' => '区域 ID', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间名称', + 'type' => 'string', + 'example' => 'default-cms-1106439496876715-cn-hangzhou', + ], + 'pid' => [ + 'title' => '对应ARMS应用pid', + 'description' => '兼容历史的ARMS应用ID', + 'type' => 'string', + 'example' => 'by6rjzro2j@0fe8dfa799e5906', + ], + 'description' => [ + 'title' => '应用描述信息。', + 'description' => '描述,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'example' => 'test', + ], + 'attributes' => [ + 'title' => '特征信息,key:value格式', + 'description' => '扩展信息。', + 'type' => 'string', + 'example' => '{"language":"java"}', + ], + 'resourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'example' => 'rg-aekxxzuad5zzzz', + ], + 'tags' => [ + 'title' => '标签数组', + 'description' => '标签数组', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签key', + 'description' => '标签key', + 'type' => 'string', + 'example' => 'env', + ], + 'value' => [ + 'title' => '标签value', + 'description' => '标签value', + 'type' => 'string', + 'example' => 'prod', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidService.NotFound', + 'errorMessage' => 'The specified Service does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\",\\n \\"service\\": {\\n \\"serviceId\\": \\"cwzxvuc6uo@4bc6b15ad81f166174ffb\\\\n\\",\\n \\"serviceName\\": \\"demo-app\\",\\n \\"createTime\\": \\"2025-05-13T03:32:55Z\\",\\n \\"serviceType\\": \\"TRACE\\",\\n \\"serviceStatus\\": \\"Running\\",\\n \\"displayName\\": \\"demo应用\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"workspace\\": \\"default-cms-1106439496876715-cn-hangzhou\\",\\n \\"pid\\": \\"by6rjzro2j@0fe8dfa799e5906\\",\\n \\"description\\": \\"test\\",\\n \\"attributes\\": \\"{\\\\\\"language\\\\\\":\\\\\\"java\\\\\\"}\\",\\n \\"resourceGroupId\\": \\"rg-aekxxzuad5zzzz\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询应用可观测服务', + ], + 'CreateService' => [ + 'summary' => '创建应用可观测服务', + 'path' => '/workspace/{workspace}/service', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'serviceName' => [ + 'title' => '应用资源名称', + 'description' => '服务名称', + 'type' => 'string', + 'required' => true, + 'example' => 'mag_test', + ], + 'serviceType' => [ + 'title' => '类型:TRACE(应用监控)/ RUM(用户体验监控)/ XTRACE(OT版)', + 'description' => '服务类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'TRACE' => '应用性能监控', + 'RUM' => '用户体验监控', + 'XTRACE' => 'OpenTelemtry链路追踪', + ], + 'example' => 'TRACE', + ], + 'displayName' => [ + 'title' => '别名', + 'description' => '显示名称,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'mag测试应用', + ], + 'description' => [ + 'title' => '应用描述信息。', + 'description' => '服务描述,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'mag测试应用', + ], + 'attributes' => [ + 'title' => '特征信息,key:value格式', + 'description' => '扩展属性。', + 'type' => 'string', + 'required' => false, + 'example' => '{"language":"java"}', + ], + 'serviceStatus' => [ + 'title' => '应用体验监控的服务状态,Running/Stopped/Created/Suspend', + 'description' => '服务状态,创建服务无需指定。', + 'type' => 'string', + 'required' => false, + 'example' => 'Created', + ], + 'pid' => [ + 'title' => '对应ARMS应用pid', + 'description' => '应用ID,一般无需指定', + 'type' => 'string', + 'required' => false, + 'example' => 'bx3udsi5ie@ed2ba6beebdb6de', + ], + 'resourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-xxxxxxx', + ], + 'tags' => [ + 'title' => '标签数组', + 'description' => '标签数组。', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签key', + 'description' => '标签`key`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'value' => [ + 'title' => '标签value', + 'description' => '标签`value`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default-cms-1793369865235921-cn-shenzhen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3A2FA9E9-9CF1-5CB1-A808-52828F14310D', + ], + 'serviceId' => [ + 'title' => '应用服务id', + 'description' => '服务ID', + 'type' => 'string', + 'example' => 'cwzxvuc6uo@4bc6b15ad81f166174ffb', + ], + 'pid' => [ + 'title' => '对应ARMS应用pid', + 'description' => '兼容历史的ARMS应用ID', + 'type' => 'string', + 'example' => 'cwzxvuc6uo@d60088ad4797d26', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3A2FA9E9-9CF1-5CB1-A808-52828F14310D\\",\\n \\"serviceId\\": \\"cwzxvuc6uo@4bc6b15ad81f166174ffb\\",\\n \\"pid\\": \\"cwzxvuc6uo@d60088ad4797d26\\"\\n}","type":"json"}]', + 'title' => '创建应用可观测服务', + 'requestParamsDescription' => '扩展属性attributes,'."\n" + .'serviceType=TRACE时,可选属性language,可选值java/python/golang;'."\n" + .'serviceType=XTRACE时,可选属性language,可选值参考开源值https://opentelemetry.io/docs/specs/semconv/registry/attributes/telemetry/。', + ], + 'ListServices' => [ + 'summary' => '批量查询应用可观测服务', + 'path' => '/workspace/{workspace}/services', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '翻页的 token,从 NextToken 开始按字典序返回文件信息列表。第一次调用此接口时,设置为空。', + 'description' => '下一次查询的token,为空表示最后一页', + 'type' => 'string', + 'required' => false, + 'example' => '7-b81a-4bc9-bbfa-a50cc6988667', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '查询一页数量,最大500。', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '500', + 'minimum' => '0', + 'exclusiveMinimum' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'title' => '工作空间', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'serviceType', + 'in' => 'query', + 'schema' => [ + 'title' => '类型:TRACE(应用监控)/ RUM(用户体验监控)/ XTRACE(OT版)', + 'description' => '服务类型', + 'type' => 'string', + 'required' => false, + 'example' => 'apm', + 'enum' => [ + 'TRACE', + 'XTRACE', + 'RUM', + ], + ], + ], + [ + 'name' => 'serviceName', + 'in' => 'query', + 'schema' => [ + 'title' => '应用服务名称', + 'description' => '应用服务名称', + 'type' => 'string', + 'required' => false, + 'example' => 'app-demo', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekxxzuad5zzzz', + ], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'title' => '标签数组', + 'description' => '标签数组', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签key', + 'description' => '标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'evn', + ], + 'value' => [ + 'title' => '标签value', + 'description' => '标签value', + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求 ID。', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + 'nextToken' => [ + 'title' => '分页标识。返回值 nextToken 非空代表还有剩余数据。把 nextToken 作为参数继续查询会获得下一页。', + 'description' => '分页Token', + 'type' => 'string', + 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', + ], + 'totalCount' => [ + 'title' => '总应用服务数量', + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + 'maxResults' => [ + 'title' => '查询一页数量。', + 'description' => '最大返回结果数,最大值200', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'services' => [ + 'title' => '应用服务列表', + 'description' => '服务信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '应用服务', + 'description' => '服务信息', + 'type' => 'object', + 'properties' => [ + 'serviceId' => [ + 'title' => '应用服务id', + 'description' => '服务ID', + 'type' => 'string', + 'example' => 'jm2pl0yoqf@d4905cb11a4f218dfb0a8', + ], + 'serviceName' => [ + 'title' => '应用资源名称', + 'description' => '服务名称', + 'type' => 'string', + 'example' => 'demo-app', + ], + 'createTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-01T02:23:59Z', + ], + 'serviceType' => [ + 'title' => '类型:TRACE(应用监控)/ RUM(用户体验监控)/ XTRACE(OT版)', + 'description' => '服务类型', + 'type' => 'string', + 'example' => 'TRACE', + ], + 'serviceStatus' => [ + 'title' => '应用体验监控的服务状态,running/stopped/created/suspend', + 'description' => '服务状态,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'example' => 'Running', + ], + 'displayName' => [ + 'title' => '别名', + 'description' => '显示名称,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'example' => 'test', + ], + 'pid' => [ + 'title' => '对应ARMS应用pid', + 'description' => '兼容历史的ARMS应用ID', + 'type' => 'string', + 'example' => 'kgcsf@192197e828d51aa', + ], + 'description' => [ + 'title' => '应用描述信息。', + 'description' => '服务描述,仅当serviceType=RUM时有效。', + 'type' => 'string', + 'example' => 'workspace api monitor test', + ], + 'attributes' => [ + 'title' => '特征信息,key:value格式', + 'description' => '扩展信息。', + 'type' => 'string', + 'example' => '{"language":"java"}', + ], + 'workspace' => [ + 'title' => '工作空间', + 'description' => '工作空间。', + 'type' => 'string', + 'example' => 'default-cms-1192928460540589-cn-hangzhou', + ], + 'resourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'example' => 'rg-aekxxzuad5zzzz', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"totalCount\\": 66,\\n \\"maxResults\\": 10,\\n \\"services\\": [\\n {\\n \\"serviceId\\": \\"jm2pl0yoqf@d4905cb11a4f218dfb0a8\\",\\n \\"serviceName\\": \\"demo-app\\",\\n \\"createTime\\": \\"2025-07-01T02:23:59Z\\",\\n \\"serviceType\\": \\"TRACE\\",\\n \\"serviceStatus\\": \\"Running\\",\\n \\"displayName\\": \\"test\\",\\n \\"pid\\": \\"kgcsf@192197e828d51aa\\",\\n \\"description\\": \\"workspace api monitor test\\",\\n \\"attributes\\": \\"{\\\\\\"language\\\\\\":\\\\\\"java\\\\\\"}\\",\\n \\"workspace\\": \\"default-cms-1192928460540589-cn-hangzhou\\",\\n \\"resourceGroupId\\": \\"rg-aekxxzuad5zzzz\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '批量查询应用可观测服务', + ], + 'CreatePrometheusVirtualInstance' => [ + 'summary' => '创建Prometheus监控虚拟实例', + 'path' => '/virtual-instances', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'namespace' => [ + 'title' => '每个云产品在每个Regin只能创建一个虚拟实例', + 'description' => '每个云产品在每个Regin只能创建一个虚拟实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'cms_prometheus', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-************', + ], + 'instance' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '地域ID', + 'description' => '地域ID', + 'type' => 'string', + 'example' => 'rw-e815960b4c9ebc5c3d89790c7e82', + ], + 'regionId' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'string', + 'example' => 'cn-zhengzhou-jva', + ], + 'userId' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'string', + 'example' => '167212345678', + ], + 'namespace' => [ + 'title' => '云产品', + 'description' => '云产品', + 'type' => 'string', + 'example' => 'ack-csi-fuse', + ], + 'httpApiUrl' => [ + 'title' => 'HTTP API查询地址', + 'description' => 'HTTP API查询地址', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + 'createdAt' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1751520976660', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-************\\",\\n \\"instance\\": {\\n \\"instanceId\\": \\"rw-e815960b4c9ebc5c3d89790c7e82\\",\\n \\"regionId\\": \\"cn-zhengzhou-jva\\",\\n \\"userId\\": \\"167212345678\\",\\n \\"namespace\\": \\"ack-csi-fuse\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxx\\",\\n \\"createdAt\\": \\"1751520976660\\"\\n }\\n}","type":"json"}]', + 'title' => '创建Prometheus监控虚拟实例', + 'description' => '创建Prometheus监控虚拟实例。', + ], + 'ListPrometheusVirtualInstances' => [ + 'summary' => '获取Prometheus虚拟实例', + 'path' => '/virtual-instances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '可选云产品', + 'description' => '可选云产品。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-csi-fuse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'instances' => [ + 'description' => '实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'description' => '适用数据源类型:PROMETHEUS_DS'."\n" + ."\n" + .'prometheus实例ID', + 'type' => 'string', + 'example' => 'rw-b8cfbbe94194ac37fe83f3d2d16a', + ], + 'httpApiUrl' => [ + 'description' => 'HTTP API地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxxx', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '17073812345', + ], + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai-cloudspe', + ], + 'namespace' => [ + 'description' => '适用查询类型:CMS_BASIC_QUERY。'."\n" + ."\n" + .'指标的命名空间', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'createdAt' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1750315319946', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"instances\\": [\\n {\\n \\"instanceId\\": \\"rw-b8cfbbe94194ac37fe83f3d2d16a\\",\\n \\"httpApiUrl\\": \\"http://xxxxxxxx\\",\\n \\"userId\\": \\"17073812345\\",\\n \\"regionId\\": \\"cn-shanghai-cloudspe\\",\\n \\"namespace\\": \\"arms-prom\\",\\n \\"createdAt\\": \\"1750315319946\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取Prometheus虚拟实例列表', + 'description' => '用于创建一个站点监控任务', + ], + 'GetAggTaskGroup' => [ + 'summary' => '查询聚合任务组详情。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组所属的 Prometheus 实例的 id,聚合任务从这个实例中读取数据', + 'description' => '聚合任务组所属的 Prometheus 实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-xxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aggTaskGroup-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroup' => [ + 'title' => '聚合任务组', + 'description' => '聚合任务组。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => [ + 'title' => '聚合任务组配置', + 'description' => '聚合任务组配置。', + 'type' => 'string', + 'example' => 'groups:'."\n" + .'- name: "node.rules"'."\n" + .' interval: "60s"'."\n" + .' rules:'."\n" + .' - record: "node_namespace_pod:kube_pod_info:"'."\n" + .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" + .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"', + ], + 'aggTaskGroupConfigHash' => [ + 'title' => '聚合任务组配置的摘要', + 'description' => '聚合任务组配置的摘要。', + 'type' => 'string', + 'example' => 'a54136xxx', + ], + 'aggTaskGroupId' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'example' => 'aggTaskGroup-xx', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称', + 'description' => '聚合任务组名称。', + 'type' => 'string', + 'example' => 'pipeline-aggtask-group', + ], + 'cronExpr' => [ + 'title' => '调度模式选择“Cron”情况下,聚合任务组的调度表达式', + 'description' => '调度模式选择“Cron”情况下,聚合任务组的调度表达式。', + 'type' => 'string', + 'example' => '0 1 3 * * ? *', + ], + 'delay' => [ + 'title' => '调度的固定延迟时间', + 'description' => '调度的固定延迟时间(秒)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'description' => [ + 'title' => '聚合任务组描述'."\n" + ."\n", + 'description' => '聚合任务组描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'fromTime' => [ + 'title' => '调度开始时间对应的的秒级时间戳', + 'description' => '调度开始时间对应的的秒级时间戳(暂未生效)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757409495', + ], + 'maxRetries' => [ + 'title' => '执行聚合任务的最大重试次数', + 'description' => '执行聚合任务的最大重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'maxRunTimeInSeconds' => [ + 'title' => '执行聚合任务的最大重试时间', + 'description' => '执行聚合任务的最大重试时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'precheckString' => [ + 'title' => '预检测配置', + 'description' => '预检测配置。', + 'type' => 'string', + 'example' => '{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}', + ], + 'regionId' => [ + 'title' => '地域 id', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'scheduleMode' => [ + 'title' => '调度模式', + 'description' => '调度模式。', + 'type' => 'string', + 'example' => 'FixedRate', + ], + 'scheduleTimeExpr' => [ + 'title' => '调度时间表达式', + 'description' => '调度时间表达式。', + 'type' => 'string', + 'example' => '@m', + ], + 'sourcePrometheusId' => [ + 'title' => '聚合任务组的源 Prometheus 实例 id', + 'description' => '聚合任务组的源 Prometheus实例ID。', + 'type' => 'string', + 'example' => 'rw-xxx', + ], + 'status' => [ + 'title' => '聚合任务组状态', + 'description' => '聚合任务组状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'tags' => [ + 'title' => '资源组标签', + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '资源组标签的键', + 'description' => '资源组标签的键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'value' => [ + 'title' => '资源组标签的值', + 'description' => '资源组标签的值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'targetPrometheusId' => [ + 'title' => '聚合任务组的目标 Prometheus 实例 id', + 'description' => '聚合任务组的目标 Prometheus 实例ID。', + 'type' => 'string', + 'example' => 'rw-xxx', + ], + 'toTime' => [ + 'title' => '调度结束时间对应的秒级时间戳', + 'description' => '调度结束时间对应的秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757409495', + ], + 'updateTime' => [ + 'title' => '聚合任务组的更新时间', + 'description' => '聚合任务组的更新时间(时间戳)。', + 'type' => 'string', + 'example' => '1757409499000', + ], + 'userId' => [ + 'title' => '聚合任务组所属用户', + 'description' => '聚合任务组所属用户。', + 'type' => 'string', + 'example' => '123xxx', + ], + ], + ], + 'requestId' => [ + 'title' => '请求 id', + 'description' => '请求 id', + 'type' => 'string', + 'example' => '68DAF543-35DF-5762-BE90-F5C00B5DC036', + ], + 'success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroup\\": {\\n \\"aggTaskGroupConfig\\": \\"groups:\\\\n- name: \\\\\\"node.rules\\\\\\"\\\\n interval: \\\\\\"60s\\\\\\"\\\\n rules:\\\\n - record: \\\\\\"node_namespace_pod:kube_pod_info:\\\\\\"\\\\n expr: \\\\\\"max(label_replace(kube_pod_info{job=\\\\\\\\\\\\\\"kubernetes-pods-kube-state-metrics\\\\\\\\\\\\\\"\\\\\\\\\\\\n }, \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (node, namespace, pod, cluster)\\\\\\"\\",\\n \\"aggTaskGroupConfigHash\\": \\"a54136xxx\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"cronExpr\\": \\"0 1 3 * * ? *\\",\\n \\"delay\\": 2,\\n \\"description\\": \\"test\\",\\n \\"fromTime\\": 1757409495,\\n \\"maxRetries\\": 2,\\n \\"maxRunTimeInSeconds\\": 50,\\n \\"precheckString\\": \\"{\\\\\\"policy\\\\\\":\\\\\\"skip\\\\\\",\\\\\\"prometheusId\\\\\\":\\\\\\"rw-xx\\\\\\",\\\\\\"query\\\\\\":\\\\\\"noPrecheck\\\\\\",\\\\\\"threshold\\\\\\":0.5,\\\\\\"timeout\\\\\\":15,\\\\\\"type\\\\\\":\\\\\\"none\\\\\\"}\\",\\n \\"regionId\\": \\"cn-zhangjiakou\\",\\n \\"scheduleMode\\": \\"FixedRate\\",\\n \\"scheduleTimeExpr\\": \\"@m\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"key1\\",\\n \\"value\\": \\"value1\\"\\n }\\n ],\\n \\"targetPrometheusId\\": \\"rw-xxx\\",\\n \\"toTime\\": 1757409495,\\n \\"updateTime\\": \\"1757409499000\\",\\n \\"userId\\": \\"123xxx\\"\\n },\\n \\"requestId\\": \\"68DAF543-35DF-5762-BE90-F5C00B5DC036\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '查询聚合任务组', + ], + 'CreateAggTaskGroup' => [ + 'summary' => '创建聚合任务组。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组的源 Prometheus 实例 id', + 'description' => '聚合任务组的源 Prometheus 实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'pq4apob9jm', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '入参结构体', + 'description' => '入参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => [ + 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式,要求符合开源 Prometheus 的 RecordingRule 的格式要求', + 'description' => '聚合任务组配置。'."\n" + .'目前仅支持 “RecordingRuleYaml” 格式,要求符合开源 Prometheus 的 RecordingRule 的格式要求。', + 'type' => 'string', + 'required' => true, + 'example' => 'groups:'."\n" + .'- name: "node.rules"'."\n" + .' interval: "60s"'."\n" + .' rules:'."\n" + .' - record: "node_namespace_pod:kube_pod_info:"'."\n" + .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" + .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"'."\n", + ], + 'aggTaskGroupConfigType' => [ + 'title' => '聚合任务组配置类型,默认 “RecordingRuleYaml”(开源 Prometheus 的 RecordingRule 格式)', + 'description' => '聚合任务组配置类型,默认 “RecordingRuleYaml”(开源 Prometheus 的 RecordingRule 格式)。', + 'type' => 'string', + 'required' => false, + 'example' => 'RecordingRuleYaml', + 'default' => 'RecordingRuleYaml', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称', + 'description' => '聚合任务组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-group', + ], + 'cronExpr' => [ + 'title' => '调度模式选择“Cron”情况下,具体的调度表达式。例如“0/1 * * * *”,表示从 0 分开始,每隔 1 分钟调度一次', + 'description' => '调度模式选择“Cron”情况下,具体的调度表达式。例如“0/1 * * * *”,表示从 0 分开始,每隔 1 分钟调度一次。', + 'type' => 'string', + 'required' => false, + 'example' => '0/1 * * * *', + ], + 'delay' => [ + 'title' => '调度的固定延迟时间,单位:秒,默认 30 ', + 'description' => '调度的固定延迟时间。单位:秒,默认30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '120', + 'minimum' => '0', + 'example' => '30', + 'default' => '30', + ], + 'description' => [ + 'title' => '聚合任务组描述', + 'description' => '聚合任务组描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'fromTime' => [ + 'title' => '调度开始时间对应的的秒级时间戳', + 'description' => '调度开始时间对应的的秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1724996015', + ], + 'maxRetries' => [ + 'title' => '执行聚合任务的最大重试次数,默认 20', + 'description' => '执行聚合任务的最大重试次数,默认 20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + 'maxRunTimeInSeconds' => [ + 'title' => '执行聚合任务的最大重试时间,单位:秒,默认 600', + 'description' => '执行聚合任务的最大重试时间,单位:秒,默认 600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + 'default' => '600', + ], + 'precheckString' => [ + 'title' => '预检测配置,默认不配置。输入的字符串需要能被正确 JSON 解析', + 'description' => '预检测配置,默认不配置。输入的字符串需要能被正确 JSON 解析。', + 'type' => 'string', + 'required' => false, + 'example' => '{"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}', + ], + 'scheduleMode' => [ + 'title' => '调度模式,“Cron” 或 “FixedRate”,默认 “FixedRate”', + 'description' => '调度模式,“Cron” 或 “FixedRate”,默认 “FixedRate”。', + 'type' => 'string', + 'required' => false, + 'example' => 'FixedRate', + 'default' => 'FixedRate', + 'enum' => [ + 'FixedRate', + 'Cron', + ], + ], + 'scheduleTimeExpr' => [ + 'title' => '调度时间表达式,推荐 “@s” 或者 “@m”,表示调度时间窗口对齐的粒度,默认 “@m”', + 'description' => '调度时间表达式,推荐 “@s” 或者 “@m”,表示调度时间窗口对齐的粒度,默认 “@m”。', + 'type' => 'string', + 'required' => false, + 'example' => '@m', + 'default' => '@m', + ], + 'status' => [ + 'title' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + 'default' => 'Running', + 'enum' => [ + 'Running', + 'Stopped', + ], + ], + 'tags' => [ + 'title' => '资源组标签', + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签value值。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '资源组标签的键', + 'description' => '资源组标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'value' => [ + 'title' => '资源组标签的值', + 'description' => '资源组标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'targetPrometheusId' => [ + 'title' => '聚合任务组的目标 Prometheus 实例 id', + 'description' => '聚合任务组的目标 Prometheus 实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-pq4apob9jm', + ], + 'toTime' => [ + 'title' => '调度结束时间对应的秒级时间戳,0 表示不停止调度', + 'description' => '调度结束时间对应的秒级时间戳,0 表示不停止调度。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'overrideIfExists', + 'in' => 'query', + 'schema' => [ + 'title' => '创建聚合任务组时,存在同名资源是否覆盖更新', + 'description' => '创建聚合任务组时,存在同名资源是否覆盖更新。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => [ + 'title' => '聚合任务组配置的摘要', + 'description' => '聚合任务组配置的摘要。', + 'type' => 'string', + 'example' => 'a54136014dc386a92c83a6ef1e97ff22', + ], + 'aggTaskGroupId' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'example' => 'aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称', + 'description' => '聚合任务组名称。', + 'type' => 'string', + 'example' => 'pipeline-aggtask-group', + ], + 'requestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7', + ], + 'sourcePrometheusId' => [ + 'title' => '聚合任务组的源 Prometheus 实例 id', + 'description' => '聚合任务组的源 Prometheus 实例ID。', + 'type' => 'string', + 'example' => 'rw-ecc04af14729b1a16e40a0d10068', + ], + 'status' => [ + 'title' => '聚合任务组的当前状态', + 'description' => '聚合任务组的当前状态。', + 'type' => 'string', + 'example' => 'Pending2Running', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7\\",\\n \\"sourcePrometheusId\\": \\"rw-ecc04af14729b1a16e40a0d10068\\",\\n \\"status\\": \\"Pending2Running\\"\\n}","type":"json"}]', + 'title' => '创建聚合任务组', + ], + 'DeleteAggTaskGroup' => [ + 'summary' => '删除聚合任务组。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组所属的 Prometheus 实例的 id,聚合任务从这个实例中读取数据', + 'description' => '聚合任务组所属的 Prometheus 实例ID,聚合任务从这个实例中读取数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-pq4apob9jm', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aggTaskGroup-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '删除聚合任务组', + ], + 'UpdateAggTaskGroupStatus' => [ + 'summary' => '更新聚合任务组状态。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}/status', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组所属的 Prometheus 实例的 id,聚合任务从这个实例中读取数据', + 'description' => '聚合任务组所属的 Prometheus 实例的ID。聚合任务从这个实例中读取数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-pq4apob9jm', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aggTaskGroup-xxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '入参结构体', + 'description' => '入参结构体。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running。', + 'type' => 'string', + 'required' => true, + 'example' => 'Running', + 'enum' => [ + 'Running', + 'Stopped', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => [ + 'title' => '聚合任务组配置的摘要', + 'description' => '聚合任务组配置的摘要。', + 'type' => 'string', + 'example' => 'a54136014dc386a92c83a6ef1e97ff22', + ], + 'aggTaskGroupId' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'example' => 'aggTaskGroup-xxx', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称', + 'description' => '聚合任务组名称。', + 'type' => 'string', + 'example' => 'pipeline-aggtask-group', + ], + 'requestId' => [ + 'title' => '请求 id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-***', + ], + 'sourcePrometheusId' => [ + 'title' => '聚合任务组的源 Prometheus 实例 id', + 'description' => '聚合任务组的源 Prometheus 实例ID。', + 'type' => 'string', + 'example' => 'rw-xxx', + ], + 'status' => [ + 'title' => '聚合任务组的当前状态', + 'description' => '聚合任务组的当前状态。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xxx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', + 'title' => '更新聚合任务组状态', + ], + 'UpdateAggTaskGroup' => [ + 'summary' => '应用聚合任务组。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups/{groupId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组所属的 Prometheus 实例的 id,聚合任务从这个实例中读取数据', + 'description' => '聚合任务组所属的 Prometheus 实例ID。聚合任务从这个实例中读取数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-pq4apob9jm', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'aggTaskGroup-xxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '入参结构体', + 'description' => '入参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfig' => [ + 'title' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式,要求符合开源 Prometheus 的 RecordingRule 的格式要求', + 'description' => '聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式,要求符合开源 Prometheus 的 RecordingRule 的格式要求。', + 'type' => 'string', + 'required' => true, + 'example' => 'groups:'."\n" + .'- name: "node.rules"'."\n" + .' interval: "60s"'."\n" + .' rules:'."\n" + .' - record: "node_namespace_pod:kube_pod_info:"'."\n" + .' expr: "max(label_replace(kube_pod_info{job=\\"kubernetes-pods-kube-state-metrics\\"\\'."\n" + .' }, \\"pod\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (node, namespace, pod, cluster)"', + ], + 'aggTaskGroupConfigType' => [ + 'title' => '聚合任务组配置类型,默认 “RecordingRuleYaml”(开源 Prometheus 的 RecordingRule 格式)', + 'description' => '聚合任务组配置类型,默认 “RecordingRuleYaml”(开源 Prometheus 的 RecordingRule 格式)。', + 'type' => 'string', + 'required' => false, + 'example' => 'RecordingRuleYaml', + 'default' => 'RecordingRuleYaml', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称', + 'description' => '聚合任务组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-group', + ], + 'cronExpr' => [ + 'title' => '调度模式选择“Cron”情况下,具体的调度表达式。例如“0/1 * * * *”,表示从 0 分开始,每隔 1 分钟调度一次', + 'description' => '调度模式选择“Cron”情况下,具体的调度表达式。例如“0/1 * * * *”,表示从 0 分开始,每隔 1 分钟调度一次。', + 'type' => 'string', + 'required' => false, + 'example' => '0/1 * * * *', + ], + 'delay' => [ + 'title' => '调度的固定延迟时间,单位:秒,默认 30', + 'description' => '调度的固定延迟时间,单位:秒,默认 30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '120', + 'minimum' => '0', + 'example' => '30', + 'default' => '30', + ], + 'description' => [ + 'title' => '聚合任务组描述', + 'description' => '聚合任务组描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + 'fromTime' => [ + 'title' => '调度开始时间对应的的秒级时间戳', + 'description' => '调度开始时间对应的的秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1724996015', + ], + 'maxRetries' => [ + 'title' => '执行聚合任务的最大重试次数,默认 20', + 'description' => '执行聚合任务的最大重试次数,默认 20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + 'maxRunTimeInSeconds' => [ + 'title' => '执行聚合任务的最大重试时间,单位:秒,默认 600', + 'description' => '执行聚合任务的最大重试时间,单位:秒,默认 600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + 'default' => '600', + ], + 'precheckString' => [ + 'title' => '预检测配置,默认不配置。输入的字符串需要能被正确 JSON 解析', + 'description' => '预检测配置,默认不配置。输入的字符串需要能被正确 JSON 解析。', + 'type' => 'string', + 'required' => false, + 'example' => '{"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}', + ], + 'scheduleMode' => [ + 'title' => '调度模式,“Cron” 或 “FixedRate”,默认 “FixedRate”', + 'description' => '调度模式,“Cron” 或 “FixedRate”,默认 “FixedRate”。', + 'type' => 'string', + 'required' => false, + 'example' => 'FixedRate', + 'default' => 'FixedRate', + 'enum' => [ + 'FixedRate', + 'Cron', + ], + ], + 'scheduleTimeExpr' => [ + 'title' => '调度时间表达式,推荐 “@s” 或者 “@m”,表示调度时间窗口对齐的粒度,默认 “@m”', + 'description' => '调度时间表达式,推荐 “@s” 或者 “@m”,表示调度时间窗口对齐的粒度,默认 “@m”。', + 'type' => 'string', + 'required' => false, + 'example' => '@m', + 'default' => '@m', + ], + 'status' => [ + 'title' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + 'default' => 'Running', + 'enum' => [ + 'Running', + 'Stopped', + ], + ], + 'tags' => [ + 'title' => '资源组标签', + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '资源组标签的键', + 'description' => '资源组标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'value' => [ + 'title' => '资源组标签的值', + 'description' => '资源组标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'targetPrometheusId' => [ + 'title' => '聚合任务组的目标 Prometheus 实例 id', + 'description' => '聚合任务组的目标 Prometheus 实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-pq4apob9jm', + ], + 'toTime' => [ + 'title' => '调度结束时间对应的秒级时间戳,0 表示不停止调度', + 'description' => '调度结束时间对应的秒级时间戳,0 表示不停止调度。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => [ + 'title' => '聚合任务组配置的摘要', + 'description' => '聚合任务组配置的摘要', + 'type' => 'string', + 'example' => 'a54136014dc386a92c83a6ef1e97ff22', + ], + 'aggTaskGroupId' => [ + 'title' => '聚合任务组 id', + 'description' => '聚合任务组 id', + 'type' => 'string', + 'example' => 'aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称', + 'description' => '聚合任务组名称', + 'type' => 'string', + 'example' => 'pipeline-aggtask-group', + ], + 'requestId' => [ + 'title' => '请求 id', + 'description' => '请求 id', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'sourcePrometheusId' => [ + 'title' => '聚合任务组的源 Prometheus 实例 id', + 'description' => '聚合任务组的源 Prometheus 实例 id', + 'type' => 'string', + 'example' => 'rw-083e17834e279f8c627fe91a2d72', + ], + 'status' => [ + 'title' => '聚合任务组的当前状态', + 'description' => '聚合任务组的当前状态', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroupConfigHash\\": \\"a54136014dc386a92c83a6ef1e97ff22\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"sourcePrometheusId\\": \\"rw-083e17834e279f8c627fe91a2d72\\",\\n \\"status\\": \\"Running\\"\\n}","type":"json"}]', + 'title' => '更新聚合任务组', + ], + 'ListAggTaskGroups' => [ + 'summary' => '查询聚合任务组列表。', + 'path' => '/prometheus-instances/{instanceId}/agg-task-groups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '聚合任务组所属的 Prometheus 实例的 id,聚合任务从这个实例中读取数据', + 'description' => '聚合任务组所属的 Prometheus 实例ID,聚合任务从这个实例中读取数据。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-pq4apob9jm', + ], + ], + [ + 'name' => 'filterAggTaskGroupIds', + 'in' => 'query', + 'schema' => [ + 'title' => '聚合任务组的 id 列表,需要能被 JSON 解析', + 'description' => '聚合任务组的 id 列表,需要能被 JSON 解析。', + 'type' => 'string', + 'required' => false, + 'example' => '["aggTaskGroup-xxx"]', + ], + ], + [ + 'name' => 'filterAggTaskGroupNames', + 'in' => 'query', + 'schema' => [ + 'title' => '聚合任务组名称列表,需要能被 JSON 解析', + 'description' => '聚合任务组名称列表,需要能被 JSON 解析。', + 'type' => 'string', + 'required' => false, + 'example' => '["apiserver_request_total"]', + ], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => [ + 'title' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running', + 'description' => '聚合任务组状态,“Running” 或者 “Stopped”。默认 Running。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + 'enum' => [ + 'Running', + 'Stopped', + ], + ], + ], + [ + 'name' => 'targetPrometheusId', + 'in' => 'query', + 'schema' => [ + 'title' => '聚合任务组的目标 Prometheus 实例 id', + 'description' => '聚合任务组的目标 Prometheus 实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rw-pq4apob9jm', + ], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源组标签'."\n" + ."\n", + 'description' => '资源组标签。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '资源组标签的键'."\n" + ."\n", + 'description' => '资源组标签的键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'value' => [ + 'title' => '资源组标签的值'."\n" + ."\n", + 'description' => '资源组标签的值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '返回的最多记录数', + 'description' => '返回的最多记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '查询令牌', + 'description' => '查询令牌。', + 'type' => 'string', + 'required' => false, + 'example' => '28036394xxx', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => [ + 'title' => '名称搜索,支持模糊匹配', + 'description' => '名称搜索。支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '出参结构体', + 'description' => '出参结构体。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroups' => [ + 'title' => '聚合任务组列表', + 'description' => '聚合任务组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合任务。', + 'type' => 'object', + 'properties' => [ + 'aggTaskGroupConfigHash' => [ + 'title' => '聚合任务组配置的摘要'."\n" + ."\n", + 'description' => '聚合任务组配置的摘要。', + 'type' => 'string', + 'example' => 'a54136014xxx', + ], + 'aggTaskGroupId' => [ + 'title' => '聚合任务组 id'."\n" + ."\n", + 'description' => '聚合任务组ID。', + 'type' => 'string', + 'example' => 'aggTaskGroup-xxxx', + ], + 'aggTaskGroupName' => [ + 'title' => '聚合任务组名称'."\n" + ."\n", + 'description' => '聚合任务组名称。', + 'type' => 'string', + 'example' => 'pipeline-aggtask-group', + ], + 'cronExpr' => [ + 'title' => '调度模式选择“Cron”情况下,聚合任务组的调度表达式', + 'description' => '调度模式选择“Cron”情况下,聚合任务组的调度表达式。', + 'type' => 'string', + 'example' => '0 10 8 1 * ? *', + ], + 'delay' => [ + 'title' => '调度的固定延迟时间'."\n" + ."\n", + 'description' => '调度的固定延迟时间(秒)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'description' => [ + 'title' => '聚合任务组描述'."\n" + ."\n", + 'description' => '聚合任务组描述。', + 'type' => 'string', + 'example' => 'workspace api monitor update test', + ], + 'fromTime' => [ + 'title' => '调度开始时间对应的的秒级时间戳', + 'description' => '调度开始时间对应的的秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757409499000', + ], + 'interval' => [ + 'title' => '调度间隔', + 'description' => '调度间隔。', + 'type' => 'string', + 'example' => '2025-04-24 00:00:00,2025-04-24 00:00:00', + ], + 'maxRetries' => [ + 'title' => '执行聚合任务的最大重试次数'."\n" + ."\n", + 'description' => '执行聚合任务的最大重试次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'maxRunTimeInSeconds' => [ + 'title' => '执行聚合任务的最大重试时间'."\n" + ."\n", + 'description' => '执行聚合任务的最大重试时间(秒)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'regionId' => [ + 'title' => '地域 id'."\n" + ."\n", + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'scheduleMode' => [ + 'title' => '调度模式'."\n" + ."\n", + 'description' => '调度模式。', + 'type' => 'string', + 'example' => 'FixedRate', + ], + 'scheduleTimeExpr' => [ + 'title' => '调度时间表达式'."\n" + ."\n", + 'description' => '调度时间表达式。', + 'type' => 'string', + 'example' => '@m', + ], + 'sourcePrometheusId' => [ + 'title' => '聚合任务组的源 Prometheus 实例 id', + 'description' => '聚合任务组的源 Prometheus 实例ID。', + 'type' => 'string', + 'example' => 'rw-xxx', + ], + 'status' => [ + 'title' => '聚合任务组状态'."\n" + ."\n", + 'description' => '聚合任务组状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'targetPrometheusId' => [ + 'title' => '聚合任务组的目标 Prometheus 实例 id', + 'description' => '聚合任务组的目标 Prometheus 实例ID。', + 'type' => 'string', + 'example' => 'rw-xxx', + ], + 'toTime' => [ + 'title' => '调度结束时间对应的秒级时间戳'."\n" + ."\n", + 'description' => '调度结束时间对应的秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'updateTime' => [ + 'title' => '聚合任务组的更新时间'."\n" + ."\n", + 'description' => '聚合任务组的更新时间。', + 'type' => 'string', + 'example' => '1757409499000', + ], + ], + ], + ], + 'maxResults' => [ + 'title' => '返回的最多记录数', + 'description' => '返回的最多记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'default' => '0', + ], + 'nextToken' => [ + 'title' => '下一次查询的令牌', + 'description' => '下一次查询的令牌。', + 'type' => 'string', + 'example' => 'aa9d0e569b880xxx', + 'maxLength' => 128, + ], + 'requestId' => [ + 'title' => '请求 id'."\n" + ."\n", + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E', + ], + 'totalCount' => [ + 'title' => '总实例数', + 'description' => '总实例数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"aggTaskGroups\\": [\\n {\\n \\"aggTaskGroupConfigHash\\": \\"a54136014xxx\\",\\n \\"aggTaskGroupId\\": \\"aggTaskGroup-xxxx\\",\\n \\"aggTaskGroupName\\": \\"pipeline-aggtask-group\\",\\n \\"cronExpr\\": \\"0 10 8 1 * ? *\\",\\n \\"delay\\": 30,\\n \\"description\\": \\"workspace api monitor update test\\",\\n \\"fromTime\\": 1757409499000,\\n \\"interval\\": \\"2025-04-24 00:00:00,2025-04-24 00:00:00\\",\\n \\"maxRetries\\": 2,\\n \\"maxRunTimeInSeconds\\": 200,\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"scheduleMode\\": \\"FixedRate\\",\\n \\"scheduleTimeExpr\\": \\"@m\\",\\n \\"sourcePrometheusId\\": \\"rw-xxx\\",\\n \\"status\\": \\"Running\\",\\n \\"targetPrometheusId\\": \\"rw-xxx\\",\\n \\"toTime\\": 0,\\n \\"updateTime\\": \\"1757409499000\\"\\n }\\n ],\\n \\"maxResults\\": 100,\\n \\"nextToken\\": \\"aa9d0e569b880xxx\\",\\n \\"requestId\\": \\"7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E\\",\\n \\"totalCount\\": 5\\n}","type":"json"}]', + 'title' => '查询聚合任务组列表', + ], + 'DeletePrometheusInstance' => [ + 'summary' => '删除prom实例。', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rw-abc123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '删除Prometheus实例', + 'description' => '删除Prometheus实例。', + ], + 'DeletePrometheusView' => [ + 'summary' => '删除prometheus视图实例。', + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Prometheus 视图ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rw-xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\"\\n}","type":"json"}]', + 'title' => '删除prometheus视图实例。', + 'description' => '删除prometheus视图实例。', + ], + 'GetPrometheusInstance' => [ + 'summary' => '查询指定Prometheus实例详情信息。', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcmsCP2WWY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-abc123', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2bhocin5e2na', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusInstance' => [ + 'description' => 'Prometheus 实例详情。', + 'type' => 'object', + 'properties' => [ + 'accessType' => [ + 'title' => '权限类型:'."\n" + .'readWrite、readOnly、httpReadOnly', + 'description' => '权限类型:'."\n" + .'readWrite、readOnly、httpReadOnly', + 'type' => 'string', + 'example' => 'readOnly', + ], + 'archiveDuration' => [ + 'title' => '存储到期后,自动归档保存的天数,0表示不归档保存,3650表示永久保存。', + 'description' => '存储到期后,自动归档保存的天数,0表示不归档保存,3650表示永久保存。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'authFreeReadPolicy' => [ + 'title' => '读免密地址白名单策略。', + 'description' => '免密读策略(支持IP段和VpcId)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'authFreeWritePolicy' => [ + 'title' => '写免密地址白名单策略。', + 'description' => '免密写策略(支持IP段和VpcId)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'authToken' => [ + 'title' => 'authToken串', + 'description' => 'authToken串。', + 'type' => 'string', + 'example' => 'eJwixxxxx', + ], + 'createTime' => [ + 'title' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ', + 'description' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2025-08-10T02:07:53Z', + ], + 'enableAuthFreeRead' => [ + 'title' => '是否开启读免密。', + 'description' => '是否开启读免密。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'enableAuthFreeWrite' => [ + 'title' => '是否开启写免密。', + 'description' => '是否开启写免密。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'enableAuthToken' => [ + 'description' => '是否开启鉴权Token。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'extraInfo' => [ + 'title' => '扩展信息(仅控制台请求才返回)', + 'description' => '扩展信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '其他扩展信息。', + 'example' => 'value', + ], + ], + 'httpApiInterUrl' => [ + 'description' => 'HTTP 公网地址。', + 'type' => 'string', + 'example' => ' http://workspace-default-cms-xxxxxxx', + ], + 'httpApiIntraUrl' => [ + 'description' => 'HTTP 内网地址。', + 'type' => 'string', + 'example' => ' http://workspace-default-cms-xxxxxxx', + ], + 'instanceType' => [ + 'title' => 'remote-write(Prometheus for Remote Write)', + 'description' => 'Prometheus实例类型。', + 'type' => 'string', + 'example' => 'remote-write', + ], + 'paymentType' => [ + 'title' => '计费方式:'."\n" + .'POSTPAY:按指标上报量后付费。'."\n" + .'POSTPAY_GB:按指标写入量后付费。', + 'description' => '计费方式:'."\n" + .'POSTPAY:按指标上报量后付费。'."\n" + .'POSTPAY_GB:按指标写入量后付费。', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'product' => [ + 'title' => 'prom实例归属的产品(arms或cms)', + 'description' => 'prom实例归属的产品(arms或cms)', + 'type' => 'string', + 'example' => 'cms', + ], + 'prometheusInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'rw-524ada714221af267c73122af2e1', + ], + 'prometheusInstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test-prom-name', + ], + 'pushGatewayInterUrl' => [ + 'description' => 'PushGateway公网地址。', + 'type' => 'string', + 'example' => ' http://workspace-default-cms-xxxxxxx', + ], + 'pushGatewayIntraUrl' => [ + 'description' => 'PushGateway内网地址。', + 'type' => 'string', + 'example' => ' http://workspace-default-cms-xxxxxxx'."\n", + ], + 'regionId' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'remoteReadInterUrl' => [ + 'description' => '公网读地址。', + 'type' => 'string', + 'example' => ' http://workspace-default-cms-xxxxxxx', + ], + 'remoteReadIntraUrl' => [ + 'description' => '内网读地址。', + 'type' => 'string', + 'example' => 'https://workspace-default-cms-1xxxxxxxxxx', + ], + 'remoteWriteInterUrl' => [ + 'description' => '公网写地址。', + 'type' => 'string', + 'example' => 'https://workspace-default-cms-xxxxxxxxxx', + ], + 'remoteWriteIntraUrl' => [ + 'description' => '内网写地址。', + 'type' => 'string', + 'example' => 'https://workspace-default-cms-xxxxxxxxxx', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfm3gn5i6bigbi', + ], + 'resourceType' => [ + 'title' => '固定值:PrometheusInstance', + 'description' => '固定值:PrometheusInstance。', + 'type' => 'string', + 'example' => 'Prometheus', + ], + 'status' => [ + 'title' => '后端数据存储状态', + 'description' => '实例状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'storageDuration' => [ + 'title' => '存储时长(天)。', + 'description' => '存储时长(天)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'supportAuthTypes' => [ + 'title' => '支持的认证鉴权类型。', + 'description' => '支持的认证鉴权类型。', + 'type' => 'array', + 'items' => [ + 'description' => '鉴权类型。', + 'type' => 'string', + 'example' => 'BasicAuth', + 'enum' => [ + 'BasicAuth', + 'AuthFree', + 'AuthToken', + ], + ], + ], + 'tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签Key。', + 'type' => 'string', + 'example' => 'openStorage', + ], + 'value' => [ + 'description' => '匹配值。', + 'type' => 'string', + 'example' => '130303196111114281', + ], + ], + ], + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '170731234567', + ], + 'version' => [ + 'title' => '版本', + 'description' => '版本。', + 'type' => 'string', + 'example' => 'V1', + ], + 'workspace' => [ + 'title' => 'prom实例归属的工作空间', + 'description' => 'Prometheus实例归属的工作空间。', + 'type' => 'string', + 'example' => 'ws1', + ], + 'folderUrl' => [ + 'title' => '可视化大盘Url', + 'description' => '可视化大盘目录URL。', + 'type' => 'string', + 'example' => 'https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx', + ], + 'grafanaInstanceId' => [ + 'title' => '绑定的托管grafana实例Id', + 'description' => '绑定的托管grafana实例ID。', + 'type' => 'string', + 'example' => 'SHARED', + ], + 'grafanaInstanceName' => [ + 'title' => '绑定的托管grafana实例名称', + 'description' => '绑定的托管grafana实例名称。', + 'type' => 'string', + 'example' => '共享版', + ], + 'paymentTypeUpdateTime' => [ + 'title' => '实例计费方式修改时间', + 'description' => '实例计费方式修改时间。', + 'type' => 'string', + 'example' => '2025-08-10T02:07:53Z', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求唯一标识。', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstance\\": {\\n \\"accessType\\": \\"readOnly\\",\\n \\"archiveDuration\\": 90,\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authFreeWritePolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJwixxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthFreeWrite\\": true,\\n \\"enableAuthToken\\": true,\\n \\"extraInfo\\": {\\n \\"key\\": \\"value\\"\\n },\\n \\"httpApiInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstanceId\\": \\"rw-524ada714221af267c73122af2e1\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"pushGatewayInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"pushGatewayIntraUrl\\": \\" http://workspace-default-cms-xxxxxxx\\\\n\\",\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"remoteReadInterUrl\\": \\" http://workspace-default-cms-xxxxxxx\\",\\n \\"remoteReadIntraUrl\\": \\"https://workspace-default-cms-1xxxxxxxxxx\\",\\n \\"remoteWriteInterUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"remoteWriteIntraUrl\\": \\"https://workspace-default-cms-xxxxxxxxxx\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Running\\",\\n \\"storageDuration\\": 90,\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"openStorage\\",\\n \\"value\\": \\"130303196111114281\\"\\n }\\n ],\\n \\"userId\\": \\"170731234567\\",\\n \\"version\\": \\"V1\\",\\n \\"workspace\\": \\"ws1\\",\\n \\"folderUrl\\": \\"https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx\\",\\n \\"grafanaInstanceId\\": \\"SHARED\\",\\n \\"grafanaInstanceName\\": \\"共享版\\",\\n \\"paymentTypeUpdateTime\\": \\"2025-08-10T02:07:53Z\\"\\n },\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '获取Prometheus实例详细信息', + 'description' => '获取Prometheus实例详情。', + ], + 'GetPrometheusView' => [ + 'summary' => '查询指定Prometheus视图实例详情。', + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcmsCP2WWY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rw-xxxxxx', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2bhocin5e2na', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusView' => [ + 'description' => '视图实例。', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => [ + 'title' => '读免密地址白名单策略。', + 'description' => '免密读策略(支持IP段和VpcId)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'authToken' => [ + 'title' => 'authToken串', + 'description' => 'authToken串。', + 'type' => 'string', + 'example' => 'eJxxxxxx', + ], + 'createTime' => [ + 'title' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ', + 'description' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ。', + 'type' => 'string', + 'example' => '2025-08-10T02:07:53Z', + ], + 'enableAuthFreeRead' => [ + 'title' => '是否开启读免密。', + 'description' => '是否开启读免密。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'enableAuthToken' => [ + 'title' => '是否开启authToken。', + 'description' => '是否开启authToken。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'httpApiInterUrl' => [ + 'description' => '公网HTTP地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxxx', + ], + 'httpApiIntraUrl' => [ + 'description' => '内网HTTP地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxxx', + ], + 'instanceType' => [ + 'title' => '实例类型:'."\n" + .'prom-view:新版本聚合视图'."\n" + .'global-view:老版本聚合视图', + 'description' => '实例类型,固定值prom-view。', + 'type' => 'string', + 'example' => 'prom-view', + ], + 'paymentType' => [ + 'title' => '付费类型。目前固定值FREE(免费)。', + 'description' => '付费类型。目前固定值FREE(免费)。', + 'type' => 'string', + 'example' => 'FREE', + ], + 'product' => [ + 'title' => 'prom实例归属的产品(arms或cms)', + 'description' => 'prom实例归属的产品。', + 'type' => 'string', + 'example' => 'cms', + ], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => [ + 'description' => '实例id。', + 'type' => 'string', + 'example' => 'rw-63549e054ff596a4149927961dff', + ], + 'regionId' => [ + 'description' => '地域 ID', + 'type' => 'string', + 'example' => 'cn-north-2-gov-1', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '122xxxxx', + ], + ], + ], + ], + 'prometheusViewId' => [ + 'description' => 'Prometheus视图ID。', + 'type' => 'string', + 'example' => 'view-xxx', + ], + 'prometheusViewName' => [ + 'description' => 'Prometheus 视图名称。', + 'type' => 'string', + 'example' => 'view1', + ], + 'regionId' => [ + 'description' => '地域 ID', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'remoteReadInterUrl' => [ + 'description' => 'remote read公网URL。', + 'type' => 'string', + 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read', + ], + 'remoteReadIntraUrl' => [ + 'description' => 'remote read内网URL。', + 'type' => 'string', + 'example' => 'http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfm3gn5i6bigbi', + ], + 'resourceType' => [ + 'title' => '固定值:PrometheusView', + 'description' => '固定值:PrometheusView', + 'type' => 'string', + 'example' => 'RegistryModule', + ], + 'status' => [ + 'title' => '后端数据存储状态', + 'description' => '后端数据存储状态', + 'type' => 'string', + 'example' => 'Pending2Running', + ], + 'supportAuthTypes' => [ + 'description' => '支持的认证类型。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的认证类型。', + 'type' => 'string', + 'example' => 'BasicAuth', + ], + ], + 'tags' => [ + 'description' => '实例的标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'pagerDuty的集成key。', + 'type' => 'string', + 'example' => 'global_score_series', + ], + 'value' => [ + 'description' => '标签Value。', + 'type' => 'string', + 'example' => '371293199010092839', + ], + ], + ], + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '11222', + ], + 'version' => [ + 'title' => '版本', + 'description' => '版本。', + 'type' => 'string', + 'example' => 'V1', + ], + 'workspace' => [ + 'title' => '环境归属的工作空间', + 'description' => '环境归属的工作空间', + 'type' => 'string', + 'example' => 'cms-monitor-test-aysls-pub-cn-fuzhou-monitor', + ], + 'folderUrl' => [ + 'title' => '可观测大盘Url', + 'description' => '可观测大盘URL。', + 'type' => 'string', + 'example' => 'https://xxxx', + ], + 'grafanaInstanceId' => [ + 'title' => '绑定的托管grafana实例Id', + 'description' => '绑定的托管grafana实例ID。', + 'type' => 'string', + 'example' => 'g-xxx ', + ], + 'grafanaInstanceName' => [ + 'title' => '绑定的托管grafana实例名称', + 'description' => '绑定的托管grafana实例名称。', + 'type' => 'string', + 'example' => 'gxxx', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusView\\": {\\n \\"authFreeReadPolicy\\": \\"{\\\\n \\\\\\"SourceIp\\\\\\": [\\\\n \\\\\\"192.168.1.0/24\\\\\\",\\\\n \\\\\\"172.168.2.22\\\\\\"\\\\n ],\\\\n \\\\\\"SourceVpc\\\\\\": [\\\\n \\\\\\"vpc-xx1\\\\\\",\\\\n \\\\\\"vpc-xx2\\\\\\"\\\\n ]\\\\n}\\",\\n \\"authToken\\": \\"eJxxxxxx\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"enableAuthFreeRead\\": true,\\n \\"enableAuthToken\\": true,\\n \\"httpApiInterUrl\\": \\"http://xxxxxxxx\\",\\n \\"httpApiIntraUrl\\": \\"http://xxxxxxxx\\",\\n \\"instanceType\\": \\"prom-view\\",\\n \\"paymentType\\": \\"FREE\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"regionId\\": \\"cn-north-2-gov-1\\",\\n \\"userId\\": \\"122xxxxx\\"\\n }\\n ],\\n \\"prometheusViewId\\": \\"view-xxx\\",\\n \\"prometheusViewName\\": \\"view1\\",\\n \\"regionId\\": \\"cn-shanghai\\",\\n \\"remoteReadInterUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"remoteReadIntraUrl\\": \\"http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read\\",\\n \\"resourceGroupId\\": \\"rg-acfm3gn5i6bigbi\\",\\n \\"resourceType\\": \\"RegistryModule\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"tags\\": [\\n {\\n \\"key\\": \\"global_score_series\\",\\n \\"value\\": \\"371293199010092839\\"\\n }\\n ],\\n \\"userId\\": \\"11222\\",\\n \\"version\\": \\"V1\\",\\n \\"workspace\\": \\"cms-monitor-test-aysls-pub-cn-fuzhou-monitor\\",\\n \\"folderUrl\\": \\"https://xxxx\\",\\n \\"grafanaInstanceId\\": \\"g-xxx \\",\\n \\"grafanaInstanceName\\": \\"gxxx\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '查询指定Prometheus视图实例详情。', + 'description' => '查询指定Prometheus视图实例。', + ], + 'ListPrometheusDashboards' => [ + 'summary' => '获取Prometheus实例大盘列表。', + 'path' => '/prometheus-instances/{prometheusInstanceId}/dashboards', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '实例id', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'rw-abc123', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3gn5i6bigbi', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusDashboards' => [ + 'description' => 'Prometheus实例大盘列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '', + 'description' => '大盘ID。', + 'type' => 'string', + 'example' => '1', + ], + 'uid' => [ + 'title' => '', + 'description' => '大盘UID。', + 'type' => 'string', + 'example' => '1987395500251724', + ], + 'name' => [ + 'title' => '', + 'description' => '大盘名称。', + 'type' => 'string', + 'example' => 'pod', + ], + 'title' => [ + 'title' => '', + 'description' => '大盘标题。', + 'type' => 'string', + 'example' => 'ceshi', + ], + 'url' => [ + 'title' => '', + 'description' => '大盘URL地址。', + 'type' => 'string', + 'example' => 'https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application', + ], + 'tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => '[{\\"tagName\\":\\"key1\\",\\"tagDefinePrompt\\":\\"value1\\"}]', + ], + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'totalCount' => [ + 'title' => '总实例数', + 'description' => '总实例数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusDashboards\\": [\\n {\\n \\"id\\": \\"1\\",\\n \\"uid\\": \\"1987395500251724\\",\\n \\"name\\": \\"pod\\",\\n \\"title\\": \\"ceshi\\",\\n \\"url\\": \\"https://gnew.console.aliyun.com/d/xxx-17460385-807-7-6/cs-cost-application\\",\\n \\"tags\\": [\\n \\"[{\\\\\\\\\\\\\\"tagName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tagDefinePrompt\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\"}]\\"\\n ]\\n }\\n ],\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'title' => '获取Prometheus实例大盘列表', + 'description' => '获取Prometheus实例大盘列表。', + ], + 'UpdatePrometheusView' => [ + 'summary' => '更新Prometheus视图实例信息。', + 'path' => '/prometheus-views/{prometheusViewId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'prometheusViewId', + 'in' => 'path', + 'schema' => [ + 'description' => 'Prometheus 视图实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-xxxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => [ + 'description' => '免密读策略(支持IP段和VpcId)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'enableAuthFreeRead' => [ + 'title' => '是否支持免密读', + 'description' => '是否支持免密读。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'enableAuthToken' => [ + 'title' => '是否支持authToken', + 'description' => '是否支持authToken。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c7ba84651c71e442c8d0653085d862164', + ], + 'regionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-north-2-gov-1', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '16727123456789', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'prometheusViewName' => [ + 'description' => 'Prometheus 视图名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-prom-view-name', + ], + 'status' => [ + 'description' => '运行状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + 'workspace' => [ + 'title' => '归属的工作空间。', + 'description' => '归属的工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default-cms-108490012345-cn-heyuan', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusViewId' => [ + 'title' => '操作结果', + 'description' => 'Prometheus 视图实例ID。', + 'type' => 'string', + 'example' => 'rw-xxxxxx', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '64D964F5-76C7-19A2-9399-457744AB3619', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"rw-xxxxxx\\",\\n \\"requestId\\": \\"64D964F5-76C7-19A2-9399-457744AB3619\\"\\n}","type":"json"}]', + 'title' => '更新Prom视图实例信息', + 'description' => '更新Prom视图实例信息。', + ], + 'UpdatePrometheusInstance' => [ + 'summary' => '更新Prometheus实例信息。', + 'path' => '/prometheus-instances/{prometheusInstanceId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => 'prometheus实例ID', + 'description' => 'prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rw-xxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'archiveDuration' => [ + 'title' => '存储到期后,自动归档保存的天数,0表示不归档保存。归档天数取值范围:'."\n" + .'V1:1~365天。仅按指标写入量支持。'."\n" + .'V2:1~3650天(3650表示永久保存)。', + 'description' => '存储到期后,自动归档保存的天数,0表示不归档保存。归档天数取值范围:'."\n" + .'V1:1~365天。仅按指标写入量支持。'."\n" + .'V2:1~3650天(3650表示永久保存)。', + 'type' => 'integer', + 'required' => false, + 'example' => '365', + 'enum' => [], + ], + 'authFreeReadPolicy' => [ + 'title' => '是否开启免密读的ip地址列表,支持CIDR配置。多个ip之间换行符分隔。', + 'description' => '免密读策略(支持IP段和VpcId)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'authFreeWritePolicy' => [ + 'title' => '是否开启免密写的ip地址列表,支持CIDR配置。多个ip之间换行符分隔。', + 'description' => '免密读策略(支持IP段和VpcId)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'enableAuthFreeRead' => [ + 'title' => '是否开启免密读', + 'description' => '是否开启免密读。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'enableAuthFreeWrite' => [ + 'title' => '是否开启免密写', + 'description' => '是否开启免密写。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'enableAuthToken' => [ + 'title' => '是否开启访问Token鉴权', + 'description' => '是否开启访问Token鉴权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'prometheusInstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-prom-name', + ], + 'status' => [ + 'title' => '实例存储db状态(仅支持RUNNING)。为空时,不改变存储db状态。', + 'description' => '实例存储db状态(仅支持RUNNING)。为空时,不改变存储db状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + 'storageDuration' => [ + 'title' => '存储时长(天):'."\n" + .'按写入量:90、180'."\n" + .'按指标上报量:15、30、60、90、180', + 'description' => '存储时长(天):'."\n" + .'按写入量:90、180。'."\n" + .'按指标上报量:15、30、60、90、180。', + 'type' => 'integer', + 'required' => false, + 'example' => '90', + 'enum' => [ + '15', + '30', + '60', + '90', + '180', + '365', + ], + ], + 'paymentType' => [ + 'title' => '计费方式(实例的生命周期内,只能修改一次):'."\n" + .'POSTPAY:按指标上报量后付费。'."\n" + .'POSTPAY_GB:按指标写入量后付费。', + 'description' => '计费方式(实例的生命周期内,只能修改一次):'."\n" + .'POSTPAY:按指标上报量后付费。'."\n" + .'POSTPAY_GB:按指标写入量后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'POSTPAY_GB', + 'enum' => [ + 'POSTPAY_GB', + 'POSTPAY', + ], + ], + 'workspace' => [ + 'title' => '归属的工作空间。', + 'description' => '归属的工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default-cms-1500199863951574-cn-shanghai', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => [ + 'description' => '实例id。', + 'type' => 'string', + 'example' => 'rw-abc123', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1E92F783-E057-58F1-BD5C-92DED088E7A5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"1E92F783-E057-58F1-BD5C-92DED088E7A5\\"\\n}","type":"json"}]', + 'title' => '更新Prometheus实例信息', + 'description' => '更新Prometheus实例信息。', + ], + 'ListPrometheusViews' => [ + 'summary' => '获取Prometheus视图实例信息列表。', + 'path' => '/prometheus-views', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'prometheusViewIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus视图实例Id列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'view-xxx', + ], + ], + [ + 'name' => 'prometheusViewName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus 视图名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'view1', + ], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'title' => '实例版本:V1或V2', + 'description' => '实例版本:V1或V2', + 'type' => 'string', + 'required' => false, + 'example' => 'V2', + 'enum' => [ + 'V1', + 'V2', + ], + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型:PrometheusView', + 'description' => '资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'PROMETHEUSVIEW', + ], + ], + [ + 'name' => 'filterRegionIds', + 'in' => 'query', + 'schema' => [ + 'title' => '指定筛选的regionId(目前仅支持单regioinId,暂不支持多值)。', + 'description' => '通过RegionID进行过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou,cn-beijing', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3gn5i6bigbi', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'value' => [ + 'description' => '匹配值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '返回的最多记录数。', + 'description' => '返回的最多记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '查询令牌。', + 'description' => '查询令牌。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE', + 'maxLength' => 128, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'title' => '返回的最多记录数。', + 'description' => '返回的最多记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '下一次查询的令牌。', + 'description' => '下一次查询的令牌。', + 'type' => 'string', + 'example' => '2-ba4d-4b9f-aa24-dcb067a30f1c', + 'maxLength' => 128, + ], + 'prometheusViews' => [ + 'description' => 'Prometheus视图实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prometheus视图实例。', + 'type' => 'object', + 'properties' => [ + 'createTime' => [ + 'title' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ', + 'description' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ', + 'type' => 'string', + 'example' => '2025-07-12T02:18:36Z', + ], + 'instanceType' => [ + 'title' => '实例类型:'."\n" + .'prom-view:新版本聚合视图'."\n" + .'global-view:老版本聚合视图', + 'description' => '实例类型:'."\n" + .'prom-view:新版本聚合视图'."\n" + .'global-view:老版本聚合视图', + 'type' => 'string', + 'example' => 'prom-view', + ], + 'paymentType' => [ + 'title' => '付费类型。目前固定值FREE(免费)。', + 'description' => '付费类型。目前固定值FREE(免费)。', + 'type' => 'string', + 'example' => 'FREE', + ], + 'product' => [ + 'title' => 'prom实例归属的产品(arms或cms)', + 'description' => 'prom实例归属的产品(arms或cms)。', + 'type' => 'string', + 'example' => 'cms', + ], + 'prometheusInstanceCount' => [ + 'title' => '视图包含的prometheus实例的数量。', + 'description' => '视图包含的prometheus实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'prometheusViewId' => [ + 'description' => 'Prometheus 视图 ID。', + 'type' => 'string', + 'example' => 'view-xxx', + ], + 'prometheusViewName' => [ + 'description' => 'Prometheus 视图名称。', + 'type' => 'string', + 'example' => 'view1', + ], + 'regionId' => [ + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'resourceType' => [ + 'title' => '固定值:PrometheusView', + 'description' => '固定值:PrometheusView。', + 'type' => 'string', + 'example' => 'PrometheusView', + ], + 'status' => [ + 'title' => '后端数据存储状态', + 'description' => '后端数据存储状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '123xxx', + ], + 'version' => [ + 'title' => '版本', + 'description' => '版本。', + 'type' => 'string', + 'example' => 'V2', + ], + 'workspace' => [ + 'title' => 'prom实例归属工作空间', + 'description' => 'prom实例归属工作空间。', + 'type' => 'string', + 'example' => 'default-cms-1490404746278495-cn-hangzhou', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-9A629907C1F0', + ], + 'totalCount' => [ + 'title' => '总实例数', + 'description' => '总实例数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"2-ba4d-4b9f-aa24-dcb067a30f1c\\",\\n \\"prometheusViews\\": [\\n {\\n \\"createTime\\": \\"2025-07-12T02:18:36Z\\",\\n \\"instanceType\\": \\"prom-view\\",\\n \\"paymentType\\": \\"FREE\\",\\n \\"product\\": \\"cms\\",\\n \\"prometheusInstanceCount\\": 2,\\n \\"prometheusViewId\\": \\"view-xxx\\",\\n \\"prometheusViewName\\": \\"view1\\",\\n \\"regionId\\": \\"cn-zhangjiakou\\",\\n \\"resourceType\\": \\"PrometheusView\\",\\n \\"status\\": \\"Running\\",\\n \\"userId\\": \\"123xxx\\",\\n \\"version\\": \\"V2\\",\\n \\"workspace\\": \\"default-cms-1490404746278495-cn-hangzhou\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-9A629907C1F0\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'title' => '获取Prometheus视图实例列表', + 'description' => '获取Prometheus视图实例信息列表。', + ], + 'ListPrometheusInstances' => [ + 'summary' => '获取Prometheus实例信息列表。', + 'path' => '/prometheus-instances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'prometheusInstanceIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '实例id列表(以英文逗号分隔)', + 'description' => '实例id列表(以英文逗号分隔)', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'rw-00001,rw-00002,rw-00003', + ], + ], + [ + 'name' => 'prometheusInstanceName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '实例名称(支持部分匹配)', + 'description' => '实例名称(支持部分匹配)', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'workspace', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '实例归属的工作空间', + 'description' => '实例归属的工作空间', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '实例版本:V1或V2', + 'description' => '实例版本:V1或V2', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'V2', + 'enum' => [ + 'V1', + 'V2', + ], + ], + ], + [ + 'name' => 'resourceType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '实例的资源类型:PrometheusInstance', + 'description' => '实例的资源类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Prometheus', + 'enum' => [], + ], + ], + [ + 'name' => 'filterRegionIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '指定筛选的regionId(目前仅支持单regioinId,暂不支持多值)。', + 'description' => '指定筛选的regionId列表(英文逗号分隔)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2bhocin5e2na', + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'testKey', + ], + 'value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '返回的最多记录数。', + 'description' => '返回的最多记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '查询令牌。', + 'description' => '查询令牌。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'xxxxxxxxxx', + 'maxLength' => 128, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'maxResults' => [ + 'title' => '返回的最多记录数。', + 'description' => '返回的最多记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + 'nextToken' => [ + 'title' => '下一次查询的令牌。', + 'description' => '下一次查询的令牌。', + 'type' => 'string', + 'example' => 'xxxxxxxxxx', + 'maxLength' => 128, + ], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prometheus 实例。', + 'type' => 'object', + 'properties' => [ + 'accessType' => [ + 'title' => '权限类型:'."\n" + .'readWrite、readOnly、httpReadOnly', + 'description' => '权限类型:'."\n" + .'readWrite、readOnly、httpReadOnly', + 'type' => 'string', + 'example' => 'readWrite', + ], + 'createTime' => [ + 'title' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ', + 'description' => '实例创建时间,使用 UTC+0 时间,格式为 yyyy-MM-ddTHH:mmZ', + 'type' => 'string', + 'example' => '2025-08-10T02:07:53Z', + ], + 'instanceType' => [ + 'title' => ' remote-write(Prometheus for Remote Write)'."\n" + .' ecs(Prometheus for ECS)'."\n" + .' cloud-monitor(Prometheus for 云服务 国内)'."\n" + .' cloud-product(Prometheus for 云服务 国外)'."\n" + .' global-view(Prometheus for GlobalView)'."\n" + .' aliyun-cs(Prometheus for 容器服务)', + 'description' => '实例类型。', + 'type' => 'string', + 'example' => 'remote-write', + ], + 'paymentType' => [ + 'title' => 'POSTPAY:按指标量后付费。'."\n" + .'POSTPAY_GB:按写入量后付费。'."\n" + .'PREPAY:预付费。'."\n" + .'FREE:免费。', + 'description' => 'POSTPAY:按指标量后付费。'."\n" + .'POSTPAY_GB:按写入量后付费。'."\n" + .'PREPAY:预付费。'."\n" + .'FREE:免费。', + 'type' => 'string', + 'example' => 'POSTPAY_GB', + ], + 'product' => [ + 'title' => 'prom实例归属的产品(arms或cms)', + 'description' => 'prom实例归属的产品', + 'type' => 'string', + 'example' => 'arms', + ], + 'prometheusInstanceId' => [ + 'description' => '实例id。', + 'type' => 'string', + 'example' => 'rw-63549e054ff596a4149927961dff', + ], + 'prometheusInstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test-prom-name', + ], + 'regionId' => [ + 'description' => '区域 ID', + 'type' => 'string', + 'example' => 'cn-nanjing', + ], + 'resourceType' => [ + 'title' => '固定值:PrometheusInstance', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'Prometheus', + ], + 'status' => [ + 'title' => '后端数据存储状态', + 'description' => '后端数据存储状态', + 'type' => 'string', + 'example' => 'Pending2Running', + ], + 'supportAuthTypes' => [ + 'description' => '支持的鉴权类型。', + 'type' => 'array', + 'items' => [ + 'description' => '鉴权类型。', + 'type' => 'string', + 'example' => 'BasicAuth', + ], + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '17073812345', + ], + 'version' => [ + 'title' => '版本', + 'description' => '版本', + 'type' => 'string', + 'example' => '*', + ], + 'workspace' => [ + 'title' => 'prom实例归属工作空间', + 'description' => 'prom实例归属工作空间', + 'type' => 'string', + 'example' => 'default-cms-115214006-cn-hangzhou', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'totalCount' => [ + 'title' => '总实例数', + 'description' => '总实例数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"prometheusInstances\\": [\\n {\\n \\"accessType\\": \\"readWrite\\",\\n \\"createTime\\": \\"2025-08-10T02:07:53Z\\",\\n \\"instanceType\\": \\"remote-write\\",\\n \\"paymentType\\": \\"POSTPAY_GB\\",\\n \\"product\\": \\"arms\\",\\n \\"prometheusInstanceId\\": \\"rw-63549e054ff596a4149927961dff\\",\\n \\"prometheusInstanceName\\": \\"test-prom-name\\",\\n \\"regionId\\": \\"cn-nanjing\\",\\n \\"resourceType\\": \\"Prometheus\\",\\n \\"status\\": \\"Pending2Running\\",\\n \\"supportAuthTypes\\": [\\n \\"BasicAuth\\"\\n ],\\n \\"userId\\": \\"17073812345\\",\\n \\"version\\": \\"*\\",\\n \\"workspace\\": \\"default-cms-115214006-cn-hangzhou\\"\\n }\\n ],\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"totalCount\\": 66\\n}","type":"json"}]', + 'title' => '查询 Prometheus 实例列表', + 'description' => '获取Prometheus实例列表。', + ], + 'CreatePrometheusInstance' => [ + 'summary' => '创建Prometheus监控实例', + 'path' => '/prometheus-instances', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'archiveDuration' => [ + 'title' => '存储到期后,自动归档保存的天数,0表示不归档保存。归档天数取值范围:'."\n" + .'V1:1~365天。仅按指标写入量支持。'."\n" + .'V2:1~3650天(3650表示永久保存)。', + 'description' => '存储到期后,自动归档保存的天数。0表示不归档保存。归档天数取值范围:'."\n" + .'* V1:60~365天。'."\n" + .'* V2:60~3650天(3650表示永久保存)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + 'enum' => [], + ], + 'authFreeReadPolicy' => [ + 'description' => '免密读策略(支持IP段和VpcId)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'authFreeWritePolicy' => [ + 'description' => '免密写策略', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'enableAuthFreeRead' => [ + 'description' => '是否开启免密读(仅V2版本支持)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'enableAuthFreeWrite' => [ + 'description' => '是否开启免密写(仅V2版本支持)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'enableAuthToken' => [ + 'description' => '是否开启授权Token(仅V1版本支持)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'prometheusInstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'name1', + ], + 'status' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Running' => 'Running', + 'Stoped' => 'Stoped', + ], + 'example' => 'Running', + 'default' => 'Running', + 'enum' => [ + 'Running', + ], + ], + 'storageDuration' => [ + 'title' => '存储时长(天):'."\n" + .'按写入量:90、180'."\n" + .'按指标上报量:15、30、60、90、180', + 'description' => '存储时长(天):'."\n" + .'* 按写入量:90、180。'."\n" + .'* 按指标上报量:15、30、60、90、180。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + 'enum' => [ + '15', + '30', + '60', + '90', + '180', + ], + ], + 'tags' => [ + 'description' => '标签值。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'value' => [ + 'description' => '标签Value。', + 'type' => 'string', + 'required' => false, + 'example' => '110109200001214284', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'workspace' => [ + 'title' => '默认值:default-cms-{userId}-{regionId}', + 'description' => '归属工作空间,默认值:default-cms-{userId}-{regionId}。', + 'type' => 'string', + 'required' => false, + 'example' => 'wokspace1', + ], + 'paymentType' => [ + 'title' => '计费方式:'."\n" + .'POSTPAY:按指标上报量后付费。'."\n" + .'POSTPAY_GB:按指标写入量后付费。'."\n" + .'空:则使用用户的默认计费方式配置。若用户未配置默认值,则系统默认是按指标上报量计费。', + 'description' => '计费方式:'."\n" + .'* POSTPAY:按指标上报量后付费。'."\n" + .'* POSTPAY_GB:按指标写入量后付费。'."\n" + .'注,空值则使用用户的默认计费方式配置。若用户未配置默认值,则系统默认是按指标上报量计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'POSTPAY', + 'enum' => [ + 'POSTPAY', + 'POSTPAY_GB', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => [ + 'title' => '集群id', + 'description' => '实例id。', + 'type' => 'string', + 'example' => 'rw-abc123', + ], + 'requestId' => [ + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '264C3E89-BE6E-5F82-A484-CE9C2196C7DC', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusInstanceId\\": \\"rw-abc123\\",\\n \\"requestId\\": \\"264C3E89-BE6E-5F82-A484-CE9C2196C7DC\\"\\n}","type":"json"}]', + 'title' => '创建Prometheus实例', + ], + 'CreatePrometheusView' => [ + 'summary' => '创建prometheus视图', + 'path' => '/prometheus-views', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'authFreeReadPolicy' => [ + 'description' => '暂未启用', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "SourceIp": ['."\n" + .' "192.168.1.0/24",'."\n" + .' "172.168.2.22"'."\n" + .' ],'."\n" + .' "SourceVpc": ['."\n" + .' "vpc-xx1",'."\n" + .' "vpc-xx2"'."\n" + .' ]'."\n" + .'}', + ], + 'enableAuthFreeRead' => [ + 'title' => '是否支持免密读', + 'description' => '是否支持免密读', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'enableAuthToken' => [ + 'title' => '是否支持authToken', + 'description' => '是否支持authToken。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'prometheusInstances' => [ + 'description' => 'Prometheus 实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'prometheusInstanceId' => [ + 'description' => '实例id。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-1d581fac20a462dcde743d9628', + ], + 'regionId' => [ + 'description' => '地域 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-wulanchabu', + ], + 'userId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '167271234567890', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'prometheusViewName' => [ + 'description' => 'Prometheus 视图名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-prom-view-name', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3gn5i6bigbi', + ], + 'status' => [ + 'description' => '暂未启用。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + 'default' => 'Running', + 'enum' => [ + 'Running', + ], + ], + 'tags' => [ + 'description' => '执行的操作。', + 'type' => 'array', + 'items' => [ + 'description' => '标签Key。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-key', + ], + 'value' => [ + 'description' => '标签Value。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'version' => [ + 'title' => 'V1:老版本(global-view)'."\n" + .'V2:新版本(prom-view)', + 'description' => '- V1:老版本'."\n" + .'- V2:新版本', + 'type' => 'string', + 'required' => true, + 'example' => 'V2', + 'enum' => [ + 'V1', + 'V2', + ], + ], + 'workspace' => [ + 'title' => '默认值:default-cms-{userId}-{regionId}', + 'description' => '默认值:default-cms-{userId}-{regionId}', + 'type' => 'string', + 'required' => false, + 'example' => 'cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusViewId' => [ + 'description' => 'Prometheus 视图 ID。', + 'type' => 'string', + 'example' => 'cd5237f7dbd574cf9bbd648ff9efb16cd', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusViewId\\": \\"cd5237f7dbd574cf9bbd648ff9efb16cd\\",\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '创建prometheus视图', + 'description' => '用于创建一个站点监控任务', + ], + 'ListAlertActions' => [ + 'summary' => '查询告警行动集成', + 'path' => '/alertActions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'alertActionIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '行动集成唯一标识。', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'testId', + ], + 'required' => false, + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'description' => '行动集成类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'FC', + 'enum' => [ + 'FC', + 'MNS', + 'OPEN_API', + 'SLS', + 'ESS', + 'PAGER_DUTY', + 'WEBHOOK', + 'EB', + 'FC3', + ], + ], + ], + [ + 'name' => 'alertActionName', + 'in' => 'query', + 'schema' => [ + 'description' => '行动集成名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页面。默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页大小。默认100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'pageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'alertActions' => [ + 'description' => '行动集成配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '行动集成配置列表。', + 'type' => 'object', + 'properties' => [ + 'fcParam' => [ + 'description' => '函数计算参数。', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'service' => [ + 'description' => '函数计算的服务名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'function' => [ + 'description' => '函数计算服务的函数名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'ebParam' => [ + 'description' => '事件总线。', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '区域 ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'subject' => [ + 'description' => '主题。', + 'type' => 'string', + 'example' => 'test', + ], + 'ebSource' => [ + 'description' => '事件提供方。', + 'type' => 'string', + 'example' => 'test', + ], + 'eventBusName' => [ + 'description' => '事件总线名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'alertActionId' => [ + 'description' => '行动集成唯一标识。', + 'type' => 'string', + 'example' => 'test', + ], + 'slsParam' => [ + 'description' => '日志服务参数。', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'project' => [ + 'description' => '日志服务Project名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'logstore' => [ + 'description' => '日志服务Logstore名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'fc3Param' => [ + 'description' => '函数计算3.0参数。', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-qingdao', + ], + 'function' => [ + 'description' => '函数计算服务的函数名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'qualifier' => [ + 'description' => '函数的版本或别名。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'mnsParam' => [ + 'description' => '轻量消息队列(原 MNS)参数。', + 'type' => 'object', + 'properties' => [ + 'mnsType' => [ + 'description' => '轻量消息队列(原 MNS)资源类型。', + 'type' => 'string', + 'example' => 'queue', + ], + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'name' => [ + 'description' => '资源名称。'."\n" + ."\n" + .'- 如果资源类型为 queue,则资源名称为队列名称。'."\n" + .'- 如果资源类型为 topic,则资源名称为主题名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'pagerDutyParam' => [ + 'description' => 'pageDuty参数', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => 'pagerDuty的集成key。', + 'type' => 'string', + 'example' => 'fsfer4543t5t65g4t4', + ], + 'url' => [ + 'description' => 'pagerDuty的集成webhook。支持V1和V2版', + 'type' => 'string', + 'example' => 'https://events.pagerduty.com/v2/enqueue', + ], + ], + ], + 'type' => [ + 'description' => '行动集成类型。', + 'type' => 'string', + 'example' => 'FC', + ], + 'webhookParam' => [ + 'description' => 'webhook参数', + 'type' => 'object', + 'properties' => [ + 'headers' => [ + 'description' => '请求头。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{\'X-Total-Count\': 0}', + 'description' => '请求头。', + ], + ], + 'method' => [ + 'description' => 'webhook请求方法。', + 'type' => 'string', + 'example' => 'GET', + ], + 'contentType' => [ + 'description' => '数据格式,请求方法为POST时生效。', + 'type' => 'string', + 'example' => 'JSON', + ], + 'url' => [ + 'description' => '报警回调的URL地址。', + 'type' => 'string', + 'example' => 'http://www.test.com', + ], + ], + ], + 'essParam' => [ + 'description' => '弹性伸缩参数。', + 'type' => 'object', + 'properties' => [ + 'essGroupId' => [ + 'description' => '弹性伸缩组id', + 'type' => 'string', + 'example' => 'testId', + ], + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'essRuleId' => [ + 'description' => '弹性伸缩规则id。', + 'type' => 'string', + 'example' => 'testId', + ], + ], + ], + 'alertActionName' => [ + 'description' => '行动集成名称。', + 'type' => 'string', + 'example' => 'testName', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"total\\": 9,\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 100,\\n \\"alertActions\\": [\\n {\\n \\"fcParam\\": {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"service\\": \\"test\\",\\n \\"function\\": \\"test\\"\\n },\\n \\"ebParam\\": {\\n \\"regionId\\": \\"cn-heyuan\\",\\n \\"subject\\": \\"test\\",\\n \\"ebSource\\": \\"test\\",\\n \\"eventBusName\\": \\"test\\"\\n },\\n \\"alertActionId\\": \\"test\\",\\n \\"slsParam\\": {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"project\\": \\"test\\",\\n \\"logstore\\": \\"test\\"\\n },\\n \\"fc3Param\\": {\\n \\"regionId\\": \\"cn-qingdao\\",\\n \\"function\\": \\"test\\",\\n \\"qualifier\\": \\"test\\"\\n },\\n \\"mnsParam\\": {\\n \\"mnsType\\": \\"queue\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"name\\": \\"test\\"\\n },\\n \\"pagerDutyParam\\": {\\n \\"key\\": \\"fsfer4543t5t65g4t4\\",\\n \\"url\\": \\"https://events.pagerduty.com/v2/enqueue\\"\\n },\\n \\"type\\": \\"FC\\",\\n \\"webhookParam\\": {\\n \\"headers\\": {\\n \\"key\\": \\"{\'X-Total-Count\': 0}\\"\\n },\\n \\"method\\": \\"GET\\",\\n \\"contentType\\": \\"JSON\\",\\n \\"url\\": \\"http://www.test.com\\"\\n },\\n \\"essParam\\": {\\n \\"essGroupId\\": \\"testId\\",\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"essRuleId\\": \\"testId\\"\\n },\\n \\"alertActionName\\": \\"testName\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询告警行动集成', + ], + 'UpdateSubscription' => [ + 'summary' => '更新订阅', + 'path' => '/subscriptions/{subscriptionId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '请求Body。', + 'required' => false, + '$ref' => '#/components/schemas/SubscriptionForModify', + ], + ], + [ + 'name' => 'subscriptionId', + 'in' => 'path', + 'schema' => [ + 'description' => '订阅ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123123123123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识 ID', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-******', + ], + 'subscriptionId' => [ + 'description' => '订阅ID。', + 'type' => 'string', + 'example' => '123123123123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-******\\",\\n \\"subscriptionId\\": \\"123123123123\\"\\n}","type":"json"}]', + 'title' => '更新订阅', + ], + 'CreateAlertWebhook' => [ + 'summary' => '创建Webhook', + 'path' => '/webhook', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'contentType' => [ + 'description' => '数据内容类型,支持:'."\n" + .'- JSON(默认)'."\n" + .'- FORM', + 'type' => 'string', + 'required' => false, + 'example' => 'JSON', + 'default' => 'JSON', + 'enum' => [ + 'JSON', + 'FORM', + ], + ], + 'headers' => [ + 'description' => 'headers', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'test', + 'description' => 'header', + ], + ], + 'lang' => [ + 'description' => '语言。支持:'."\n" + .'- zh_CN'."\n" + .'- en_US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + 'enum' => [ + 'zh_CN', + 'en_US', + ], + ], + 'method' => [ + 'description' => '请求方法。'."\n" + .'- GET'."\n" + .'- POST', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + 'default' => 'POST', + 'enum' => [ + 'GET', + 'POST', + ], + ], + 'name' => [ + 'description' => 'webhook名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + 'url' => [ + 'description' => '报警回调的URL地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun.com/test', + ], + 'webhookId' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'alertWebhookId' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceExist', + 'errorMessage' => 'Resource already exist .', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"alertWebhookId\\": \\"test\\"\\n}","type":"json"}]', + 'title' => '创建报警webhook', + 'description' => '创建一个webhook通知对象。', + ], + 'DeleteAlertWebhooks' => [ + 'summary' => '删除Webhook', + 'path' => '/webhooks', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\"\\n}","type":"json"}]', + 'title' => '删除报警webhook', + ], + 'ListAlertWebhooks' => [ + 'summary' => '查询Webhook', + 'path' => '/webhooks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '100', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。默认值:1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'webhookIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'wh-def456uvw012', + ], + 'required' => false, + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => 'webhook名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', + 'type' => 'object', + 'properties' => [ + 'pageNumber' => [ + 'description' => '页码,默认1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'pageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8A33DBEA-*****-*****-*****-*****', + ], + 'total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'webhooks' => [ + 'description' => 'webhooks', + 'type' => 'array', + 'items' => [ + 'description' => 'webhook', + 'type' => 'object', + 'properties' => [ + 'contentType' => [ + 'description' => '数据内容类型。支持'."\n" + .'- JSON'."\n" + .'- FORM', + 'type' => 'string', + 'example' => 'JSON', + ], + 'headers' => [ + 'description' => 'headers', + 'type' => 'object', + 'example' => 'key', + ], + 'lang' => [ + 'description' => '语言。支持:'."\n" + .'- zh_CN'."\n" + .'- en_US', + 'type' => 'string', + 'example' => 'zh_CN', + ], + 'method' => [ + 'description' => '请求方法。支持'."\n" + .'- GET'."\n" + .'- POST', + 'type' => 'string', + 'example' => 'GET', + ], + 'name' => [ + 'description' => 'webhook名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'url' => [ + 'description' => '报警回调的URL地址。', + 'type' => 'string', + 'example' => 'http://aliyun.com/test', + ], + 'webhookId' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"pageNumber\\": 1,\\n \\"pageSize\\": 10,\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\",\\n \\"total\\": 8,\\n \\"webhooks\\": [\\n {\\n \\"contentType\\": \\"JSON\\",\\n \\"headers\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"lang\\": \\"zh_CN\\",\\n \\"method\\": \\"GET\\",\\n \\"name\\": \\"test\\",\\n \\"url\\": \\"http://aliyun.com/test\\",\\n \\"webhookId\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询报警webhook', + ], + 'UpdateAlertWebhook' => [ + 'summary' => '更新Webhook', + 'path' => '/webhook/{webhookId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'webhookId', + 'in' => 'path', + 'schema' => [ + 'description' => 'webhook唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'contentType' => [ + 'description' => '数据内容类型。支持'."\n" + .'- JSON'."\n" + .'- FORM', + 'type' => 'string', + 'required' => false, + 'example' => 'JSON', + 'enum' => [ + 'JSON', + 'FORM', + ], + ], + 'headers' => [ + 'description' => 'headers', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'key', + 'description' => 'header', + ], + ], + 'lang' => [ + 'description' => '语言。支持'."\n" + .'- zh_CN'."\n" + .'- en_US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + 'enum' => [ + 'zh_CN', + 'en_US', + ], + ], + 'method' => [ + 'description' => '请求方法。支持'."\n" + .'- GET'."\n" + .'- POST', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + 'enum' => [ + 'GET', + 'POST', + ], + ], + 'name' => [ + 'description' => 'webhook名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'url' => [ + 'description' => '报警回调的URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://aliyun.com/test', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8A33DBEA-*****-*****-*****-*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => '%s is missing or invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource %s is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8A33DBEA-*****-*****-*****-*****\\"\\n}","type":"json"}]', + 'title' => '更新报警webhook', + ], + 'UpdateNotifyStrategy' => [ + 'summary' => '更新通知策略', + 'path' => '/notifyStrategies/{notifyStrategyId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间', + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'workspace-test', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '请求体参数。', + 'required' => false, + '$ref' => '#/components/schemas/NotifyStrategyForModify', + ], + ], + [ + 'name' => 'notifyStrategyId', + 'in' => 'path', + 'schema' => [ + 'title' => '通知策略ID', + 'description' => '通知策略UUID', + 'type' => 'string', + 'required' => true, + 'example' => '12312-31-23-123-1-23123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容结构', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一 ID,用于排查问题', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'notifyStrategyId' => [ + 'title' => '通知策略ID', + 'description' => '通知策略UUID', + 'type' => 'string', + 'example' => '12312-31-23-123-1-23123', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameterValue', + 'errorMessage' => 'Illegal parameters.', + ], + [ + 'errorCode' => 'StrategyNameConflict', + 'errorMessage' => 'The specified strategy name exits already.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Forbidden', + 'errorMessage' => 'You are not authorized to operate the specified resource.', + ], + ], + [ + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => 'The specified resource is not found.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalUnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"notifyStrategyId\\": \\"12312-31-23-123-1-23123\\"\\n}","type":"json"}]', + 'title' => '更新通知策略', + ], + 'CreateTicket' => [ + 'summary' => '如果您需要将控制台页面免密分享给其他人或者嵌入到第三方系统,可以调用CreateTicket生成票据,然后拼接免密链接。', + 'path' => '/tickets', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'expirationTime', + 'in' => 'query', + 'schema' => [ + 'description' => '- 过期时间(秒),即内嵌页面URL链接过期时间,默认86400秒(一天),取值0~2592000秒(30天)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '86400', + ], + ], + [ + 'name' => 'accessTokenExpirationTime', + 'in' => 'query', + 'schema' => [ + 'description' => '- 访问令牌过期时间(秒),即用户可以访问页面接口的过期时间,默认86400秒(一天),取值0~86400秒(一天)。'."\n" + .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" + .'- 若通过STS调用,访问令牌过期时间(即用户可以访问页面接口的时间)是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'ticket' => [ + 'title' => 'Id of the request', + 'description' => '免登录票据', + 'type' => 'string', + 'example' => 'eyJ***************.eyJ******************.KUT****************', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', + 'title' => '创建免登录票据', + ], + 'TagResources' => [ + 'summary' => '打标签接口', + 'path' => '/tags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => true, + 'example' => 'Service', + ], + 'resourceId' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + 'tag' => [ + 'title' => '对应新增标签列表,最多包含20个子项', + 'description' => '标签。'."\n" + ."\n" + .'最多可以绑定 20 个标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'required' => false, + '$ref' => '#/components/schemas/Tag', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '3B311FD9-A60B-55E0-A896-A0C73*********', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'InvalidParameter.RegionId', + 'errorMessage' => 'The RegionId parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceId.N.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'You must specify ResourceType.', + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'You must specify Tags.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'MissingParameter.TagValue', + 'errorMessage' => 'You must specify Tag.N.Value.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagValue', + 'errorMessage' => 'The Tag.N.Value parameter is invalid.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceed.TagsPerResource', + 'errorMessage' => 'The maximum number of tags for each resource is exceeded.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'The operator is not permission for this operate', + ], + ], + 500 => [ + [ + 'errorCode' => 'InvalidOperation.ConcurrentModification', + 'errorMessage' => 'The resource is modified concurrently.', + ], + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"3B311FD9-A60B-55E0-A896-A0C73*********\\"\\n}","type":"json"}]', + 'title' => '绑定标签', + ], + 'UntagResources' => [ + 'summary' => '删标签接口', + 'path' => '/tags', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => true, + 'example' => 'Service', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'tagKey', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '对应标签键列表,最多包含20个子项', + 'description' => '标签键。'."\n" + ."\n" + .'最多可以解绑 20 个标签键', + 'type' => 'array', + 'items' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'required' => false, + ], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => [ + 'title' => '是否全部删除,只针对tags为空时有效。取值范围: true false True False 默认是 false', + 'description' => '是否解绑指定资源的全部标签。取值:'."\n" + ."\n" + .'false(默认值):否'."\n" + .'true:是', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'You must specify ResourceId.N.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'You must specify ResourceType.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKey', + 'errorMessage' => 'The Tag.N.Key parameter is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter.TagKeysOrDeleteAll', + 'errorMessage' => 'The TagKeys or DeleteAll parameter is invalid.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.TagKeys', + 'errorMessage' => 'The maximum number of TagKeys is exceeded.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidResourceId.NotFound', + 'errorMessage' => 'The specified ResourceIds are not found in our records.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'The operator is not permission for this operate ', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '解绑标签', + ], + 'ListTagResources' => [ + 'summary' => '查标签接口。', + 'path' => '/tags', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'resourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => true, + 'example' => 'Service', + ], + ], + [ + 'name' => 'resourceId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => false, + ], + ], + [ + 'name' => 'tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '对应新增标签列表,最多包含20个子项', + 'description' => '标签。查询的过滤条件。'."\n" + ."\n" + .'最多可以指定 20 个标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。查询的过滤条件。'."\n" + ."\n" + .'最多可以指定 20 个标签。', + 'required' => false, + '$ref' => '#/components/schemas/Tag', + ], + 'required' => false, + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => '下一个查询开始Token', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxxxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回结果数,最大值200', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-***', + ], + 'maxResults' => [ + 'title' => '列表最大数量', + 'description' => '最大返回结果数,最大值200', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'title' => '下一个查询开始Token', + 'description' => '下一个查询开始Token', + 'type' => 'string', + 'example' => 'xxxxxxxxxx', + ], + 'tagResources' => [ + 'title' => '资源列表', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表', + 'type' => 'object', + 'properties' => [ + 'tagKey' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'example' => 'env', + ], + 'tagValue' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'example' => 'test', + ], + 'resourceId' => [ + 'title' => '资源ID', + 'description' => '资源ID', + 'type' => 'string', + 'example' => 'test', + ], + 'resourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'Service', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter.ResourceType', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIdsOrTags', + 'errorMessage' => 'You must specify ResourceId.N or Tags.', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'You must specify ResourceType.', + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'You must specify Tag.N.Key.', + ], + [ + 'errorCode' => 'NumberExceed.ResourceIds', + 'errorMessage' => 'The maximum number of ResourceIds is exceeded.', + ], + [ + 'errorCode' => 'NumberExceed.Tags', + 'errorMessage' => 'The maximum number of Tags is exceeded.', + ], + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contains duplicate keys.', + ], + [ + 'errorCode' => 'InvalidParameter.NextToken', + 'errorMessage' => 'The NextToken parameter is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'The operator is not permission for this operate', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\",\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxxxxxxxx\\",\\n \\"tagResources\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"test\\",\\n \\"resourceId\\": \\"test\\",\\n \\"resourceType\\": \\"Service\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询标签列表', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改资源所属资源组', + 'path' => '/resourcegroup', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体', + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Service', + ], + 'resourceId' => [ + 'description' => '资源ID', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'resourceGroupId' => [ + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ae******ey', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '修改资源组', + ], + 'DescribeRegions' => [ + 'summary' => '查询地域信息列表', + 'path' => '/regions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言,取值:'."\n" + ."\n" + .'- zh:中文(默认值)'."\n" + .'- en:英文'."\n" + .'- ja:日文', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ja' => 'ja', + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'regions' => [ + 'description' => '地域信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '区域ID', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'localName' => [ + 'description' => '地域名称', + 'type' => 'string', + 'example' => 'China (Beijing)', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"regions\\": [\\n {\\n \\"regionId\\": \\"cn-beijing\\",\\n \\"localName\\": \\"China (Beijing)\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询地域列表', + ], + 'GetCmsService' => [ + 'summary' => '检查Prometheus服务或商品开通状态。', + 'path' => '/cmsservice', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'product', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '空:云产品开通prometheus场景使用。'."\n" + .'prometheus:开通prometheuse服务(按上报量或写入量计费)'."\n" + .'sls:开通sls日志服务', + 'description' => 'prometheus:prometheuse服务(按上报量或写入量计费)开通状态。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'prometheus' => 'prometheus', + ], + 'example' => 'prometheus', + 'enum' => [ + 'prometheus', + ], + ], + ], + [ + 'name' => 'service', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '空:云产品开通prometheus场景使用。'."\n" + .'prometheus:检查上报量计费的prometheus是否开通。'."\n" + .'prometheusgb:检查写入量计费的prometheus是否开通。'."\n" + .'ackpro:检查容器监控pro是否开通。', + 'description' => 'prometheus:prometheus上报量计费商品是否开通。'."\n" + .'prometheusgb:prometheus写入量计费商品是否开通。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'prometheusgb' => 'prometheusgb', + 'promethues' => 'promethues', + ], + 'example' => 'prometheus', + 'enum' => [ + 'prometheus', + 'prometheusgb', + 'promethues', + 'ackpro', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'enabled' => [ + 'description' => '服务或商品是否开通。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'errorCode' => [ + 'title' => 'PROM_NOT_OPEN:prometheus未开通'."\n" + .'SLS_NOT_OPEN:sls未开通'."\n" + .'CMS_SLR_NOT_EXIST:cloudmonitor SLR未创建'."\n" + .'SLS_SLR_NOT_EXIST:sls SLR未创建', + 'description' => 'PROM_NOT_OPEN:prometheus未开通。'."\n" + .'SLS_NOT_OPEN:prometheus依赖的sls未开通。'."\n" + .'CMS_SLR_NOT_EXIST:cloudmonitor SLR未创建。'."\n" + .'SLS_SLR_NOT_EXIST:SLS SLR未创建。', + 'type' => 'string', + 'example' => 'PROM_NOT_OPEN', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"enabled\\": false,\\n \\"errorCode\\": \\"PROM_NOT_OPEN\\"\\n}","type":"json"}]', + 'title' => '检查Prometheus服务或商品开通状态', + 'description' => 'product和service两个入参,不支持同时填写。', + ], + 'CreateBizTrace' => [ + 'summary' => '创建业务链路', + 'path' => '/bizTrace', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default-cms-xxxxxxx-cn-hangzhou', + ], + 'bizTraceCode' => [ + 'description' => '业务链路标识,仅使用字母、数字和下划线(_),且首字母需要小写', + 'type' => 'string', + 'required' => false, + 'example' => 'label_env', + ], + 'bizTraceName' => [ + 'description' => '业务链路名称', + 'type' => 'string', + 'required' => false, + 'example' => 'just test', + ], + 'ruleConfig' => [ + 'description' => '配置规则列表', + 'type' => 'string', + 'required' => false, + 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]'."\n", + ], + 'advancedConfig' => [ + 'description' => '高级配置', + 'type' => 'string', + 'required' => false, + 'example' => '{"sample":{"strategy":"BY_APP"}}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'bizTraceId' => [ + 'description' => '业务链路id', + 'type' => 'string', + 'example' => 'e339260ed64c95d', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', + 'title' => '创建业务链路', + ], + 'CreateServiceObservability' => [ + 'summary' => '创建应用可观测,完成接入前置资源准备等;', + 'path' => '/workspace/{workspace}/service-observability/{type}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'path', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => true, + 'example' => 'default-cms-1654218965343050-cn-hangzhou', + ], + ], + [ + 'name' => 'type', + 'in' => 'path', + 'schema' => [ + 'description' => '应用可观测类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'rum' => '用户体验监控', + 'apm' => '应用性能监控', + ], + 'example' => 'apm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '创建应用可观测', + 'extraInfo' => '说明:'."\n" + ."\n" + .'- 资源初始化涉及较多动作可能存在延迟,接口发起成功即可;可以通过GetServiceObservability来获取状态,如果status返回running则表示资源初始化成功;'."\n" + ."\n" + .'- 应用性能监控,链路追踪OpenTelemetry以及用户体验监控需要单独进行资源初始化;', + ], + 'DeleteBizTrace' => [ + 'summary' => '删除业务链路。', + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => [ + 'description' => '业务链路id', + 'type' => 'string', + 'required' => false, + 'example' => 'e339260ed64c95d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '删除业务链路', + ], + 'GetAddon' => [ + 'summary' => '获取插件详情(Addon)。', + 'path' => '/addons/{addonName}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'addonName', + 'in' => 'path', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数', + 'type' => 'string', + 'required' => true, + 'example' => 'security-actiontrail', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon版本号', + 'description' => 'Addon版本号', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境,默认为中文 zh | en', + 'description' => '语言环境,默认为中文 zh | en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '请求头对应的数据列表', + 'type' => 'object', + 'properties' => [ + 'alias' => [ + 'description' => '接入组件别名。', + 'type' => 'string', + 'example' => 'resume_vector_alias', + ], + 'categories' => [ + 'description' => '接入组件分类目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分类目录名称', + 'type' => 'string', + 'example' => 'alibaba-cloud-service', + ], + ], + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘信息。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '仪表盘描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'name' => [ + 'description' => '仪表盘名称。', + 'type' => 'string', + 'example' => 'rum_api_dot_metric_set', + ], + 'url' => [ + 'description' => '效果图URL地址。', + 'type' => 'string', + 'example' => 'http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f', + ], + ], + ], + ], + 'description' => [ + 'description' => 'Addon描述', + 'type' => 'string', + 'example' => 'o11y-demo-cn-heyuan', + ], + 'environments' => [ + 'description' => '环境信息。', + 'type' => 'array', + 'items' => [ + 'description' => '单个环境信息。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'label' => [ + 'description' => '环境展示名称。', + 'type' => 'string', + 'example' => '容器环境', + ], + 'dependencies' => [ + 'description' => '附加依赖文件。', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => '对集群类型的依赖。', + 'type' => 'array', + 'items' => [ + 'description' => '对集群类型的依赖。', + 'type' => 'string', + 'example' => 'ManagedKubernetes/Default', + ], + ], + 'features' => [ + 'description' => '对探针的依赖。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'description' => '是否依赖目标探针组件', + 'example' => 'true', + ], + ], + 'services' => [ + 'description' => '对开通服务的依赖', + 'type' => 'array', + 'items' => [ + 'description' => '服务名称', + 'type' => 'string', + 'example' => 'Prometheus', + ], + ], + ], + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'Observability integration.', + ], + 'name' => [ + 'description' => 'Addon名称。', + 'type' => 'string', + 'example' => 'cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85', + ], + 'policies' => [ + 'description' => '资源组ID。', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => [ + 'description' => '告警规则默认策略的启用状态。', + 'type' => 'string', + 'example' => 'true', + ], + 'defaultInstall' => [ + 'description' => '是否默认安装', + 'type' => 'boolean', + 'example' => 'true', + ], + 'enableServiceAccount' => [ + 'description' => '是否分配 Service Account 用以与 Console API 通信。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'metricCheckRule' => [ + 'description' => '指标检测规则。', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => '安装后数据检查规则', + 'type' => 'array', + 'items' => [ + 'description' => '安装后数据检查规则', + 'type' => 'string', + 'example' => 'up=1', + ], + ], + ], + ], + 'needRestartAfterIntegration' => [ + 'description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'protocols' => [ + 'description' => '协议。', + 'type' => 'array', + 'items' => [ + 'description' => '协议。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '协议说明', + 'type' => 'string', + 'example' => 'Support OpenTelemetry Protocol', + ], + 'icon' => [ + 'description' => '图标地址', + 'type' => 'string', + 'example' => 'icon URL', + ], + 'label' => [ + 'description' => '协议展示名称。', + 'type' => 'string', + 'example' => 'OpenTelemetry', + ], + 'name' => [ + 'description' => '协议名称。', + 'type' => 'string', + 'example' => 'OpenTelemetry', + ], + ], + ], + ], + 'targetAddonName' => [ + 'description' => '跳转的目标 Addon 名称', + 'type' => 'string', + 'example' => 'cs-default', + ], + ], + ], + 'policyType' => [ + 'description' => '接入策略类型。', + 'type' => 'string', + 'example' => 'CS', + ], + 'commonSchemaRefs' => [ + 'description' => '关联的Common Schema列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联的Common Schema信息', + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'description' => 'CommonSchema 的分组名称', + 'type' => 'string', + 'example' => 'acs-ecs', + ], + 'version' => [ + 'description' => 'CommonSchema 的版本', + 'type' => 'string', + 'example' => '0.1.3', + ], + ], + ], + ], + ], + ], + ], + 'icon' => [ + 'description' => '图标地址', + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'keywords' => [ + 'description' => '关键词', + 'type' => 'array', + 'items' => [ + 'description' => '关键词', + 'type' => 'string', + 'example' => 'metrics', + ], + ], + 'language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'latestReleaseCreateTime' => [ + 'description' => '最新一次创建时间。', + 'type' => 'string', + 'example' => '2023-09-12 12:30:30', + ], + 'name' => [ + 'description' => 'Addon名称。', + 'type' => 'string', + 'example' => 'rum_api_dashboard_explorer_link_metric_set', + ], + 'once' => [ + 'description' => '是否只能安装一次。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'scene' => [ + 'description' => '组件场景。', + 'type' => 'string', + 'example' => 'middleware', + ], + 'version' => [ + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '*', + ], + 'weight' => [ + 'description' => '权重值。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"alibaba-cloud-service\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_api_dot_metric_set\\",\\n \\"url\\": \\"http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f\\"\\n }\\n ],\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"environments\\": [\\n {\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"Observability integration.\\",\\n \\"name\\": \\"cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"true\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"up=1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocol\\",\\n \\"icon\\": \\"icon URL\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"OpenTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cs-default\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.3\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"https://xxxxx\\",\\n \\"keywords\\": [\\n \\"metrics\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2023-09-12 12:30:30\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"10\\"\\n },\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '获取 Addon 配置详情', + 'description' => '获取Addon详情。', + ], + 'GetAddonCodeTemplate' => [ + 'summary' => '插件schema详情(Addon)', + 'path' => '/addons/{addonName}/alert-code-template', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'addonName', + 'in' => 'path', + 'schema' => [ + 'title' => 'Addon的名称信息', + 'description' => 'Addon的名称信息', + 'type' => 'string', + 'required' => true, + 'example' => 'apm-opentelemetry', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境,默认为中文 zh | en', + 'description' => '语言环境,默认为中文 zh | en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'environmentType', + 'in' => 'query', + 'schema' => [ + 'title' => '环境类型 CS(容器) | ECS', + 'description' => '环境类型 CS(容器) | ECS', + 'type' => 'string', + 'required' => false, + 'example' => 'Client', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'description' => '组件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '0.1.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'codes' => [ + 'description' => '代码模版信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'codeTemplate' => [ + 'description' => '代码模版', + 'type' => 'string', + 'example' => 'javascript\\nnpm install @arms/rum-miniapp --save', + ], + 'name' => [ + 'description' => '代码模版名称', + 'type' => 'string', + 'example' => 'cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"codes\\": [\\n {\\n \\"codeTemplate\\": \\"javascript\\\\\\\\nnpm install @arms/rum-miniapp --save\\",\\n \\"name\\": \\"cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver\\"\\n }\\n ],\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-***\\"\\n}","type":"json"}]', + 'title' => '获取Addon内代码模版', + 'description' => '本文将提供一个示例,修改版本`1`的报警模板`123456`,将报警级别修改为`Critical`,报警统计方法修改为`Average`,报警阈值比较符修改为`GreaterThanOrEqualToThreshold`,报警阈值修改为`90`,报警重试次数修改为`3`。返回结果显示,修改报警模板成功。', + ], + 'GetAddonSchema' => [ + 'summary' => '插件schema详情(Addon)。', + 'path' => '/addons/{addonName}/schema', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'addonName', + 'in' => 'path', + 'schema' => [ + 'title' => 'Addon的名称信息', + 'description' => 'Addon的名称信息', + 'type' => 'string', + 'required' => true, + 'example' => 'cloud-rds-audit-log', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境,默认为中文 zh | en', + 'description' => '语言环境,默认为中文 zh | en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'environmentType', + 'in' => 'query', + 'schema' => [ + 'title' => '环境类型 CS(容器) | ECS', + 'description' => '环境类型 CS(容器) | ECS', + 'type' => 'string', + 'required' => false, + 'example' => 'CS', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'description' => '组件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '0.1.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'fields' => [ + 'description' => '数据表字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据表字段信息。', + 'type' => 'object', + 'properties' => [ + 'conditions' => [ + 'description' => '展示条件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '展示条件。', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'description' => '字段控制模式。', + 'type' => 'string', + 'example' => 'show', + ], + 'field' => [ + 'description' => '字段名称', + 'type' => 'string', + 'example' => 'store.storageTarget', + ], + 'op' => [ + 'description' => '判断条件操作符。', + 'type' => 'string', + 'example' => '==', + ], + 'value' => [ + 'description' => '判断目标值。', + 'type' => 'any', + 'example' => 'Custom', + ], + ], + ], + ], + 'defaultValue' => [ + 'description' => '默认值', + 'type' => 'any', + 'example' => 'mysql.default', + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'MySQL datasource', + ], + 'disabled' => [ + 'description' => '是否隐藏: true - 隐藏, false - 显示', + 'type' => 'boolean', + 'example' => 'false', + ], + 'element' => [ + 'description' => '元素类型。', + 'type' => 'string', + 'example' => 'input', + ], + 'fieldPath' => [ + 'description' => '字段路径。', + 'type' => 'string', + 'example' => 'mysql.host', + ], + 'label' => [ + 'description' => '字段展示名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'name' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'example' => 'host', + ], + 'placeholder' => [ + 'description' => '输入提示。', + 'type' => 'string', + 'example' => 'Please enter the metrics collection interval', + ], + 'props' => [ + 'description' => '组件其他属性。', + 'type' => 'object', + 'properties' => [ + 'dataSource' => [ + 'description' => '数据源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息。', + 'type' => 'object', + 'properties' => [ + 'label' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'tagKey', + ], + 'value' => [ + 'description' => '标签Value。', + 'type' => 'string', + 'example' => 'tagValue', + ], + ], + ], + ], + 'related' => [ + 'description' => '相关的数据集合。', + 'type' => 'array', + 'items' => [ + 'description' => '相关数据。', + 'type' => 'string', + 'example' => 'mysql.host', + ], + ], + 'selectMode' => [ + 'description' => '模式。', + 'type' => 'string', + 'example' => 'single', + ], + ], + ], + 'type' => [ + 'description' => '字段类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'validation' => [ + 'description' => '字段校验规则', + 'type' => 'object', + 'properties' => [ + 'max' => [ + 'description' => '分数区间最大值(包含)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'maxLength' => [ + 'description' => '文本控件支持的最大长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'length limit', + ], + 'min' => [ + 'description' => '最小值。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'minLength' => [ + 'description' => '最短长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'regular' => [ + 'description' => '正则表达式。', + 'type' => 'string', + 'example' => '^(http|https)://', + ], + 'required' => [ + 'description' => '参数是否必填。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E5B1D3D4-BB28-5996-8AD2-***********', + ], + 'type' => [ + 'description' => 'Schema类型。', + 'type' => 'string', + 'example' => 'common', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"fields\\": [\\n {\\n \\"conditions\\": [\\n {\\n \\"action\\": \\"show\\",\\n \\"field\\": \\"store.storageTarget\\",\\n \\"op\\": \\"==\\",\\n \\"value\\": \\"Custom\\"\\n }\\n ],\\n \\"defaultValue\\": \\"mysql.default\\",\\n \\"description\\": \\"MySQL datasource\\",\\n \\"disabled\\": false,\\n \\"element\\": \\"input\\",\\n \\"fieldPath\\": \\"mysql.host\\",\\n \\"label\\": \\"mysql\\",\\n \\"name\\": \\"host\\",\\n \\"placeholder\\": \\"Please enter the metrics collection interval\\",\\n \\"props\\": {\\n \\"dataSource\\": [\\n {\\n \\"label\\": \\"tagKey\\",\\n \\"value\\": \\"tagValue\\"\\n }\\n ],\\n \\"related\\": [\\n \\"mysql.host\\"\\n ],\\n \\"selectMode\\": \\"single\\"\\n },\\n \\"type\\": \\"string\\",\\n \\"validation\\": {\\n \\"max\\": 2000,\\n \\"maxLength\\": 100,\\n \\"message\\": \\"length limit\\",\\n \\"min\\": 0,\\n \\"minLength\\": 16,\\n \\"regular\\": \\"^(http|https)://\\",\\n \\"required\\": false\\n }\\n }\\n ],\\n \\"requestId\\": \\"E5B1D3D4-BB28-5996-8AD2-***********\\",\\n \\"type\\": \\"common\\"\\n}","type":"json"}]', + 'title' => '获取Addon的Schema信息', + 'description' => '获取Addon的Schema信息。', + ], + 'GetBizTrace' => [ + 'summary' => '查询业务链路', + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => [ + 'description' => '业务链路id', + 'type' => 'string', + 'required' => false, + 'example' => 'e339260ed64c95d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + 'item' => [ + 'description' => '业务链路', + '$ref' => '#/components/schemas/BizTraceConfig', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\",\\n \\"item\\": {\\n \\"workspace\\": \\"default-cms-xxxxxxx-cn-hangzhou\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\",\\n \\"bizTraceName\\": \\"just test\\",\\n \\"bizTraceCode\\": \\"label_env\\",\\n \\"ruleConfig\\": \\"[{\\\\\\"entrancePid\\\\\\":\\\\\\"xxxxx@b57c44xx6e86\\\\\\",\\\\\\"rpcMatcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"EQUALS\\\\\\",\\\\\\"pattern\\\\\\":\\\\\\"/createApp\\\\\\"},\\\\\\"characteristics\\\\\\":{\\\\\\"operation\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"target\\\\\\":\\\\\\"CUSTOM_EXTRACT\\\\\\",\\\\\\"matcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"CONTAINS\\\\\\",\\\\\\"pattern\\\\\\":[]}}]}}]\\",\\n \\"advancedConfig\\": \\"{\\\\\\"sample\\\\\\":{\\\\\\"strategy\\\\\\":\\\\\\"BY_APP\\\\\\"}}\\",\\n \\"createTime\\": \\"2025-12-12 00:00:00\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n }\\n}","type":"json"}]', + 'title' => '查询业务链路', + ], + 'GetIntegrationVersionForCS' => [ + 'summary' => '查询容器集群链接的接入中心版本。', + 'path' => '/integration-version/cs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c502646fd0d1249baaf792b3a1b589e1b', + ], + ], + [ + 'name' => 'clusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。取值:acs.ack.cluster,acs.asi.cluster。', + 'description' => '集群类型。取值:acs.ack.cluster,acs.asi.cluster。', + 'type' => 'string', + 'required' => true, + 'example' => 'acs.ack.cluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'integrationVersion' => [ + 'title' => '接入中心版本。', + 'description' => '接入中心版本。', + 'type' => 'string', + 'example' => 'V1', + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"integrationVersion\\": \\"V1\\",\\n \\"requestId\\": \\"CD9BCF34-EA09-5643-BC11-AF41C8DFAE5A\\"\\n}","type":"json"}]', + 'title' => '查询容器集群链接的接入中心版本', + 'description' => '根据传入ID获取集成', + ], + 'GetPrometheusUserSetting' => [ + 'summary' => '查询Prometheus用户配置。', + 'path' => '/prometheus-user-setting', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcmsCP2WWY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'prometheusUserSetting' => [ + 'description' => 'Prometheus用户配置详情。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '配置值。', + 'example' => 'value1', + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '058550FA-DDBE-519E-9C6D-93521B9A5E90', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"prometheusUserSetting\\": {\\n \\"key\\": \\"value1\\"\\n },\\n \\"requestId\\": \\"058550FA-DDBE-519E-9C6D-93521B9A5E90\\"\\n}","type":"json"}]', + 'title' => '获取Prometheus用户配置。', + ], + 'ListAddons' => [ + 'summary' => '新版接入中心产品列表(分组)。', + 'path' => '/addons', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'aliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境:zh / en'."\n" + .'默认为中文 zh', + 'description' => '语言环境:zh / en'."\n" + .'默认为中文 zh', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '标签筛选', + 'description' => '标签筛选', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + ], + ], + [ + 'name' => 'search', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon名称', + 'description' => '支持 Addon 名称、描述、关键词查询', + 'type' => 'string', + 'required' => false, + 'example' => '105095', + ], + ], + [ + 'name' => 'regexp', + 'in' => 'query', + 'schema' => [ + 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", + 'description' => '查询字段, 是否正则匹配, 默认为false'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'addons' => [ + 'description' => '可用接入组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接入组件详情。', + 'type' => 'object', + 'properties' => [ + 'alias' => [ + 'description' => '接入组件别名。', + 'type' => 'string', + 'example' => 'resume_vector_alias', + ], + 'categories' => [ + 'description' => '接入组件标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'middleware', + ], + ], + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘信息。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '仪表盘描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'name' => [ + 'description' => '仪表盘名称。', + 'type' => 'string', + 'example' => 'rum_view_link_rum_api', + ], + 'url' => [ + 'description' => '仪表盘效果图地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + ], + ], + ], + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'workspace api monitor test', + ], + 'environments' => [ + 'description' => '支持的接入策略类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接入策略类型信息', + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'description' => '接入组件的依赖列表。', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => '支持的集群类型。', + 'type' => 'array', + 'items' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'ManagedKubernetes/Default', + ], + ], + 'features' => [ + 'description' => '接入依赖的探针。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'description' => '是否支持。', + 'example' => 'true', + ], + ], + 'services' => [ + 'description' => '依赖的服务列表', + 'type' => 'array', + 'items' => [ + 'description' => '服务名称', + 'type' => 'string', + 'example' => 'Prometheus', + ], + ], + ], + ], + 'description' => [ + 'description' => '接入策略类型描述信息', + 'type' => 'string', + 'example' => 'o11y-demo-cn-heyuan', + ], + 'enable' => [ + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'label' => [ + 'description' => '接入策略类型标签。', + 'type' => 'string', + 'example' => '容器环境', + ], + 'name' => [ + 'description' => '接入策略类型名称。', + 'type' => 'string', + 'example' => 'CS', + ], + 'policies' => [ + 'description' => '接入策略配置。', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => [ + 'description' => '告警规则默认策略的启用状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'defaultInstall' => [ + 'description' => '是否默认安装', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'enableServiceAccount' => [ + 'description' => '是否分配 Service Account 用以与 Console API 通信。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'metricCheckRule' => [ + 'description' => '指标检测规则。', + 'type' => 'object', + 'properties' => [ + 'promQL' => [ + 'description' => 'PromQL 查询语句列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'PromQL 查询语句。', + 'type' => 'string', + 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', + ], + ], + ], + ], + 'needRestartAfterIntegration' => [ + 'description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'protocols' => [ + 'description' => '配置支持的协议类型。', + 'type' => 'array', + 'items' => [ + 'description' => '配置支持的协议类型详情。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '协议描述。', + 'type' => 'string', + 'example' => 'Support OpenTelemetry Protocal', + ], + 'icon' => [ + 'description' => '图标URL。', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + 'label' => [ + 'description' => '协议展示名称。', + 'type' => 'string', + 'example' => 'OpenTelemetry', + ], + 'name' => [ + 'description' => '协议名称。', + 'type' => 'string', + 'example' => 'openTelemetry', + ], + ], + ], + ], + 'targetAddonName' => [ + 'description' => '目标Addon名称。', + 'type' => 'string', + 'example' => 'cloud-acs-ecs', + ], + ], + ], + 'policyType' => [ + 'description' => '接入中心策略类型', + 'type' => 'string', + 'example' => 'CS', + ], + 'commonSchemaRefs' => [ + 'description' => '关联的Common Schema列表', + 'type' => 'array', + 'items' => [ + 'description' => '关联的Common Schema信息', + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'description' => 'Common Schema 的分组名称', + 'type' => 'string', + 'example' => 'acs-ecs', + ], + 'version' => [ + 'description' => 'Common Schema的版本', + 'type' => 'string', + 'example' => '0.1.4', + ], + ], + ], + ], + ], + ], + ], + 'icon' => [ + 'description' => '图标URL地址', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + 'keywords' => [ + 'description' => '关键词列表', + 'type' => 'array', + 'items' => [ + 'description' => '关键词', + 'type' => 'string', + 'example' => 'Container', + ], + ], + 'language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'latestReleaseCreateTime' => [ + 'description' => '最新一次创建时间。', + 'type' => 'string', + 'example' => '2025-09-03T03:15:56Z', + ], + 'name' => [ + 'description' => '接入组件名称。', + 'type' => 'string', + 'example' => 'rum_api_dashboard_explorer_link_metric_set', + ], + 'once' => [ + 'description' => '是否只能安装一次。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'scene' => [ + 'description' => '组件场景。', + 'type' => 'string', + 'example' => 'middleware', + ], + 'version' => [ + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '*', + ], + 'weight' => [ + 'description' => '接入组件展示权重。', + 'type' => 'string', + 'example' => '99', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addons\\": [\\n {\\n \\"alias\\": \\"resume_vector_alias\\",\\n \\"categories\\": [\\n \\"middleware\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"name\\": \\"rum_view_link_rum_api\\",\\n \\"url\\": \\"http://xxxxxxx\\"\\n }\\n ],\\n \\"description\\": \\"workspace api monitor test\\",\\n \\"environments\\": [\\n {\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"enable\\": false,\\n \\"label\\": \\"容器环境\\",\\n \\"name\\": \\"CS\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"scraper_up{scraper=\\\\\\\\\\\\\\"ecs\\\\\\\\\\\\\\"}==1\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"Support OpenTelemetry Protocal\\",\\n \\"icon\\": \\"http://xxxxxxx\\",\\n \\"label\\": \\"OpenTelemetry\\",\\n \\"name\\": \\"openTelemetry\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"cloud-acs-ecs\\"\\n },\\n \\"policyType\\": \\"CS\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"acs-ecs\\",\\n \\"version\\": \\"0.1.4\\"\\n }\\n ]\\n }\\n ],\\n \\"icon\\": \\"http://xxxxxxx\\",\\n \\"keywords\\": [\\n \\"Container\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2025-09-03T03:15:56Z\\",\\n \\"name\\": \\"rum_api_dashboard_explorer_link_metric_set\\",\\n \\"once\\": true,\\n \\"scene\\": \\"middleware\\",\\n \\"version\\": \\"*\\",\\n \\"weight\\": \\"99\\"\\n }\\n ],\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '查询接入组件列表', + 'description' => '用于创建一个站点监控任务', + ], + 'ListBizTraces' => [ + 'summary' => '业务链路列表', + 'path' => '/bizTraces', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'workspace', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间名称', + 'type' => 'string', + 'required' => false, + 'example' => 'default-cms-xxxxxx-cn-beijing', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回结果数,最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页Token', + 'type' => 'string', + 'required' => false, + 'example' => 'aa9d0e569b88098a0e3155c29b473201a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0CEC5375-C554-562B-A65F-*****', + ], + 'maxResults' => [ + 'description' => '最大返回结果数,最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'nextToken' => [ + 'description' => '下一次查询的令牌。', + 'type' => 'string', + 'example' => 'aa9d0e569b88098a0e3155c29b473201a', + ], + 'totalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + 'items' => [ + 'description' => '业务链路列表', + 'type' => 'array', + 'items' => [ + 'description' => '业务链路', + '$ref' => '#/components/schemas/BizTraceConfig', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0CEC5375-C554-562B-A65F-*****\\",\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"aa9d0e569b88098a0e3155c29b473201a\\",\\n \\"totalCount\\": 66,\\n \\"items\\": [\\n {\\n \\"workspace\\": \\"default-cms-xxxxxxx-cn-hangzhou\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\",\\n \\"bizTraceName\\": \\"just test\\",\\n \\"bizTraceCode\\": \\"label_env\\",\\n \\"ruleConfig\\": \\"[{\\\\\\"entrancePid\\\\\\":\\\\\\"xxxxx@b57c44xx6e86\\\\\\",\\\\\\"rpcMatcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"EQUALS\\\\\\",\\\\\\"pattern\\\\\\":\\\\\\"/createApp\\\\\\"},\\\\\\"characteristics\\\\\\":{\\\\\\"operation\\\\\\":\\\\\\"AND\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"target\\\\\\":\\\\\\"CUSTOM_EXTRACT\\\\\\",\\\\\\"matcher\\\\\\":{\\\\\\"matchType\\\\\\":\\\\\\"CONTAINS\\\\\\",\\\\\\"pattern\\\\\\":[]}}]}}]\\",\\n \\"advancedConfig\\": \\"{\\\\\\"sample\\\\\\":{\\\\\\"strategy\\\\\\":\\\\\\"BY_APP\\\\\\"}}\\",\\n \\"createTime\\": \\"2025-12-12 00:00:00\\",\\n \\"regionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询业务链路列表', + ], + 'ListIntegrationPolicyAddons' => [ + 'summary' => '获取当前策略安装的Addon列表。', + 'path' => '/integration-policies/{policyId}/addons', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境id', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-3563e6bf338141b3b92c118e2c318c37', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'addons' => [ + 'description' => 'Addon列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Addon信息。', + 'type' => 'object', + 'properties' => [ + 'alias' => [ + 'description' => '展示名。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'categories' => [ + 'description' => '类别。', + 'type' => 'array', + 'items' => [ + 'description' => '类别。', + 'type' => 'string', + 'example' => 'database', + ], + ], + 'dashboards' => [ + 'description' => '仪表盘的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '仪表盘。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '用于mysql的监控大盘', + ], + 'name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'MySQL Overview', + ], + 'url' => [ + 'description' => '大盘地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + ], + ], + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Observability integration.', + ], + 'environments' => [ + 'description' => '支持的环境列表。', + 'type' => 'array', + 'items' => [ + 'description' => '环境信息。', + 'type' => 'object', + 'properties' => [ + 'dependencies' => [ + 'description' => '依赖。', + 'type' => 'object', + 'properties' => [ + 'clusterTypes' => [ + 'description' => '对集群类型的依赖。', + 'type' => 'array', + 'items' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'ACK', + ], + ], + 'features' => [ + 'description' => '对探针的依赖。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'description' => 'metric-agent', + 'example' => 'true', + ], + ], + 'services' => [ + 'description' => '对产品 Code 的依赖。', + 'type' => 'array', + 'items' => [ + 'description' => '服务名称', + 'type' => 'string', + 'example' => 'Prometheus', + ], + ], + ], + ], + 'description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'o11y-demo-cn-heyuan', + ], + 'enable' => [ + 'description' => '是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'label' => [ + 'description' => '环境展示名称。', + 'type' => 'string', + 'example' => 'Cloud', + ], + 'name' => [ + 'description' => '环境名称。', + 'type' => 'string', + 'example' => 'Cloud', + ], + 'policies' => [ + 'description' => '策略。', + 'type' => 'object', + 'properties' => [ + 'alertDefaultStatus' => [ + 'description' => '告警规则默认策略的启用状态。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'defaultInstall' => [ + 'description' => '是否默认安装', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'enableServiceAccount' => [ + 'description' => '是否分配 Service Account 用以与 Console API 通信。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'metricCheckRule' => [ + 'description' => '指标检测规则。', + 'type' => 'object', + 'properties' => [ + 'promQl' => [ + 'description' => 'Prom查询语句。', + 'type' => 'array', + 'items' => [ + 'description' => 'Prom查询语句', + 'type' => 'string', + 'example' => 'up{job="mysql"} > 0', + ], + ], + ], + ], + 'needRestartAfterIntegration' => [ + 'description' => '是否在插件接入时完成安装后即进入 Pod 重启引导。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'protocols' => [ + 'description' => '协议。', + 'type' => 'array', + 'items' => [ + 'description' => '协议。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'icon' => [ + 'description' => '图标', + 'type' => 'string', + 'example' => ' https://img.alixxxx', + ], + 'label' => [ + 'description' => '展示名称。', + 'type' => 'string', + 'example' => 'Golang', + ], + 'name' => [ + 'description' => '协议名称。', + 'type' => 'string', + 'example' => 'golang', + ], + ], + ], + ], + 'targetAddonName' => [ + 'description' => '目标Addon名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + ], + ], + ], + ], + ], + 'icon' => [ + 'description' => '组件图标。', + 'type' => 'string', + 'example' => 'asert/mysql.svg', + ], + 'keywords' => [ + 'description' => '关键词', + 'type' => 'array', + 'items' => [ + 'description' => '关键词', + 'type' => 'string', + 'example' => 'container', + ], + ], + 'language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'latestReleaseCreateTime' => [ + 'description' => '最新一次创建时间。', + 'type' => 'string', + 'example' => '2025-09-03T03:15:56Z', + ], + 'name' => [ + 'description' => 'Addon名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'once' => [ + 'description' => '是否只能安装一次。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'scene' => [ + 'description' => '组件场景。', + 'type' => 'string', + 'example' => 'container', + ], + 'version' => [ + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '0.1.1', + ], + 'weight' => [ + 'description' => '权重。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '99', + ], + ], + ], + ], + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7E00EF90-CEF9-57C9-9AE9-5AA937D37C03', + ], + 'total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"addons\\": [\\n {\\n \\"alias\\": \\"MySQL\\",\\n \\"categories\\": [\\n \\"database\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"description\\": \\"用于mysql的监控大盘\\",\\n \\"name\\": \\"MySQL Overview\\",\\n \\"url\\": \\"http://xxxxxxx\\"\\n }\\n ],\\n \\"description\\": \\"Observability integration.\\",\\n \\"environments\\": [\\n {\\n \\"dependencies\\": {\\n \\"clusterTypes\\": [\\n \\"ACK\\"\\n ],\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"Prometheus\\"\\n ]\\n },\\n \\"description\\": \\"o11y-demo-cn-heyuan\\",\\n \\"enable\\": true,\\n \\"label\\": \\"Cloud\\",\\n \\"name\\": \\"Cloud\\",\\n \\"policies\\": {\\n \\"alertDefaultStatus\\": \\"RUNNING\\",\\n \\"defaultInstall\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"metricCheckRule\\": {\\n \\"promQl\\": [\\n \\"up{job=\\\\\\"mysql\\\\\\"} > 0\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"protocols\\": [\\n {\\n \\"description\\": \\"test\\",\\n \\"icon\\": \\" https://img.alixxxx\\",\\n \\"label\\": \\"Golang\\",\\n \\"name\\": \\"golang\\"\\n }\\n ],\\n \\"targetAddonName\\": \\"mysql\\"\\n }\\n }\\n ],\\n \\"icon\\": \\"asert/mysql.svg\\",\\n \\"keywords\\": [\\n \\"container\\"\\n ],\\n \\"language\\": \\"zh\\",\\n \\"latestReleaseCreateTime\\": \\"2025-09-03T03:15:56Z\\",\\n \\"name\\": \\"mysql\\",\\n \\"once\\": true,\\n \\"scene\\": \\"container\\",\\n \\"version\\": \\"0.1.1\\",\\n \\"weight\\": 99\\n }\\n ],\\n \\"requestId\\": \\"7E00EF90-CEF9-57C9-9AE9-5AA937D37C03\\",\\n \\"total\\": 5\\n}","type":"json"}]', + 'title' => '获取当前策略安装的Addon列表', + 'description' => '获取当前策略安装的Addon列表。', + ], + 'ListIntegrationPolicyCollectors' => [ + 'summary' => '获取接入中心策略的采集器信息', + 'path' => '/integration-policies/{policyId}/collectors', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '接入中心策略ID。', + 'description' => '接入中心策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-d95435164593aece55f9999ce45c', + ], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon Release名称。', + 'description' => 'Addon Release名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'release-1234567', + ], + ], + [ + 'name' => 'collectorType', + 'in' => 'query', + 'schema' => [ + 'description' => '采集器类型', + 'type' => 'string', + 'required' => true, + 'example' => 'Exporter', + ], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'collectors' => [ + 'description' => '采集器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '采集器信息。', + 'type' => 'object', + 'properties' => [ + 'collectorName' => [ + 'description' => '采集器名称', + 'type' => 'string', + 'example' => 'collector-kkxx', + ], + 'collectorType' => [ + 'description' => '采集器类型', + 'type' => 'string', + 'example' => 'Exporter', + ], + 'conditions' => [ + 'description' => '阶段状态。', + 'type' => 'array', + 'items' => [ + 'description' => '详细信息。', + 'type' => 'object', + 'properties' => [ + 'firstTransitionTime' => [ + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2024-08-27T13:59:23+08:00', + ], + 'lastTransitionTime' => [ + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2024-08-27T13:59:23+08:00', + ], + 'message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'reason' => [ + 'description' => '失败原因', + 'type' => 'string', + 'example' => 'Probe', + ], + 'status' => [ + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => 'True', + ], + 'type' => [ + 'description' => '阶段类型', + 'type' => 'string', + 'example' => 'Ready', + ], + ], + ], + ], + 'managed' => [ + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'state' => [ + 'description' => '采集器状态。', + 'type' => 'string', + 'example' => 'xx', + ], + 'version' => [ + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '2.6.2', + ], + 'workloads' => [ + 'description' => '工作负载列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作负载详情', + 'type' => 'object', + 'properties' => [ + 'hostIp' => [ + 'description' => '主机IP', + 'type' => 'string', + 'example' => '10.10.10.10', + ], + 'ip' => [ + 'description' => '工作负载的IP地址。', + 'type' => 'string', + 'example' => '11.193.82.198', + ], + 'managed' => [ + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'managedInfo' => [ + 'description' => '策略管理信息。', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-xxxxx', + ], + 'vswitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-xxxxxx', + ], + ], + ], + 'message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'name' => [ + 'description' => '工作负载名称', + 'type' => 'string', + 'example' => 'exporter-xxx', + ], + 'namespace' => [ + 'description' => '工作负载命名空间', + 'type' => 'string', + 'example' => 'prod-db', + ], + 'ownerReferenceKind' => [ + 'description' => '引用上级的Kind', + 'type' => 'string', + 'example' => 'Deployment', + ], + 'ownerReferenceName' => [ + 'description' => '引用上级的名称', + 'type' => 'string', + 'example' => 'exporter', + ], + 'startTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2024-08-27T13:59:23+08:00', + ], + 'status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => '{}', + ], + 'version' => [ + 'description' => '工作负载版本。', + 'type' => 'string', + 'example' => 'v2.4.4', + ], + ], + ], + ], + 'releaseName' => [ + 'description' => 'AddonRelease名称。', + 'type' => 'string', + 'example' => 'ecs-loong-collector-i-f8z1176fg57rlwmc1rfi', + ], + 'addonMeta' => [ + 'description' => 'Addon详情。', + '$ref' => '#/components/schemas/AddonMeta', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"collectors\\": [\\n {\\n \\"collectorName\\": \\"collector-kkxx\\",\\n \\"collectorType\\": \\"Exporter\\",\\n \\"conditions\\": [\\n {\\n \\"firstTransitionTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"lastTransitionTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"message\\": \\"success\\",\\n \\"reason\\": \\"Probe\\",\\n \\"status\\": \\"True\\",\\n \\"type\\": \\"Ready\\"\\n }\\n ],\\n \\"managed\\": false,\\n \\"state\\": \\"xx\\",\\n \\"version\\": \\"2.6.2\\",\\n \\"workloads\\": [\\n {\\n \\"hostIp\\": \\"10.10.10.10\\",\\n \\"ip\\": \\"11.193.82.198\\",\\n \\"managed\\": false,\\n \\"managedInfo\\": {\\n \\"securityGroupId\\": \\"sg-xxxxx\\",\\n \\"vswitchId\\": \\"vsw-xxxxxx\\"\\n },\\n \\"message\\": \\"ok\\",\\n \\"name\\": \\"exporter-xxx\\",\\n \\"namespace\\": \\"prod-db\\",\\n \\"ownerReferenceKind\\": \\"Deployment\\",\\n \\"ownerReferenceName\\": \\"exporter\\",\\n \\"startTime\\": \\"2024-08-27T13:59:23+08:00\\",\\n \\"status\\": \\"{}\\",\\n \\"version\\": \\"v2.4.4\\"\\n }\\n ],\\n \\"releaseName\\": \\"ecs-loong-collector-i-f8z1176fg57rlwmc1rfi\\",\\n \\"addonMeta\\": {\\n \\"name\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"language\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"scene\\": \\"\\",\\n \\"alias\\": \\"\\",\\n \\"icon\\": \\"\\",\\n \\"keywords\\": [\\n \\"\\"\\n ],\\n \\"once\\": true,\\n \\"environments\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"enable\\": true,\\n \\"label\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"policies\\": {\\n \\"defaultInstall\\": true,\\n \\"targetAddonName\\": \\"\\",\\n \\"alertDefaultStatus\\": \\"\\",\\n \\"protocols\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"label\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"icon\\": \\"\\"\\n }\\n ],\\n \\"metricCheckRule\\": {\\n \\"promQL\\": [\\n \\"\\"\\n ]\\n },\\n \\"needRestartAfterIntegration\\": true,\\n \\"enableServiceAccount\\": true,\\n \\"bindEntity\\": {\\n \\"entityGroupMode\\": true,\\n \\"singleEntityMode\\": true,\\n \\"entityType\\": \\"\\",\\n \\"vpcIdFieldKey\\": \\"\\"\\n },\\n \\"bindDefaultPolicy\\": true\\n },\\n \\"dependencies\\": {\\n \\"features\\": {\\n \\"key\\": true\\n },\\n \\"services\\": [\\n \\"\\"\\n ],\\n \\"clusterTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"policyType\\": \\"\\",\\n \\"commonSchemaRefs\\": [\\n {\\n \\"group\\": \\"\\",\\n \\"version\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"categories\\": [\\n \\"\\"\\n ],\\n \\"dashboards\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"url\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"weight\\": 0,\\n \\"latestReleaseCreateTime\\": \\"\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8\\"\\n}","type":"json"}]', + 'title' => '获取接入中心策略的采集器', + ], + 'ListIntegrationPolicyServiceMonitors' => [ + 'summary' => '获取接入中心策略的ServiceMonitor信息', + 'path' => '/integration-policies/{policyId}/service-monitors', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'policyId', + 'in' => 'path', + 'schema' => [ + 'title' => '接入中心策略ID。', + 'description' => '接入中心策略ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', + ], + ], + [ + 'name' => 'addonReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon Release名称。', + 'description' => 'Addon Release名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'release-12345678', + ], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间。', + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'encryptYaml', + 'in' => 'query', + 'schema' => [ + 'title' => '是否加密Yaml。', + 'description' => '是否加密Yaml。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'description' => '集群ID.', + 'type' => 'string', + 'example' => 'ea119prod-ea119blinkcptssd1', + ], + 'policyId' => [ + 'description' => '策略 ID。', + 'type' => 'string', + 'example' => 'policy-ac38a7cb02d14ff48bc9f97d0a75063e', + ], + 'serviceMonitors' => [ + 'description' => 'ServiceMonitor列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'addonName' => [ + 'description' => 'Addon 名称。', + 'type' => 'string', + 'example' => 'cloud-acs-ecs', + ], + 'addonReleaseName' => [ + 'description' => 'AddonRelease名称', + 'type' => 'string', + 'example' => 'release-1234567', + ], + 'addonVersion' => [ + 'description' => 'Addon版本', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'configYaml' => [ + 'description' => '配置yaml', + 'type' => 'string', + 'example' => 'apiVersion: xxxxx', + ], + 'enableStatus' => [ + 'description' => '启用状态', + 'type' => 'string', + 'example' => 'run', + ], + 'encryptYaml' => [ + 'description' => '加密yaml', + 'type' => 'boolean', + 'example' => 'YXBpVmVyc2lvbjogeHh4eHgK', + ], + 'endpoints' => [ + 'description' => 'Endpoint列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint列表', + 'type' => 'object', + 'properties' => [ + 'interval' => [ + 'description' => '采集时间', + 'type' => 'string', + 'example' => '30s', + ], + 'matchedTargetCount' => [ + 'description' => '匹配的target数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '65', + ], + 'path' => [ + 'description' => '采集路径', + 'type' => 'string', + 'example' => '/metrics', + ], + 'port' => [ + 'description' => '采集端口', + 'type' => 'string', + 'example' => '9100', + ], + 'targetPort' => [ + 'description' => '目标端口', + 'type' => 'string', + 'example' => 'http', + ], + ], + ], + ], + 'matchedServiceCount' => [ + 'description' => '匹配service的数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'name' => [ + 'description' => 'ServiceMonitor名称。', + 'type' => 'string', + 'example' => '62a526c5-f6ca-4cfb-b5a4-b76974cffe51', + ], + 'namespace' => [ + 'description' => '项目空间名称。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'CD8BA7D6-995D-578D-9941-78B0FECD14B5', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusterId\\": \\"ea119prod-ea119blinkcptssd1\\",\\n \\"policyId\\": \\"policy-ac38a7cb02d14ff48bc9f97d0a75063e\\",\\n \\"serviceMonitors\\": [\\n {\\n \\"addonName\\": \\"cloud-acs-ecs\\",\\n \\"addonReleaseName\\": \\"release-1234567\\",\\n \\"addonVersion\\": \\"0.0.1\\",\\n \\"configYaml\\": \\"apiVersion: xxxxx\\",\\n \\"enableStatus\\": \\"run\\",\\n \\"encryptYaml\\": true,\\n \\"endpoints\\": [\\n {\\n \\"interval\\": \\"30s\\",\\n \\"matchedTargetCount\\": 65,\\n \\"path\\": \\"/metrics\\",\\n \\"port\\": \\"9100\\",\\n \\"targetPort\\": \\"http\\"\\n }\\n ],\\n \\"matchedServiceCount\\": 50,\\n \\"name\\": \\"62a526c5-f6ca-4cfb-b5a4-b76974cffe51\\",\\n \\"namespace\\": \\"arms-prom\\"\\n }\\n ],\\n \\"requestId\\": \\"CD8BA7D6-995D-578D-9941-78B0FECD14B5\\"\\n}","type":"json"}]', + 'title' => '获取接入中心策略的ServiceMonitor信息', + ], + 'UpdateBizTrace' => [ + 'summary' => '修改业务链路', + 'path' => '/bizTrace/{bizTraceId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'bizTraceId', + 'in' => 'path', + 'schema' => [ + 'description' => '业务链路id', + 'type' => 'string', + 'required' => false, + 'example' => 'e339260ed64c95d', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'bizTraceName' => [ + 'description' => '业务链路名称', + 'type' => 'string', + 'required' => false, + 'example' => 'just test', + ], + 'workspace' => [ + 'description' => '工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default-cms-xxxxxxx-cn-hangzhou', + ], + 'ruleConfig' => [ + 'description' => '配置规则列表', + 'type' => 'string', + 'required' => false, + 'example' => '[{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]', + ], + 'advancedConfig' => [ + 'description' => '高级配置', + 'type' => 'string', + 'required' => false, + 'example' => '{"sample":{"strategy":"BY_APP"}}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC', + ], + 'bizTraceId' => [ + 'description' => '业务链路id', + 'type' => 'string', + 'example' => 'e339260ed64c95d', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC\\",\\n \\"bizTraceId\\": \\"e339260ed64c95d\\"\\n}","type":"json"}]', + 'title' => '修改业务链路', + ], + 'UpdatePrometheusUserSetting' => [ + 'summary' => '更新Prometheus用户配置信息。'."\n" + .'注意:修改settingKey=financeUsageRegion,会将Prometheus用量数据切换到指定region的sls,同时历史用量数据将无法在Prometheus控制台查看。', + 'path' => '/prometheus-user-setting/{settingKey}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'settingKey', + 'in' => 'path', + 'schema' => [ + 'description' => '用户配置key。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'defaultPaymentType' => '默认付费方式', + 'defaultPostPayDays' => '上报量付费方式的默认存量时长', + 'financeUsageRegion' => '用量统计的存量regionId', + 'defaultPostPayGBDays' => '写入量付费方式的默认存量时长', + ], + 'example' => 'financeUsageRegion', + ], + ], + [ + 'name' => 'settingValue', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => 'setting值', + 'description' => '用户配置setting值。', + 'type' => 'string', + 'required' => true, + 'example' => 'ap-southeast-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8FDE2569-626B-5176-9844-28877A*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"8FDE2569-626B-5176-9844-28877A*****\\"\\n}","type":"json"}]', + 'title' => '更新Prometheus用户配置。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cms.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cms.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cms.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'metrics.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'metrics.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'metrics.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'metrics.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'metrics.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'metrics.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'metrics.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'metrics.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'metrics.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'metrics.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'metrics.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'metrics.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'metrics.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'metrics.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'metrics.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'metrics.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'metrics.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'metrics.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cms.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'metrics.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'metrics.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhongwei', + 'endpoint' => 'metrics.cn-zhongwei.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'metrics.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'metrics.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'metrics.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'metrics.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'metrics.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'metrics.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'metrics.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'metrics.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'metrics.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cms.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'metrics.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'metrics.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'metrics.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'metrics.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'metrics.cn-north-2-gov-1.aliyuncs.com', + ], + ], +]; |
